Use this API to send an Apple Messages for Business invitation message to an opted-in customer mobile number. Invitation messages allow a business to start an Apple Messages for Business conversation before an AMB opaque user ID is available. When the customer responds to the invitation, Webex Connect resolves the conversation to the AMB user ID for subsequent messages. Note: Modify YourRegion in the URL to the right to reflect your tenant’s region. See Know your endpoint page. Apple Messages for Business Invitation Messages require Apple invitation entitlement for the business account. Customers must explicitly opt in before you send an invitation message. Invitation messages are Apple-managed template messages and do not support free-form text. Webex Connect derives the Apple invitation template based on the withImage value.
Note:
- It is recommended to use a valid authorization ID; the failure of notification won’t be logged in Debug Logs.
- The notify URL should be filled with the proper URL format; otherwise, it would be considered an invalid URL.
- The notify URL should be provided with proper spacing of the URL; when space is provided in front of the URL or at the end of the URL, it would be considered an invalid URL.
Responses
200
The request is accepted for processing. Webex Connect returns a transaction identifier for the request. Submission status is available through outbound webhooks, Notify URL, and Debug Console.
400
The request is invalid. This response is returned for synchronous Messaging API request validation failures, such as missing mandatory parameters or invalid request values.
Error Codes
Refer to the Apple Messages for Business section in Channel Specific Status Codes.
Important Considerations
- Invitation messages are addressed to customer mobile numbers.
- Standard Apple Messages for Business message types continue to use the AMB opaque user ID.
- Subsequent standard Apple Messages for Business messages must use the resolved AMB opaque user ID.
- Invitation messages do not support free-form text.
- To send an Invitation Message with a brand logo, configure the business logo on the Apple Messages for Business app asset and set
withImagetotrue. Webex Connect uses the image-enabled invitation template. - If
withImageis set totrueand the selected Apple Messages for Business app asset does not have a business logo configured, the invitation message transaction fails. - To send an Invitation Message without a brand logo, set
withImagetofalse. Webex Connect uses the no-image invitation template. - If the customer selects No on the invitation, opts out of invitation messages, or closes the Apple Messages for Business conversation, Webex Connect suppresses subsequent invitation messages to that customer. If another invitation message is attempted for the same customer, the invitation message may fail with the following error:
The user you are trying to communicate with, has opted not to receive messages from you.Send another invitation only after customer consent is re-established. - Apple does not provide delivery or read status events for invitation messages. Webex Connect provides submission success or failure notifications.