Índice:
- Buscando todas las citas
- recopila el ID del broadcast del que quieres obtener la información
- Buscando información sobre un horario específico
El módulo de programación Blip es una herramienta poderosa para involucrar a los usuarios en un bot. A través de él, es posible programar el lanzamiento de mensajes (broadcasts) para una lista de usuarios previamente definida. De forma predeterminada, cada bot ya tiene una lista de usuarios llamada Todos los Usuarios, que contiene a cualquier usuario que haya hablado con el bot, al menos una vez, independientemente del canal. Para hacer una cita entra en el Portal, elige tu bot y en el menú superior elige más opciones y luego haz clic en Programador.
Después de realizar un broadcast es muy importante analizar la asertividad del disparo. Para ello es necesario realizar algunas peticiones en la API Blip (mediante peticiones HTTP o mediante comandos en los SDK).
Buscando todas las citas
Método de solicitud: POST
| Nota: Use la URL con la identificación del contrato para consumir los puntos finales informados a continuación, su rendimiento y operación pueden verse afectados si no tiene la identificación del contrato, por lo que es esencial usar la URL con la identificación del contrato para usar las solicitudes http. |
URL: https://{{contractid}}.http.msging.net/commands
Encabezados:
- Key: Autorización
- Value: clave API-KEY-BOT
{
"id": "640aaaca-499a-4b21-8375-1e005b0fa583",
"method": "get",
"to": "postmaster@scheduler.msging.net",
"uri": "/schedules?since=2018-04-18T00:00:00.938Z&$skip=0&$take=100"
}
Cuerpo: JSON con el comando que busca todas las citas programadas, según el protocolo LIME (más información sobre las extensiones Blip aquí).
- El parámetro since define un filtro para la fecha de inicio de la encuesta, es decir, solo se les dará un retorno a las citas realizadas a partir del 18 de marzo.
- El parámetro skip define el número de programas que se descartarán (utilizados para la paginación).
- El parámetro Blip define el número de citas agendadas las que se les dará un retorno.
Recopila el ID del broadcast del que quieres obtener la información
La devolución de la solicitud realizada en el paso 1 devolverá una lista de horarios con el ID de cada mensaje programado. Analiza la propiedad de los elementos contenidos en la respuesta devuelta por el servidor y elige de cuál de los horarios deseas obtener la información.
Observa un ejemplo de retorno a continuación:
{
"id": "640aaaca-499a-4b21-8375-1e005b0fa583",
"from": "postmaster@scheduler.msging.net/#az-iris3",
"method": "get",
"resource": {
"total": 3,
"itemType": "application/vnd.iris.schedule+json",
"items":[
{
"when": "2018-05-18T16:37:35.900Z",
"status": "executed",
"message": {
"content": "Some text",
"from": "assistentedeastronomia@msging.net",
"id": "30385066-a00c-423c-b254-0debc51093f8",
"pp": "postmaster@scheduler.msging.net/assistentedeastronomia%40msging.net",
"to": "assistentedeastronomia+senders@broadcast.msging.net",
"type": "text/plain"
}
},
...
],
},
"status": "success",
"to": "bot@msging.net/default",
"type": "application/vnd.lime.collection+json"
}
- El valor 30385066-a00c-423c-b254-0debc51093f8 representa el ID de mensaje que fue programado.
- El nodo assistentedeastronomia+senders@broadcast.msging.net, que identifica la lista a la que se envió el agendamiento.
Buscando información sobre un horario específico
Con el ID del mensaje programado y el identificador de la lista para la cual se realizó el horario, simplemente realiza una solicitud para buscar la información relacionada con la transmisión respectiva.
El siguiente ejemplo muestra un ejemplo de esta solicitud:
Método de solicitud: POST
| Nota: Use la URL con la identificación del contrato para consumir los puntos finales informados a continuación, su rendimiento y operación pueden verse afectados si no tiene la identificación del contrato, por lo que es esencial usar la URL con la identificación del contrato para usar las solicitudes http. |
URL: https://{{contractid}}.http.msging.net/commands
Encabezados:
- Key: Authorization
- Value: Key API-KEY-BOT
Cuerpo: JSON con el comando que busca todas los agendamientos, según el protocolo LIME (ver más información sobre las extensiones Blip aquí)
{
"id": "829044c9-3c97-46fd-9dc0-6a8ce0dbca3c",
"method": "get",
"to": "postmaster@broadcast.msging.net",
"uri": "/lists/assistentedeastronomia%2Bsenders%40broadcast.msging.net/messages/30385066-a00c-423c-b254-0debc51093f8"
}
- El valor assistentedeastronomia%2Bsenders%40broadcast.msging.net, representa el identificador de la lista utilizada para la programación (recopilada en el paso 2), codificada en formato URL.
- El valor 30385066-a00c-423c-b254-0debc51093f8 representa el ID de mensaje que se programó (recopilado en el paso 2).
El resultado de esta solicitud tiene información detallada sobre un horario específico. El JSON a continuación mostramos un ejemplo del resultado de la solicitud anterior:
{
"from": "postmaster@broadcast.msging.net/#az-iris3",
"id": "829044c9-3c97-46fd-9dc0-6a8ce0dbca3c",
"method": "get",
"resource":{
"id": "30385066-a00c-423c-b254-0debc51093f8",
"status": "processed",
"statusDate": "2018-05-18T16:37:42.420Z",
"consumed": 0,
"failed": 0,
"received": 0,
"recipients": 2,
"sent": 2
},
"status": "success",
"to": "assistentedeastronomia@msging.net/default",
"type": "application/vnd.iris.distribution-list-message+json"
}
La información más importante sobre cada programación se encuentra dentro del objeto Resource.
| Estado | Descripción |
| consumed | El número de análisis que se omitirán. |
| failed | El número de análisis que se devolverán. |
| received | Número de mensajes recibidos. |
| recipients | Número de usuarios presentes en la lista. |
| sent | Número de mensajes enviados durante el broadcast. |
Para obtener más información, acceda a la discusión sobre el tema en nuestra comunidad o los videos en nuestro canal. 😃