inquiries-list.md

Get Inquiries List

Lists all open Livechat inquiries.

HTTP Method	URL	Requires Auth
GET	/api/v1/livechat/inquiries.list	yes

{% hint style="info" %}

• An incoming chat that has not yet been taken by the agent is called an inquiry. After it's been taken by the agent it is referred to as room.
• Permission required: view-livechat-manager {% endhint %}

Query Parameters

This endpoint supports the optional #pagination parameters. Other optional parameters are as follows:

Key	Example Value	Description
department	ByehQjC44FwMeiLbX	The department ID or name.

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/livechat/inquiries.list

Example Response

{
    "inquiries": [
          {
            "_id": "GpxfRo8TaPHfsnnC5",
            "rid": "EbQjtCosHJWLQmQYT",
            "name": "Marcos Defendi",
            "ts": "2019-06-11T19:01:57.424Z",
            "status": "queued"
        }
    ],
    "offset": 0,
    "count": 1,
    "total": 1,
    "success": true
}

Change Log

Version	Description
1.2.0	Added