Apple Business Chat integration API
Business Chat is a service that allows your organization to communicate directly with your customers through your Messaging Service Provider (MSP) using the Messages app. The Apple Business Chat integration creates the communication channel between Apple’s Messages app and LiveChat. In such a case, LiveChat plays the role of a MSP.
This article documents how to implement services for Authorization, Apple Pay, Custom Extensions, as well as List and Date Pickers.
Available methods
Send List Picker
Let the customer choose from a list of items by sending a list picker. More about list pickers.
Method URL: https://apple-csp.livechatinc.com/list-picker
Required header: Authorization with the agent’s token
| Request object | Required | Data type | Notes |
|---|---|---|---|
| chatId | Yes | string | ID of an ABC chat |
| threadId | Yes | string | ID of an ABC thread |
| title | Yes | string | Title of a list picker message |
| subtitle | No | string | Subtitle of a list picker message |
| image | No | string | URL of a list picker image |
| groups | Yes | array | Array of groups in a list picker |
| groups.title | Yes | string | Title of a group |
| groups.multipleChoice | Yes | bool | Should a user select multiple items in a group? |
| groups.items | Yes | array | Array of items in a group |
| groups.items.id | Yes | string | Unique ID of an item |
| groups.items.image | No | string | URL of an item image |
| groups.items.title | Yes | string | Title of an item |
| groups.items.subtitle | No | string | Subtitle of an item |
Send Date Picker
Let the customer choose a date by sending a date picker. More about date pickers.
Method URL: https://apple-csp.livechatinc.com/date-picker
Required header: Authorization with the agent’s token
| Request object | Required | Data type | Notes |
|---|---|---|---|
| chatId | Yes | string | ID of an ABC chat |
| threadId | Yes | string | ID of an ABC thread |
| title | Yes | string | Title of a date picker message |
| subtitle | No | string | Subtitle of a date picker message |
| image | No | string | URL of a date picker image |
| timeSlots | Yes | array | Array of time slots |
| timeSlots.identifier | Yes | string | Unique ID of a time slot |
| timeSlots.duration | Yes | int | Duration of a time slot |
| timeSlots.startTime | Yes | string | Start time in the format: 2020-12-15T17:00+0000 |
Send Apple Pay Payment
A request for payment, which includes information about payment processing capabilities, the payment amount, and shipping information. More about Apple Pay payments.
Method URL: https://apple-csp.livechatinc.com/payment
Required header: Authorization with the agent’s token
| Request object | Required | Data type | Notes |
|---|---|---|---|
| chatId | Yes | string | ID of an ABC chat |
| threadId | Yes | string | ID of an ABC thread |
| title | Yes | string | Title of a payment message |
| subtitle | No | string | Subtitle of a payment message |
| image | No | string | URL of a payment image |
| payment | Yes | object | |
| payment.paymentRequest.items | Yes | array | |
| payment.paymentRequest.items.label | Yes | string | |
| payment.paymentRequest.items.amount | Yes | string | |
| payment.paymentRequest.items.type | Yes | string | |
| payment.paymentRequest.total | Yes | object | |
| payment.paymentRequest.total.label | Yes | string | |
| payment.paymentRequest.total.amount | Yes | string | |
| payment.paymentRequest.total.type | Yes | string | |
| payment.paymentRequest.applePay | Yes | object | |
| payment.paymentRequest.applePay.merchantIdentifier | Yes | object | |
| payment.paymentRequest.applePay.supportedNetworks | Yes | object | |
| payment.paymentRequest.applePay.merchantCapabilities | Yes | object | |
| payment.paymentRequest.merchantName | Yes | string | |
| payment.paymentRequest.countryCode | Yes | string | |
| payment.paymentRequest.currencyCode | Yes | string | |
| payment.paymentRequest.merchantName | Yes | string | |
| payment.paymentRequest.requiredBillingContactFields | Yes | []string | |
| payment.paymentRequest.requiredShippingContactFields | Yes | []string | |
| payment.merchantSession | Yes | string | MerchantSession encoded as JSON |
| payment.endpoints | Yes | object | |
| payment.endpoints.paymentGatewayUrl | Yes | string | |
| payment.endpoints.fallbackUrl | No | string | |
| payment.endpoints.orderTrackingUrl | No | string | |
| payment.endpoints.paymentMethodUpdateUrl | No | string | |
| payment.endpoints.shippingContactUpdateUrl | No | string | |
| payment.endpoints.shippingMethodUpdateUrl | No | string |
Send Authentication request
Pass authentication data between LiveChat and the customer’s device using OAuth. More about the authentication message.
Method URL: https://apple-csp.livechatinc.com/authenticate
Required header: Authorization with the agent’s token
| Request object | Required | Data type | Notes |
|---|---|---|---|
| chatId | Yes | string | ID of an ABC chat |
| threadId | Yes | string | ID of an ABC thread |
| title | Yes | string | Title of an authentication message |
| subtitle | No | string | Subtitle of an authentication message |
| authenticate | Yes | object | |
| authenticate.oauth2 | Yes | object | |
| authenticate.oauth2.responseType | Yes | string | |
| authenticate.oauth2.scope | Yes | string | |
| authenticate.oauth2.clientSecret | Yes | string | |
| authenticate.oauth2.state | Yes | string | |
| authenticate.oauth2.responseEncryptionKey | Yes | string |
Invoke Custom Extension
Invoke a custom extension of an app. More about custom app extensions.
Method URL: https://apple-csp.livechatinc.com/custom-interactive
Required header: Authorization with the agent’s token
Источник
Apple business chat oauth
Apple Business Chat, or Business Chat, allows customers to interact with a business through the Messages app. Businesses engage with a Messaging Service Provider (MSP) to manage customer enquiries through Business Chat.
Apple devices running iOS 11.3 and later or macOS 10.13.4 and later support Business Chat.
It depends on the scope of your Business Chat deployment and the Messaging Service Provider (MSP) used to implement your vision.
To identify a business that uses Business Chat look for a button, which looks like a Messages bubble with a call to action (see image on right). Customers can start a Business Chat conversation by tapping the Business Chat button on any touch point the business placed it, such as websites, mobile sites, emails, leaflets through a QR code, or in an iOS app.
For additional entry points, see Business Chat Suggest 
Business Chat currently does not support internal business, or business-to-business, communications.
A blend of bots, or virtual agents, and human agents is recommended to manage Business Chat. The option to escalate to a human agent is mandatory in Business Chat. For implementation purposes, a virtual assistant needs to access Business Chat through a Messaging Service Provider (MSP), not through the Business Chat REST API.
This is not possible because phone numbers are not sent through Business Chat.
Apple recommends a blend of bots, or virtual agents, and human agents to manage Business Chat. The option to escalate to a human agent is mandatory in Business Chat. Therefore, we won’t approve a deployment using virtual agents exclusively.
An MSP implements the server-to-server REST API solutions on their messaging platform, which makes it possible to send and receive texts and photos, request payment through Apple Pay, and much more. They also provide the live agent console to interact with customers and route messages, if necessary, to the correct team in your customer care center.
Businesses need to register for Apple’s Business Chat service and confirm that they can provide a Messaging service. Once Apple confirms the capability, in addition to other details businesses provided, then the business can be reached by customers through Business Chat.
Group chat with a business is not supported.
Ask for permission before enrolling a customer in push notifications. Don’t assume people always want notifications. When a customer opts into notifications, explain how to opt out in the future. For example, you could send a response that says “You’re now signed up for order status notifications. Text ‘unsubscribe’ at anytime to turn off notifications.” Make sure your opt out process is straightforward and easy to remember.
Learn more about conversation guidelines from Business Chat’s Human Interface Guidelines
Respond only to active conversations. When a customer ends a conversation they shouldn’t receive additional messages unless they initiate a new conversation.
Learn more about conversation guidelines from Business Chat’s Human Interface Guidelines
The diagram to the right shows the basic flow when a customer’s device sends a message to a business. The Business Chat service receives the message and posts it to the MSP platform endpoint. The MSP platform takes the message, performs backend processes, if applicable, and forwards it to the appropriate business agent for a response. The Business agent responds to the customer, which sends the message back to the MSP platform and posts it to the Business Chat Service, and it is forwarded back to the customer’s device.
Learn more about the Business Chat’s REST API
Getting Started
First, choose a Messaging Service Provider (MSP) to deploy your Business Chat solution. Apple has integrated with over 20 MSPs to date. Contact your chosen MSP to discuss first steps. Following that, go to Apple Register and create your Business Chat account with Apple (at no charge). During the registration process, let us know which MSP you chose, indicate the names of your project team, approve our terms, and upload your branding. Then you can start implementing Business Chat.
Apple has integrated with a wide variety of approved MSPs.
Learn more about available MSPs at Business Chat
MSP platforms are responsible for receiving, routing, processing, responding where appropriate, and forwarding customer messages to businesses. MSPs can implement the many Business Chat features, as well as a bot to respond to simple questions such as store hours or store locations.
When you log into Apple Register make sure that you review all actions pending for the account. When logged in, you can also send us a message by clicking Help. Additionally, we recommend that you contact your MSP representative.
Business Chat Features
Business Chat supports the OAuth2 protocol that allows you or your MSP to integrate password autofill, which uses a third-party vendor’s authentication to provide the authentication. Also, your MSP or third-party vendor can implement a full authentication and authorization flow.
Learn more information about implementing Authentication
Apple Pay provides an easy and secure way for customers to buy goods and services through Business Chat.
Learn more about implementing Apple Pay in Business Chat
A list picker allows you to provide visually organized choices to your customer, such as items they want to buy or questions that lead to more choices. This gives you a better understanding of what your customer wants without the back and forth of simple text messaging.
Learn more about List Pickers
A time picker gives your customer a choice to conveniently schedule a pick up and delivery of items and services.
Learn more about Time Pickers
Rich links enhance the customer experience by allowing them to preview content, such as images and video, inline.
Learn more about Sending Rich Links
Chat Suggest allows your customers to choose how to contact your business through Apple Business Chat in the Messages app. When your customers tap on any of your registered business phone numbers, a phone sheet appears.
Learn more about Chat Suggest
iMessages App
An iMessage app allows your customers to interact with your app directly within Messages, including within a Business Chat conversation.
Learn more about building and submitting your iMessage app
An iMessage app extension allows customers to interact with your app directly in Messages. A standalone app sends the customer to the iOS app to interact, which resides outside of the Messages app. Your iMessage app extension is hosted inside your current iOS app.
Источник
