Envio de SMS
Envie mensagens SMS para qualquer número de telefone no Brasil e no mundo com alta taxa de entrega e baixa latência.
Características: Entrega em até 5 segundos • Suporte a 160 caracteres • Remetente personalizável • Relatórios detalhados
Enviar SMS Único
Envie uma mensagem SMS para um único destinatário:
POST
/api/v1/integration/send
Parâmetros
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
to |
String | Sim | Número de telefone com código do país (ex: 5511999999999) |
message |
String | Sim | Conteúdo da mensagem (máx. 160 caracteres) |
routeId |
String | Sim | ID da rota de envio (obtenha via GET /integration/routes) |
type |
String | Não | Tipo: "SMS" (padrão) |
callbackUrl |
String | Não | URL para webhooks de status |
Exemplo de Requisição
{
"to": "5511999999999",
"message": "Seu código de verificação é: 123456",
"routeId": "6584a9b1c2d3e4f5a6b7c8d9",
"type": "SMS",
"callbackUrl": "https://sua-app.com/webhook"
}
Resposta (200 OK)
{
"message": "Requisição recebida com sucesso. A campanha foi enviada para análise e processamento.",
"details": {
"campaignId": "6584b123c2d3e4f5a6b7c999",
"status": "UNDER_APPROVAL",
"type": "SMS",
"routeName": "Rota SMS Premium",
"content": "Seu código de verificação é: 123456",
"recipients": 1,
"cost": {
"perUnit": 0.08,
"total": 0.08,
"currency": "BRL"
}
}
}
Nota sobre custos: Os valores apresentados nos exemplos são meramente ilustrativos. Os custos reais variam por rota e são definidos individualmente. Consulte seu gerente de conta para informações específicas sobre precificação.
Envio em Lote
Envie a mesma mensagem para múltiplos destinatários (até 1000 por requisição):
Exemplo com Array de Números
{
"to": [
"5511999999999",
"5511988888888",
"5511977777777"
],
"message": "Promoção especial! 50% de desconto hoje.",
"routeId": "6584a9b1c2d3e4f5a6b7c8d9",
"type": "SMS"
}
Resposta (200 OK)
{
"message": "Requisição recebida com sucesso. A campanha foi enviada para análise e processamento.",
"details": {
"campaignId": "6584b123c2d3e4f5a6b7c999",
"status": "UNDER_APPROVAL",
"type": "SMS",
"routeName": "Rota SMS Premium",
"content": "Promoção especial! 50% de desconto hoje.",
"recipients": 3,
"cost": {
"perUnit": 0.08,
"total": 0.24,
"currency": "BRL"
}
}
}
Templates SMS
Crie templates reutilizáveis com variáveis dinâmicas:
Criar Template
POST
/api/sms-template
Exemplo de Template
{
"name": "OTP Verification",
"senderName": "MeuApp",
"message": "Seu código de verificação é: {{code}}. Válido por 5 minutos."
}
Usar Template
Ao enviar mensagem, substitua as variáveis:
{
"to": "5511999999999",
"message": "Seu código de verificação é: 123456. Válido por 5 minutos.",
"type": "SMS"
}
Playground - Teste Envio de SMS
Experimente enviar SMS diretamente pela documentação (simulação):
Modo Simulação: Este playground apenas simula as respostas da API. Nenhuma mensagem real é enviada e nenhuma requisição é feita ao backend.
Testar Envio de SMS
Limites e Restrições
| Limite | Valor | Descrição |
|---|---|---|
| Tamanho da Mensagem | 160 caracteres | SMS padrão. Mensagens maiores são divididas automaticamente |
| Destinatários por Lote | 1000 | Máximo de números por requisição |
| Taxa de Envio | 100 msg/s | Limite por API Key |
| Remetente | 11 caracteres | Nome do remetente (alfabético) |
Caracteres Especiais
Caracteres especiais consomem mais espaço na mensagem:
- Padrão (GSM-7): 160 caracteres por SMS
- Unicode (UTF-16): 70 caracteres por SMS (usado quando há emojis ou acentos especiais)
Dica: Para otimizar custos, evite usar emojis em SMS. Use RCS para mensagens com rich media.