Consulta Status
Veja detalhes de como consultar o status de uma ou mais mensagens.
A partir deste serviço você poderá consultar o status individual ou em lote das mensagens enviadas via API. 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 atualizações dos status das mensagens do aplicativo, elas serão repassadas ao seu endpoint imediatamente.
Fique atento quanto ao rate-limit de requisições para o correto funcionamento da API.
Consulta individual
GET
https://api-v2.smsfire.com.br/whatsapp/status/:id
Informe o id
da mensagem que é dado no callback das requisições ou então customId
que é informado na requisição de envio da mensagem.
Atenção: Campos com * (asterisco) são obrigatórios
Path Parameters
Name | Type | Description |
---|---|---|
id* | string |
|
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Basic <Token> |
Exemplo de requisição
Consulta por
id
GET - https://api-v2.smsfire.com.br/whatsapp/status/000001
Consulta por
customId
GET - https://api-v2.smsfire.com.br/whatsapp/status/firezap0001
Consulta múltipla
POST
https://api-v2.smsfire.com.br/whatsapp/status/search
Realize consulta de múltiplas mensagens ao informar seus respectivos id
e/ou customId
Atenção: Campos com * (asterisco) são obrigatórios
Headers
Name | Type | Description |
---|---|---|
Authorization* | string | Basic <Token> |
Content-Type* | string | application/json |
Request Body
Name | Type | Description |
---|---|---|
customIds | array |
|
ids | array |
|
Exemplo de requisição
Os parâmetros ids
e customIds
são independentes, ou seja, você poderá consultar mensagens informando valores distintos em cada um deles ou em apenas um deles.
A consulta retornará no máximo 200 itens.
Campos JSON do status
Detalhamento dos tipos de cada um dos campos dados no response das consultas individuais ou múltiplas
A API retornará o código HTTP 204 No Content
quando não encontrar a 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 | Id personalizado fornecido pelo cliente. Parâmetro será omitido quando não informado no envio da mensagem |
| string | Tipo da mensagem enviada podendo ser:
|
| string | Prefixo do país do destinatário |
| string | Telefone do destinatário em formato internacional |
| int | Código do status atual da mensagem |
| string | Nome do status atual da mensagem |
| string | Data da última atualização do status (ISO8601) |
| string | Data do envio da mensagem (ISO8601) |
A formatação do JSON apresentada neste serviço é exatamente a mesma da que enviaremos via Webhooks em Callback ou DLR quando configurados.
Acesse a página Código de status para ter informações detalhadas sobre cada um dos códigos fornecidos pelo serviço.
Last updated