post https://api.{YourRegion}.webexconnect.io/resources/v1/messaging/
Provides an easy and secure way for customers to buy goods and services through Messages for Business using Apple Pay. When a business asks for payment from a customer who is purchasing goods and services through Messages for Business, the customer can use Apple Pay to make the payment. Note: The following is an example of Authentication. Examples of other media types can be found below. Note: Modify YourRegion in the URL to the right to reflect your tenant’s region. See Know your endpoint page.
Apple Pay
{
"deliverychannel": "AppleBusinessChat",
"appid": "{{ambAppid}}",
"destination": [{
"abcUserId": ["{{abcUserId}}"]
}],
"channels": {
"AppleBusinessChat": {
"type": "interactive",
"x_msg_seq": 1,
"interactiveData": {
"data": {
"version": "1.0",
"requestIdentifier": "21d4a1c4-327c-ba35-45b1-36a050b15ad2",
"images": [{
"identifier": "6de6a59c-846f-45d8-a1d7-24382d9919db",
"url": "http://clipart-library.com/data_images/320464.png"
}
],
"payment": {
"paymentRequest": {
"lineItems": [{
"amount": "1.50",
"type": "final",
"label": "Adoption fee"
}],
"shippingMethods": [{
"label": "shipping charges (Optional)",
"amount": "8",
"detail": "fast delivery (Optional)",
"identifier": "b3062736-e911-42db-b7a2-b5c603805858"
}],
"requiredShippingContactFields": [
"postalAddress",
"name",
"phone"
],
"countryCode": "US",
"requiredBillingContactFields": [
"postalAddress",
"name",
"phone"
],
"currencyCode": "USD",
"total": {
"amount": "3.0",
"type": "final",
"label": "Your Total"
}
}
}
},
"useLiveLayout": true,
"receivedMessage": {
"title": "The best deals on new iPhones!"
},
"replyMessage": {
"title": "Reply Title"
}
}
}
},
"correlationid": "",
"callbackData": "",
"notifyurl": ""
}
| Parameter/Object | Parameter within the Object | Mandatory | Description |
|---|---|---|---|
| delivery channel | Yes | Options: text, richlink, interactive | |
| app id | Yes | Rich link object | |
| destination | Unique user id for the recipient of the message on WhatsApp. | ||
| abcUserId | Unique user id | ||
| channels | |||
| AppleBusinessChat | |||
| type | Options: text, richlink, interactive | ||
| interactiveData | Yes | Contains the list/Time Picker (Date Picker) and Quick Reply data | |
| data | |||
| version | Yes | A string representing the version number of the message extension schema. Should be 1.0. | |
| requestIdentifier | Yes | A string that representing a unique identifier for the request. imiconnect returns the ID in the response it sends back to the client application | |
| images | Yes | An array of image dictionaries | |
| identifier | Yes | An identifier to identify the item. | |
| url | Yes | Publicly accessible URL that is a direct link to the media | |
| authenticate | |||
| oauth2 | |||
| responseType | |||
| scope | |||
| receivedMessage | |||
| subtitle | |||
| title | |||
| imageIdentifier | |||
| replyMessage | |||
| correlationid | The corrrelationid 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. | ||
| notifyurl | Configure a URL to get notifications on delivery reports for a WhatsApp message. This field accepts only a valid URL or a variable. If an invalid URL is passed in an API request or via a variable, then such a request will not be considered eligible for retries. |
Error Codes
Refer to the below page https://developers.imiconnect.io/reference/channel-specific-status-codes-1#apple-messages-for-business