La API de MO permite la automatización del proceso de recuperación de respuestas enviadas por los clientes a los mensajes que usted le envió a ellos. Todas las solicitudes usan el método GET y las respuestas son enviadas en formato JSON.
Póngase en contacto con el soporte para configurar su cuenta para recibir MO.
Es posible también la configuración para que los MOs sean encaminados conforme llegan, para una API del cliente. Esa es la forma mas eficiente ya que no es necesario realizar ninguna llamada, solo se tratan los envíos conforme van llegando. Para que esta configuración sea realizada es necesario abrir un ticket con nuestro equipo de soporte técnico a través de nuestro pasando la URL que recibirán los MOs.
Hemos podido enviar los MOs tanto vía método GET (query string) como vía método POST (Json)
Cada solicitud realizada retornara los MOs de los últimos 5 días, hasta un limite de 1.000 MOs. Para las fechas anteriores o cantidades mayores por favor entrar en contacto con nuestro equipo de soporte a través del nuestro .
El comportamiento de Query List MO sera diferente para cada usuario autenticado debido al nivel de permisos de cada usuario.
Recomendamos el metodo de envio de los MOs para la API, todo MO enviado será automaticamente enviada para la API ya que de esta forma las respuestas pueden ser tratadas inmediatamente despues de recibidas
Perfil
Permisos
Regular
Cada solicitud realizada en la MO API solo retornara los MOs correspondientes a la subcuenta a la que el usuario pertenece. No es posible para un usuario regular recuperar los MOs de otras subcuentas.
Administrador
El comportamiento estándar para el usuario administrador es recuperar todos los MOs de todas las subcuentas. Si un admin desea recuperar los MOs de apenas una de las subcuentas es necesario especificar la subcuenta en el parámetro subAccount con el id de la subcuenta deseada.
Tanto las solicitudes de listado (list) como la funcion de busqueda (search) retornan un objeto JSON con los campos abajo:
Campo
Detalles
Tipo
total
Numero total de MOs retornados por la solicitud
Integer
start
Limite minimo de la query
String
end
Limite máximo de la query
String
messages
Listado de los objetos
List
Cada mensaje del campo messages posee la siguiente estructura:
Campo
Detalles
Tipo
id
Id del mensaje
String
subAccount
subcuenta responsable por enviar el mensaje que genero la respuesta
String
carrierId
Id de la operadora
Integer
carrierName
Nombre de la operadora
String
source
Numero de telefono que envio el mensaje de respuesta
String
shortCode
String
messageText
Texto del mensaje de respuesta.
String
receivedAt
hora de recebido
Long
receivedDate
Fecha y hora de recibimiento en formato UTC
String
campaignAlias
Alias da campaña que origino la respuesta
String
mt
MT
MTs tienen la siguinte estructura
Campo
Detalles
Tipo
id
Id del MT
String
correlationId
CorrelationID enviado en el MT
String
username
Username del usuário responsable por enviar el MT
String
email
Email del responsable por enviar el MT
String
Solicitud listar MO (list)
El listado ira a retornar todos los MOs recibidos desde la ultima llamada de acuerdo con la respuesta estándar descripta encima. Una vez que esta llamada es realizada sera consumida y no retornara las llamadas siguientes.
Como un usuario regular, para recuperar todos los MOs de una subcuenta use:
GET https://api-messaging.wavy.global/v1/sms/receive/list
Como usuario administrador, para recuperar TODOS los MOs de TODAS las subcuentas use:
GET https://api-messaging.wavy.global/v1/sms/receive/list
Como usuario administrador. Para recuperar los MOs de una subcuenta con la referencia “referencia_subcuenta”, use:
GET https://api-messaging.wavy.global/v1/sms/receive/list?subAccount=referencia_subconta
