Smsfire APIs v3

https://docs.smsfire.com.br/apis-v3/
Admin
Smsfire APIs v3 provides documentation and guidelines for authenticating and interacting with...
Tokens:11,816
Snippets:35
Trust Score:5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Request Examples

Source: https://docs.smsfire.com.br/apis-v3/autenticacao

Examples of how to make authenticated API requests in various programming languages.

```APIDOC
## Request Examples

### Node.Js

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

const headers = {
    Username: 'seu_usuario', 
    Api_Token: 'seu_token'
};
axios.request({
  method: 'GET',
  url: 'http://....',
  params: ...,
  headers
});
```

### Php

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://...",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "",
  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;
}
```

### C-Sharp

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://...."),
    Headers =
    {
        { "Username", "seu_usuario" },
        { "Api_Token", "seu_token" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}
```

### Shell/cURL

```sh
curl --request GET \
  --url 'https://...' \
  --header 'Api_Token: seu_token' \
  --header 'Username: seu_usuario'
```
```

--------------------------------

### Send Individual SMS API Request Examples

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

Demonstrates how to send an individual SMS message using the SMSFire API v3. These examples show how to construct the request, including setting the target phone number, sender ID, message text, and scheduling options. Ensure you replace placeholder credentials with your actual API token and username.

```javascript
var axios = require("axios").default;

var options = {
  method: 'GET',
  url: 'https://api-v3.smsfire.com.br/sms/send/individual',
  params: {
    scheduleTime: '2025-09-10T10:00:00Z',
    scheduleTimezone: 'America/Sao_Paulo'
    from: '28149',
    to: '5511944556677',
    text: 'hello'
  },
  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
<?php

$endpoint = "https://api-v3.smsfire.com.br/sms/send/individual";

$params = [
    "scheduleTime"     => "2025-09-10T10:00:00Z",
    "scheduleTimezone" => "America/Sao_Paulo",
    "from"             => "28149",
    "to"               => "5511944556677",
    "text"             => "hello",
];

$url = $endpoint . "?" . http_build_query($params);

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => $url,
    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 #:";
} else {
    echo $response;
}


```

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

var client = new HttpClient();

var baseUrl = "https://api-v3.smsfire.com.br/sms/send/individual";

// parâmetros dinâmicos
var queryParams = new Dictionary<string, string>
{
    ["scheduleTime"] = "2025-09-10T10:00:00Z",
    ["scheduleTimezone"] = "America/Sao_Paulo",
    ["from"] = "28149",
    ["to"] = "5511944556677",
    ["text"] = "hello"
};

// monta a URL final com os parâmetros
var requestUrl = QueryHelpers.AddQueryString(baseUrl, queryParams);

var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri(requestUrl),
    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);


```

```sh
curl --request GET \
  --url 'https://api-v3.smsfire.com.br/sms/send/individual?scheduleTime=2025-09-10T10%3A00%3A00Z&from=28149&to=5511944556677&text=hello' \
  --header 'Api_Token: seu_token' \
  --header 'Username: seu_usuario'
```

--------------------------------

### HTTP API Authentication Examples

Source: https://docs.smsfire.com.br/apis-v3/autenticacao

Exemplos de como autenticar requisições HTTP utilizando tokens e credenciais de usuário. Inclui exemplos em Node.js, PHP, C# e cURL. As requisições devem incluir 'Username' e 'Api_Token' nos headers.

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

const headers = {
    Username: 'seu_usuario', 
    Api_Token: 'seu_token'
};
axios.request({
  method: 'GET',
  url: 'http://....',
  params: ...
  headers
});
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://...",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => "",
  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;
}
```

```csharp
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://...."),
    Headers =
    {
        { "Username", "seu_usuario" },
        { "Api_Token", "seu_token" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}
```

```shell
curl --request GET \
  --url 'https://...' \
  --header 'Api_Token: seu_token' \
  --header 'Username: seu_usuario'
```

--------------------------------

### MO PDU Example - deliver_sm

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

This PDU structure represents a received message (MO) from a sender. It includes fields like 'source_addr' for the sender's number and 'short_message' for the message content. The 'data_coding' field specifies the message encoding.

```protobuf
{
  command_length: 67,
  command_id: 5,
  command_status: 0,
  sequence_number: 4,
  command: 'deliver_sm',
  service_type: '',
  source_addr_ton: 0,
  source_addr_npi: 0,
  source_addr: '5512988439629',
  dest_addr_ton: 0,
  dest_addr_npi: 0,
  destination_addr: '28149',
  esm_class: 0,
  protocol_id: 0,
  priority_flag: 0,
  schedule_delivery_time: '',
  validity_period: '',
  registered_delivery: 3,
  replace_if_present_flag: 0,
  data_coding: 8,
  sm_default_msg_id: 0,
  short_message: { message: 'Hello 🤩' }
}
```

--------------------------------

### JSON Response for Server-Side Errors (5xx)

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

While no specific JSON example is provided for 5xx errors, the documentation states that these indicate internal API or server failures. In such cases, users are advised to contact the support team. These responses typically signify issues on the SMSFire platform itself.

--------------------------------

### DLR PDU Example - deliver_sm

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

This PDU structure represents a delivery report for a sent SMS. It includes fields like 'receipted_message_id' and 'message_state' to track the delivery status. Note that 'message_state' and 'receipted_message_id' might not be supported by all SMPP libraries.

```protobuf
{
  command_length: 227,
  command_id: 5,
  command_status: 0,
  sequence_number: 3,
  command: 'deliver_sm',
  service_type: '',
  source_addr_ton: 0,
  source_addr_npi: 0,
  source_addr: '5512988439629',
  dest_addr_ton: 0,
  dest_addr_npi: 0,
  destination_addr: '4306745',
  esm_class: 4,
  protocol_id: 0,
  priority_flag: 0,
  schedule_delivery_time: '',
  validity_period: '',
  registered_delivery: 3,
  replace_if_present_flag: 0,
  data_coding: 1,
  sm_default_msg_id: 0,
  short_message: {
    message: 'id:d803ab6a-fecc-45ba-8c14-297dd7a45e7e sub:001 dlvrd:001 submit date:2509101509 done date:2509101509 stat:DELIVRD err:000 text:'
  },
  message_state: 2,
  receipted_message_id: 'd803ab6a-fecc-45ba-8c14-297dd7a45e7e'
}
```

--------------------------------

### DLR (Delivery Report) Webhook Payload Example - JSON

Source: https://docs.smsfire.com.br/apis-v3/sms/api/webhooks

Este é o formato de dados em JSON que a API SMSFire v3 enviará para o seu endpoint de webhook quando um evento de DLR (Delivery Report) ocorrer. Ele contém detalhes sobre o status da mensagem enviada.

```json
{
  "id": "6eda4709-109c-4626-a08f-a9ea143c7b20",
  "customId": "abc-xyz-123",
  "ip": "127.0.0.1",
  "phone": "5511944556677",
  "statusCode": 2,
  "statusName": "DELIVRD",
  "statusDate": "2025-09-12T19:43:45.298Z"
}
```

--------------------------------

### JSON Response for Client-Side Errors (4xx)

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

This JSON format outlines the structure for errors originating from the client-side, indicated by a 4xx HTTP status code. It includes a human-readable message explaining the error, a short error identifier, and the corresponding status code. An example includes a 'Not Available Balance' error.

```json
{
	"message": "Not Available Balance",
	"error": "Forbidden",
	"statusCode": 403
}
```

--------------------------------

### SMS PDU Commands Overview

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

This section provides an overview of the available PDU (Protocol Data Unit) commands for interacting with the SMSFire BR APIs v3.

```APIDOC
## SMS PDU Commands Overview

This document outlines all permitted PDU commands and their respective uses for SMS message operations.

### Available Commands:

*   **submit_sm**: Used for sending messages.
*   **deliver_sm**: Used for receiving delivery reports (DLR) and response messages (MO).
*   **enquire_link**: Required to maintain an active connection with the server.
*   **unbind**: Used to remove a user session.
```

--------------------------------

### SMPP Connection

Source: https://docs.smsfire.com.br/apis-v3/autenticacao

Information on how to connect using SMPP, requiring system_id and password (SMPP Token).

```APIDOC
## SMPP Connection

For the connection, you will need to use your username and the **SMPP TOKEN** to establish the connection in the following manner:

| Parameter  | Value                  |
| ---------- | ---------------------- |
| system_id | Your username          |
| password   | Your unique user token |

See [smpp](https://docs.smsfire.com.br/apis-v3/sms/smpp) for more details.
```

--------------------------------

### deliver_sm - Receive Reports and MO Messages

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

Details the use of the `deliver_sm` command for receiving delivery reports and incoming messages (MO).

```APIDOC
## deliver_sm

Used to receive delivery reports (DLR) and incoming messages (MO) from the network. This command is typically invoked by the server to push information to the client.
```

--------------------------------

### Deliver SM - MO PDU

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

This section describes the structure of the 'deliver_sm' command when used for received messages (MO - Mobile Originated).

```APIDOC
## deliver_sm (MO PDU)

### Description
This PDU structure is used to send received messages (MO) if the connection supports it.

### Method
This is a data structure representation, not a direct HTTP method.

### Endpoint
N/A (This describes a PDU structure within an SMPP protocol context).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This represents a Protocol Data Unit (PDU) structure:
- **command_length** (integer) - The length of the command.
- **command_id** (integer) - The identifier for the command (5 for deliver_sm).
- **command_status** (integer) - The status of the command.
- **sequence_number** (integer) - The sequence number of the command.
- **command** (string) - The command name ('deliver_sm').
- **service_type** (string) - The service type.
- **source_addr_ton** (integer) - Type of Number for the source address.
- **source_addr_npi** (integer) - Numbering Plan Indicator for the source address.
- **source_addr** (string) - The source address of the message.
- **dest_addr_ton** (integer) - Type of Number for the destination address.
- **dest_addr_npi** (integer) - Numbering Plan Indicator for the destination address.
- **destination_addr** (string) - The destination address.
- **esm_class** (integer) - Enhanced Services Management class.
- **protocol_id** (integer) - Protocol Identifier.
- **priority_flag** (integer) - Priority flag for the message.
- **schedule_delivery_time** (string) - Scheduled delivery time.
- **validity_period** (string) - Validity period of the message.
- **registered_delivery** (integer) - Flag indicating if delivery receipt is requested.
- **replace_if_present_flag** (integer) - Flag to replace if present.
- **data_coding** (integer) - Data coding scheme.
- **sm_default_msg_id** (integer) - Default message ID.
- **short_message** (object) - Contains the message content.
  - **message** (string) - The actual short message content.

### Request Example
```json
{
  "command_length": 67,
  "command_id": 5,
  "command_status": 0,
  "sequence_number": 4,
  "command": "deliver_sm",
  "service_type": "",
  "source_addr_ton": 0,
  "source_addr_npi": 0,
  "source_addr": "5512988439629",
  "dest_addr_ton": 0,
  "dest_addr_npi": 0,
  "destination_addr": "28149",
  "esm_class": 0,
  "protocol_id": 0,
  "priority_flag": 0,
  "schedule_delivery_time": "",
  "validity_period": "",
  "registered_delivery": 3,
  "replace_if_present_flag": 0,
  "data_coding": 8,
  "sm_default_msg_id": 0,
  "short_message": {
    "message": "Hello 🤩"
  }
}
```

### Response
This PDU represents an incoming message from the network.

#### Success Response (200)
N/A (This is an incoming PDU structure).

#### Response Example
See Request Example.
```

--------------------------------

### HTTP Authentication Headers

Source: https://docs.smsfire.com.br/apis-v3/autenticacao

All API requests require authentication via HTTP headers. You must include your Username and Api_Token in the request headers.

```APIDOC
## HTTP Authentication

To use all APIs via the HTTP protocol, it is necessary to send user and token data via **HEADERS** in the following format:

| Key      | Value                  |
| -------- | ---------------------- |
| Username | Your username          |
| Api_Token | Your unique user token |

### Error Handling

When authentication fails due to invalid or missing data, the request will return with an **HTTP 401 Unauthorized** status code.
```

--------------------------------

### Deliver SM - DLR PDU

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

This section describes the structure of the 'deliver_sm' command when used for delivery reports (DLR). It includes details on message status and receipt identifiers.

```APIDOC
## deliver_sm (DLR PDU)

### Description
This PDU structure is used to send delivery reports and received messages (MO) if the connection supports it.

### Method
This is a data structure representation, not a direct HTTP method.

### Endpoint
N/A (This describes a PDU structure within an SMPP protocol context).

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
This represents a Protocol Data Unit (PDU) structure:
- **command_length** (integer) - The length of the command.
- **command_id** (integer) - The identifier for the command (5 for deliver_sm).
- **command_status** (integer) - The status of the command.
- **sequence_number** (integer) - The sequence number of the command.
- **command** (string) - The command name ('deliver_sm').
- **service_type** (string) - The service type.
- **source_addr_ton** (integer) - Type of Number for the source address.
- **source_addr_npi** (integer) - Numbering Plan Indicator for the source address.
- **source_addr** (string) - The source address of the message.
- **dest_addr_ton** (integer) - Type of Number for the destination address.
- **dest_addr_npi** (integer) - Numbering Plan Indicator for the destination address.
- **destination_addr** (string) - The destination address.
- **esm_class** (integer) - Enhanced Services Management class.
- **protocol_id** (integer) - Protocol Identifier.
- **priority_flag** (integer) - Priority flag for the message.
- **schedule_delivery_time** (string) - Scheduled delivery time.
- **validity_period** (string) - Validity period of the message.
- **registered_delivery** (integer) - Flag indicating if delivery receipt is requested.
- **replace_if_present_flag** (integer) - Flag to replace if present.
- **data_coding** (integer) - Data coding scheme.
- **sm_default_msg_id** (integer) - Default message ID.
- **short_message** (object) - Contains the message content.
  - **message** (string) - The actual short message, often containing delivery report details.
- **message_state** (integer) - The state of the message (e.g., DELIVRD, ENROUTE). See Message State table.
- **receipted_message_id** (string) - The ID of the receipted message.

### Request Example
```json
{
  "command_length": 227,
  "command_id": 5,
  "command_status": 0,
  "sequence_number": 3,
  "command": "deliver_sm",
  "service_type": "",
  "source_addr_ton": 0,
  "source_addr_npi": 0,
  "source_addr": "5512988439629",
  "dest_addr_ton": 0,
  "dest_addr_npi": 0,
  "destination_addr": "4306745",
  "esm_class": 4,
  "protocol_id": 0,
  "priority_flag": 0,
  "schedule_delivery_time": "",
  "validity_period": "",
  "registered_delivery": 3,
  "replace_if_present_flag": 0,
  "data_coding": 1,
  "sm_default_msg_id": 0,
  "short_message": {
    "message": "id:d803ab6a-fecc-45ba-8c14-297dd7a45e7e sub:001 dlvrd:001 submit date:2509101509 done date:2509101509 stat:DELIVRD err:000 text:"
  },
  "message_state": 2,
  "receipted_message_id": "d803ab6a-fecc-45ba-8c14-297dd7a45e7e"
}
```

### Response
This PDU represents an incoming message from the network.

#### Success Response (200)
N/A (This is an incoming PDU structure).

#### Response Example
See Request Example.
```

--------------------------------

### enquire_link - Maintain Connection

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

Explains the purpose of the `enquire_link` command for maintaining an active connection.

```APIDOC
## enquire_link

This command is necessary to keep the connection with the server active. It is used for keep-alive purposes.
```

--------------------------------

### submit_sm - Send Message

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

Details the parameters required for the `submit_sm` command to send an SMS message.

```APIDOC
## submit_sm

This command is used to send SMS messages. Below are the considered parameters:

### Parameters

#### Request Body Parameters

*   **source_addr** (string) - Required - Sender of the message.
*   **source_addr_ton** (integer) - Required - Type of sender. Default value is 5.
*   **source_addr_npi** (integer) - Required - Numbering plan. Default value is 0.
*   **destination_addr** (string) - Required - Recipient of the message.
*   **dest_addr_ton** (integer) - Required - Type of destination. Default value is 1.
*   **dest_addr_npi** (integer) - Required - Numbering plan. Default value is 1.
*   **registered_delivery** (integer) - Optional - Level of delivery report (DLR) requested. See details below.
*   **data_coding** (integer) - Required - Encoding of the message. See details below.

### registered_delivery

Defines the level of delivery reports you wish to receive in your `deliver_sm` PDU.

| Value | Hexadecimal | Description                     |
| ----- | ----------- | ------------------------------- |
| 0     | 0x00        | No delivery reports             |
| 1     | 0x01        | Final reports only              |
| 3     | 0x03        | Intermediate and final reports  |

*Note*: The default server value is 0x03 if the parameter is not sent or an invalid value is provided.

### data_coding

Specifies the type of encoding for the sent message. See accepted values below.

| Type        | Value | Hexadecimal |
| ----------- | ----- | ----------- |
| GSM-7       | 0     | 0x00        |
| UCS-2       | 8     | 0x08        |
| FLASH GSM-7 | 16    | 0x10        |
| FLASH UCS-2 | 24    | 0x18        |

*Note*: Your `submit_sm` will fail with the error code [ESME_RINVDCS] if a value other than the mentioned ones is used.
```

--------------------------------

### Error Codes

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

Information on error codes used within the SMPP protocol, with a link to the official SMPP error code documentation.

```APIDOC
## Error Codes

### Description
Error codes follow the standard SMPP protocol conventions. Refer to the provided link for a comprehensive list of error codes. If issues persist, contact support.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Provides guidance on error handling.

#### Response Example
Error codes are standard SMPP codes. Consult the following resource for details:

[https://smpp.org/smpp-error-codes.html](https://smpp.org/smpp-error-codes.html)
```

--------------------------------

### unbind - Terminate Session

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

Describes the `unbind` command for properly terminating a user session.

```APIDOC
## unbind

Used to gracefully disconnect and remove the user's session from the server.
```

--------------------------------

### SMS Sending API - Response Details

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

This section details the expected response format for SMS sending requests, covering both successful immediate and scheduled sends, as well as error responses.

```APIDOC
## SMS Sending API - Response Details

### Description
This endpoint provides details about the status of SMS sending requests. The response is in JSON format and includes information about the sent messages or any failures encountered.

### Method
POST (Implied by the context of sending requests)

### Endpoint
/websites/smsfire_br_apis-v3 (Inferred from the project path)

### Parameters
#### Response Body (Success)
- **messages** (array) - An array of message objects, each containing details about an SMS.
  - **id** (string) - The unique identifier of the message (UUID V4).
  - **customId** (string, optional) - A custom identifier provided for the message.
  - **statusCode** (number) - The status code of the message.
  - **statusName** (string) - The name of the message status (e.g., ENROUTE, SCHEDULED).
  - **scheduleTime** (string, optional) - The scheduled time for the message in ISO8601 format (UTC), if applicable.

#### Response Body (Error)
- **message** (string) - A description of the error.
- **error** (string) - The error type (e.g., Forbidden).
- **statusCode** (number) - The HTTP status code for the error.

### Response Example
#### Success Response (200 - Immediate Send)
```json
{
	"messages": [
		{
			"id": "8b412996-bbc8-4174-b079-4617fe0e2e6e",
			"customId":"abc-123-xyz",
			"statusCode": 0,
			"statusName": "ENROUTE"
		},
		{
			"id": "50ae7497-9c92-4211-a311-7536bb07301c",
			"customId":"abc-123-xyz",
			"statusCode": 0,
			"statusName": "ENROUTE"
		}
	]
}
```

#### Success Response (200 - Scheduled Send)
```json
{
	"messages": [
		{
			"id": "8b412996-bbc8-4174-b079-4617fe0e2e6e",
			"customId":"abc-123-xyz",
			"statusCode": 0,
			"statusName": "ENROUTE"
		},
		{
			"id": "50ae7497-9c92-4211-a311-7536bb07301c",
			"statusCode": 6,
			"statusName": "SCHEDULED",
			"scheduleTime": "2025-09-10T10:00:00.000Z"
		}
	]
}
```

#### Error Response (4xx)
```json
{
	"message": "Not Available Balance",
	"error": "Forbidden",
	"statusCode": 403
}
```

### Error Handling
- **4xx Errors**: Indicate client-side issues. Details will be included in the JSON response.
- **5xx Errors**: Indicate server-side issues. Contact the support team for assistance.
```

--------------------------------

### Concatenation

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

Information on supported concatenation formats for SMS messages, including UDH 8-bit and 16-bit.

```APIDOC
## Concatenation

Supports UDH 8-bit and 16-bit formats for message concatenation.

**Reference**: [UDH Headers](https://en.wikipedia.org/wiki/Concatenated_SMS)
```

--------------------------------

### Send Individual SMS

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

This endpoint allows you to send an individual SMS message. You can schedule the message for a specific time and timezone. Authentication is done via Username and Api_Token headers.

```APIDOC
## GET /sms/send/individual

### Description
Allows sending an individual SMS message with optional scheduling.

### Method
GET

### Endpoint
https://api-v3.smsfire.com.br/sms/send/individual

### Query Parameters
- **scheduleTime** (string) - Optional - The time to schedule the SMS in ISO 8601 format (e.g., '2025-09-10T10:00:00Z').
- **scheduleTimezone** (string) - Optional - The timezone for the scheduled time (e.g., 'America/Sao_Paulo').
- **from** (string) - Required - The sender ID.
- **to** (string) - Required - The recipient's phone number in international format (e.g., '5511944556677').
- **text** (string) - Required - The content of the SMS message.

### Headers
- **Username** (string) - Required - Your SMSFire API username.
- **Api_Token** (string) - Required - Your SMSFire API token.

### Request Example (cURL)
```sh
curl --request GET \
  --url 'https://api-v3.smsfire.com.br/sms/send/individual?scheduleTime=2025-09-10T10%3A00%3A00Z&from=28149&to=5511944556677&text=hello' \
  --header 'Api_Token: seu_token' \
  --header 'Username: seu_usuario'
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the SMS was sent or scheduled.
- **status** (integer) - Status code (e.g., 200).

#### Response Example
```json
{
  "message": "SMS sent successfully",
  "status": 200
}
```
```

--------------------------------

### Message State Codes

Source: https://docs.smsfire.com.br/apis-v3/sms/smpp/comandos-pdu

Provides a mapping of numerical codes to their corresponding message states as per SMPP protocol specifications.

```APIDOC
## Message State

### Description
This table details the possible states a message can be in, along with their corresponding codes and descriptions, as defined by the SMPP protocol.

### Method
N/A

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
This is a reference table.

#### Response Example
| Código | Nome    | Descrição                                                                           |
| ------ | ------- | --------------------------------------------------------------------------------- |
| 1      | ENROUTE | Mensagem recebida e direcionada a fila de processamento interna                   |
| 2      | DELIVRD | Operadora confirma o envio e a entrega da mensagem ao destinatário                |
| 3      | EXPIRED | Tempo limite de tentativas de entrega ao destinatário expirado na operadora.      |
| 4      | DELETED | Mensagem removida de processamento                                                |
| 5      | UNDELIV | Mensagem não entregue ao destinatário                                             |
| 6      | ACCEPTD | Mensagem aceita na operadora e enviada ao destinatário sem confirmação de entrega |
| 7      | UNKNOWN | Dados corrompidos vindos da operadora.                                            |
| 8      | REJECTD | Mensagem rejeitada na operadora                                                   |
```

--------------------------------

### POST /websites/smsfire_br_apis-v3

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

Send SMS messages to one or more recipients. This endpoint supports various options including scheduling, flash messages, and custom IDs.

```APIDOC
## POST /websites/smsfire_br_apis-v3

### Description
Send SMS messages to one or more recipients. This endpoint supports various options including scheduling, flash messages, and custom IDs.

### Method
POST

### Endpoint
/websites/smsfire_br_apis-v3

### Parameters
#### Request Body
- **messages** (array) - Required - Array with the list of messages and their respective definitions. Max 100 items.
  - **messages[].to** (string) - Required - Recipient's phone number in international format [E.164]. Min 8 Characters, Max 20 Characters.
  - **messages[].text** (string) - Required - Message text. Min 3 Characters, Max 765 Characters.
  - **messages[].from** (string) - Optional - Message sender. Min 3 Characters, Max 11 Characters.
  - **messages[].customId** (string) - Optional - Custom message ID. Max 40 characters.
  - **messages[].flash** (boolean) - Optional - When true, the sent message is of Type 0 [Class 0 SMS]. Default: false.
  - **messages[].scheduleTimezone** (string) - Optional - Timezone to consider when scheduling a message. Default: UTC.
  - **messages[].scheduleTime** (string) - Optional - Date and time in UTC for message scheduling. ISO8601 format.

### Request Example
```json
{
  "messages": [
    {
      "to": "5511944556677",
      "text": "Hi welcome",
      "from": "smsfire",
      "customId": "abc-123-qwrt",
      "flash": true,
      "scheduleTimezone": "America/Sao_Paulo",
      "scheduleTime": "2025-09-10T10:00:00Z"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the message sending operation.
- **messageId** (string) - The unique identifier for the sent message.
- **customId** (string) - The custom ID provided in the request, if any.

#### Response Example
```json
{
  "status": "sent",
  "messageId": "msg_12345abcde",
  "customId": "abc-123-qwrt"
}
```
```

--------------------------------

### POST /sms/send/individual

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

Send an individual SMS message. This endpoint allows for immediate or scheduled sending of messages to a single recipient. It supports various parameters for customization, including sender ID, custom message IDs, flash messages, and scheduling.

```APIDOC
## POST /sms/send/individual

### Description
Send an individual SMS message. This endpoint allows for immediate or scheduled sending of messages to a single recipient. It supports various parameters for customization, including sender ID, custom message IDs, flash messages, and scheduling.

### Method
GET

### Endpoint
https://api-v3.smsfire.com.br/sms/send/individual

### Parameters
#### Query Parameters
- **to** (string) - Required - The recipient's phone number in E.164 international format (Min. 8, Max. 20 characters).
- **text** (string) - Required - The content of the SMS message (Min. 3, Max. 765 characters).
- **from** (string) - Optional - The sender ID of the message (Min. 3, Max. 11 characters).
- **customId** (string) - Optional - A custom identifier for the message (Max. 40 characters).
- **flash** (boolean) - Optional - If true, sends a Class 0 SMS (Default: false).
- **scheduleTimezone** (string) - Optional - The timezone to consider for scheduling messages (Default: UTC).
- **scheduleTime** (string) - Optional - The date and time for scheduling the message in ISO8601 format.

### Request Example
```json
{
  "to": "5511944556677",
  "text": "Hi welcome",
  "from": "smsfire",
  "customId": "abc-123-qwrt",
  "flash": false,
  "scheduleTimezone": "America/Sao_Paulo",
  "scheduleTime": "2025-09-10T10:00:00Z"
}
```

### Response
#### Success Response (200)
- **messageId** (string) - The unique identifier for the sent message.
- **status** (string) - The status of the message sending.

#### Response Example
```json
{
  "messageId": "msg_12345abc",
  "status": "sent"
}
```

### Error Handling
- **400 Bad Request**: Invalid parameters provided.
- **429 Too Many Requests**: Rate limit exceeded.
```

--------------------------------

### POST /sms/send/bulk

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

Send bulk SMS messages to multiple recipients. Requires authentication via Username and Api_Token headers and Content-Type set to application/json.

```APIDOC
## POST /sms/send/bulk

### Description
Send bulk SMS messages to multiple recipients. Requires authentication via Username and Api_Token headers and Content-Type set to application/json.

### Method
POST

### Endpoint
https://api-v3.smsfire.com.br/sms/send/bulk

### Parameters
#### Headers
- **Username** (string) - Required - Your SMSFire username.
- **Api_Token** (string) - Required - Your SMSFire API token.
- **Content-Type** (string) - Required - Must be set to `application/json`.

#### Request Body
- **messages** (array) - Required - An array of message objects.
  - **from** (string) - Required - The sender ID.
  - **to** (string) - Required - The recipient's phone number.
  - **text** (string) - Required - The message content.

### Request Example
```json
{
  "messages": [
    {
      "from": "28149",
      "to": "5511944556677",
      "text": "Ola Brasil"
    },
    {
      "from": "1800934",
      "to": "18005553697",
      "text": "Hi USA"
    }
  ]
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the status of the operation.
- **message** (string) - A message describing the result of the operation.
- **data** (object) - Contains details about the sent messages, such as message IDs and status codes.

#### Response Example
```json
{
  "status": "success",
  "message": "Messages sent successfully.",
  "data": {
    "accepted": [
      {
        "message_id": "msg_12345",
        "to": "5511944556677",
        "status": "accepted"
      }
    ],
    "rejected": []
  }
}
```
```

--------------------------------

### JSON Response for Immediate SMS Dispatch (200 OK)

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

This JSON structure represents a successful immediate SMS dispatch. It includes a unique message ID, an optional custom ID, and status codes indicating the message is en route. This is the standard success response for non-scheduled messages.

```json
{
	"id": "6eda82f8-3aba-45e0-a5d3-18c3a72f78b3",
	"customId":"abc-123-xyz",
	"statusCode": 0,
	"statusName": "ENROUTE"
}
```

--------------------------------

### POST /sms/send/bulk

Source: https://docs.smsfire.com.br/apis-v3/sms/api/enviar-mensagem

Send multiple SMS messages to one or more destinations in a single request. This endpoint is subject to a rate limit of 30 requests per minute per IP.

```APIDOC
## POST /sms/send/bulk

### Description
Send multiple SMS messages to one or more destinations in a single request. This endpoint is subject to a rate limit of 30 requests per minute per IP.

### Method
POST

### Endpoint
https://api-v3.smsfire.com.br/sms/send/bulk

### Request Body
* **messages** (array) - Required - An array of message objects to be sent.
    * **to** (string) - Required - The recipient's phone number.
    * **text** (string) - Required - The content of the SMS message.
    * **countryCode** (string) - Optional - The country code for the recipient's number (e.g., "55" for Brazil).
    * **customId** (string) - Optional - A custom identifier for the message.
    * **scheduleTime** (string) - Optional - The desired time to schedule the message in ISO8601 format (e.g., "2025-09-10T10:00:00.000Z").

### Request Example
```json
{
  "messages": [
    {
      "to": "+1234567890",
      "text": "Hello from SMSFire!",
      "countryCode": "1",
      "customId": "msg-001"
    },
    {
      "to": "+9876543210",
      "text": "Another message.",
      "scheduleTime": "2025-09-10T10:00:00.000Z"
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (string) - Unique identifier for the message (UUID V4).
- **customId** (string) - Custom identifier provided in the request (if any).
- **statusCode** (number) - Status code of the message.
- **statusName** (string) - Name of the message status (e.g., ENROUTE, SCHEDULED).
- **scheduleTime** (string) - The scheduled time for the message in UTC (if scheduled).

#### Response Example
```json
{
  "id": "6eda82f8-3aba-45e0-a5d3-18c3a72f78b3",
  "customId": "msg-001",
  "statusCode": 0,
  "statusName": "ENROUTE"
}
```

Or for scheduled messages:
```json
{
  "id": "7c7d9ff2-7fd4-4861-bcd3-2e010952aca4",
  "customId": "msg-002",
  "statusCode": 6,
  "statusName": "SCHEDULED",
  "scheduleTime": "2025-09-10T10:00:00.000Z"
}
```

#### Error Response (4xx)
- **message** (string) - Description of the error.
- **error** (string) - Type of error.
- **statusCode** (number) - HTTP status code.

#### Error Response Example
```json
{
  "message": "Not Available Balance",
  "error": "Forbidden",
  "statusCode": 403
}
```

#### Error Response (5xx)
Indicates internal API or server errors. Contact support.
```
Tokens:
Raw