Apple Messages for Business Functions

Apple Messages for Business Features

In this part you will learn how to work with all Apple Messages for Business Functions:

1. List Picker Message
2. Image List Picker
3. Time Picker Message
4. Rich Link
5. Quick Reply
6. Form Message
7. Apple Pay
8. OAuth 2.0 Request
9. App Extension Call

List Picker Message

Allows to create a text list of items.
Can be used as a menu, list of products / services, etc.

The official documentation of Apple Messages for Business: List Picker

A List Picker Message Example

The task Reference in a State Diagram Attachments: textListPicker.

   {
       "abc": {    
           "type": "text_list_picker",
               "list_picker": {
                 "sections": [
                   {
                       "items": [
                             {
                               "identifier": "/textListPicker",
                               "order": 0,
                               "title": "📜 Text List Picker",
                               "subtitle": "",
                               "style": "small"
                           } 
                       ],
                       "order": 0,
                       "title": "⚙️ {{t'mainMenu}}",
                       "multipleSelection": false  
                   }
               ],
               "receivedMessage": {
                   "title": "⚙️ {{t'mainMenu}}",
                   "subtitle": "",
                   "style": "small"
               },
               "replyMessage": {
                   "title": "Ok",
                   "subtitle": "",
                   "style": "small"
               }
           }
       }
   }

List Picker Message parameters description

Adding an item to a List Picker Message

To expand a List Picker Message with a new item the following object needs to be added to the items[] array:

{
    "identifier": "2",
    "order": 2,
    "title": "Option 2" ,
    "subtitle": "Subtitle for option 2" ,
    "style": "small"
} 

Image List Picker

Allows to create a list of elements with text and images.
The official documentation of Apple Messages for Business: List Picker

An Image List Picker Example

The task Reference in a State Diagram Attachments: imageListPicker.

{
    "abc": {
        "type": "image_list_picker",
        "images": [
            {
                "identifier": "0",
                "url": "https://i5.walmartimages.com/asr/2b4a8c7c-941f-4575-b1fe-2479c8024077_1.b3c876a51211d14cbdd5fc631995809c.jpeg"
            },
            {
                "identifier": "1",
                "url": "https://i5.walmartimages.com/asr/d43233f6-920f-4b9d-9b97-80a31487901b_1.9ecb6491c6307ebd24e5426dfc9ee4e8.jpeg"

            }
        ],
        "list_picker": {
            "sections": [
                {
                    "items": [
                        {
                            "identifier": "1",
                            "imageIdentifier": "0",
                            "order": 0,
                            "title": "Gala Apples",
                            "subtitle": "Price: $1.57 / each",
                            "style": "default"
                        },
                        {
                            "identifier": "2",
                            "imageIdentifier": "1",
                            "order": 1,
                            "title": "Navel Oranges",
                            "subtitle": "Price: $0.68 / each",
                            "style": "default"
                        }
                    ],
                    "order": 0,
                    "title": "Fruit",
                    "multipleSelection": true
                }
            ],
            "receivedMessage": {
                "style": "small",
                "subtitle": "Farm fresh to you",
                "title": "✅ Select Produce"
            },
            "replyMessage": {
                "style": "small",
                "title": "✅ Selected Produce",
                "subtitle": "Selected Produce"
            }
        }
    }
}

Image List Picker parameters description

Adding an item to an Image List Picker

To expand Image List Picker, with a new item there’s need to be added the following objects to the arrays items[]and images[]:

"images": [
             {
                "identifier": "1",
                "url": "{{image URL}}"
            }
        ]

"items": [
        {
            "identifier": "1", 
            "imageIdentifier": "1", 
            "order": 0, 
            "title": "Gala Apples",
            "subtitle": "Price: $1.57 / each", 
            "style": "small" 
        } 
]

Time Picker Message

The date and time picker function allows to provide to your customers a convenient tool for scheduling an appointment, meeting or event.
The official documentation of Apple Messages for Business: Time Picker

A Time Picker Example

The task Reference in a State Diagram Attachments: timePicker.

{
    "abc": {
        "type": "time_picker",
        "time_picker": {
            "event": {
                "identifier": "1", 
                "location": { 
                    "latitude": 37.7725,
                    "longitude": -22.4311,
                    "radius": "2",
                    "title": "Building One"
                },
                "timeslots": [
                    {
                        "duration": 3600,
                        "identifier": "5",
                        "startTime": "2020-04-01T15:30+0000"
                    },
                    {
                        "duration": 3600,
                        "identifier": "7",
                        "startTime": "2020-04-02T08:30+0000"
                    },
                    {
                        "duration": 3600,
                        "identifier": "9",
                        "startTime": "2020-04-03T21:30+0000"
                    }
                ],
                "timezoneOffset": 0,
                "title": "Schedule an Appointment"
            },
            "receivedMessage": {
                "style": "icon",
                "title": "Please pick a time",
                "subtitle": "This should be 10:00am for -7h users"
            },
            "replyMessage": {
                "style": "icon",
                "title": "Thank you!"
            }
        }
    }
}

Time Picker parameters description

Adding an item to a Time Picker Message

To expand the date and time selection list - Time Picker Message with a new item, you need to add the following object to the timeslots array:

"timeslots": [
     {
             "duration": 3600, 
             "identifier": "1",
             "startTime": "2020-04-1T15:30+0000" 
        }
]

Rich Link

Allows to send messages with images and videos to clients.

The official documentation of Apple Messages for Business: Rich Link

A Rich Link Example

The task Reference in a State Diagram
Attachments: richLink.

{
    "abc": {   
        "type": "rich_link",
        "rich_link": {
            "richLinkData": {
                "url": "https://www.corezoid.com/",
                "title": "Welcome to Corezoid!",
                "assets": {
                    "image": {
                        "data": "<…code img in base64…>",
                        "mimeType": "image/png"
                    }
                }
            }
        }
     }
}

Rich Link parameters description

It’s possible to convert an image to base64 in the online converter, for example:

• https://www.base64-image.de/
• https://codebeautify.org/image-to-base64-converter

Quick Reply

Allows to display from two to five customizable choices, and the user can select only one item.
The official documentation of Apple Messages for Business: Quick Reply

A Quick Reply Message Example

The task Reference for Quick Reply in a State Diagram Attachments: quickReply:

   {
    "abc": {
        "type": "quick_reply",
        "quick_reply": {
            "summaryText": "{{t'key_from_local_1}}",
            "items": [
                {
                    "identifier": "yes",
                    "title": "{{t'key_from_local_2}}"
                },
                {
                    "identifier": "menu",
                    "title": "{{t'key_from_local_3}}"
                }
            ]
        }
    }
}

Quick Reply parameters description

Form Message

Form Messages allow you to create rich, multipage interactive flows for users on iOS and iPadOS devices using a single JSON payload.

The official documentation of Apple Form Messages: Form Messages

Form Message Example

The task Reference in the Attachments state diagram: abcForm.

   {
    "abc": {
        "type": "form",
        "interactiveData": {
            "bid": "com.apple.messages.MSMessageExtensionBalloonPlugin:0000000000:com.apple.icloud.apps.messages.business.extension",
            "data": {
                "version": "1.0",
                "requestIdentifier": "{{id}}",
                "dynamic": {
                    "version": "1.1",
                    "template": "form",
                    "data": {
                            "splash": {
                            "header": "Messages for Business Form Demo",
                            "splashtext": "Check out the types of pages available",
                            "buttonTitle": "Continue",
                            "imageIdentifier": "2"
                        },
                        "startPageIdentifier": "001",
                        "showSummary": true,
                        "pages": [
                              {
                                "pageIdentifier": "001",
                                "type": "select",
                                "title": "Please Choose One Selection To Move On To The Next Page",
                                "subtitle": "Single Select Page",
                                "multipleSelection": true,
                                "items": [
                                    {
                                        "title": "Single 1",
                                        "imageIdentifier": "2",
                                        "value": "option01",
                                        "identifier": "001_01",
                                        "nextPageIdentifier": "002"
                                    },
                                    {
                                        "title": "Single 2",
                                        "imageIdentifier": "2",
                                        "value": "option02",
                                        "identifier": "001_02",
                                        "nextPageIdentifier": "002"
                                    },
                                    {
                                        "title": "Single 3",
                                        "value": "option03",
                                        "imageIdentifier": "2",
                                        "identifier": "001_03",
                                        "nextPageIdentifier": "002"
                                    },
                                    {
                                        "title": "Single 4",
                                        "value": "option04",
                                        "imageIdentifier": "2",
                                        "identifier": "001_04",
                                        "nextPageIdentifier": "002"
                                    },
                                    {
                                        "title": "Single 5",
                                        "value": "option01",
                                        "imageIdentifier": "2",
                                        "identifier": "001_05",
                                        "nextPageIdentifier": "002"
                                    }
                                ]
                            },
                            
		{
                                "pageIdentifier": "002",
                                "title": "Select All That Apply",
                                "subtitle": "Multiple Selection",
                                "type": "select",
                                "multipleSelection": true,
                                "nextPageIdentifier": "003",
                                "items": [
                                    {
                                        "title": "Multi 1",
                                        "value": "multi1",
                                        "identifier": "002_01"
                                    },
                                    {
                                        "title": "Multi 2",
                                        "value": "multi2",
                                        "identifier": "002_02"
                                    },
                                    {
                                        "title": "Multi 3",
                                        "value": "multi3",
                                        "identifier": "002_03"
                                    },
                                    {
                                        "title": "Multi 4",
                                        "value": "multi4",
                                        "identifier": "002_04"
                                    },
                                    {
                                        "title": "Multi 5",
                                        "value": "multi5",
                                        "identifier": "002_05"
                                    }
                                ]
                            },
                            {
                                "pageIdentifier": "003",
                                "title": "Date Picker With Min/Max Date and Label Text",
                                "subtitle": "Date Picker",
                                "type": "datePicker",
                                "options": {
                                    "minimumDate": "01/01/1970",
                                    "maximumDate": "01/01/2050",
                                    "labelText": "Select Date:"
                                
		},
                                "nextPageIdentifier": "004"
                            },
                            {
                                "pageIdentifier": "004",
                                "title": "With Custom Label, Prefix, Regex and Placeholder Text",
                                "subtitle": "Numeric Input - Currency",
                                "type": "input",
                                "options": {
                                    "keyboardType": "decimalPad",
                                    "regex": "^\\d*\\.?\\d?\\d?$",
                                    "labelText": "Enter Amount:",
                                    "placeholder": "50.00",
                                    "prefixText": "$"
                                },
                                "nextPageIdentifier": "005"
                            },
                            {
                                "pageIdentifier": "005",
                                "title": "With Placeholder, Label and Expecting a Name",
                                "subtitle": "Text Input - Single Line",
                                "type": "input",
                                "nextPageIdentifier": "006",
                                "options": {
                                    "placeholder": "J. Appleseed",
                                    "labelText": "Name:",
                                    "textContentType": "name",
                                    "required": true
                                }
                            },
                            {
                                "pageIdentifier": "006",
                                "title": "Optional Additional Comment Field",
                                "subtitle": "Text Input - Multiple Lines",
                                "type": "input",
                                "submitForm": true,
                                "options": {
                                    "inputType": "multiline",
                                    "placeholder": "Add any additional details here"
                                }
                            }
                        ]
                    }
                },
                
	         "images": [
                    {
                        "identifier": "1",
                        "data": "{{imageBit}}"
                    },
                    {
                        "identifier": "2",
                        "data": "{{imageBit}}"
                    }
                ]
            },
            "receivedMessage": {
                "title": "Messages for Business Form",
                "subtitle": "Tap to view the available pages",
                "style": "small",
                "imageIdentifier": "1"
            },
            "replyMessage": {
                "title": "Messages for Business Form",
                "subtitle": "Tap to review your selections",
                "style": "small",
                "imageIdentifier": "1"
            }
        },
        "attachments": [
            
        ]
    }
}

Form Message parameters description

Types of keyboard supported for keyboardType

Apple Pay

Customers will be able to pay your goods and services right from Apple Messages for Business, without having to go to any external sites or fill in the card data.

The official documentation of Apple Messages for Business: Apple Pay

An Apple Pay Message Example

The task Reference in a State Diagram Attachments: applePay.

{
   "abc": {
       "type": "apple_pay_request",
       "apple_pay_request": {
           "receivedMessage": {
               "title": "{{title}}",
               "subtitle": "{{subtitle}}",
               "style": "icon"
           },
           "payment": {
               "paymentRequest": {
                   "lineItems": [
                       {
                           "label": "Item 1",
                           "amount": "0.01",
                           "type": "final"
                       },
                       {
                           "label": "Item 2",
                           "amount": "0.01",
                           "type": "final"
                       }
                   ],
                   "total": {
                       "label": "Your Total",
                       "amount": "0.02",
                       "type": "final"
                   },
                   "applePay": {
                       "merchantIdentifier": "{{merchantIdentifier}}",
                       "supportedNetworks": [
                           "amex",
                           "visa",
                           "discover",
                           "masterCard",
                           "chinaUnionPay",
                           "interac",
                           "privateLabel"
                       ],
                       "merchantCapabilities": [
                           "supportsDebit",
                           "supportsCredit", 
                           "supportsEMV", 
                           "supports3DS"            
                       ]
                   },
                   "merchantName": "{{merchantName}}",
                   "countryCode": "US", 
                   "currencyCode": "USD", 
                   "requiredBillingContactFields": [
                       "postalAddress"
                   ],
                   "requiredShippingContactFields": [
                       "postalAddress",
                       "name",
                       "phoneticName",
                       "phone",
                       "email"
                    ]
               },
               "endpoints": {
                   "paymentGatewayUrl": "https://botplatform.corezoid.com/paymentGateway" 
               }
           }
       }  
   }
}

Apple Pay in Messages for Business parameters description

An items array example to form a dynamic invoice

"items": [
    {
        "title": "...",
        "quantity": "...",
        "total": "..."
    },
    {
        "title": "...", 
        "quantity": "...",
        "total": "..."
    }
]

App Extension Call

This option allows to call a function/window from the iOS-application, to expand Apple Messages for Business capabilities.

The official documentation of Apple Messages for Business: iMessage App

An iMessage App Example

The task Reference in a State Diagram Attachments: appExtensionCall.

{
   "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": []
   }
}

iMessage App parameters description

OAuth 2.0 Request

Verify your customers using the OAuth 2.0 protocol through your own or external services:

The official Apple Messages for Business documentation: OAuth 2.0 Request.

Version 1.0

The official Apple Messages for Business documentation.
A user needs to add the following ref token config to the tokens storage:

The Authentication Process Architecture v 1.0

Version 2.0

The official Apple Messages for Business documentation.
A user needs to add the following ref token config to the tokens storage:

The Authentication Process Architecture v 2.0