Consulta Status

Detalhes do funcionamento para consulta de uma ou mais mensagens SMS

A partir deste serviço você poderá consultar em tempo real o status atual de uma ou mais mensagens enviadas.

O parâmetro id ou batchId, necessários para o consumo deste serviço, são informados no response de todas as requisições de envio de SMS via API

Enviar mensagem

Consulta individual

GET https://api-v3.smsfire.com.br/sms/status/message/:id

Rate Limiter: Este serviço possui um limite global de 30 requisições por minuto a partir do mesmo IP.

Parâmetros de requisição

Parâmetro

Tipo

Descrição

Exemplo

string

Identificador único da mensagem

019adc7e-6011-705d-b5d6-d1d0627ed993

Exemplos de requisição

const axios = require("axios").default;

const id = "019adc7e-6011-705d-b5d6-d1d0627ed993";

const options = {
  method: 'GET',
  url: `https://api-v3.smsfire.com.br/sms/status/message/${id}`,
  headers: {Username: 'seu_usuario', Api_Token: 'seu_token'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

<?php

$endpoint = "https://api-v3.smsfire.com.br/sms/status/message/";
$endpoint .= "019adc7e-6011-705d-b5d6-d1d0627ed993";

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $endpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Api_Token: seu_token",
        "Username: seu_usuario",
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

using System.Net.Http;
using Microsoft.AspNetCore.WebUtilities; // precisa do pacote Microsoft.AspNetCore.WebUtilities

var client = new HttpClient();

var id = "019adc7e-6011-705d-b5d6-d1d0627ed993";
var endpoint = $"https://api-v3.smsfire.com.br/sms/status/message/{id}";

var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri(endpoint),
    Headers =
    {
        { "Api_Token", "seu_token" },
        { "Username", "seu_usuario" }
    }
};

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Response

O conjunto de dados retornados será em formato JSON com detalhes do envio ou possível falha da requisição

MT - Mensagem enviada

{
	"id": "019adf54-2b62-747d-a9e4-ae3a8239fb27",
	"batchId": "019adf54-2b62-747d-a9e4-a85832954a6e",
	"customId":"meu-id-pessoal",
	"ip": "0.0.0.0",
	"phone": "5511944556677",
	"statusCode": 2,
	"statusName": "DELIVRD",
	"statusDate": "2025-12-02T13:50:28.000Z"
}

MO - Mensagem recebida

{
	"id": "019adf54-2b62-747d-a9e4-ae3a8239fb27",
	"batchId": "019adf54-2b62-747d-a9e4-a85832954a6e",
	"ip": "0.0.0.0",
	"phone": "5511944556677",
	"text":"Quero mais informações",
	"statusCode": 8,
	"statusName": "RECEIVD",
	"statusDate": "2025-12-02T13:50:28.000Z"
}

O valor retornado em statusDate é correspondente a data em fuso UTC

Erros poderão ser facilmente filtrados a partir dos códigos HTTP retornados e adicionalmente detalhes do erro serão incluídos no JSON que seguirá o seguinte formato:

{
	"message": "Invalid or Missing params: id",
	"error": "Bad Request",
	"statusCode": 400
}

Código de Status

Consulta lote

GET https://api-v3.smsfire.com.br/sms/status/batch/:batchId

Rate Limiter: Este serviço possui um limite global de 10 requisições por minuto a partir do mesmo IP.

Parâmetros de requisição

Parâmetro

Tipo

Descrição

Exemplo

batchId

string

Identificador único do lote de mensagens

019adc7e-6011-705d-b5d6-d1d0627ed993

Exemplos de requisição

const axios = require("axios").default;

const batchId = "019adc7e-6011-705d-b5d6-d1d0627ed993";

const options = {
  method: 'GET',
  url: `https://api-v3.smsfire.com.br/sms/status/batch/${batchId}`,
  headers: {Username: 'seu_usuario', Api_Token: 'seu_token'}
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

<?php

$endpoint = "https://api-v3.smsfire.com.br/sms/status/batch/";
$endpoint .= "019adc7e-6011-705d-b5d6-d1d0627ed993";

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $endpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "Api_Token: seu_token",
        "Username: seu_usuario",
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}

using System.Net.Http;
using Microsoft.AspNetCore.WebUtilities; // precisa do pacote Microsoft.AspNetCore.WebUtilities

var client = new HttpClient();

var batchId = "019adc7e-6011-705d-b5d6-d1d0627ed993";
var endpoint = $"https://api-v3.smsfire.com.br/sms/status/batch/{batchId}";

var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri(endpoint),
    Headers =
    {
        { "Api_Token", "seu_token" },
        { "Username", "seu_usuario" }
    }
};

using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

Response

O conjunto de dados retornados será um array em formato JSON com detalhes do envio ou possível falha da requisição

Array de dados com MT e MO

[
	{
		"id": "019adf54-2b62-747d-a9e4-ae3a8239fb27",
		"batchId": "019adf54-2b62-747d-a9e4-a85832954a6e",
		"customId":"meu-id-pessoal",
		"ip": "0.0.0.0",
		"phone": "5511944556677",
		"statusCode": 2,
		"statusName": "DELIVRD",
		"statusDate": "2025-12-02T13:50:28.000Z"
	},
	{
		"id": "019adf54-2b62-747d-a9e4-ae3a8239fb27",
		"batchId": "019adf54-2b62-747d-a9e4-a85832954a6e",
		"ip": "0.0.0.0",
		"phone": "5511944556677",
		"text":"Quero mais informações",
		"statusCode": 8,
		"statusName": "RECEIVD",
		"statusDate": "2025-12-02T13:50:28.000Z"
	}
]

O valor retornado em statusDate é correspondente a data em fuso UTC

Erros poderão ser facilmente filtrados a partir dos códigos HTTP retornados e adicionalmente detalhes do erro serão incluídos no JSON que seguirá o seguinte formato:

{
	"message": "Invalid or Missing params: id",
	"error": "Bad Request",
	"statusCode": 400
}

Código de Status

AnteriorEnviar mensagem PróximoCódigo de Status

Atualizado há 15 dias