This method retrieves a list of conversations that the consumer participated in.
Request
| Method | URL |
|---|---|
| POST | https://{domain}/messaging_history/api/account/{accountID}/conversations/consumer/search |
URL parameters
| Name | Description | Type/Value | Required | Notes |
|---|---|---|---|---|
| offset | The offset specifies from which record to retrieve the chat | numeric | Optional | Default is 0. Example: Of 100 records, the first 20 have already been retrieved. Thus, in the next request will be specified with offset 21. |
| limit | Max amount of conversations to be received in the response | numeric | Optional | Default is 50. Max value is 100. The remaining conversations can be obtained using pagination (using offset, in a subsequent request). |
| source | Used to describe the originator of the call. The source name should be unique for every project or process within the organization | String | Required | The source name should not exceed 20 characters. Please follow the format of ProjectName+AppName+UseCase. Example: LP_AgentUI_History |
BODY/POST parameters
Filter is sent in the POST data (body) with the following JSON structure.
| Name | Description | Type/Value | Required | Notes |
|---|---|---|---|---|
| consumer | ID of the consumer to search. | string | Required | the consumerId is the same as the participantId in the consumerParticipants section (it is an LivePerson-unique identification of the consumer) |
| status | Latest status of the conversation | Array | Required | Valid values: "OPEN", " or "CLOSE" |
| contentToRetrieve | List of content types that should be retrieved | alphanumeric | Optional | Valid values: campaign, messageRecords, agentParticipants, agentParticipantsLeave, agentParticipantsActive, consumerParticipants, transfers, interactions, messageScores, messageStatuses, conversationSurveys, coBrowseSessions, summary, sdes, unAuthSdes, monitoring, responseTime |
Response
See Response in the Conversations method.