getAllChatAssignments
Returns all chat assignments that occurred during the time range defined by the ToDate and FromDate parameters.
Input parameters
Parameter | Type | Version | Required | Description |
---|---|---|---|---|
FromDate |
date |
All |
no |
The start date |
ToDate |
date |
All |
no |
The end date |
PageStart |
integer |
v1 |
no |
The number of elements to skip in the result set. |
PageSize |
integer |
v1 |
no |
The number of results in the returned set. This can be used to limit the returned set to less than the server maximum (this will not allow you to exceed the server page size, which is 1000 records in most cases.) |
Return values
Parameter | Type | Description |
---|---|---|
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. |
ChatAssignmentID | Unique ID of the Assignment event. | |
AssignmentType |
The type of Assignment that took place:
|
|
OperatorID | Internal ID of the agent who was last assigned to a chat record. | |
ChatID | Bold360-assigned unique identifier for each chat session. | |
AssignmentNumber |
Sequential number of an Assignment event taking place on a Chat Record. |
|
Started | Date and time when a chat was started within the chat queue. | |
Answered | Date and time when the chat was most recently answered. | |
Ended | Date and time when the chat was ended, either by the customer or agent. | |
OperatorAnswerChatCount |
The number of agent answers within the chat assignment. |
|
OperatorEndChatCount |
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
|
|
AccountID | Unique account ID (AID) that a chat record was created within. | |
Created | Date and time when the chat message was created by clicking the Chat button, or by sending an invite. | |
Updated | Date and time when the record was most recently updated. | |
Deleted | Date and time when the record was deleted. The value is null if the record was not deleted. | |
ClientType | The type of the Bold360 client used for Chat:
|
|
FromOperatorID | Internal ID of the Operator/Agent who assigned the chat. | |
AssignmentByOperatorID | Internal ID of the Operator/Agent who initiated the assignment of chat. | |
FromDepartmentID | Internal ID of the Department where the chat is assigned from. | |
DepartmentID | Internal ID of the department that the chat was last assigned to. | |
ToOperatorID | Internal ID of the Operator/Agent who the chat is currently assigned to. | |
ToAssignmentByOperatorID | Internal ID of the agent who initiated the Assignment event of the chat. | |
ToDepartmentID | Internal ID of the Department who the chat is currently assigned to. | |
VisitorMessageCount | The number of customer-sent messages. | |
OperatorMessageCount | The number of agent-sent messages. | |
EndedVisitorMessageCount | Total number of messages that the customer sent during the chat engagement. | |
EndedOperatorMessageCount | Total number of messages that the agent sent during the chat engagement. |
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": "805846348511328",
"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
}
]
}