Serviços / Mensageria

Envio de SMS

POST/api/v1/messenger/sms

Envie códigos de verificação (OTP) e avisos transacionais por SMS, sem contrato com operadora.

Envie um JSON com to em formato internacional (+5511999999999) e message, até 1600 caracteres. A cobrança é por unidade de mensagem: 160 caracteres por unidade, ou 70 quando o texto tem acento fora do alfabeto GSM ou emoji, e mensagem com link soma 1 unidade. O bloco billing mostra a conta.

Mensagem não entregue não é cobrada.

Fonte: Provedores parceiros · tempo real

Parâmetros

tostringObrigatório

Destinatário em E.164, com DDI. A pontuação é ignorada.

+5511999999999
body
messagestringObrigatório

Texto da mensagem, até 1600 caracteres.

Seu código de verificação é 123456.
body

Campos da resposta

Status

status

string

Detalhe

detail

string

Destinatário (mascarado)

to

Destinatário mascarado — o número não volta inteiro.

string

ID da mensagem

message_id

string

Composição da cobrança

billing

object

Caracteres

billing.characters

Tamanho do texto enviado.

integer

Alfabeto

billing.encoding

`gsm-7` cabe 160 caracteres por unidade; `ucs-2` (acento, emoji), 70.

string

Caracteres por unidade

billing.characters_per_unit

integer

Unidades do texto

billing.segments

Unidades que o texto consome.

integer

Unidades por link

billing.link_surcharge_units

Unidades somadas por conter URL. Zero quando não há link.

integer

Unidades cobradas

billing.billable_units

`segments + link_surcharge_units`. É o `tokens_in`.

integer

Exemplo de resposta

Modelo de resposta: SmsSendOutput
JSON · response
{
  "success": true,
  "code": 200,
  "code_message": "A requisição foi processada com sucesso.",
  "errors": [],
  "header": null,
  "data_count": 1,
  "data": [
    {
      "status": "success",
      "detail": "Mensagem enviada.",
      "to": "+55119****4321",
      "message_id": "9182736",
      "billing": {
        "characters": 38,
        "encoding": "gsm-7",
        "characters_per_unit": 160,
        "segments": 1,
        "link_surcharge_units": 0,
        "billable_units": 1
      }
    }
  ]
}

Casos de uso

Código de verificação

Enviar o código de login ou de confirmação de uma operação por SMS.

Aviso transacional

Confirmar pedido, entrega ou cobrança sem manter contrato com operadora.

Notas de integração

  • O número do destinatário nunca volta inteiro na resposta.
  • `tokens_in` no bloco `header` é o número de unidades de SMS: é por elas que a mensagem é cobrada.