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 |
---|---|---|---|---|
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.