Message Delivery Failed Interaction
Notifies Salesforce when an inbound message interaction event fails.
Whenever an inbound interaction event fails, the response payload returns a “success” : “false” value. If the event is a Message or FileAttachment interaction, the response payload also includes an error code and message. If the event is a TypingStartedIndicator or TypingStoppedIndicator interaction, the response payload includes an ID.
This API doesn’t process the failures. Instead, Salesforce tracks the failures, which you can ignore or use to send your own delivery failed notifications.
v1/interactions
POST
Authorization: Bearer <Salesforce access token>
String. Standard header. The authorization token, where \<token\> is the JSON Web Token (JWT). Required.
Content-Type: <Request body format>
String. Standard header. The format of the request body. Valid format is multipart/form-data. Required.
OrgId: <Salesforce Org Id>
String. Standard header. The 15-character Org ID of the Salesforce org. Required.
AuthorizationContext: <ConversationChannel Definition developer name>
String. Standard header. The ConversationChannelDefinition developer name in the format {prefix}_{ConversationChannelDefinitionName}. The prefix must match the developer name prefix of the corresponding connected app. For example, Partner1_ChannelDefinition1. Required.
RequestId: <GUID>
String. Standard header. A globally unique ID (GUID). Required.
For example,
| Property Name | Type | Description | Required |
|---|---|---|---|
| to | string | The channel address identifier. This is the globally unique ID for the conversation channel (MessagingChannel.ChannelAddressIdentifier). | Yes |
| from | string | The end user client identifier. This value comes from the partner system and can be up to 240 characters long. | Yes |
| interactions | array | A list of interactions that are initiated by a messaging or voice rep or end user. | Yes |
| interactions.timestamp | boolean | The date and time when the interaction was received by the Salesforce server. | Yes |
| interactions.interactionType | string | The type of interaction. Possible values include: - EntryInteraction to represent the type of interaction, such as an inbound message, a message sent failure, or a typing start or stop indicator. - AttachmentInteraction to represent a file attachment that comes within the inbound messaging request. | Yes |
| interactions.payload | array | The interaction payload. | Yes |
| interactions.payload.id | string | The unique ID for the interaction. | Yes |
| interaction.payload.entryType | string | The conversation entry type. Valid values are: - Message–When a conversation participant sends a message. - TypingStartedIndicator–When a conversation participant starts typing. - TypingStoppedIndicator–When a conversation participant stops typing. - MessageDeliveryFailed–When a message fails to send. | Yes |
| interaction.payload.failedConversationEntryIdentifier | string | The unique ID for the conversation entry that’s associated with the failed delivery. | Yes |
| interaction.payload.recipient | object | A description of the recipient in the conversation. The subject represents the end user client identifier. The role represents the participant type and must be set to EndUser. The appType represents the type of app used by the conversation and must be set to custom. | Yes |
| interaction.payload.errorCode | object | The Salesforce error code that’s associated with the failure reason. | Yes |
- GitHub: Interaction Service APIs
- GitHub: Interaction Service API Error Codes