Crear conversación en Chatwoot, con una API

Inicia una conversación con un contacto en una bandeja, opcionalmente con un primer mensaje. source_id identifica al contacto en esa bandeja: viene de contact_inboxes en Search contacts, de Create contact o de Create contact inbox. En bandejas de WhatsApp, el primer mensaje va como plantilla aprobada en message.template_params.

Identificador
chatwoot_create_conversation

La llamada

POST https://connect.reportei.com/api/tools/chatwoot_create_conversation/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "account_id": 1,
    "source_id": "<source_id>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
account_idintegerSíId of the Chatwoot account: the id of one of the accounts from Get profile, also shown in the dashboard URL after /accounts/, as in app.chatwoot.com/app/accounts/123.
source_idstringSísource_id of the contact in the inbox, from contact_inboxes of Search contacts, Create contact or Create contact inbox. Each item pairs an inbox with its source_id.
inbox_idintegerNoInbox of the conversation, the same of the source_id, from List inboxes.
contact_idintegerNoId of the contact, from Search contacts.
statusstringNoInitial status of the conversation.Valores: open, resolved, pending
assignee_idintegerNoId of the agent to assign, from List agents.
team_idintegerNoId of the team to assign, from List teams.
custom_attributesobjectNoConversation custom attribute values keyed by attribute key.
messageobjectNoFirst message of the conversation, sent to the contact.

Conexiones posibles

Tu cliente conecta su cuenta de Chatwoot una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/chatwoot_create_conversation. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Chatwoot

Ver las 15 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.