Respuesta del usuario (MO)

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 Service Center 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 Service Center.

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

PerfilPermisos

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.

Ejemplo JSON enviado a su API (método POST)

{
     "id": "25950050-7362-11e6-be62-001b7843e7d4",
     "subAccount": "Sinch",
     "campaignAlias": "Sinch",
     "carrierId": 1,
     "carrierName": "VIVO",
     "source": "55119123456789",
     "shortCode": "28128",
     "messageText": "Eu quero pizza",
     "receivedAt": 1473088405588,
     "receivedDate": "2016-09-05T12:13:25Z",
     "mt": {
       "id": "8be584fd-2554-439b-9ba9-aab507278992",
       "correlationId": "1876",
       "username": "Sinch",
       "email": "customer.support@sinch.com"
     }
   }

Fomato de respuesta estandar de MO

Tanto las solicitudes de listado (list) como la funcion de busqueda (search) retornan un objeto JSON con los campos abajo:

CampoDetallesTipo

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:

CampoDetallesTipo

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

O shortcode del mensaje que origino la respuesta y por el cual la respuesta fue enviada.

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 original que genero la respuesta

MT

MTs tienen la siguinte estructura

CampoDetallesTipo

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

Ejemplo JSON de respuesta:

{
  "total": 1,
  "start": "2016-09-04T11:12:41Z",
  "end": "2016-09-08T11:17:39.113Z",
  "messages": [
    {
      "id": "25950050-7362-11e6-be62-001b7843e7d4",
      "subAccount": "Sinch",
      "campaignAlias": "Sinch",
      "carrierId": 1,
      "carrierName": "VIVO",
      "source": "55119123456789",
      "shortCode": "28128",
      "messageText": "Eu quero pizza",
      "receivedAt": 1473088405588,
      "receivedDate": "2016-09-05T12:13:25Z",
      "mt": {
        "id": "8be584fd-2554-439b-9ba9-aab507278992",
        "correlationId": "1876",
        "username": "Sinch",
        "email": "customer.support@sinch.com"
      }
    },
    {
      "id": "d3afc42a-1fd9-49ff-8b8b-34299c070ef3",
      "subAccount": "Sinch",
      "campaignAlias": "Sinch",
      "carrierId": 5,
      "carrierName": "TIM",
      "source": "55119876543210",
      "shortCode": "28128",
      "messageText": "Meu hamburguer está chegando?",
      "receivedAt": 1473088405588,
      "receivedDate": "2016-09-05T12:13:25Z",
      "mt": {
        "id": "302db832-3527-4e3c-b57b-6a481644d88b",
        "correlationId": "1893",
        "username": "Sinch",
        "email": "customer.support@sinch.com"
      }
    }
  ]
}
PreviousEstatus de envio (Callback e DLR)NextCódigos de Estatus de Envió

Last updated