Apple Business Chat integration API

1 minutes reading time

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 objectRequiredData typeNotes
chatIdYesstringID of an ABC chat
threadIdYesstringID of an ABC thread
titleYesstringTitle of a list picker message
subtitleNostringSubtitle of a list picker message
imageNostringURL of a list picker image
groupsYesarrayArray of groups in a list picker
groups.titleYesstringTitle of a group
groups.multipleChoiceYesboolShould a user select multiple items in a group?
groups.itemsYesarrayArray of items in a group
groups.items.idYesstringUnique ID of an item
groups.items.imageNostringURL of an item image
groups.items.titleYesstringTitle of an item
groups.items.subtitleNostringSubtitle 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 objectRequiredData typeNotes
chatIdYesstringID of an ABC chat
threadIdYesstringID of an ABC thread
titleYesstringTitle of a date picker message
subtitleNostringSubtitle of a date picker message
imageNostringURL of a date picker image
timeSlotsYesarrayArray of time slots
timeSlots.identifierYesstringUnique ID of a time slot
timeSlots.durationYesintDuration of a time slot
timeSlots.startTimeYesstringStart 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 objectRequiredData typeNotes
chatIdYesstringID of an ABC chat
threadIdYesstringID of an ABC thread
titleYesstringTitle of a payment message
subtitleNostringSubtitle of a payment message
imageNostringURL of a payment image
paymentYesobject
payment.paymentRequest.itemsYesarray
payment.paymentRequest.items.labelYesstring
payment.paymentRequest.items.amountYesstring
payment.paymentRequest.items.typeYesstring
payment.paymentRequest.totalYesobject
payment.paymentRequest.total.labelYesstring
payment.paymentRequest.total.amountYesstring
payment.paymentRequest.total.typeYesstring
payment.paymentRequest.applePayYesobject
payment.paymentRequest.applePay.merchantIdentifierYesobject
payment.paymentRequest.applePay.supportedNetworksYesobject
payment.paymentRequest.applePay.merchantCapabilitiesYesobject
payment.paymentRequest.merchantNameYesstring
payment.paymentRequest.countryCodeYesstring
payment.paymentRequest.currencyCodeYesstring
payment.paymentRequest.merchantNameYesstring
payment.paymentRequest.requiredBillingContactFieldsYes[]string
payment.paymentRequest.requiredShippingContactFieldsYes[]string
payment.merchantSessionYesstringMerchantSession encoded as JSON
payment.endpointsYesobject
payment.endpoints.paymentGatewayUrlYesstring
payment.endpoints.fallbackUrlNostring
payment.endpoints.orderTrackingUrlNostring
payment.endpoints.paymentMethodUpdateUrlNostring
payment.endpoints.shippingContactUpdateUrlNostring
payment.endpoints.shippingMethodUpdateUrlNostring

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 objectRequiredData typeNotes
chatIdYesstringID of an ABC chat
threadIdYesstringID of an ABC thread
titleYesstringTitle of an authentication message
subtitleNostringSubtitle of an authentication message
authenticateYesobject
authenticate.oauth2Yesobject
authenticate.oauth2.responseTypeYesstring
authenticate.oauth2.scopeYesstring
authenticate.oauth2.clientSecretYesstring
authenticate.oauth2.stateYesstring
authenticate.oauth2.responseEncryptionKeyYesstring

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

Request objectRequiredData typeNotes
chatIdYesstringID of an ABC chat
threadIdYesstringID of an ABC thread
interactiveDataYesobject
interactiveData.appIdYesstring
interactiveData.appNameYesstring
interactiveData.receiveMessageYesobject
interactiveData.receiveMessage.titleYesobject
interactiveData.receiveMessage.subtitleYesobject
interactiveData.receiveMessage.useLiveLayoutYesbool

Resources