getTextChatMessages

Input parameters

Parameter	Type	Required	Description
TextChatID	numeric - ID code	Yes	The identifier of the text chat to get messages for.

Request format

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

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: 0 - Visitor stated the chat with an agent 1 - Operator initiated the chat (using auto invite) 2 - Operator invited the customer to chat (using custom invite) 3 - Operator was unavailable 4 - Auto-invited chat 5 - Blocked chat 6 - Recovery invite 7 - XMPP chat 8 - Chat started via API
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: 0 - Operator 1 - Visitor / Customer 2 - Email address 3 - Contact 4 - System 5 - Rescue system 6 - Auto message 7 - Operator translated 8 - Customer translated
RuleID	numeric - ID code	Identifier for an auto-invite or other rule.
Status	codes - set values	"Success" when the call completes; "Error" when the call fails.
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.
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.
Type	string	Field entry type for pre-chat survey fields: Email Phone Radio Rating Select Text

Sample code

{
    "Status": "success",
    "Truncated": false,
    "Data": [
        {
            "TextChatMessageID": "4845673167395030464",
            "PersonType": 1,
            "PersonID": "3087219595505372173",
            "Name": "test elek",
            "Text": "okay now try again this",
            "TextChatID": "2326974666799838307",
            "Created": "2020-06-17T15:20:07.250Z",
            "Deleted": null,
            "AccountID": "2300000001",
            "CannedMessageID": null,
            "LastIncomingArrived": null,
            "Type": null,
            "ChatType": 3,
            "RuleID": null,
            "JsonData": null
        },
        {
            "TextChatMessageID": "2264076387945949468",
            "PersonType": 0,
            "PersonID": "1880569197409634",
            "Name": "Bot",
            "Text": "Sorry, could not understand that...",
            "TextChatID": "2326974666799838307",
            "Created": "2020-06-17T15:20:07.260Z",
            "Deleted": null,
            "AccountID": "2300000001",
            "CannedMessageID": null,
            "LastIncomingArrived": "2020-06-17T15:20:07.000Z",
            "Type": null,
            "ChatType": 3,
            "RuleID": null,
            "JsonData": null
        }
    ]
}