getAllChatMessages

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	Version	Description
Truncated	boolean	All	Whether or not the above JSON array is the complete result set, or if the server limited the returned results.
Next	json object	v1	If the method called supports it, and the data is truncated, the Next parameter will contain the necessary parameters to pass back to the same server method to get more results.
SystemMessage	string	All	Textual content of system messages displayed; The value is `null` when there is no system message displayed.
ChatMessageID	long	All	Unique identifier of a single chat message within the chat transcript.
PersonType	byte	All	The persona of the user who sent the chat message: 0 - Agent/Operator 1 - Visitor 2 - Email Address 3 - Contact 4 - System 5 - Rescue System 6 - Auto Message
Name	string(30)	All	Typed name of the person who sent the chat message.
Created	date	All	Date and time when the chat message was created by clicking the Chat button, or by sending an invite.
LanguageCode	string(8)	All	The language of the chat, based on two-letter ISO 639-1 standard.
PersonID	long	All	The unique ID of the PersonType who sent the chat message.
Hidden	byte	All	Date and time when the chat message was hidden; The value is `null` if the chat message was not hidden.
Deleted	date	All	Date and time when the record was deleted. The value is `null` if the record was not deleted.
OriginalMessageID	long	All	ID of the original content provided within a chat message prior to being translated. The value is `null` if the chat message was not translated.
AccountID	long	All	Unique account ID (AID) that a chat record was created within.
CannedMessageID	long	All	The Internal ID of Canned Message configuration item used to deliver the chat message. The value is `null` when if the Canned Message was not used.
VisitorFacing	byte	All	Indicates if the chat message was included in the customer-facing chat transcript; The value is `null` if the message was sent by a non-human PersonType.
Text	string	All	Content of the message.
ChatID	long	All	Bold360-assigned unique identifier for each chat session.
MessageKey	string	All
HasAutoTranslationError	byte	All	Indicates whether there is an error in the Geofluent translation of a chat message. The value is `null` when there is no error present.

Additional information

Maximum page size: 500 records

Sample code

"Truncated": true,
    "Data": [
        {
            "SystemMessage": null,
            "AccountID": "627499986405274345",
            "CannedMessageID": "1792142004296032200",
            "ChatMessageID": "3216359571328669457",
            "VisitorFacing": null,
            "PersonType": 0,
            "Text": "<font size=\"2\" face=\"Verdana\"></font><font size=\"7\" face=\"Arial Black\">We will speak in english</font>",
            "Name": "This Is My Operator Name",
            "ChatID": "623452251678712606",
            "Created": "2019-04-17T17:31:26.247Z",
            "LanguageCode": "en-US",
            "MessageKey": null,
            "PersonID": "5676748830204723022",
            "Hidden": null,
            "HasAutoTranslationError": null,
            "Deleted": null,
            "OriginalMessageID": null
        },