Skip to main content
POST

Autorizações

Authorization
string
header
obrigatório

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Cabeçalhos

Idempotency-Key
string

Chave única para evitar envio duplicado. Alternativa: x-idempotency-key.

x-idempotency-key
string

Chave única para idempotência (alternativa a Idempotency-Key).

Corpo

application/json
to
string[]
obrigatório

Um ou mais números no formato internacional (ex.: 5511999999999).

Required array length: 1 - 500 elements
type
enum<string>
obrigatório

Escolha text para mensagem livre ou template para usar um template do workspace.

Opções disponíveis:
text,
template
payload
object
obrigatório

Corpo conforme type. text: message (obrigatório). template: templateId e variables opcionais.

from
string
obrigatório

Remetente SMS (opcional): id ou E.164 do número do workspace.

variables
object

Placeholders na raiz para type: text (ex.: {{name}} em payload.message). Mesclado com dados do contato do CRM.

localization
object

Localização do texto por destinatário.

i18n
object

Traduções manuais por locale quando localization.mode é manual.

schedule
object
options
object
metadata
object

Objeto JSON persistido em SmsLog.metadata (máx. 20 chaves, 16 KB). Valores podem ser strings ou outros tipos JSON.

Resposta

SMS aceito(s). Enfileirado(s) para envio imediato ou agendado.

success
boolean
obrigatório
Exemplo:

true

data
object
obrigatório