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
Headers
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.
A formatação do JSON apresentada neste serviço é exatamente a mesma da que enviaremos via Webhooks em MO quando configurados.
Last updated