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 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 individual

GET https://api-v2.smsfire.com.br/sms/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	id ou customId da mensagem. (Max. 40 caracteres)

Headers

Name	Type	Description
Authorization*	string	Basic <Token>

200 Objeto JSON

{
  "id": 000001,
  "customId": "fire0001",
  "campaignId": 001,
  "cost": 0.12,
  "parts": 1,
  "country": "55",
  "ip": "200.200.20.200",
  "phone": "5511944556677",
  "carrier": "Claro",
  "statusCode": 2,
  "statusName": "DELIVERED",
  "statusDate": "2021-07-19T20:58:57-0300",
  "sentDate": "2021-07-19T20:58:35-0300"
}

Exemplo de requisição

• Consulta por id

GET - https://api-v2.smsfire.com.br/sms/status/000001

• Consulta por customId

GET - https://api-v2.smsfire.com.br/sms/status/fire0001

Consulta múltipla

POST https://api-v2.smsfire.com.br/sms/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	customId das mensagens
ids	array	Id das mensagens

200 Array do objeto JSON

[
  {
    "id": 00001,
    "customId": "fire00001",
    "campaignId": 001,
    "cost": 0.12,
    "parts": 1,
    "country": "55",
    "ip": "127.1.1.0",
    "phone": "5511944556677",
    "carrier": "Oi",
    "statusCode": 2,
    "statusName": "DELIVERED",
    "statusDate": "2021-07-20T10:00:48-0300",
    "sentDate": "2021-07-20T10:00:00-0300"
  },
  {
    "id": 00002,
    "customId": "fire00002",
    "campaignId": 001,
    "cost": 0.12,
    "parts": 1,
    "country": "55",
    "ip": "127.1.1.0",
    "phone": "5511955667722",
    "carrier": "Tim",
    "statusCode": 2,
    "statusName": "DELIVERED",
    "statusDate": "2021-07-20T10:00:48-0300",
    "sentDate": "2021-07-20T10:00:00-0300"
  },
]

Exemplo de requisição

curl --request POST \
  --url http://api-v2.smsfire.com.br/sms/status/search \
  --header 'Authorization: Basic <TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{ "ids": ["0001"],	"customIds":["fire0002"] }'

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
id	int	Id da mensagem
customId	string | null	Id personalizado fornecido pelo cliente
campaignId	int	Id da campanha vinculada a mensagem
cost	float	Tarifa cobrada por cada parte da mensagem
parts	int	Número de partes da mensagem
country	string	Prefixo do país do destinatário
ip	string	Ip de onde a mensagem foi enviada
phone	string	Telefone do destinatário em formato internacional
carrier	string | null	Nome da operadora
statusCode	int	Código do status atual da mensagem
statusName	string	Nome do status atual da mensagem
statusDate	string	Data da última atualização do status (ISO8601)
sentDate	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.