Skip to main content
POST

Autorizaciones

Authorization
string
header
requerido

Clave API sin autorización de encabezado. Ejemplo: Authorization: Bearer sk_live_xxxxx

Encabezados

Idempotency-Key
string

Clave única para evitar envíos duplicados. Alternativa: x-idempotencia-clave.

x-idempotency-key
string

Clave única para idempotencia (alternativa a Idempotency-Key).

Cuerpo

application/json
to
string[]
requerido

Uno o más números en formato internacional (ej.: 5511999999999).

Required array length: 1 - 100 elements
type
enum<string>
requerido

Use text para mensaje libre o template para una plantilla del workspace.

Opciones disponibles:
text,
template
payload
object
requerido

Cuerpo del mensaje: texto libre o datos de la plantilla (ID y variables).

schedule
object
options
object
metadata
object

Cadena → metadatos de cadena por envío, persistidos en SmsLog.metadata. Respete los límites de carga útil de la API.

Respuesta

SMS aceptados. En cola para envío inmediato o programado.

success
boolean
requerido
Ejemplo:

true

data
object
requerido