You can configure Outbound Webhooks to receive a copy of submission notifications for Apple Messages and for a copy of incoming Apple Messages/Events by navigating to 'Assets -> Integrations -> Outbound Webhooks' sections in the platform.
Outbound Webhook configuration for tracking message status
If you want to track message submission status, select the Webex Connect Service you are sending the Apple messages from under 'Entity' dropdown.
Please note Apple Messages for Business doesn't offer deliver receipts for message delivery, read, or click events. Hence, the DRs are limited to confirmed successful submission of message from Webex Connect to Apple Messages for Business platform.
{
"deliveryInfoNotification": {
"subtid": "85c4aea8-66f0-4bcc-8045-c443f7d1a178",
"deliveryInfo": {
"deliveryChannel": "applebusinesschat",
"Description": "Submitted",
"destinationType": "applebusinesschat",
"timeStamp": "2019-03-03T06:52:59.311Z",
"code": "7501",
"additionalInfo": "",
"deliveryStatus": "Submitted",
"destination": "urn:mbid:AQAAY45PVG4jg/ni/q6rWSYuu9d7Ga6K22bxp0iUmPkdOwxr3yAbisjOmtYFzw6LjDqhABFFHD/nFz6S2U5rBEcSqO7Eg0B5ikXukFD/x+6hPeOuR0Bvb3JDbU24DLlT/E5Yj9aBzFVASwfwStWnuGMX/+FXmAs="
},
"correlationid": "",
"callbackData": "",
"transid": "00dff89a-4feb-cc3c-8742-3847933492bb"
}
}
Field Name | Description |
|---|---|
subtid | A unique transaction id will be generated as subtid for the flow level transactions(or node tid) |
deliveryChannel | Channel used to send the message i.e., Apple Messages for Business in this case. |
Description | Detailed description of the delivery status |
destinationType | This is always applebusinesschat for Apple Messages for Business. |
timeStamp: | Timestamp of the event. The timestamp mentioned in the outbound webhook is as per the timezone of the tenant and not UTC as a standard. |
code | Status code as mentioned in the documentation |
additionalInfo | |
deliveryStatus | Status of messages once sent |
correlationid | The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request. |
callbackData | Data that you have configured to receive on the notify Url. This is configured as a part of the request |
transid | Unique transaction reference id of the request |
Outbound Webhook configuration for tracking incoming messages and events
If you want to track incoming messages or responses, select the Apple Messages for Business asset you are sending and receiving the Apple messages from under 'Entity' dropdown.
{
"abcUserId": "urn:mbid:SAMPLeFy8He+XuETx+Z52eprTnbIwCPwO/vlXMYKQuJNKJy7SefjtHMetEmlg9jA18Bg5tjdng92D7xHLPyw56R5XCl8fdIjRxtkPkeC7nt6h7aB3kgIOO1FFOpbVHpIHilAxN0R5NkyLFNKku4mb2O4AncxU30=",
"channel": "AppleBusinessChat",
"abcAccountId": "00f67e37-e26a-47c7-8f1b-a73608a976cf",
"appId": "a_637818908588360000",
"event": "MO",
"ts": "2022-07-26T19:56:51.809+01:00",
"tid": "d38ba2f4-f81a-5079-37f5-882ddb350ce0",
"message": "Hey",
"attachments": "",
"locale": "en_IN",
"bizGroupId": "",
"bizIntentId": "",
"requestIdentifier": "",
"timestamp": "",
"capabilities": "",
"deviceAgent": "",
"capabilityList": "AUTH%2CLIST%2CTIME%2CQUICK"
}
{
"abcUserId": "urn:mbid:AQAAY+muaCxppiRFbNZFEiuJAGjZM9I6qRiQqkXVB2gPRPev57AgWIpx431qaDe/JajE2gtnC861/rnOaYWwHUDv7s/lEjgaXYQw0WINUOeouvEY9xOoRqdIwD1c+PkU/8JsPtlLSZupUty4vjT/LYXhya/nyPM=",
"channel": "AppleBusinessChat",
"abcAccountId": "137f8c97-8e00-459c-ad8f-56051e485e35",
"appId": "a_636779515721130000",
"event": "MO",
"ts": "2018-11-17T12:23:08.407Z",
"tid": "f18b67ec-1b11-a485-5237-7e56619b1fe1",
"message": "\ufffc",
"attachments": "[{\"size\":\"148861\",\"name\":\"5E57E087-5C6B-4FD2-8B06-03F0BB17D188.jpeg\",\"mimeType\":\"image/jpeg\",\"type\":\"image\",\"url\":\"https://s3.amazonaws.com/appleattachment/5E57E087-5C6B-4FD2-8B06-03F0BB17D188.jpeg\"}]",
"locale": "en_IN",
"bizGroupId": "",
"bizIntentId": "",
"requestIdentifier": "",
"timestamp": "",
"capabilities": "",
"deviceAgent": "",
"capabilityList": "AUTH%2CLIST%2CTIME%2CQUICK"
}
{
"abcUserId": "urn:mbid:AQAAY+muaCxppiRFbNZFEiuJAGjZM9I6qRiQqkXVB2gPRPev57AgWIpx431qaDe/JajE2gtnC861/rnOaYWwHUDv7s/lEjgaXYQw0WINUOeouvEY9xOoRqdIwD1c+PkU/8JsPtlLSZupUty4vjT/LYXhya/nyPM=",
"channel": "AppleBusinessChat",
"abcAccountId": "137f8c97-8e00-459c-ad8f-56051e485e35",
"appId": "a_636779515721130000",
"event": "MO",
"ts": "2018-11-17T12:19:43.815Z",
"tid": "59493791-95b8-89f5-8b07-fd4f3163e3e4",
"message": "\ufffc",
"attachments": "[{\"size\":\"8588423\",\"name\":\"IMG_0028.mov\",\"mimeType\":\"video/quicktime\",\"type\":\"video\",\"url\":\"https://s3.amazonaws.com/appleattachment/IMG_0028.mov\"}]",
"locale": "en_IN",
"bizGroupId": "",
"bizIntentId": "",
"requestIdentifier": "",
"timestamp": "",
"capabilities": "",
"deviceAgent": "",
"capabilityList": "AUTH%2CLIST%2CTIME%2CQUICK"
}
{
"abcUserId": "urn:mbid:AQAAY+muaCxppiRFbNZFEiuJAGjZM9I6qRiQqkXVB2gPRPev57AgWIpx431qaDe/JajE2gtnC861/rnOaYWwHUDv7s/lEjgaXYQw0WINUOeouvEY9xOoRqdIwD1c+PkU/8JsPtlLSZupUty4vjT/LYXhya/nyPM=",
"channel": "AppleBusinessChat",
"abcAccountId": "137f8c97-8e00-459c-ad8f-56051e485e35",
"appId": "a_636779515721130000",
"event": "INTERACTIVERESPONSE",
"ts": "2018-11-17T12:40:27.185Z",
"tid": "ce7524f7-bbea-8bf7-15d1-4247c5cb785a",
"message": "",
"attachments": "[{\"size\":\"27344\",\"name\":\"jpeg-image-8iEic2.jpeg\",\"mimeType\":\"image/jpeg\",\"type\":\"image\",\"url\":\"https://s3.amazonaws.com/appleattachment/jpeg-image-8iEic2.jpeg\"}]",
"datePicker": "",
"listPicker": "{\"otherItemCount\":2,\"selectedItemCount\":1,\"otherItems\":[{\"identifier\":\"1\",\"style\":\"default\",\"title\":\"iPhone 8\",\"url\":\"https://s3.amazonaws.com/appleattachment/f3dee919-4ebe-4a93-92e6-b4da8eab3a68.jpeg\",\"order\":\"1\"},{\"identifier\":\"2\",\"style\":\"default\",\"title\":\"iPhone SE\",\"url\":\"https://s3.amazonaws.com/appleattachment/06ade50d-5195-4e0a-88c7-315130ba6703.jpeg\",\"order\":\"2\"}],\"selectedItems\":[{\"identifier\":\"0\",\"style\":\"default\",\"title\":\"iPhone X\",\"url\":\"https://s3.amazonaws.com/appleattachment/3566bd31-d031-4bfe-9d1d-36b4b2c3d646.jpeg\",\"order\":\"0\"}]}",
"locale": "",
"bizGroupId": "",
"bizIntentId": "",
"requestIdentifier": "21d4a1c4-327c-ba35-45b1-36a050b15ad2",
"timezone": "",
"capabilities": "",
"deviceAgent": "",
"capabilityList": "AUTH%2CLIST%2CTIME%2CQUICK"
}
{
"abcUserId": "urn:mbid:AQAAY+muaCxppiRFbNZFEiuJAGjZM9I6qRiQqkXVB2gPRPev57AgWIpx431qaDe/JajE2gtnC861/rnOaYWwHUDv7s/lEjgaXYQw0WINUOeouvEY9xOoRqdIwD1c+PkU/8JsPtlLSZupUty4vjT/LYXhya/nyPM=",
"channel": "AppleBusinessChat",
"abcAccountId": "137f8c97-8e00-459c-ad8f-56051e485e35",
"appId": "a_636779515721130000",
"event": "INTERACTIVERESPONSE",
"ts": "2018-11-17T12:49:56.989Z",
"tid": "0d2f7154-87ac-44cf-5927-156bb2ade6e3",
"message": "",
"attachments": "",
"datePicker": "{\"identifier\":\"fd296699-6ad1-4c96-af78-ae10dee1f19c\",\"timezoneOffset\":\"-100\",\"location\":{},\"title\":\"NHS Appointments\",\"timeslots\":[{\"duration\":\"1800\",\"identifier\":\"0\",\"startTime\":\"2019-01-18T15:30+0000\"}]}",
"listPicker": "",
"locale": "",
"bizGroupId": "",
"bizIntentId": "",
"requestIdentifier": "b0291fd1-d2ac-4109-bd53-9258d6748619",
"timezone": "",
"capabilities": "",
"deviceAgent": "",
"capabilityList": "AUTH%2CLIST%2CTIME%2CQUICK"
}
{
"abcUserId": "urn:mbid:AQAAYw0Y67QGE2NeYq9uX3t+UeD3B07eJDj86A/uU/XrcUiI6MNNF0VFr0iEsBjZGZLFY8sxy3Ia4FgBwguB7rja8tFvvYIJuvDzbFwDl3TIERGzlpN1sxk3rgbPSVyyzgODUIWc924JOO6WSDiFkzz8WHHoxwg=",
"channel": "AppleBusinessChat",
"abcAccountId": "3364d419-4b4a-4f59-a767-ac7e60214baa",
"appId": "a_636893638318070000",
"event": "QuickReplyResponse",
"ts": "2021-12-13T11:46:51.926+05:30",
"tid": "9df83f75-20f9-1cb3-cba7-4f38e134d2d4",
"locale": "en_IN",
"bizGroupId": "",
"bizIntentId": "",
"requestIdentifier": "[email protected]",
"timezone": "",
"capabilities": "AUTH%2C1.01",
"deviceAgent": "iPhone+OS",
"quickreplies": "{"selectedIdentifier":"nmdsf345knjkjkjfsdkjf esnjkj324j24kj234nm kjdsfdsjfkjdsfkjdskfdskn","items":[{"identifier":"b123","title":"No"},{"identifier":"c123","title":"YesNo"},{"identifier":"nmdsf345knjkjkjfsdkjf esnjkj324j24kj234nm kjdsfdsjfkjdsfkjdskfdskn","title":"3rd option"},{"identifier":"123213","title":"4th option 345kjkmkjdslkjfdf fkdsfdsf"},{"identifier":"a1234","title":"Yes"}],"selectedIndex":2}",
"capabilityList": "AUTH%2CLIST%2CTIME%2CQUICK"
}
{
"abcUserId": "urn:mbid:AQAAY70GM+x7gX8NkVOGzgGSqRnQW0YSGkrOV0c6vrKx6iI3nWFDEoxmy80TGcz7ve5/OE7siVVphKDlO+jfNXW2yCDpnGOaryVCkiW+Y8zMM0TxsJUVC92vvgbSULMIc6XqviL7BrVmSa8Oc5XySIFAsbeOLrI=",
"channel": "AppleBusinessChat",
"abcAccountId": "5564aa28-66b0-4c39-bc1c-795867da2241",
"appId": "a_637438705447650000",
"event": "AuthenticationResponse",
"ts": "2022-12-07T22:31:15.402+05:30",
"tid": "4f6d32ba-e0ce-6766-253e-2670f9ae571f",
"authenticateStatus": "authenticated",
"authenticateToken": "AQVs-Z2u2TudcFeIPJSiXiqyIGBefBS-4rkHgaGj-1IRxfatFKWGj0gmrXKYZ1wZcdbDtKA8NJzjYQsZKxPvscD1rqhyQeMHvQkqIz_Nr_jr7-Ypwrh3f163EE-RsKH5JKg-HBtlmNMDk9_MwoKn4RTA0TNAHXCRwFdXMIMQktvBkR4EjgfcifWtlItfLYp60MTFW-Sd4duzrFB-vYPxhDHMxbECtH2jM26XQ2IIMud6uwsS9NcbZ7avGRkfsB2lIZvly3TPC3DhOVx8y808vdWTzi0eS1OPKA8SJM8pHkCezXZbk201t2oH2uoSzooPMVwOG_azBuKTkhJcQzmkEn4j6J3L5g",
"requestIdentifier": "abcd4343",
"capabilities": "",
"timezone": "2022-12-07T22:31:15.402+05:30",
"deviceAgent": "",
"capabilityList": "AUTH%2CLIST%2CTIME%2CFORM%2CQUICK%2CAUTH2"
}
Field Name | Description |
|---|---|
abcUserId | Contains the unique Apple Messages for Business user ID |
channel | Channel is AppleBusinessChat always for incoming chats on Apple Messages for Business |
abcAccountId | Contains the unique Apple Messages for Business account ID |
appId | Contains the application ID |
ts | Timestamp when MO received to connect |
tid | Transaction ID |
message | Contains the text message sent by the user |
attachments | Contains the attachments sent by the user |
locale | Contains the geographical location of the user |
bizGroupId | Contains the business group ID |
bizIntentId | The intention, or purpose, of the chat as specified by the business, such as account_question. |
requestIdentifier | Applicable for responses to interactive message types such as Quick Replies. It can be used to correlate user response to a previously sent interactive message. |
timestamp | Timestamp when MO received to connect. This is an old field. This info is now available in the 'ts' field. |
capabilities | This field has been deprecated by Apple Messages for Business in March 2022 and no longer contains any value. Refer to capabilityList field instead. |
deviceAgent | This field has been deprecated by Apple Messages for Business in March 2022 and no longer contains any value. |
capabilityList | A string list that identifies Messages for Business features supported by the customer’s device. The list items are case insensitive and separated by commas. When a customer sends a message, this field allows you to understand the customer device capabilities to compose an appropriate response for that device. Sample values are:
Refer this link for full list. Apple Pay, Rich Links are supported on all devices type and version. |