Pular para o conteúdo
    PT
    Entrar

    Documentação da API CPaaS

    APIs / CPaaS / SMS

    Precisa de ajuda com a integração CPaaS? Fale com um especialista

    Enviar SMS

    Envia uma mensagem de texto para um único destinatário, com suporte a variáveis de template, múltiplos encodings (emoji via UCS-2), encurtador de URL e status de entrega.

    POST/cpaas/v1/sms/messages
    AUTORIZAÇÕES:Bearer JWTAPI Key Header
    RATE LIMIT:100 req/s
    REQUEST BODY SCHEMA:application/json

    from

    obrigatório

    string

    Remetente alfanumérico aprovado (ex.: DISPARO) ou shortcode.

    to

    obrigatório

    string

    Destinatário em dígitos com DDI, sem + (ex.: 5511999990000).

    body

    obrigatório

    string [ 1 .. 1530 ] caracteres

    Texto da mensagem, com suporte a variáveis {{var}}. Até 10 partes concatenadas.

    variables

    opcional

    object

    Pares chave-valor para substituição das variáveis do template.

    encoding

    opcional

    enum · AUTO | GSM-7 | UCS-2

    Encoding da mensagem. AUTO detecta automaticamente (padrão).

    useShortener

    opcional

    boolean

    Ativa o encurtador Clila para URLs HTTPS no corpo (padrão false).

    shortenerSettings

    opcional

    object

    Configurações do encurtador: trackClicks, expiryDays, customAlias.

    callbackUrl

    opcional

    string <url>

    URL para receber status de entrega. Se informada, ignora os webhooks cadastrados.

    reference

    opcional

    string <uuid>

    Identificador de correlação. Gerado automaticamente se omitido; devolvido como id e nos callbacks.

    expiresIn

    opcional

    integer <int32>

    TTL da mensagem em segundos. Padrão 86400 (24h).