getAllChatAssignments
Returns chat assignments occurring during the time range defined by the ToDate and FromDate parameters.
Input parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
|
FromDate |
date - ISO / UTC |
No |
The start date. |
|
ToDate |
date - ISO / UTC |
No |
The end date. |
|
NextPage |
string |
No |
Tells the server the next page of data to retrieve. This parameter should be the same value as what was returned in the response field "NextPage" by the previous call. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getAllChatAssignments?auth=$authHash&FromDate=2020-01-01T00:00:00Z"Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
| Parameter | Type | Description |
|---|---|---|
| AccountID | numeric - ID code | Bold360 product account ID. |
| Answered | date - ISO/UTC | Date and time when the chat was most recently answered. |
| AssignmentByOperatorID | numeric - ID code | The ID of the operator who reassigned the chat. |
| AssignmentNumber | integer | Count of assignments on a specified chat. |
| AssignmentType | integer | The type of Assignment that took place:
|
| ChatAssignmentID | numeric - ID code | Unique ID of the Assignment event. |
| ChatID | numeric - ID code | Bold360-assigned unique identifier for the chat session. |
| ClientType | integer | The type of the Bold360 client used for Chat:
|
| Created | date - ISO/UTC | Date and time when the target resource was created. |
| Data | text - heading | JSON array heading that precedes report data output |
| Deleted | date - ISO / UTC | Date and time when the item was deleted. The value is null if the item was not deleted. |
| DepartmentID | numeric - ID code | ID of the department. |
| Ended | date - ISO/UTC | Date and time visit or chat ended. |
| EndedOperatorMessageCount | integer | Total number of messages that the agent sent during the chat engagement. |
| EndedVisitorMessageCount | integer | Total number of messages the customer sent during the chat. |
| FromDepartmentID | numeric - ID code | ID of the Department where the chat is assigned from. |
| FromOperatorID | numeric - ID code | ID of the operator who assigned the chat. |
| OperatorAnswerChatCount | integer | The number of agent answers within the chat assignment. |
| OperatorEndChatCount | integer | The number of active chats assigned to and accepted by the operator, who is currently assigned to the chat (identified by the ChatID parameter). This value is calculated when the chat ends. Only those chats are included that were accepted by the operator (for example, chats assigned by ACD but not accepted are not included) AND are active at the time of ending the current chat. The current chat is also included in the value. Before the chat ends, this value is zero. |
| OperatorID | numeric - ID code | System-assigned ID of the operator. |
| OperatorMessageCount | integer | The number of operator-sent messages. |
| Started | date - ISO / UTC | Date and time when a chat was started within the chat queue. |
| Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
| ToAssignmentByOperatorID | numeric - ID code | Internal ID of the agent who initiated the Assignment event of the chat. |
| ToDepartmentID | numeric - ID | ID of the Department who the chat is currently assigned to. |
| ToOperatorID | numeric - ID | ID of the Operator who the chat is currently assigned to. |
| Truncated | Boolean | TRUE if results were shortened to fit the report, FALSE if full results for the report criteria were returned. If TRUE, you can filter down the results set or contact us to try to find a way to get at the data you are looking for. |
| Updated | date - ISO / UTC | Date and time when the <event/record> was most recently modified. |
| PageType | integer | The last page of a chat window presented to a customer - The
legend of page types is:
|
| PageViewCount | integer | Number of pages a visitor viewed during their current session. |
Sample code
{
"Status": "success",
"Truncated": true,
"Next":{"PageSize":500,"PageStart":1,"ToDate":"2016-07-09T03:51:45.000Z"},
"Data": [
{
"ChatAssignmentID": "4437774764210404",
"AssignmentType": 0,
"OperatorID": "1285356983897857",
"ChatID": "3189853051598820",
"AssignmentNumber": 1,
"Started": "2019-10-25T11:18:06.000Z",
"Answered": "2019-10-25T11:18:22.000Z",
"Ended": "2019-10-25T11:18:39.000Z",
"OperatorAnswerChatCount": 1,
"OperatorEndChatCount": 1,
"AccountID": "805866648511328",
"Created": "2019-10-25T11:18:06.070Z",
"Updated": "2019-10-25T11:18:39.987Z",
"Deleted": null, "FolderID": "1024852943181144",
"WebsiteDefID": "158278074758892865",
"ClientType": 0, "FromAssignmentType": 1,
"FromOperatorID": null,
"AssignmentByOperatorID": null,
"FromDepartmentID": "1159194063827769324",
"DepartmentID": "1159194063827769324",
"ToOperatorID": null,
"ToAssignmentByOperatorID": null,
"ToDepartmentID": null,
"VisitorMessageCount": 0,
"OperatorMessageCount": 0,
"EndedVisitorMessageCount": 1,
"EndedOperatorMessageCount": 1
}
]
}