take-inquiry.md

Take Inquiry

Join an open inquiry.

HTTP Method	URL	Requires Auth
POST	/api/v1/livechat/inquiries.take	yes

Body Parameters

Key	Example Value	Description
inquiryId*	ByehQjC44FwMeiLbX	The inquiry ID.
userId	yuhehQjCfsd876sfd	The user's (agent) ID who is taking the inquiry. This is an optional parameter.

{% hint style="info" %} If the userId is provided, the user must have the view-l-room permission. {% endhint %}

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application/json" \
     http://localhost:3000/api/v1/livechat/inquiries.take \
     -d '{ 
          "inquiryId": "ByehQjC44FwMeiLbX"}'

Example Response

{
    "success": true
}

Change Log

Version	Description
1.2.0	Added