Referencia de la API
Enviar mensaje
Envía un mensaje de texto libre por WhatsApp. Según las reglas de WhatsApp, solo funciona dentro de la ventana de 24 horas de atención al cliente; fuera de ella usa una plantilla.
POST/api-send-message
En esta página
Solicitud#
POSThttps://api.comdig.co/v1/api-send-message
Permiso requerido: messages:send
Parámetros del cuerpo#
| Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
phone | string | Si no hay wa_user_id | Teléfono del destinatario en formato E.164, por ejemplo +573001234567. |
wa_user_id | string | No | ID de usuario de WhatsApp. Úsalo en lugar de phone para contactos sin número. |
message | string | Sí | Texto del mensaje. |
contact_name | string | No | Nombre del contacto. |
phone_number_id | string | No | Línea de envío. Necesario si la empresa tiene varias líneas activas (o usa inbox_id). |
inbox_id | string | No | Alternativa a phone_number_id para elegir la línea de envío. |
badge_label | string | No | Texto de la insignia que se ve en la conversación de Comdig.Por defecto: APIMáx. 40 caracteres |
badge_color | string | No | Color de la insignia.Valores: cyan | blue | purple | pink | slate | tealPor defecto: cyan |
source_label | string | No | Etiqueta del origen del envío.Máx. 40 caracteres |
Ejemplo#
curl -X POST "https://api.comdig.co/v1/api-send-message" \
-H "X-API-Key: $COMDIG_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phone": "+573001234567",
"message": "Hola Ana, tu pedido ya va en camino.",
"contact_name": "Ana Gómez"
}'Respuestas#
200Mensaje enviado.
JSON
{
"success": true,
"message_id": "wamid.HBgMNTczMDAxMjM0NTY3FQIAERgS",
"conversation_id": "8f1c2a4e-3b7d-4e9a-9c11-2d5f6a7b8c90",
"contact_id": "1d2e3f4a-5b6c-7d8e-9f01-a2b3c4d5e6f7"
}400Datos inválidos o no se pudo resolver la línea de envío.
JSON
{
"error": "Descripción del error"
}401Token ausente, inválido, expirado o sin el permiso messages:send.
JSON
{
"error": "Descripción del error"
}