GuidesReferenceChangelogVideosDiscord
Sign UpLogin

Send Message to Conversation

The Send Message to Conversation Data Operation is used to send a message to a Conversation.

📘

Enterprise Feature

This Data Operation requires an ENTERPRISE license. If you would like to enable this feature for your Airkit Organization, please contact your Airkit representative or contact [email protected].

Use Cases

  • Thank users for their participation
  • Inform users of an update to their account
  • Send links to relevant Web Pages

Data Operation Properties

Conversation

Expects type Text. This text should correspond to the identifier that a Conversation got assigned upon being initialized; this identifier will be stored under channels.message.conversationId in the relevant Session.

This property defines the Conversation that the Send Message to Conversation Data Operation will send its message to.

Message

Expects type Text.

This is the message that the Send Message to Conversation Data Operation will send to to the Conversation.

Create conversation if needed

Expects type Boolean.

If this box is checked, the Send Message to Conversation Data Operation will create a new Conversation to send the message to if the Conversation property does not reference a Live Conversation.

The following properties are used to define new Conversations:

Resource ID

Expects a Conversation Hub Channel Resource.

Conversation Hub Channel Resource are configured under Settings > Conversations. These resources must be associated with a Conversation Hub in the Console before they can be configured inside an application.

External ID

Expects type Text.

This optional field is used to assign an external identifier that can be manually referenced downstream.

Customer Destination

Expects type Text or Phone.

The address of the external Chat source. If the Conversation will take place via a Chat Web Control, the Customer Destination will be the corresponding Session ID. If the Conversation will take place via SMS, the Customer Destination will be the corresponding phone number.

Customer Identifier

Expects type Text.

This optional field is used to assign the end user an identifier that can be manually referenced downstream.

Run Results

By default, Airkit stores the output of this Data Operation in an auto-created variable called messages that can then be passed into subsequent operations. The value of messages indicates whether or not the message was successfully sent to the designated Conversation.

📘

Messages can only be sent to Conversations occurring in deployment.

Unlike most Data Operations, the Send Message to Conversation Data Operation cannot be run without referring to a deployed application. Before you can test any instance of this Data Operation, it must be able to refer to a published Conversation Chat Bot. For more on how to publish a Conversation Chat Bot, see Configuring Conversation Chat Bots.