Saltar al contenido
ComdigDocs

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

Solicitud#

POSThttps://api.comdig.co/v1/api-send-message

Permiso requerido: messages:send

Parámetros del cuerpo#

Parámetros del cuerpo
NombreTipoRequeridoDescripción
phonestringSi no hay wa_user_idTeléfono del destinatario en formato E.164, por ejemplo +573001234567.
wa_user_idstringNoID de usuario de WhatsApp. Úsalo en lugar de phone para contactos sin número.
messagestringSíTexto del mensaje.
contact_namestringNoNombre del contacto.
phone_number_idstringNoLínea de envío. Necesario si la empresa tiene varias líneas activas (o usa inbox_id).
inbox_idstringNoAlternativa a phone_number_id para elegir la línea de envío.
badge_labelstringNoTexto de la insignia que se ve en la conversación de Comdig.Por defecto: APIMáx. 40 caracteres
badge_colorstringNoColor de la insignia.Valores: cyan | blue | purple | pink | slate | tealPor defecto: cyan
source_labelstringNoEtiqueta del origen del envío.Máx. 40 caracteres

Ejemplo#

Mensaje de texto
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"
}