While a chatbot user is handed over to a livechat agent, the chatbot does not respond to or process any message requests sent to the chatbot.
Send a handback request to hand the chatbot user back to the chatbot and have the chatbot process requests again.
Request
The webhook integration page contains the base URL to use for all webhook endpoints and the access token to include as a Bearer token in all requests.
| Endpoint | POST | {baseURL}/conversations/{conversationId}/handback |
| Headers | Content-Type | application/json |
| Authorization | Bearer {AccessToken} | |
| Path parameters | conversationID | The chat identifier that was returned when you initiated the chat. |
| Body | {
"author" :{
"type": "agent"
},
"handback":{
"metadata": {}
}
} |
A JSON object containing:
|
curl --location 'https://au.api.ingenious.ai/messaging/webhook/v1/{teamId}/{botId}/conversations/{conversationId}/handback' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {accessToken}' \
--data '{
"author" :{
"type": "agent"
},
"handback":{
"metadata": {}
}
}'Response
| Response code | Description |
|---|---|
| 200 |
Acknowledged. An empty JSON object is returned to acknowledge the request. Requests that result in issues still return the acknowledgement and empty object. |
| 400 | Error. Common causes of errors include a malformed or missing delivery payload, an incomplete webhook integration, incorrect or missing authorization headers, or invalid chatbot or team ID in the base URL. |