getDiscussionMessages

Retrieves discussions messages across the account based on the Created date.

Input parameters

Parameter Type Version Required Description
DiscussionID long All yes The identifier of the discussion to retrieve data from
PageStart integer All no The number of elements to skip in the result set.
PageSize integer All 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
Data json array All A JSON array of JSON objects with the mappings of fields to values
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 All 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.
DiscussionMessageID long All Unique identifier of the discussion message.
ItemType byte All Type of the item as described in FolderType (ItemType).
OperatorID long All Internal ID of the agent who was last assigned to a chat record.
OperatorType byte All Type of the Operator who sent the message.
DiscussionMessage string All Content of the message sent. System messages begin with a hashmark.
MessageType byte All Signals whether the message was a user message or a system message.
Created date All Date and time when the chat message was created by clicking the Chat button, or by sending an invite.
Updated date All Date and time when the record was most recently updated.

Additional information

Maximum page size: 3000 records

Sample code

{
    "Status": "success",
    "Truncated": false,
    "Data": [
        {
            "DiscussionMessageID": "2528473398527078",
            "ItemType": 5,
            "OperatorID": "3045730147295814594",
            "OperatorType": 0,
            "DiscussionMessage": "#initiated",
            "MessageType": 1,
            "Created": "2020-03-31T08:21:30.083Z",
            "Updated": "2020-03-31T08:21:30.083Z"
        },
        {
            "DiscussionMessageID": "2528472680711494",
            "ItemType": 5,
            "OperatorID": "3045730147295814594",
            "OperatorType": 0,
            "DiscussionMessage": "<p>Hi there</p>",
            "MessageType": 0,
            "Created": "2020-03-31T08:21:30.340Z",
            "Updated": "2020-03-31T08:21:30.340Z"
        },
        {
            "DiscussionMessageID": "2528473485677603",
            "ItemType": 5,
            "OperatorID": "2235129457845087924",
            "OperatorType": 1,
            "DiscussionMessage": "#accepted",
            "MessageType": 1,
            "Created": "2020-03-31T08:21:33.523Z",
            "Updated": "2020-03-31T08:21:33.523Z"
        },
        {
            "DiscussionMessageID": "2528607214621909",
            "ItemType": 5,
            "OperatorID": "2235129457845087924",
            "OperatorType": 1,
            "DiscussionMessage": "#ended",
            "MessageType": 1,
            "Created": "2020-03-31T12:05:31.727Z",
            "Updated": "2020-03-31T12:05:31.727Z"
        }
    ]
}