livechat-room-forward.md

Forward Livechat Room

The Chatbot agent forwards the chat to a human agent.

HTTP Method	URL	Requires Auth
POST	/api/v1/livechat/room.forward	yes

Body

Key	Example Value	Description
roomId*	XFzMqgn33DcsQkpJp	The room _id.
userId	iNKE8a6k6cjbqWhWd	The new agent ID.
departmentId	wXpPLofkffqWAwDNF	The new department ID.

Example Call

With roomId and userId:

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/livechat/room.forward \
     -d '{"roomId": "XFzMqgn33DcsQkpJp", 
          "userId": "iNKE8a6k6cjbqWhWd"}'

With roomId and departmentId:

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/livechat/room.forward \
     -d '{"roomId": "XFzMqgn33DcsQkpJp", 
          "departmentId": "wXpPLofkffqWAwDNF"}'

Example Response

{
  "success": true
}