Object

BaseInteractiveMessage

The Interactive Data dictionary keys common to all interactive messages.

Properties

bid
string
(Required)

A string identifying the iMessage extension that the customer interacts with while using Messages. The bid value format is:

com.apple.messages.MSMessageExtensionBalloonPlugin:team-id:extension-id

When using your custom interactive message, replace team-id and extension-id with your team and extension IDs. When using a Business Chat interactive message, set team-id to 0000000000 and the extension-id to com.apple.icloud.apps.messages.business.extension. For example:

com.apple.messages.MSMessageExtensionBalloonPlugin:0000000000:com.apple.icloud.apps.messages.business.extension

receivedMessage
(Required)

A dictionary with information telling the Messages app how and what content to display the received message bubble.

replyMessage
(Required)

A dictionary with information telling the Messages app how and what to display in the reply message bubble.

Discussion

Messages of type interactive should include the interactiveData dictionary. This dictionary tells the Messages app which iMessage extension to use and provides the data to pass into the extension. It also provides settings that control the visual appearance of the interactive message.

See Also

Interactive Message Dictionaries

object InteractiveResponse

The response body is a JSON dictionary of the decoded interactive message data dictionary. The dictionary keys are listed below.

object InteractiveMessageData

The keys for the InteractiveMessageData dictionary can be used for all interactive messages.

object ImageItem

The keys to the image item dictionary used in sending interactive messages.

object InteractiveMessageResponse

A list of dictionaries contained in the feature's response.

object ReceivedMessage

The keys for the received message dictionary.

object ReplyMessage

A dictionary with information telling Messages how and what to display in the reply message bubble.