Retrieve Conversation Entries
Retrieve messages from a conversation.
This API applies to the following product:
- Bring Your Own Bot (BYOB)
For authentication details, see Generate an Access Token.
v1/conversationEntry
GET
Format: Bearer <Salesforce Access Token>
String. Standard header. The authorization token, where <token> is the JSON Web Token (JWT). Required.
Format: application/json
String. Standard header. The format of the request body. Valid format is application/json. Required.
Format: <Salesforce Org ID>
String. Standard header. The 15-character Org ID of the Salesforce org. Required.
Format: <External Conversation Participant Integration Definition developer name>
String. Standard header. The ExtConvParticipantIntegDef developer name in the format {prefix}_{ExtConvParticipantIntegDef}. The prefix must match the developer name prefix of the corresponding ExternalClientApp. For example, Partnerapp_ExtConvParticipantIntegDef. Required.
Format: ExternalConversationParticipant
String. Standard header. Set this value to ExternalConversationParticipant. Required.
Format: <GUID>
String. Standard header. A globally unique ID (GUID). Required.
| Property Name | Type | Description | Required |
|---|---|---|---|
| conversationIdentifier | string | A unique identifier generated for the conversation. | Yes |
| startTime | timestamp | Specifies the starting time boundary for retrieving conversation entries. Must be greater than 0. If invalid, returns error code 10090. | Yes |
| endTime | timestamp | Specifies the ending time boundary for retrieving conversation entries. Must be greater than 0 and greater than startTime. If invalid, returns error code 10091. If omitted, queries up to the current time. | No |
| direction | string | Defines the order or direction in which conversation entries are retrieved. Valid values are FROM_START and FROM_END. | No |
| limit | number | Sets a maximum number of conversation entries to be returned in the API response. Valid range is 1–20; server maximum is 20. If invalid, returns error code 10092. | No |