Skip to main content
POST
Send message
Los mensajes de texto libre (content) no pueden llevar un archivo adjunto. Para mandar una imagen, video o documento, usa template_id con una plantilla cuyo formato de header coincida, y pasa la URL del archivo en un componente header dentro de components (ver el ejemplo whatsapp_template_with_document más abajo). Las plantillas también funcionan fuera de la ventana de 24 horas de servicio al cliente. Crea y aprueba plantillas desde Integraciones → WhatsApp → Plantillas — ver Plantillas de mensaje.
Una llamada puede devolver HTTP 409 con code: "call_suppressed". No se hizo ninguna llamada. Dos valores de reason se refieren a leads que esperan al equipo:
  • lead_in_support con retryable: false: el lead está esperando una respuesta del equipo, porque el agente de IA le pasó la conversación. Las llamadas automáticas a ese lead quedan en pausa hasta que el equipo cierre esa conversación. Reintentar antes devuelve la misma respuesta.
  • lead_support_unverified con retryable: true: Nexor no pudo confirmar si el lead está esperando al equipo. La misma solicitud se puede reintentar tras una breve espera.

Autorizaciones

X-API-Key
string
header
requerido

API key for authentication. Keys are prefixed with nxr_live_.

Cuerpo

application/json
channel
enum<string>
requerido
Opciones disponibles:
whatsapp
content
string
requerido

Plain text message body. Required for whatsapp (unless using template_id). For email: use content for plain text or html for formatted email.

Minimum string length: 1
lead_id
string<uuid>
requerido

Lead to contact

template_id
string<uuid>

WhatsApp template ID. Sends a template message instead of free-form text.

Minimum string length: 1
workflow_id
string<uuid>

Optional when the lead has exactly one active workflow run; otherwise required to disambiguate.

html
string

HTML email body. When provided, the email is sent with this HTML directly (not escaped). Use instead of content for formatted emails.

subject
string

Email subject line. Defaults to 'Message from your advisor'.

components
object[]

Template parameters in Meta format. Used with template_id. To send a file (image, video, or document) as part of the message, include a header component whose parameter carries the file — see the whatsapp_template_with_document request example. The template must already be approved with a matching header format; free-form content messages cannot carry attachments.

begin_message
string

Custom greeting for call channel. Overrides the workflow default.

voice_tool_allowlist
string[]

Allowed only for call; restricts the voice agent tools for this call.

Required array length: 1 - 20 elements
Pattern: ^[a-z][a-z0-9_]{0,127}$
author_type
enum<string>
predeterminado:automation
Opciones disponibles:
human,
automation
author_name
string

Respuesta

Message sent successfully

success
boolean

Whether the message was sent

channel
enum<string>

Channel used

Opciones disponibles:
whatsapp,
unsupervised-whatsapp,
imessage,
email,
sms,
call
type
enum<string>

WhatsApp only: message type

Opciones disponibles:
text,
template
message_id
string | null

Internal message identifier

provider_message_id
string | null

WhatsApp only: Meta wamid

activity_id
string | null

Email only: delivery tracking ID

call_id
string | null

Call only: call identifier

call_status
string | null

Call only: initial status (registered)

provider
string

Provider identifier returned for provider-specific channels.

Última modificación el 27 de septiembre de 2026