API de notificación de grupo

Descripción

Esta API se utiliza para crear un envío push de grupo. Una llamada puede enviar mensajes a todas las aplicaciones del grupo.

No se admite el atributo override_msg_id en option.

El envío push de grupo solo admite configurar tareas programadas al realizar el envío desde la consola, pero no admite llamar a la Schedule API para configurar tareas programadas.

Validación de la llamada

Añadir un campo (par clave/valor) al encabezado HTTP (Header):

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Este bloque de código se muestra en una ventana flotante

Es decir, el algoritmo de generación de base64_auth_string es base64(username:password)
El nombre del encabezado es Authorization y el valor es el par username:password convertido a base64 (separados por dos puntos).
En el contexto de la API de envío push de grupo, username es el prefijo group- más la GroupKey, y la contraseña es el Master Secret del grupo. Ambos se encuentran en Gestión de grupos > Editar en la consola.

Dirección de llamada

POST v4/grouppush

Solicitudes de ejemplo

curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/grouppush -H "Content-Type: application/json" -u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" -d '{ "from": "push", "to": "all", "body": { "platform": "all", "notification": { "android": { "alert": "Hi, Push!", "title": "Send to Android", "builder_id": 1, "extras": { "newsid": 321 } }, "ios": { "alert": "Hi, MTPush!", "sound": "default", "badge": "+1", "extras": { "newsid": 321 } } }, "message": { "msg_content": "Hi,MTPush", "content_type": "text", "title": "msg", "extras": { "key": "value" } }, "options": { "time_to_live": 60, "apns_production": false } }, "request_id": "12345678", "custom_args": "business info" }' > POST /v4/grouppush HTTP/1.1 > Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

              
              curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/grouppush 
-H "Content-Type: application/json" 
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" 
-d '{
    "from": "push",
    "to": "all",
    "body": {
        "platform": "all",
        "notification": {
            "android": {
                "alert": "Hi, Push!",
                "title": "Send to Android",
                "builder_id": 1,
                "extras": {
                    "newsid": 321
                }
            },
            "ios": {
                "alert": "Hi, MTPush!",
                "sound": "default",
                "badge": "+1",
                "extras": {
                    "newsid": 321
                }
            }
        },
        "message": {
            "msg_content": "Hi,MTPush",
            "content_type": "text",
            "title": "msg",
            "extras": {
                "key": "value"
            }
        },
        "options": {
            "time_to_live": 60,
            "apns_production": false
        }
    },
    "request_id": "12345678",
    "custom_args": "business info"
}'
> POST /v4/grouppush HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==

Este bloque de código se muestra en una ventana flotante

Parámetros de la solicitud

Para obtener más información sobre los parámetros de la solicitud, consulte Create Push API.

Ejemplo de respuesta

Correcto

{ "0c3de43c6a6b68c9f4261b06": {"request_id":"12345678","msg_id":"2460001"}, "35c424abde12f475566ca8af": {"request_id":"12345678","msg_id":"2460001"}, "8f02a4fa717a6235734d92de": {"request_id":"12345678","msg_id":"2460001"}, "group_msgid": "cbou2uum98lps87rtic0" }

              
              {
    "0c3de43c6a6b68c9f4261b06": {"request_id":"12345678","msg_id":"2460001"},
    "35c424abde12f475566ca8af": {"request_id":"12345678","msg_id":"2460001"},
    "8f02a4fa717a6235734d92de": {"request_id":"12345678","msg_id":"2460001"},
    "group_msgid": "cbou2uum98lps87rtic0"
}

Este bloque de código se muestra en una ventana flotante

Fallido

{ "code": 400, "data": "", "message": "error message" }

              
              {   
  "code": 400,
  "data": "",
  "message": "error message"
}

Este bloque de código se muestra en una ventana flotante

Códigos

Para obtener más información, consulte Create Push API - Response.