Mensagens recebidas
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 uma mensagem for enviada ao seu número, elas serão repassadas ao seu endpoint imediatamente, enquanto existir uma instância com sincronização ativa.
Fique atento quanto ao rate-limit de requisições para o correto funcionamento da API.
Consulta mensagens
GET
https://api-v2.smsfire.com.br/whatsapp/inbox/:filter
Visualize as mensagens recebidas em seu número - enquanto sincronizado com a SMSFire - 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 |
|
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Basic <Token> |
Exemplo de requisição
Consulta por novas mensagens
GET - https://api-v2.smsfire.com.br/whatsapp/inbox/new
GET - https://api-v2.smsfire.com.br/whatsapp/inbox
Consulta por todas as mensagens
GET - https://api-v2.smsfire.com.br/whatsapp/inbox/all
A consulta retornará no máximo os 100 itens mais recentes.
Campos JSON da mensagem
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 |
| string | Token da instância vinculada a mensagem |
| int | Id da mensagem |
| string | Tipo da mensagem recebida podendo ser:
|
| string | Url de acesso público a mídia recebida do contato Parâmetro será omitido quando |
| object | Objeto com dados da localização recebida do contato Parâmetro será omitido quando |
| float | Código da latitude |
| float | Código da longitude |
| string | Descrição da localização recebida |
| string | Prefixo do país do contato |
| string | Telefone do contato em formato internacional |
| string | Mensagem recebida do contato Parâmetro será omitido quando contato enviar multimídia sem texto |
| string | Data da captação da mensagem através da API (ISO8601) |
| string | Data da abertura da mensagem através da API (ISO8601) |
A formatação do JSON apresentada neste serviço é exatamente a mesma da que enviaremos via Webhooks em MO quando configurados.
Verifique os detalhes sobre mensagens multimídia a partir da seção Suporte a Multimídia
Last updated