Consultel - Documentación
Pasarela Premium
¿Qué es la Pasarela Premium?
La Pasarela Premium es una aplicación de nuestra plataforma que te permite recibir en la URL que tu elijas los mensajes enviados a tus números Premium, y contestar estos mensajes realizando una petición a nuestra API con el mensaje de respuesta.
Recibir mensajes Premium (MO)
Cuando creas una aplicación de Pasarela Premium, uno de los campos obligatorios es la URL donde quieres que te enviemos una petición con los datos del mensaje Premium que acabamos de recibir.
Te enviaremos una petición POST con un JSON con el siguiente formato:
{
"data":{
"message_id": "20181010000000_00000_00000_999999_99999999",
"message": "123456",
"number": "34666666666",
"operator": "movistar",
"app_configuration": {
"id": 123,
"name": "gateway",
"keyword": {
"short_number": "25048",
"keyword": "GATEWAY"
}
},
"received_at": "2018-10-10 00:00:00+0000",
"expires_at": "2018-10-10 00:20:00+0000"
}
}
Te detallamos cada uno de los campos de la petición:
- message_id: es el identificador del mensaje. Es el identificador que deberás usar más tarde cuando respondas el mensaje a través de la API.
- message: es el texto enviado por el usuario sin el Keyword.
- number: es el número desde el cual se ha enviado el mensaje.
- operator: es el nombre de la operadora a la que pertenece el número.
- app_configuration - id: es el identificador de configuración utilizada en nuestra plataforma.
- app_configuration - name: es el nombre de la configuración utilizada en nuestra plataforma.
- app_configuration - keyword - short_number: es el número corto asociado a la configuración utilizada.
- app_configuration - keyword - keyword : es la palabra clave asociada a la configuración utilizada.
- received_at: es la hora en GMT en la que hemos recibido el mensaje.
- expires_at: es la hora en GMT en la que va a caducar el mensaje
Ten en cuenta que si por algún motivo no recibimos correctamente una respuesta HTTP OK
en menos de 2s, volveremos a reenviarte la petición. Al guardar un nuevo mensaje en tu sistema, comprueba que no hayas procesado ya un mensaje con el mismo message_id
.
Si no procesas correctamente la petición, te la volveremos a enviar aproximadamente cada minuto hasta que puedas procesarla. Dejaremos de enviarla cuando contestes el mensaje a través de la API o hayan pasado 30 minutos después de la fecha de caducidad.
Enviar mensaje de respuesta (MT)
Una vez hayas procesado el mensaje y tengas la respuesta que quieras enviar, debes realizar una petición POST a nuestra API. Aquí encontrarás la documentación de nuestra API sobre Premium Gateway