The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Send Message Use Cases

These types are referred by the Send Message section.

Request Payload for Messages that contain URLs: The salesforce API parses the message to identify the presence of valid URLs that appear either at the start or end of a text message. Once the URLs are identified, it splits the actual message into multiple messages to render the URL with more information needed for URL previews. For example: A message “Please click on this link https://google.com” is divided into two different messages. The clients receive two different CONVERSATION_MESSAGE events from SSE.

  • A message containing the text “Please click on this link”
  • Another message which contains metadata information regarding the URLs, which can be used to generate previews

Refer to the payload for Rich Link Preview for more information.

Here is a sample request.

These are typically defined as Message with the selected choices as a response to a Choices message sent by BOT or agents for specific format types like carousels.

Here is a sample payload for the ChoicesResponseMessage. The optionIdentifier is the identifier pointing to the option selected by the end user.

See the ChoicesMessage section for more details around the payload for ChoicesMessage and the different supported format types, such as Buttons, Quick Replies and Carousel.

Message with a form containing multiple single or multi select choices that a recipient can select from.

Here is a sample request payload. The example shown below only covers inputTypeValue of SingleInputValue and value type of TextValue and DateTime. See the FormMessage section for the payload structure.

There are other inputValueType and Value Type combinations that are supported.