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	new - Mensagens não abertas via API all - Todas as mensagens já recebidas

Headers

Name	Type	Description
Authorization*	string	Basic <Token>

200 Array do objeto JSON

[
  {
    "instanceToken": "499893c21b1b467970b2n58dcak6009d92d9dscx1",
    "id": 00003,
    "messageType": "TEXT",
    "country": "55",
    "phone": "5511944556677",
    "text": "Obrigado",
    "receivedDate": "2021-08-06T10:05:14-0300",
    "openDate": "2021-08-06T10:51:45-0300"
  },
  {
    "instanceToken": "499893c21b1b467970b2n58dcak6009d92d9dscx1",
    "id": 00002,
    "messageType": "STICKER",
    "messageMedia": "https:\/\/smsfire...\/650818A9B6901C50E2F36AACFE532BFA.webp",
    "country": "55",
    "phone": "5511977889900",
    "receivedDate": "2021-08-06T09:59:54-0300",
    "openDate": "2021-08-06T09:59:55-0300"
  },
  {
    "instanceToken": "499893c21b1b467970b2n58dcak6009d92d9dscx1",
    "id": 00001,
    "messageType": "LOCATION",
    "location":{
      "latidude": 40.01173076879178,
      "longitude": -105.01789945249678,
      "description": "Disney Land\nErie, CO 80516"
    },
    "country": "55",
    "phone": "5511977889900",
    "receivedDate": "2021-08-06T09:59:54-0300",
    "openDate": "2021-08-06T09:59:55-0300"
  }
]

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
instanceToken	string	Token da instância vinculada a mensagem
id	int	Id da mensagem
messageType	string	Tipo da mensagem recebida podendo ser: TEXT IMAGE VIDEO AUDIO DOCUMENT LOCATION STICKER
messageMedia	string	Url de acesso público a mídia recebida do contato Parâmetro será omitido quando messageType for igual a TEXT
location	object	Objeto com dados da localização recebida do contato Parâmetro será omitido quando messageType for diferente de LOCATION
location.latitude	float	Código da latitude
location.longitude	float	Código da longitude
location.description	string	Descrição da localização recebida
country	string	Prefixo do país do contato
phone	string	Telefone do contato em formato internacional
text	string	Mensagem recebida do contato Parâmetro será omitido quando contato enviar multimídia sem texto
receivedDate	string	Data da captação da mensagem através da API (ISO8601)
openDate	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