Resposta do usuário (MO)

A API de MO permite a automação do processo de recuperação de respostas enviadas pelos clientes em resposta as mensagens que voce enviou a eles. Todas as requisições usam o método GET e as respostas são enviadas no formato JSON.

Entre em contato com o suporte para configurar sua conta para receber MOs.

É possível também a configuração para que as MOs sejam encaminhadas conforme chegaram para uma API do cliente, essa é a forma mais eficiente pois não é necessário realizar nenhuma chamada, so tratar os envios conforme chegaram. Para que esta configuração seja realizada é necessário abrir um ticket com nosso time de suporte técnico através do nosso Service Center passando a url que receberá os MOs.

Conseguimos enviar os MOs tanto via método GET (query string) como via método POST (Json)

Cada requisição feita irá retornar os MOs dos ultimos 5 dias, até um limite de 1.000 MOs. Para datas anteriores ou quantidades maiores favor entrar em contato com nosso time de suporte através do nosso Service Center.

O comportamento da query List MO será diferente para cada usuário autenticado devido ao nivel de permissão de cada usuário.

Recomendamos o método de envio das MOs para API, toda MO enviada será automaticamente enviada para API pois desta forma as respostas podem ser tratadas imediatamente após o recebimento.

Perfil	Permissão
Regular	cada requisição realizada na MO API só irá retornar os MOs correspondentes a subconta que o usuário pertence. Não é possível a um usuário regular recuperar MOs de outras subcontas.
Administrador	o comportamento padrão para o usuário administrador é recuperar todos os MOs de todas as subcontas. Se um administrador desejar recuperar os MOs de apenas uma das subcontas é necessário especificar a subconta no parametro subAccount com o id da subconta desejada.

Exemplo JSON enviado para sua API (método POST)

cURL

{
     "id": "25950050-7362-11e6-be62-001b7843e7d4",
     "subAccount": "test",
     "campaignAlias": "teste",
     "carrierId": 1,
     "carrierName": "VIVO",
     "source": "55119999999",
     "shortCode": "28128",
     "messageText": "Eu quero pizza",
     "receivedAt": 1473088405588,
     "receivedDate": "2016-09-05T12:13:25Z",
     "mt": {
       "id": "8be584fd-2554-439b-9ba9-aab507278992",
       "correlationId": "1876",
       "username": "teste",
       "email": "[e-mail]"
     }
   }

Ruby

{
     "id": "25950050-7362-11e6-be62-001b7843e7d4",
     "subAccount": "teste",
     "campaignAlias": "teste",
     "carrierId": 1,
     "carrierName": "VIVO",
     "source": "551199999999",
     "shortCode": "28128",
     "messageText": "Eu quero pizza",
     "receivedAt": 1473088405588,
     "receivedDate": "2016-09-05T12:13:25Z",
     "mt": {
       "id": "8be584fd-2554-439b-9ba9-aab507278992",
       "correlationId": "1876",
       "username": "teste",
       "email": "[e-mail]"
     }
   }

Python

{
     "id": "25950050-7362-11e6-be62-001b7843e7d4",
     "subAccount": "teste",
     "campaignAlias": "teste",
     "carrierId": 1,
     "carrierName": "VIVO",
     "source": "551199999999",
     "shortCode": "28128",
     "messageText": "Eu quero pizza",
     "receivedAt": 1473088405588,
     "receivedDate": "2016-09-05T12:13:25Z",
     "mt": {
       "id": "8be584fd-2554-439b-9ba9-aab507278992",
       "correlationId": "1876",
       "username": "teste",
       "email": "[e-mail]"
     }
   }

PHP

{
     "id": "25950050-7362-11e6-be62-001b7843e7d4",
     "subAccount": "teste",
     "campaignAlias": "teste",
     "carrierId": 1,
     "carrierName": "VIVO",
     "source": "551199999999",
     "shortCode": "28128",
     "messageText": "Eu quero pizza",
     "receivedAt": 1473088405588,
     "receivedDate": "2016-09-05T12:13:25Z",
     "mt": {
       "id": "8be584fd-2554-439b-9ba9-aab507278992",
       "correlationId": "1876",
       "username": "teste",
       "email": "[e-mail]"
     }
   }

Java

{
     "id": "25950050-7362-11e6-be62-001b7843e7d4",
     "subAccount": "teste",
     "campaignAlias": "teste",
     "carrierId": 1,
     "carrierName": "VIVO",
     "source": "551199999999",
     "shortCode": "28128",
     "messageText": "Eu quero pizza",
     "receivedAt": 1473088405588,
     "receivedDate": "2016-09-05T12:13:25Z",
     "mt": {
       "id": "8be584fd-2554-439b-9ba9-aab507278992",
       "correlationId": "1876",
       "username": "teste",
       "email": "[e-mail]"
     }
   }

Formato de resposta padrões de MO

Tanto as requisições de listagem (list) e a função de busca (search) retornam um objeto JSON com os campos abaixo:

Campo	Detalhes	Tipo
total	O número total de MOs retornadas pela requisição	Integer
start	O limite minimo da query	String
end	O limite máximo da query	String
messages	Listagem dos objetos	List

Cada mensagem do campo messages possui a seguinte estrutura:

MTs tem a seguinte estrutura

Campo	Detalhes	Tipo
id	Id da MT	String
correlationId	CorrelationID enviado na MT	String
username	Username do usuário responsável por enviar a MT	String
email	Email do responsavel por enviar a MT	String

Exemplo de JSON de resposta chamada API:

cURL

{
  "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": "5511123456789",
      "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": "[e-mail]"
      }
    },
    {
      "id": "d3afc42a-1fd9-49ff-8b8b-34299c070ef3",
      "subAccount": "Sinch",
      "campaignAlias": "Sinch",
      "carrierId": 5,
      "carrierName": "TIM",
      "source": "5511123456789",
      "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": "[e-mail]"
      }
    }
  ]
}

Ruby

{
  "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": "5511123456789",
      "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": "[e-mail]"
      }
    },
    {
      "id": "d3afc42a-1fd9-49ff-8b8b-34299c070ef3",
      "subAccount": "Sinch",
      "campaignAlias": "Sinch",
      "carrierId": 5,
      "carrierName": "TIM",
      "source": "5511123456789",
      "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": "[e-mail]"
      }
    }
  ]
}

Python

{
  "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": "5511123456789",
      "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": "[e-mail]"
      }
    },
    {
      "id": "d3afc42a-1fd9-49ff-8b8b-34299c070ef3",
      "subAccount": "Sinch",
      "campaignAlias": "Sinch",
      "carrierId": 5,
      "carrierName": "TIM",
      "source": "5511123456789",
      "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": "[e-mail]"
      }
    }
  ]
}

PHP

{
  "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": "5511123456789",
      "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": "[e-mail]"
      }
    },
    {
      "id": "d3afc42a-1fd9-49ff-8b8b-34299c070ef3",
      "subAccount": "Sinch",
      "campaignAlias": "Sinch",
      "carrierId": 5,
      "carrierName": "TIM",
      "source": "5511123456789",
      "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": "[e-mail]"
      }
    }
  ]
}

Pynthon

{
  "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": "5511123456789",
      "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": "[e-mail]"
      }
    },
    {
      "id": "d3afc42a-1fd9-49ff-8b8b-34299c070ef3",
      "subAccount": "Sinch",
      "campaignAlias": "Sinch",
      "carrierId": 5,
      "carrierName": "TIM",
      "source": "5511123456789",
      "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": "[e-mail]"
      }
    }
  ]
}

Requisição listar MO (list)

A Listagem irá retornar todos os MOs recebidos desde a última chamada de acordo com a resposta padrão descrita acima. Uma vez que esta chamada é realizada ela será consumida e não irá retornar as chamadas seguintes.

Como um usuário regular, para recuperar todas MOs de uma subconta use:

GET https://api-messaging.wavy.global/v1/sms/receive/list

Como usuário administrador, para recuperar TODAS as MOs de TODAS subcontas use:

GET https://api-messaging.wavy.global/v1/sms/receive/list

Como usuário administrador. para recuperar as MOs de uma subconta com a referencia “referencia_subconta”, use:

GET https://api-messaging.wavy.global/v1/sms/receive/list?subAccount=referencia_subconta