Push API v4

Enviar una notificación o un mensaje a un único dispositivo o a una lista de dispositivos.

El contenido del push solo puede ser un único objeto push en formato JSON.

Para funciones relacionadas con etiquetas/alias, consulte AppPushAPI.

Límites de tasa de solicitudes

Nuestra API impone límites a la frecuencia de llamadas para garantizar la estabilidad y la equidad del servicio. Los límites de QPS (consultas por segundo) para cada AppKey son los siguientes:

• Límite estándar: un máximo de 500 solicitudes por segundo.
• Límite avanzado: si usted es suscriptor de nuestro plan de pago y su AppKey de pago requiere un límite de QPS más alto, póngase en contacto con nuestro equipo comercial: Sales@engagelab.com.

Validación de llamadas

Para obtener más información, consulte Método de autenticación

Dirección de llamada

              
              POST /v4/push

            

Ejemplos de solicitud

Encabezado de solicitud

              
              > POST /v4/push HTTP/1.1
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            

Cuerpo de la solicitud

              
              {
    "from": "push",
    "to": "all",
    "body": {
        "platform": "web",
        "notification": {
            "alert": "Hi,MTPush !",
            "web": {
              "alert": "Hi,MTPush !",
                "title": "web_push",
                "url": "http://www.google.com",
                "extras": {
                    "web-key1": "web-value1"
                }
            }
        }
    },
    "request_id": "12345678",
    "custom_args": {
        "business": "info"
    }
}

            

Parámetros de la solicitud

La estructura de parámetros del push se detalla en la tabla siguiente:

from

El remitente del negocio actual. El valor es de tipo String y es opcional.

Ejemplos de solicitud

              
              {
    "from":"push"
}

            

to

Objeto de dispositivo de push, que indica la lista de dispositivos a los que se puede enviar un push. MTPush proporciona dos métodos: Registration ID y difusión.

Destino de push

              
              "to" : {"tag" : [ "tag1", "tag2"],
"tag_and" : ["tag3", "tag4"],
"tag_not" : ["tag5", "tag6"]
}

            

Ejemplos de solicitud

• Enviar a todos (difusión):

              
              {
  "to": "all",
}

            

• Enviar a múltiples Registration ID:

              
              {
  "to": {
    "registration_id": [
      "1a3018970ab49abcd8e",
      "1537bfd3f7d57d13cef",
      "163a3797c816b1160dc"
    ]
  }
}

            

body

Cuerpo de la solicitud de envío. Los campos admitidos son los siguientes:

platform

MTPush actualmente solo admite push en la plataforma Web, por lo que la palabra clave de platform es: "web".

              
              { "platform" : "web" }

            

notification

El objeto "notification" es uno de los objetos de contenido de un push (el otro es "message"), y se envía a la Web como una notificación.

web

Notificación en la plataforma Web.

              
              {
    "notification": {
        "web": {
            "alert": "hello, Push!",
            "title": "Push Test",
            "url":"http://www.google.com",
            "icon":"",
            "image":"",
            "extras": {
                "news_id": 134,
                "my_key": "a value"
            }
        }
    }
}

            

message

Mensaje dentro de la aplicación. También conocido como: mensaje personalizado o mensaje transparente. Este contenido no se mostrará en el navegador. Tras recibir el contenido del mensaje, el SDK lo transmite a la Web, que se encarga de la lógica empresarial.

El mensaje contiene los siguientes campos:

Ejemplo:

              
              {
  "message": {
    "msg_content": "Hi,Push",
    "content_type": "text",
    "title": "msg",
    "extras": {
      "key": "value"
    }
  }
}

            

options

Opciones de push. Actualmente incluye las siguientes opciones:

multi_language

Este campo es la funcionalidad de push multilingüe del servicio EngageLab Push. Permite enviar notificaciones personalizadas para usuarios de diferentes idiomas. Al especificar múltiples idiomas y su contenido de mensaje, título correspondiente en la solicitud de push, puede enviar notificaciones adecuadas según la configuración de idioma del usuario.

Parámetros de solicitud

Ejemplo de solicitud

              
                 {
    "options": {
      "multi_language": {
        "en": {
          "content": "",
          "title": "",
        }
      }
    }
   }

            

web_buttons

Utilice el parámetro web_buttons para describir el id, texto, icono y url del botón. La descripción de los parámetros es la siguiente:

Ejemplo:

              
              [
  {
    "id": "like-button",
    "text": "Like",
    "icon": "http://i.imgur.com/N8SN8ZS.png",
    "url": "https://yoursite.com"
  },
  {
    "id": "read-more-button",
    "text": "Read more",
    "icon": "http://i.imgur.com/MIxJp1L.png",
    "url": "https://yoursite.com"
  }
]

            

third_party_channel

Este campo se utiliza para rellenar la información personalizada del canal del sistema Web. El nombre de la clave es w3push y el valor es un objeto JSON que solo contiene un campo opcional distribution de tipo String.

Ejemplo:

              
              {
  "third_party_channel":{
    "w3push":{
      "distribution":"mtpush"
    }
  }
}

            

request_id

ID de solicitud, campo opcional personalizado por el cliente. El cliente lo utiliza para identificar la solicitud y se devuelve en la respuesta.

Ejemplo de solicitud

              
              {
      "request_id":"12345678"
}

            

Ejemplo de respuesta

custom_args

Campo opcional personalizado por el cliente. No se devuelve en la respuesta, pero se devuelve durante el callback.

              
              {
  "custom_args": {
        "business": "info"
    }
}

            

Parámetros de respuesta

Respuesta exitosa

              
              < HTTP/1.1 200 OK
< Content-Type: application/json
{"request_id":"18","msg_id":"1828256757"}

            

Respuesta fallida

El código de estado HTTP es 4xx o 5xx. El cuerpo de la respuesta contiene los siguientes campos:

              
              {
    "code": 3002,
    "message": "Push.template field must be set correctly when type is template"
}

            

Respuesta de llamada

Código de estado HTTP

Documento de referencia: HTTP-Status-Code

Códigos de error

Restricciones de push

Códigos de idioma