Skip to main content
POST
/
v1
/
sms
/
messages
Enviar SMS
curl --request POST \
  --url https://api.notifique.dev/v1/sms/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": [
    "5511999999999",
    "5521988887777"
  ],
  "message": "Olá! SMS de teste.",
  "schedule": {
    "sendAt": "2025-12-31T14:00:00.000Z"
  },
  "options": {
    "priority": "high",
    "webhook": {
      "url": "https://api.seudominio.com/hooks/sms-events",
      "secret": "opcional_hmac_secret"
    }
  },
  "metadata": {
    "orderId": "12345",
    "source": "checkout"
  }
}
'
{
  "success": true,
  "data": {
    "status": "QUEUED",
    "count": 2,
    "smsIds": [
      "clxx123...",
      "clxx456..."
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
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).

Body

application/json
​
to
string[]
required

Lista de números no formato E.164 (ex.: 5511999999999). Um SMS por número.

Required array length: 1 - 100 elements
​
message
string
required

Texto do SMS (mínimo 9 caracteres, máximo 160; comparação após trim).

Required string length: 9 - 160
​
schedule
object
​
options
object
​
metadata
object

Metadados string→string por envio, persistidos em SmsLog.metadata. Respeite os limites de payload da API.

Response

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

​
success
boolean
required
Example:

true

​
data
object
required