SMS
8 rotasEnvio imediato, agendamento, mensagens personalizadas, status e respostas.
Documentação prática para autenticar, enviar mensagens, consultar saldos, acompanhar status e trabalhar com templates oficiais da Meta.
Resumo da API
Base pública de produção
Quickstart
A API usa Basic Auth. Junte login:senha, converta para Base64 e envie no header Authorization em todas as chamadas HTTPS.
curl --request POST "https://api.hotmobile.com.br/Sms/EnviarMensagem" \
--header "Authorization: Basic BASE64_DO_SEU_LOGIN_E_SENHA" \
--header "Content-Type: application/json" \
--data '{
"mensagem": "Seu código de confirmação é 123456.",
"centroDeCusto": "CRM",
"idExterno": "pedido-9876",
"listNumeros": [
{ "numero": "11999999999" }
]
}'Exemplos
const credentials = btoa("usuario@email.com:senha123");
const response = await fetch("https://api.hotmobile.com.br/Sms/ConsultaSaldo", {
headers: {
Authorization: `Basic ${credentials}`,
},
});
const saldo = await response.json();<?php
$credentials = base64_encode("usuario@email.com:senha123");
$ch = curl_init("https://api.hotmobile.com.br/Sms/ConsultaSaldo");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Basic {$credentials}",
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$saldo = json_decode(curl_exec($ch), true);using var client = new HttpClient();
var token = Convert.ToBase64String(
Encoding.UTF8.GetBytes("usuario@email.com:senha123")
);
client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Basic", token);
var saldo = await client.GetFromJsonAsync<object>(
"https://api.hotmobile.com.br/Sms/ConsultaSaldo"
);Produtos
Envio imediato, agendamento, mensagens personalizadas, status e respostas.
Disparos, instâncias, QR Code, grupos, respostas e controle de bot.
Conexão Meta, sincronização de números, templates oficiais e envio por template.
Consulta de saldo, envio de campanhas HTML e acompanhamento por campanha.
Fluxos
Retornos
A maioria das respostas segue um padrão simples: um indicador de erro, uma mensagem textual e identificadores para consulta posterior.
| Campo | Uso |
|---|---|
| erro | Indica se a operação retornou falha lógica. |
| mensagemRetorno | Mensagem textual para exibição ou diagnóstico. |
| mensagemId | Identificador do envio para consultas futuras. |
| idExterno | Identificador enviado pelo seu sistema para conciliação. |
| statusEnvioId | Status numérico do envio retornado pela plataforma. |
Changelog
A referência local foi sincronizada com o OpenAPI público da Hotmobile em 27/08/2026.
Novas rotas WhatsApp Cloud adicionadas.
Schemas disponíveis para consulta no Scalar.
OpenAPI disponível em /openapi.json.