API – Enviar mensajes de texto o plantillas en WhatsApp Business

Documentación para enviar mensajes de texto o plantillas en WhatsApp Business.

api_token: El token se genera automaticamente en el momento de crear la cuenta en SalesBot. El token estará disponible en Preferencias – Integración y Desarrolladores:

instance: Cód. Identificador del canal / instancia de comunicación. Está disponible en Canales y haga clic en Ver:


Estará disponible en el campo: Cód. Identificador

POST https://salesbot.es/app/api/whatsapp_business/sendMessage?instance=XXXX&api_token=AAAA

PARAMETERS:
instance (obligatório)
api_token (obligatório)

PAYLOAD: (Content type: application/json)

phoneDDI del país y Número de Whatsapp
bodyTexto plano del mensaje
template_idCódigo de la plantilla (Campo código en el listado)
assign_userCorreo electrónico del usuario a asignar la conversación o «auto»

Mensaje de texto:

{
"phone": "34600123456",
"body": "Hola, buenos días"
}

Mensaje de plantilla:

{
"phone": "34600123456",
"template_id": "hola_mundo",
"assign_user": "auto"
}

RESPUESTA – suceso:

{
  "type": "message",
  "data": {
    "_id": "D366CCE3BAC40676737C2E0ECEF44EBFBD4158D1",
    "message_id": "wamid.HBgLMzQ2MjgzNDQ0MTIVAgARGBIyQkQ037SMDFEOTk4Njk1NDXX",
    "message_quoted_id": null,
    "instance_number": "12334567890000",
    "body": "Hola, buenos días",
    "content": "",
    "type": "chat",
    "fromMe": true,
    "from": "34900123456",
    "to": "34600123456",
    "author": null,
    "time": 1727253481,
    "timeFormatted": "2024-09-25 10:38:01",
    "chatId": "34600123456",
    "chatName": null,
    "chatImage": null,
    "isGroup": null,
    "isLoading": false,
    "status_sent": null,
    "status_sent_time": null,
    "status_delivered": null,
    "status_delivered_time": null,
    "status_viewed": null,
    "status_viewed_time": null,
    "deviceType": "api",
    "buttons": null
  },
  "time": 1727253481,
  "instance": "12334567890000",
  "session": "12334567890000",
  "user": "salesbot@salesbot.es",
  "product": "whatsapp"
}

ERROR:

{
"status":false,
"err":"codigo_del_error"
}

Código de errores:

number_requiredEl Número de whatsapp es requerido
instance_not_foundLa instancia no es correcta
body_or_template_id_requiredSe debe enviar el body o template_id
template_not_foundNo se ha encontrado el template con el código enviado
need_use_templateHan pasado más de 24 horas desde el inicio de la conversación o nunca ha habido una conversación previa, es necesario enviar una plantilla (template_id)
need_wait_customer_messageNo se puede enviar ningún mensaje de texto, salvo que sea un template, hasta que conteste el cliente

Actualizaciones:

  • 18/10/2024 – Nuevo campo de assign_user, utilizado para asignar el operador a la conversación. Permite utilizar el correo electrónico o «auto» para asignar automáticamente el operador. Solo aplica si no hay otro operador ya asignado.