Inbox

Veja detalhes de como consultar mensagens recebidas (MO).

A partir deste serviço você poderá consultar todas as mensagens recebidas (MOs). Recomendável para situações onde o recebimento por webhook tenha falhado por algum motivo.

Para que evite-se requisições desnecessárias recomendamos o registro de endpoint como webhook. Dessa forma, logo que recebermos as mensagens dos nossos agregadores e operadoras, elas serão repassadas ao seu endpoint imediatamente.

Fique atento quanto ao rate-limit de requisições para o correto funcionamento da API.

Consulta Inbox

GET https://api-v2.smsfire.com.br/sms/inbox/:filter

Visualize as mensagens recebidas em sua Inbox de acordo com o filtro aplicado. Quando não aplicado nenhum filtro, a consulta sempre irá retornar as mensagens ainda não abertas via API.

Atenção: Campos com * (asterisco) são obrigatórios

Path Parameters

Name	Type	Description
filter	string	new - Mensagens não abertas via API all - Todas as mensagens do Inbox

Headers

Name	Type	Description
Authorization*	string	Basic <Token>

200 Array do objeto JSON

[
  {
    "id": 246,
    "mtId": 485489,
    "customId": "meu-Id-0001",
    "campaignId": 389,
    "cost": 0.12,
    "country": "55",
    "phone": "5511944556677",
    "carrier": "Claro",
    "text": "Ola, muito obrigada",
    "receivedDate": "2021-07-21T17:01:10-0300",
    "openDate": "2021-07-21T17:29:06-0300"
  },
  {
    "id": 245,
    "mtId": 485489,
    "customId": null,
    "campaignId": 389,
    "cost": 0.12,
    "country": "55",
    "phone": "5511955667788",
    "carrier": "Vivo",
    "text": "Remarcar para as 10AM",
    "receivedDate": "2021-07-21T16:58:44-0300",
    "openDate": "2021-07-21T17:01:53-0300"
  }
]

Exemplo de requisição

• Consulta por novas mensagens

GET - https://api-v2.smsfire.com.br/sms/inbox/new GET - https://api-v2.smsfire.com.br/sms/inbox

• Consulta por todas as mensagens

GET - https://api-v2.smsfire.com.br/sms/inbox/all

A consulta retornará no máximo os 100 itens mais recentes.

Campos JSON da resposta

A API retornará o código HTTP 204 No Content quando não encontrar nenhuma mensagem pesquisada e o corpo da resposta será vazio.

Campo	Tipo	Descrição
id	int	Id da mensagem
mtId	int	Id do MT original que gerou a resposta
customId	string | null	Id personalizado fornecido pelo cliente
campaignId	int	Id da campanha vinculada a mensagem
cost	float	Valor debitado do saldo
country	string	Prefixo do país do telefone
phone	string	Telefone do destinatário em formato internacional
carrier	string | null	Nome da operadora
text	string	Texto de resposta do destinatário
receivedDate	string	Data do recebimento da mensagem (ISO8601)
openDate	string	Data da abertura da mensagem via API (ISO8601)

A formatação do JSON apresentada neste serviço é exatamente a mesma da que enviaremos via Webhooks em MO quando configurados.