getAllTextChatAssignments

Additional information

Maximum page size: 500 records.

Input parameters

None.

Request format

curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getAllTextChatAssignments?auth=$authHash"

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: 0 - Operator assigned 1 - ACD assigned
ChatType (aka ChatLaunchType)	integer	Type of the chat at the start or after someone tried to start it: 0 - Visitor stated the chat with an agent 1 - Agent initiated the chat (using auto invite) 2 - Agent invited the customer to chat (using custom invite) 3 - Agent was unavailable 4 - Auto-invited chat 5 - Blocked chat 6 - Recovery invite 7 - XMPP chat 8 - Chat started via API
ClientType	integer	The type of the Bold360 client used for Chat: 0 - Normal 1 - iPhone 2 - Web 3 - Visitor 4 - Call 5 - Offline 6 - Web Mobile 7 - Login 8 - Enabled 9 - Dashboard 10 - Bold360 Agent Workspace
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.
FolderID	numeric	The ID of the folder.
FromAssignmentType	integer	The assignment type of the chat prior to the current assignment.
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.
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.
TextChatAssignmentID	numeric - ID code	The unique identifier of returned text chat assignment records.
TextChatID	integer	The identifier of the message conversation to get assignments for.
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.

Sample return

{
    "Status": "success",   
    "Truncated": false,
    "Data": [
      {
      "TextChatAssignmentID":"6549796078426795170"
      "AssignmentType":0
      "OperatorID":"1285356983897857"
      "TextChatID":"6548548124234703778"
      "AssignmentNumber":1
      "Started":"2019-03-18T15:05:36.000Z"
      "Answered":"2019-03-18T15:05:40.000Z"
      "Ended":"2019-03-18T15:05:43.000Z"
      "OperatorAnswerChatCount":1
      "OperatorEndChatCount":1
      "AccountID":"805666348511328"
      "Created":"2019-03-18T15:05:36.727Z"
      "Updated":"2019-03-18T15:05:43.257Z"
      "Deleted":null
      "FolderID":"1024853090490371"
      "ClientType":null
      "FromAssignmentType":1
      "FromOperatorID":null
      "AssignmentByOperatorID":null
      "FromDepartmentID":"1159194063827769324"
      "DepartmentID":"1159194063827769324"
      "ToOperatorID":null
      "ToAssignmentByOperatorID":null
      "ToDepartmentID":null
      "ChatType":1
       }
   ]
}