SMS — envio de mensagens de texto via API
Envie mensagens de texto para números de celular e acompanhe automaticamente o status de entrega e as respostas dos destinatários. Envie até 1.000 SMS por requisição e identifique cada envio por um valor de referência.
A URL base é https://api.assertivasolucoes.com.br/sms e o
endpoint principal de envio é /sms/v3/send. A API usa REST,
recebe JSON e exige um token OAuth2 no cabeçalho
Authorization: Bearer.
Principais operações
| Funcionalidade | Método | Endpoint |
|---|---|---|
| Gerar token | POST |
/oauth2/v3/token |
| Enviar SMS | POST |
/sms/v3/send |
| Consultar status do SMS | GET |
/sms/v3/status |
| Consultar resposta do SMS | GET |
/sms/v3/answer |
id_sms da
mensagem. Conforme a documentação, confirme na Referência técnica o formato
final da URL usado pelo ambiente, pois a especificação apresenta o parâmetro
associado ao endpoint sem explicitá-lo no caminho.
Como funciona o envio
O endpoint POST /sms/v3/send recebe uma lista de mensagens
(arraySms) e permite configurar o recebimento de status e de
respostas. Cada item da lista contém:
| Campo | Obrigatório | Descrição |
|---|---|---|
number |
sim | Número de destino com 11 dígitos, incluindo o DDD, somente números. |
message |
sim | Texto da mensagem, limitado a 600 caracteres. |
filter_value |
não | Valor livre usado como referência no sistema integrado. |
Tipos de rota
O campo route_type define a rota de envio:
| Código | Tipo | Utilização |
|---|---|---|
1 |
Exclusivo | Ideal para campanhas que precisam acompanhar as respostas. |
2 |
Básico | Ideal para campanhas que não precisam acompanhar respostas. |
5 |
Bet | Ideal para campanhas sem acompanhamento de respostas e sem necessidade de envio rápido. |
route_type não é informado, a documentação indica que será
utilizada a rota Exclusivo.
Status e respostas
Por webhook
Defina can_receive_status e/ou
can_receive_answer como true e informe as URLs
(webhook_status_url e webhook_answer_url). A API
envia POST para elas a cada atualização.
Por consulta
Use GET /sms/v3/status e GET /sms/v3/answer com
o id_sms retornado no envio para consultar o status de
entrega e a resposta do destinatário.
Tabela de status
| Código | Status | Detalhamento |
|---|---|---|
1 |
Enviado | Com confirmação — a operadora confirmou a chegada ao dispositivo. |
2 |
Enviado | Sem confirmação — aparelho pode estar desligado ou fora de área. |
3 |
Não enviado | Blacklist — número em lista de bloqueio. |
7 |
Não enviado | Com erro — falha no processo de envio. |
10 |
Não enviado | Não me ligue — número no serviço do Procon-SP. |
11 |
Não enviado | Inválido — número informado é inválido. |
12 |
Andamento | Enviando — SMS em processo de envio. |
13 |
Não enviado | Cancelado — envio cancelado por ausência de saldo. |
14 |
Não enviado | Link inválido — bloqueado por link não validado previamente. |