getActiveChats
Returns active chats for a specified folder, operator or department.
Input parameters
Parameter | Type | Required | Description |
---|---|---|---|
FolderID | numeric - ID code | No | The identifier of the folder to get active chats for. |
OperatorID | numeric - ID code | No | The identifier of the agent to get active chats for. |
DepartmentID | numeric - ID code | No | The identifier of the department to get active chats for. |
Additional information
Maximum page size: 1000 records.
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getActiveChats?auth=$authHash&FolderID=$FolderID"
Return values
Parameter | Type | Description |
---|---|---|
Data | JSON array | A JSON array of JSON objects with the mappings of fields to values. |
Truncated | boolean | Whether or not the above JSON array is the complete result set, or if the server limited the returned results. For these methods, it is unlikely the limit will be hit, but if it is either filter down the results set or contact us to try to find a way to get at the data you are looking for. |