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.
This API applies to the following products:
- Bring Your Own Channel for Contact Center as a Service
- Bring Your Own Channel for Messaging
This API is available in version 61.0 and later.
v1/interactions
POST
Format: Bearer <Salesforce Access Token>
String. Standard header. Used to authenticate the user, where <Salesforce Access Token> is the Salesforce access token used as the bearer token to make requests to the Interaction Service APIs. Required.
Format: multipart/form-data
String. Standard header. Format of the request payload. Required for any request that includes a body.
Format: <Salesforce Org ID>
String. Custom header. The Salesforce org. <Salesforce Org ID> is the 15-character Org ID of the Salesforce org. Required.
Format: <UUID>
String. Custom header. Universally Unique Identifier (<UUID>) that references and tracks this request. Required.
Format: <AuthorizationContext>
String. Custom header. Additional information for the request authorization used to authenticate and validate requests against the connected app scopes.
- For Bring Your Own Channel for CCaaS, set
<AuthorizationContext>to the developer name of the ConversationChannelDefinition record. For example, Partner1_ChannelDefinition1. Required. - For Bring Your Own Channel for Messaging, set
<AuthorizationContext>to the developer name of the ConversationChannelDefinition record. For example, Partner1_ChannelDefinition1. Required. - don’t set this header.
| 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