Enviar mensaje

POST /api/outbound/send

Encola un mensaje saliente hacia el canal indicado (WhatsApp, Instagram, Messenger). En WhatsApp, to acepta un teléfono E.164 sin + o un BSUID (US.… / US.ENT.…); Neike detecta el formato y lo rutea al campo correcto de la Cloud API (error 131062 = el mensaje no soporta destinatarios BSUID). Responde 202 y el resultado llega por webhook de estado. Requiere scope messages:send.

Authentication

Send your API key in the x-neike-api-key header. Console sessions can use a bearer JWT plus x-neike-client-id instead.

Request body

Field	Type		Description
channelId	string	required	channel_id del canal conectado (prefijo nk_). Example: "nk_dvzobn7m4h4y".
to	string	required	Destinatario. En WhatsApp, número en formato E.164 sin +, o un BSUID (US.13491208655302741918 / parent US.ENT.…): Neike detecta el formato y lo rutea al campo correcto de la Cloud API. Example: "5491112345678".
type	text · image · video · audio · document · template · interactive · reaction	required	Tipo de mensaje. Example: "text".
content	object	required	Contenido según type. text → { text }; media → { [type]: { link|id, caption?, filename? } }; template → { template: {...} }; interactive → { interactive: {...} }; reaction → { reaction: { message_id, emoji } }. Example: {"text":"Hola, este es un mensaje de prueba"}.
humanAgent	boolean	optional	Solo Instagram: agrega el tag HUMAN_AGENT (fuera de la ventana de 24h). Example: false.

Responses

Status	Description	Schema
202	Mensaje encolado.	SendMessageResponseDto

Example

curl -X POST https://api.neike.dev/api/outbound/send \
  -H "x-neike-api-key: whk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
       "channelId": "nk_dvzobn7m4h4y",
       "to": "5491112345678",
       "type": "text",
       "content": {
         "text": "Hola, este es un mensaje de prueba"
       }
     }'

SendMessageResponseDto

Field	Type		Description
ok	boolean	required	true si el mensaje se encoló correctamente. Example: true.
jobId	string	optional	Id del job en la cola de salida. Example: "outbound_nk_dvzobn7m4h4y_1712345678901".
reason	string	optional	Motivo, cuando ok=false.