Conversation Entries

Get and update conversation entries.

The Conversation Entries resource is designed to retrieve individual conversations or small batches of transcripts, not for bulk data export or large-scale data analysis. This API has a different hourly rate limit than standard Salesforce APIs and bulk usage will likely cause you to hit that limit quickly. Each API call marks the conversation as active, counting against your org’s concurrent active session limit. Exceeding this limit can result in errors or dropped messages. For better options to export or analyze conversation data, see Accessing Messaging and Voice Conversation Data.

Note

Resource
1/connect/conversation/conversationIdentifier/entries
Available version
51.0
HTTP methods
GET, PATCH
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
endTimestamp Long End timestamp, in milliseconds, for the conversation. For example, 1600788018. Optional 51.0
queryDirection String Direction of the query. Values are:
  • FromEnd
  • FromStart
If unspecified, the default is FromEnd.
Optional 51.0
recordLimit Integer Maximum number of entries to return. Valid values are from 1 to 1000. If unspecified, the default is 25. Optional 51.0
startTimestamp Long Start timestamp, in milliseconds, for the conversation. If unspecified, the default is 0. Optional 51.0
Response body for GET
Conversation Entries
Request body for PATCH
JSON example
1{
2  "conversationEntriesUpdates": [
3    {
4      "identifier": "36b0f4d9-7c14-43dc-bb9e-7713a4930df0",
5      "messageText": "The credit card I used was xxxx-xxxx-xxxx-4321."
6    },
7    {
8      "identifier": "46b0f5d9-7c14-43dc-bb9e-b713a4930df1",
9      "messageText": "My ssn is: XXXXX."
10    }
11  ]
12}
Properties
Name Type Description Required or Optional Available Version
conversation​Entries​Updates Conversation Entry Update Input[] List of conversation entry updates. Required 51.0
Response body for PATCH
Conversation Entries Update