In this setup we expect you to have your own widget for the end user to start the conversation. And then you will use our import conversation endpoint to either escalate to an agent or have a closed conversation be added to Dixa for analytics and auto QA.
The document covers three main sections — Handoff Setup, Adding Conversations to Dixa, and Adding Custom Attributes — with all API endpoints linked, curl examples formatted as proper code blocks, and a field reference table for the key IDs.
To prepare your conversation for the escalation then you need to know which end-user ID to use, which you can find at List end-user.
To create a conversation use the Import Conversation API. The "genericChannelName" should be set to "genericapimessaging", and the "agentId" must be the chatbot user that's created for you.
After the conversations have been created, transfer it to a queue using the Transfer to Queue API endpoint. Queues in Dixa is used different between the customers, so make sure that you are transfering the conversation to the appropriate queue.
For webhooks, add a filter for Generic API Messaging to keep focus on relevant events and only receive relevant events. Select Message added and Closed conversation events so that the chatbot can pick up the contact again when the agent has helped out.
Optionally, check for "Typing started" to show typing indicators on the chatbot's widget. Note: it is not possible to read events and show them in the agent interface.
Use the Import Conversation API.
| Field | Description |
|---|---|
requesterId | End-user ID |
agentId | Bot ID |
queueId | Queue ID for human staffed queues |
Use the Patch Custom Attributes API.
To retrieve available custom attributes, use the Get Custom Attributes API.