Actions Developer Guide

Introducing Actions
Action Objects
Apex Actions
Assign Enablement Program
Apply Case Classification Recommendations
B2B Commerce Checkout Flow Actions
Commerce Checkout Flow Actions
Create Service Report Actions
Custom Notification Actions
Email Alert Actions
Flow Actions
Generate Order Summary Action
Generate Work Orders Actions
Get Assessment Response Summary
Knowledge Actions
Lead Action
Live Message Notification Actions
Omni-Channel Action
Apply Payment Action
Payment Sale Action
PlatformAction
Post to Chatter Actions
Perform Survey Sentiment Analysis
Quick Actions
Refresh Metric Actions
Sales Engagement Actions
Salesforce Omnichannel Inventory Actions
Salesforce Order Management Actions
Send Conversation Messages Actions
Send Notification Actions
Session-Based Permission Set Actions
Simple Email Actions
Submit for Approval Actions
Survey Invitation Actions
Work Plan and Work Step Actions
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Send Conversation Messages Actions

Send a messaging component to users in enhanced WhatsApp, enhanced Apple Messages for Business, or Messaging for In-App channels when the targeted channel has bandwidth. Each Send Conversation Messages action corresponds to a supported messaging component.

This object is available in API version 59.0 and later.

On invocation, this action inserts and enqueues a message for handling the request and sending out the messages async. The request record can be used to track the progress.

Typical use cases include:

  • Confirmation of a purchase or booking
  • Shipping or delivery updates
  • Password reset requests
  • Account verification messages
  • Payment reminders
  • Abandoned cart reminders

Supported REST HTTP Methods

URI
/services/data/v59.0/actions/standard/sendConversationMessages
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
messageDefinitionName
Type
string
Description
The API name of a ConversationMessageDefinition record that's used to render the messages.
messagingDefinitionInputParameters
Type
list
Description
Optional. A collection of Apex richmessaging__MessageDefinitionInputParameter records that contain messaging component details to use when rendering messages.
requestType
Type
string
Description
Specifies the type of the request. Valid values are: SendNotificationMessages.
isEnforceMessagingChannelConsent
Type
boolean
Description
Indicates whether messaging consent must be verified after messages are queued for sending.
allowedSessionStatus
Type
string
Description
Limits the times when the message can be sent. Valid values are:
  • Any—Send the message whether or not the messaging user is engaged in a messaging session with the business.
  • NonActive—Send the message unless the messaging user is engaged in a messaging session with a status of Active. The message is sent after the session’s status changes.
  • Closed—Send the message unless the messaging user is engaged in a messaging session. The message is sent after the session is closed.
messagingEndUserIds
Type
list
Description
A collection of messaging end user record IDs to use as recipients of the messages.

Outputs

Input Details
requestId
Type
string
Description
The ID of the ConvMessageSendActionRequest record created by the request that's used to track the message progress.
messageIdentifiers
Type
list
Description
A collection of generated message UUIDs with one entry for each recipient specified in messagingUserIds.

Usage

Sample Input

The following sample input attempts to create a ConvMessageSendRequest record using a Messaging Component (messageDefinitionName), the request for the type of component being sent (requestType), the consent preferences (isEnforceMessagingChannelConsent), when the message can be sent (allowedSessionStatus), and the message recipients (messagingEndUserIds). Additionally, the request contains a list of custom parameters (messagingDefinitionInputParameters). These parameters are mapped to parameters configured in the messaging component, which may be optional. Applicable data types for parameters are textValue, recordIdValue, dateValue, dateTimeValue, numberValue, and booleanValue.

1{
2  "inputs": [{
3      "messageDefinitionName":"Notification",
4      "requestType":"SendNotificationMessages",
5      "isEnforceMessagingChannelConsent":true,
6      "allowedSessionStatus":"Any",
7      "messagingEndUserIds":"0PARM000000Lc3I,0PARM000000MZ3p",
8      "messagingDefinitionInputParameters":[{"name":"custom_parameter_name","textValue":"custom parameter value"}]
9  }]
10}
Sample Output

The following sample output illustrates a response after a successful request.

1[
2  {
3    "actionName":"sendConversationMessages",
4    "errors":null,
5    "isSuccess":true,
6    "outputValues":{
7 "messageIdentifiers":"c581098c-5db6-4ed8-915f-c9aaa016c671,d8e1990e-5d67-414c-9713-180107d7d1bb",
8"requestId":"1srM000000000p"
9    }
10  }
11]

For more information about this action, see Flow Core Actions: Send Conversation Messages and Send Automated Messages in Enhanced Messaging Channels in Salesforce Help.