Apple Message for Business: List Picker

post https://api.{YourRegion}.webexconnect.io/resources/v1/messaging/

Allows the customer to choose from a list of items. A list picker displays a list of items, and information about the items—such as product name, description, and image—in the Messages app on the customer's device. The customer can choose one or more items from the list to send with a reply. Note: Modify YourRegion in the URL to the right to reflect your tenant’s region. See Know your endpoint page.

Error Codes

Refer to the below page https://developers.imiconnect.io/reference/channel-specific-status-codes-1#apple-messages-for-business

Body Params

deliverychannel

string

Defaults to AppleBusinessChat

Channel used to send the message i.e., AppleBusinessChat in this case.

appid

string

The ID of the app asset that you can obtain from the Connect platform.

destination

array of objects

User's Opaque ID that uniquely identifies a user and is specific to the business.

destination

channels

object

Channels object used for messaging.

correlationid

string

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

string

Data that you have configured to receive on the notify Url. This is configured as a part of the request.

notifyurl

string

Configure a URL to get notifications on delivery reports for a Apple message. This field accepts only a valid URL or a variable. If an invalid URL is passed in API request or via a variable, then such request will not be considered eligible for retries.

Headers

key

string

Applicable when you want to use service key for API authentication. Available under API tab within a service in your webexconnect tenant.

authorization

string

JSON Web Token (JWT) for authentication (e.g. bearer [token]) used alternatively to Service Key

Responses

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.yourregion.webexconnect.io/resources/v1/messaging/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "deliverychannel": "AppleBusinessChat"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Error Codes

200200

400400