Object

CustomInteractiveData

The CustomInteractiveData dictionary keys.

Properties

appIcon
byte
(Required)

A Base64-encoded string representing the app icon of the iMessage extension. The Messages app displays the icon when a customer's device receives a custom interactive message that uses an iMessage extension not installed on the device. The MSP platform must include this key when sending an interactive message that uses an iMessage extension provided by the business. Don’t include this key when sending an interactive message that uses a Business Chat iMessage extension. For more information, see Sending Custom iMessage Extensions.

appId
string
(Required)

The App Store identifier of the iMessage extension. The MSP platform must include this key when sending an interactive message that uses an iMessage extension provided by the business. Don’t include this key when sending an interactive message that uses a Business Chat iMessage extension. For more information, see Sending Custom iMessage Extensions.

appName
string
(Required)

The name of the iMessage extension. The MSP platform must include this key when sending an interactive message that uses an iMessage extension provided by the business. Don’t include this key when sending an interactive message that uses a Business Chat iMessage extension. For more information, see Sending Custom iMessage Extensions.

(Required)

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

(Required)

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

URL
string
(Required)

A URL string containing data that the Messages app sends to the iMessage extension.

useLiveLayout
boolean
(Required)

A Boolean that determines whether the Messages app should use Live Layout. The default is true.

Discussion

In addition to the keys from the BaseInteractiveMessage dictionary, the message can also include the keys from the CustomInteractiveData dictionary.

Relationships

See Also

Custom Interactive Dictionaries

object CustomInteractiveMessage

A channel to an iMessage extension.

object CustomInteractiveData.ReceivedMessage

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

object CustomInteractiveData.ReplyMessage

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