App Extension Call
- 05 Jun 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
App Extension Call
- Updated on 05 Jun 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
With App Extension Call, you can call a function/window from the iOS application, to expand Apple Messages for Business capabilities.
For more information on App Extension Call, go to the official documentation of Apple Messages for Business: iMessage App.
Example
Below, you can see the appExtensionCall task reference in the Attachments State Diagram.
{
"abc": {
"type": "app_extension_call",
"interactiveData": {
"appId": 123456789,
"appName": "Package Delivery",
"URL": "?name=WWDC%20Goodies&deliveryDate=09-06-2017&destinationName=Moscone%20Convention%20Center&street=747%20Howard%20St&state=CA&city=San%20Fransisco&country=USA&postalCode=94103&latitude=37%2E7831&longitude=%2D122%2E4041&extraCharge=15%2E00",
"bid": "com.apple.messages.MSMessageExtensionBalloonPlugin:WRS8W2ZKCT:com.example.apple-samplecode.PackageDeliveryWRS8W2ZKCT.MessagesExtension",
"sessionIdentifier": "{{uuid}}",
"receivedMessage": {
"title": "WWDC Goodies",
"subtitle": "Scheduled for delivery - Today",
"secondarySubtitle": "",
"tertiarySubtitle": "",
"imageTitle": "",
"imageSubtitle": ""
},
"useLiveLayout": true
},
"attachments": []
}
}
Parameters
Parameter | Type | Required | Description |
---|---|---|---|
type | string | + | A type of an object to send. |
interactiveData | object | + | An object in which an interactive message is described. |
interactiveData.appId | string | + | An iMessage extension ID from App Store. |
interactiveData.appName | string | + | An iMessage extension name. |
interactiveData.URL | string | + | A deep link that is used by the customer to call an iMessage extension. |
interactiveData.bid | string | + | An iMessage extension ID. |
interactiveData.sessionIdentifier | string | + | A background session ID. |
receivedMessage.title | object | + | An object in where is described how to display a message upon receiving. |
receivedMessage.title | string | + | An item’s title. |
receivedMessage.subtitle | string | An item subtitle. | |
receivedMessage.imageTitle | string | An attached image name . | |
receivedMessage.imageSubtitle | string | An attached image subtitle. | |
interactiveData.useLiveLayout | boolean | + | A parameter that determines whether iMessage application should use Live Layout. The default value is "true". |
Was this article helpful?