Loading...

Aviso:

Para brindarle información de soporte completa de manera más rápida, el contenido de esta página ha sido traducido al español mediante traducción automática. Para consultar la información de soporte más precisa, consulte la versión en inglés de este contenido.

Enviar Push Notifications de iOS

Descripción

Esta API se utiliza para enviar push notifications de texto a los dispositivos de los usuarios desde tu aplicación iOS para pruebas, después de registrar tu aplicación con Apple, inscribirte en las push notifications de Catalyst y registrar tu dispositivo. Debes implementar los seis pasos explicados en la sección de ayuda de Push Notifications- iOS antes de poder enviar push notifications a los dispositivos.

Catalyst te permite enviar push notifications ya sea a dispositivos de prueba registrados o a dispositivos de producción pasando el valor de appID desde el archivo de configuración del entorno correspondiente. La URL de solicitud para enviar push notifications a dispositivos de prueba y a dispositivos de producción varía. Estas se presentan en la sección de Detalles de la solicitud.

Puedes pasar el mensaje de la push notification y el destinatario al que deseas enviar las push notifications, junto con otros detalles en tu solicitud de API como se muestra en la solicitud de ejemplo.

Detalles de la solicitud

URL de solicitud para enviar notificaciones de prueba

POST

{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/test

copy

URL de solicitud para enviar notificaciones de producción

POST

{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/project-user/notify

copy

api-domain
URL
El dominio específico del DC para acceder a Catalyst API

project_id
Numerical
El ID único del proyecto

app_id
Numerical
El notificationAppID obtenido del archivo AppConfigurationDevelopment.plist/ AppConfigurationProduction.plist para el entorno apropiado

Encabezados de solicitud

Content-Type: application/json

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Alcance

ZohoCatalyst.notifications.mobile.CUSTOM

Propiedades JSON de la solicitud

recipient string
mandatory
La dirección de correo electrónico del usuario al que se debe enviar la push notification. Solo puedes enviarla a un usuario por llamada de API.
push_details json
mandatory

El JSON que contiene los detalles del contenido y los metadatos de la push notification

message string
mandatory
El contenido de texto de la push notification
Tamaño máximo: 100 caracteres

additional_info json
optional
Cualquier información adicional que necesites enviar en la forma de “sample_key” : “sample_value”
Tamaño máximo: 100 caracteres

badge_count integer
optional
El conteo que se mostrará sobre el ícono de la aplicación

reference_id string
optional
El ID de referencia

expiry_time integer
optional
El tiempo de expiración de la notificación en horas

Detalles de la respuesta

La respuesta devuelve el estado de la notificación enviada como success o failed, y los datos que se pasaron incluyendo message y expiry_time.

Sample Request: Production Device
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/204000000024010/push-notification/204000000036005/project-user/notify
-H “Content-Type: application/json”
-d ‘{ “recipients”:“amanda.boyle@zylker.com”, “push_details”:{ “message”:“Welcome to Zylker App!”, “badge_count”:10, “expiry_time”:12, “additional_info”:{ “sample_key” : “sample_value” } } }’

Sample Response
copy
{
"status": "success",
"data": {
    "recipients": "amanda.boyle@zylker.com",
    "push_details": {
        "message": "Welcome to Zylker App!",
        "additional_info": {
            "sample_key": "sample_value"
        },
        "badge_count": 10,
        "reference_id": null,
        "expiry_time": 12
    }
}
}