API de envío push en grupo

Descripción general de la función

Esta API se utiliza para crear un envío push para un grupo de aplicaciones. Con una sola llamada, se pueden enviar mensajes a todas las aplicaciones del grupo.

La propiedad override_msg_id de option no es compatible en este momento.

En el envío push en grupo, las tareas programadas solo se pueden configurar al enviar desde la consola. No se admite la configuración de tareas programadas mediante la API.

Autenticación

Añade el siguiente par clave/valor a la cabecera HTTP:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

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

El algoritmo de generación de base64_auth_string anterior es: base64(username:password)
El nombre de la cabecera es Authorization, y el valor es el par username:password convertido a Base64 (con dos puntos entre ambos).
En el escenario de la API de envío push en grupo, username es el prefijo group- más GroupKey, y password es el secreto maestro del grupo. Ambos pueden consultarse en la consola, en [Gestión de grupos] - [Editar].

Endpoint

POST v4/grouppush

              
              POST v4/grouppush

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

Ejemplo de solicitud

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": "web", "notification": { "alert": "Hi,MTPush !", "web": { "title": "web_push", "url": "http://www.google.com", "extras": { "web-key1": "web-value1" } } } }, "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": "web",
        "notification": {
            "alert": "Hi,MTPush !",
            "web": {
                "title": "web_push",
                "url": "http://www.google.com",
                "extras": {
                    "web-key1": "web-value1"
                }
            }
        }
    },
    "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 conocer los parámetros de la solicitud, consulta la API de creación de push.

Ejemplo de respuesta

Respuesta correcta

{ "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

Respuesta de error

{ "error": { "code": 21037, "message": "group_key is not a 24 size string or does not exist" } }

              
              {
    "error": {
        "code": 21037,
        "message": "group_key is not a 24 size string or does not exist"
    }
}

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

Códigos de error

Para más información, consulta "API de creación de push - Respuesta".