Close Chat or Perform Handover
- Print
- DarkLight
- PDF
Close Chat or Perform Handover
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/apps/public/{app-id}/incoming
Close a chat session or perform handover. The appropriate endpoint URL including the appId for closing chat or perfoming handover in your workspace is displayed under App Info > Details > APIs > POST incoming section of the Rasa app.
Changelog
| Version | Description |
|---|---|
| 5.0.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Path parameters
app-id
stringRequired
The app id. Navigate to App Info > Details > APIs > POST incoming to get the complete URL for this endpoint.
Body parameters
Example
{
"action": "close-chat",
"sessionId": "2Sfq8wXw4fYPMf6r4"
}object
action
string Required
The action can either be handover or close-chat.
sessionId
string Required
The ID of the Rasa session.
actionData
object
targetDepartment
string
The targeted department.
Responses
200
OK
Close chat
{
"msg": " Close chat request handled successfully"
}Perform handover
{
"msg": " Perform Handover request handled successfully"
}object
msg
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?