getAllTextChatMessages
Returns text chat messages for an account based on the Created date.
Additional information
Maximum page size: 1000 records.
Input parameters
Parameter | Type | Required | Description |
---|---|---|---|
PageSize | integer | 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.) |
PageStart | integer | No | The number of elements to skip in the result set. |
ToDate | date - ISO-UTC | No | The end date. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getAllTextChatMessages?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. |
CannedMessageID | string (max) | The ID of Canned Message configuration item used to deliver the chat message. The value is null if the Canned Message was not used. |
ChatType (aka ChatLaunchType) | integer | Type of the chat at the start or after someone tried to start
it:
|
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. |
LastIncomingArrived | date - ISO-UTC | Date and time last message arrived. |
Name | string(30) | The name of the folder as defined in the system. |
PersonID | string (max) | The ID of the person who sent the chat message. |
PersonType | integer | The persona of the user who sent the chat message:
|
RuleID | numeric - ID code | Identifier for an auto-invite or other rule. |
Text | string | Content of the message in HTML or text. |
TextChatID | integer | The identifier of the message conversation to get assignments for. |
TextChatMessageID | numeric - ID code | Identifier of the text chat message. |
Type | string | Field entry type for pre-chat survey fields:
|
Sample code
{
"Status": "success",
"Truncated": false,
"Data": [
{
"TextChatMessageID":"6549796078426795170",
"PersonType":0,
"PersonID":"1285356983897857",
"Name":"Charley Patton",
"Text": "Sorry, could not understand that... [Ask an agent] []",
"TextChatID":"445353301403598897",
"Created":"2020-11-18T15:05:36.727Z",
"Deleted":null,
"AccountID":"805666348511328",
"CannedMessageID":"445353908703598822",
"LastIncomingArrived":"2020-12-03T12:34:22.117Z",
"Type":"Text",
"ChatType":1,
"RuleID":"1060953090490332",
}
]
}