| - | Mobile App Messaging | -Web Messaging | -Apple Business chat | -SMS | -Google RCS | -Line | -Messaging Window API | -Connector API | - - - {% for category in site.data.capabilities %} -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| {{ category.categoryName }} | -- | - | - | - | - | - | - | - | - | - | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| {{ feature.featureName }} | - {% for channel in feature.channels %} - {% if forloop.index == 1 %} - {% if channel.mobileAppMessaging == "Supported" %} -{{ channel.mobileAppMessaging }} | - {% else %} -{{ channel.mobileAppMessaging }} | - {% endif %} - {% endif %} - {% if forloop.index == 2 %} - {% if channel.webMessaging == "Supported" %} -{{ channel.webMessaging }} | - {% else %} -{{ channel.webMessaging }} | - {% endif %} - {% endif %} - {% if forloop.index == 3 %} - {% if channel.appleBusinessChat == "Supported" %} -{{ channel.appleBusinessChat }} | - {% else %} -{{ channel.appleBusinessChat }} | - {% endif %} - {% endif %} - {% if forloop.index == 4 %} - {% if channel.sms == "Supported" %} -{{ channel.sms }} | - {% else %} -{{ channel.sms }} | - {% endif %} - {% endif %} - {% if forloop.index == 5 %} - {% if channel.facebook == "Supported" %} -{{ channel.facebook }} | - {% else %} -{{ channel.facebook }} | - {% endif %} - {% endif %} - {% if forloop.index == 6 %} - {% if channel.whatsapp == "Supported" %} -{{ channel.whatsapp }} | - {% else %} -{{ channel.whatsapp }} | - {% endif %} - {% endif %} - {% if forloop.index == 7 %} - {% if channel.googleRCS == "Supported" %} -{{ channel.googleRCS }} | - {% else %} -{{ channel.googleRCS }} | - {% endif %} - {% endif %} - {% if forloop.index == 8 %} - {% if channel.line == "Supported" %} -{{ channel.line }} | - {% else %} -{{ channel.line }} | - {% endif %} - {% endif %} - {% if forloop.index == 9 %} - {% if channel.messagingWindowAPI == "Supported" %} -{{ channel.messagingWindowAPI }} | - {% else %} -{{ channel.messagingWindowAPI }} | - {% endif %} - {% endif %} - {% if forloop.index == 10 %} - {% if channel.connectorAPI == "Supported" %} -{{ channel.connectorAPI }} | - {% else %} -{{ channel.connectorAPI }} | - {% endif %} - {% endif %} - {% endfor %} -
| + | Mobile App Messaging | +Web Messaging | +Apple Messages for Business | +SMS | +Google RCS | +Line | +Messaging Window API | +Connector API | + + + {% for category in site.data.capabilities %} +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| {{ category.categoryName }} | ++ | + | + | + | + | + | + | + | + | + | ||||||||||
| {{ feature.featureName }} | + {% for channel in feature.channels %} + {% if forloop.index == 1 %} + {% if channel.mobileAppMessaging == "Supported" %} +{{ channel.mobileAppMessaging }} | + {% else %} +{{ channel.mobileAppMessaging }} | + {% endif %} + {% endif %} + {% if forloop.index == 2 %} + {% if channel.webMessaging == "Supported" %} +{{ channel.webMessaging }} | + {% else %} +{{ channel.webMessaging }} | + {% endif %} + {% endif %} + {% if forloop.index == 3 %} + {% if channel.appleBusinessChat == "Supported" %} +{{ channel.appleBusinessChat }} | + {% else %} +{{ channel.appleBusinessChat }} | + {% endif %} + {% endif %} + {% if forloop.index == 4 %} + {% if channel.sms == "Supported" %} +{{ channel.sms }} | + {% else %} +{{ channel.sms }} | + {% endif %} + {% endif %} + {% if forloop.index == 5 %} + {% if channel.facebook == "Supported" %} +{{ channel.facebook }} | + {% else %} +{{ channel.facebook }} | + {% endif %} + {% endif %} + {% if forloop.index == 6 %} + {% if channel.whatsapp == "Supported" %} +{{ channel.whatsapp }} | + {% else %} +{{ channel.whatsapp }} | + {% endif %} + {% endif %} + {% if forloop.index == 7 %} + {% if channel.googleRCS == "Supported" %} +{{ channel.googleRCS }} | + {% else %} +{{ channel.googleRCS }} | + {% endif %} + {% endif %} + {% if forloop.index == 8 %} + {% if channel.line == "Supported" %} +{{ channel.line }} | + {% else %} +{{ channel.line }} | + {% endif %} + {% endif %} + {% if forloop.index == 9 %} + {% if channel.messagingWindowAPI == "Supported" %} +{{ channel.messagingWindowAPI }} | + {% else %} +{{ channel.messagingWindowAPI }} | + {% endif %} + {% endif %} + {% if forloop.index == 10 %} + {% if channel.connectorAPI == "Supported" %} +{{ channel.connectorAPI }} | + {% else %} +{{ channel.connectorAPI }} | + {% endif %} + {% endif %} {% endfor %} +
-The first thing our functions do is to get the particular channel the user is coming from. If you would like to force the channel to make the ABC or SMS option dialogs appear, you can set the channel variable to the following:
+The first thing our functions do is to get the particular channel the user is coming from. If you would like to force the channel to make the Apple Messages for Business or SMS option dialogs appear, you can set the channel variable to the following:
```javascript
// What channel is the user on? If you'd like to force the display of a particular channel's content,
- // set the "channel" variable to: "CustomContext" for ABC, "sms" for SMS. Web will be displayed by default.
+ // set the "channel" variable to: "CustomContext" for AMB, "sms" for SMS. Web will be displayed by default.
//var channel = "CustomContext";
var channel = botContext.getChannel(); // Comment this line out if forcing the channel
botContext.printDebugMessage("=====> USER CHANNEL IS: " + channel);
@@ -137,7 +137,7 @@ Options are set to be shown by default, but if you don’t want them to be shown
diff --git a/pages/Documents/ConversationalAI/Third-PartyBots/getting-started.md b/pages/Documents/ConversationalAI/Third-PartyBots/getting-started.md
index 4acc8675a4..8e4e4a017e 100644
--- a/pages/Documents/ConversationalAI/Third-PartyBots/getting-started.md
+++ b/pages/Documents/ConversationalAI/Third-PartyBots/getting-started.md
@@ -87,7 +87,7 @@ Those identifies are as follows:
#### Support for different messaging channels and corresponding rich content
-The bot Connector system is designed to support [all relevant rich content](getting-started-with-rich-messaging-rich-messaging-channel-capabilities.html) since it only forwards the received structured content and metadata to LivePerson's messaging and chat services, where it is handled. We have verified and tested the support for **Web Messaging**, **Facebook** and **Apple Business Chat**. All other channels are not verified, but should work if you send the right structured content for the channel. If you experience any issues, please contact LivePerson support or your account team.
+The bot Connector system is designed to support [all relevant rich content](getting-started-with-rich-messaging-rich-messaging-channel-capabilities.html) since it only forwards the received structured content and metadata to LivePerson's messaging and chat services, where it is handled. We have verified and tested the support for **Web Messaging**, **Facebook** and **Apple Messages for Business**. All other channels are not verified, but should work if you send the right structured content for the channel. If you experience any issues, please contact LivePerson support or your account team.
#### Creating and starting bots
diff --git a/pages/Documents/GettingStarted/APIGuidelines/messaging-features-capabilities-comparison.md b/pages/Documents/GettingStarted/APIGuidelines/messaging-features-capabilities-comparison.md
new file mode 100644
index 0000000000..399e864b79
--- /dev/null
+++ b/pages/Documents/GettingStarted/APIGuidelines/messaging-features-capabilities-comparison.md
@@ -0,0 +1,121 @@
+---
+pagename: Messaging features Capabilities Comparison
+sitesection: Documents
+categoryname: "Getting Started"
+documentname: API Guidelines
+permalink: api-guidelines-messaging-features-capabilities-comparison.html
+indicator: messaging
+redirect_from:
+ - essential-resources-messaging-features-capabilities-comparison.html
+---
+
+
+| + | Mobile App Messaging | +Web Messaging | +Apple Messages for Business | +SMS | +Google RCS | +Line | +Messaging Window API | +Connector API | + + + {% for category in site.data.capabilities %} +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| {{ category.categoryName }} | ++ | + | + | + | + | + | + | + | + | + | ||||||||||
| {{ feature.featureName }} | + {% for channel in feature.channels %} + {% if forloop.index == 1 %} + {% if channel.mobileAppMessaging == "Supported" %} +{{ channel.mobileAppMessaging }} | + {% else %} +{{ channel.mobileAppMessaging }} | + {% endif %} + {% endif %} + {% if forloop.index == 2 %} + {% if channel.webMessaging == "Supported" %} +{{ channel.webMessaging }} | + {% else %} +{{ channel.webMessaging }} | + {% endif %} + {% endif %} + {% if forloop.index == 3 %} + {% if channel.appleBusinessChat == "Supported" %} +{{ channel.appleBusinessChat }} | + {% else %} +{{ channel.appleBusinessChat }} | + {% endif %} + {% endif %} + {% if forloop.index == 4 %} + {% if channel.sms == "Supported" %} +{{ channel.sms }} | + {% else %} +{{ channel.sms }} | + {% endif %} + {% endif %} + {% if forloop.index == 5 %} + {% if channel.facebook == "Supported" %} +{{ channel.facebook }} | + {% else %} +{{ channel.facebook }} | + {% endif %} + {% endif %} + {% if forloop.index == 6 %} + {% if channel.whatsapp == "Supported" %} +{{ channel.whatsapp }} | + {% else %} +{{ channel.whatsapp }} | + {% endif %} + {% endif %} + {% if forloop.index == 7 %} + {% if channel.googleRCS == "Supported" %} +{{ channel.googleRCS }} | + {% else %} +{{ channel.googleRCS }} | + {% endif %} + {% endif %} + {% if forloop.index == 8 %} + {% if channel.line == "Supported" %} +{{ channel.line }} | + {% else %} +{{ channel.line }} | + {% endif %} + {% endif %} + {% if forloop.index == 9 %} + {% if channel.messagingWindowAPI == "Supported" %} +{{ channel.messagingWindowAPI }} | + {% else %} +{{ channel.messagingWindowAPI }} | + {% endif %} + {% endif %} + {% if forloop.index == 10 %} + {% if channel.connectorAPI == "Supported" %} +{{ channel.connectorAPI }} | + {% else %} +{{ channel.connectorAPI }} | + {% endif %} + {% endif %} + {% endfor %} +
-
-
- Now that you know the basics, you’re ready to take a deeper dive into the full capabilities of the Conversational Cloud. The solutions you create using the Conversational Cloud are fully customizable. You can integrate our mobile SDK, create custom solutions with LivePerson APIs, and more. Select a journey below to learn more about the tools and customization options available.
-
-
-
-
-
- Prerequisites Before you move ahead be sure you’ve completed the guidance in Getting Started with your Free Trial Account which outlines the first steps to take in the Conversational Cloud.
-
-
-
- 
- 
-
-
- 
- 
- 
-
-
-
-
-
-
-
- CONVERSATIONAL AI
-Understand consumer intents
- - -
- MESSAGING CHANNELS
-Engage with consumers proactively
- - -
- MESSAGING CHANNELS
-Customize your messaging operations
- - -
- CONVERSATIONAL AI
-Create new bots and dialogs
- - -
- FUNCTION AS A SERVICE
-Develop custom behaviors
- - -
- LIVEPERSON APIS
-Build your own solution
- - -
- Messaging Channels
-Integrate Mobile Messaging SDK for iOS
- - -
- Messaging Channels
-Integrate Mobile Messaging SDK for Android
- - -
- Conversational AI
-Integrate a messaging bot using Agent Messaging SDK
- - -
- LIVEPERSON APIS
-Enable consumer monitoring with Monitoring API
- - -
- LIVEPERSON APIS
-Manage users with Users API
- - -
- LIVEPERSON APIS
-Implement a retry policy
- -
-
-
-
-
+
diff --git a/pages/Documents/GettingStarted/liveperson-apis-and-sdks.md b/pages/Documents/GettingStarted/liveperson-apis-and-sdks.md
index 5e4ad265b7..3363b545cd 100644
--- a/pages/Documents/GettingStarted/liveperson-apis-and-sdks.md
+++ b/pages/Documents/GettingStarted/liveperson-apis-and-sdks.md
@@ -70,7 +70,7 @@ indicator: both
| SDK | Purpose |
|---|---|
| [Agent Workspace Widget SDK](agent-workspace-widget-sdk-overview.html) | Add custom widgets to the Conversational Cloud |
-| [Apple Business Chat SDK](apple-business-chat-sdk-overview.html) | Implement interactive experience for ABC consumers |
+| [Apple Messages for Business SDK](apple-business-chat-sdk-overview.html) | Implement interactive experience for AMB consumers |
| [Engagement Window Widget SDK](engagement-window-widget-sdk-overview.html) | Add custom widgets to the Engagement Window |
| [JavaScript Chat SDK](javascript-chat-sdk-overview.html) | Create a chat window from scratch |
| [Messaging Agent SDK](messaging-agent-sdk-overview.html) | Provide access to Agent Messaging API, enable bots to handle consumer conversations, and perform agent actions |
diff --git a/pages/Documents/MessagingChannels/AppleBusinessChatSDK/implementation.md b/pages/Documents/MessagingChannels/AppleBusinessChatSDK/implementation.md
index 09d9a721a0..dd567cf113 100644
--- a/pages/Documents/MessagingChannels/AppleBusinessChatSDK/implementation.md
+++ b/pages/Documents/MessagingChannels/AppleBusinessChatSDK/implementation.md
@@ -4,8 +4,8 @@ redirect_from:
Keywords:
sitesection: Documents
categoryname: "Messaging Channels"
-documentname: Apple Business Chat SDK
-permalink: apple-business-chat-sdk-implementation.html
+documentname: Apple Messages for Business SDK
+permalink: apple-messages-for-business-sdk-implementation.html
indicator: messaging
---
@@ -33,7 +33,7 @@ LPABCSDK.initialize(eventSubscription: LPABCEvent.noEvents)
### Update the SDK with Incoming CIM
-Upon an agent sending a [Custom Interactive Message (CIM)](apple-business-chat-templates-custom-interactive-message-template.html) to the consumer, this method will update the SDK with a payload that will enable SDE reporting to Conversational Cloud.
+Upon an agent sending a [Custom Interactive Message (CIM)](apple-messages-for-business-templates-custom-interactive-message-template.html) to the consumer, this method will update the SDK with a payload that will enable SDE reporting to Conversational Cloud.
```swift
func update(with conversation: MSConversation, message: MSMessage? = nil, abcsdkParams: ABCSDKParams? = nil)
@@ -50,7 +50,7 @@ Should be implemented from these override functions in the iMessage app extensio
- `didSelect(_ message: MSMessage, conversation: MSConversation)`
- `didReceive(_ message: MSMessage, conversation: MSConversation)`
-See [step 6 of Installation for more](apple-business-chat-sdk-installation.html#sdk-installation-in-xcode).
+See [step 6 of Installation for more](apple-messages-for-business-sdk-installation.html#sdk-installation-in-xcode).
### Create SDEs
diff --git a/pages/Documents/MessagingChannels/AppleBusinessChatSDK/installation.md b/pages/Documents/MessagingChannels/AppleBusinessChatSDK/installation.md
index 111def25c4..2ab7c86516 100644
--- a/pages/Documents/MessagingChannels/AppleBusinessChatSDK/installation.md
+++ b/pages/Documents/MessagingChannels/AppleBusinessChatSDK/installation.md
@@ -19,7 +19,7 @@ indicator: messaging
### Apple and LivePerson Configuration
-1. Make sure you have an Apple Business Chat business ID.
+1. Make sure you have an Apple Messages for Business business ID.
2. Contact your LivePerson account representative to enable this SDK on the backend server.
### SDK Installation in XCode
@@ -76,7 +76,7 @@ Add the LPABCSDK pod to integrate it into your Xcode project. Make sure you chan
{: .important}
Your app group id should be the same across all implementing targets.
-3. Add `import LPABCSDK` to the relevant class files and [initialize the SDK](apple-business-chat-sdk-implementation.html#initializing-the-sdk).
+3. Add `import LPABCSDK` to the relevant class files and [initialize the SDK](apple-messages-for-business-sdk-implementation.html#initializing-the-sdk).
4. In the iMessage app/extension's `MessagesViewController` class, please make sure to override the following two methods:
diff --git a/pages/Documents/MessagingChannels/AppleBusinessChatSDK/overview.md b/pages/Documents/MessagingChannels/AppleBusinessChatSDK/overview.md
index ca45d6cccb..93fff6ceea 100644
--- a/pages/Documents/MessagingChannels/AppleBusinessChatSDK/overview.md
+++ b/pages/Documents/MessagingChannels/AppleBusinessChatSDK/overview.md
@@ -9,18 +9,18 @@ permalink: apple-business-chat-sdk-overview.html
indicator: messaging
---
-### What is the ABC SDK
+### What is the Apple Messages for Business SDK
-The Apple Business Chat SDK is an iOS Swift framework that allows developers to easily implement a rich, interactive experience for consumers, by reacting to conversational context in real time.
+The Apple Messages for Business SDK is an iOS Swift framework that allows developers to easily implement a rich, interactive experience for consumers, by reacting to conversational context in real time.
The framework is very lightweight and designed to be an easy addition to any host app or iMessage app.
### What does the SDK do?
-After sending a [Custom Interactive Message (CIM)](apple-business-chat-templates-custom-interactive-message-template.html) to the consumer, this SDK allows the developer to monitor the consumer behavior and report it back to LivePerson as engagement attributes to enhance the conversation.
+After sending a [Custom Interactive Message (CIM)](apple-messages-for-business-templates-custom-interactive-message-template.html) to the consumer, this SDK allows the developer to monitor the consumer behavior and report it back to LivePerson as engagement attributes to enhance the conversation.
- Report SDEs
- - Allows you to measure incremental lift and ROI from ABC conversations and Conversational Cloud operational tools
+ - Allows you to measure incremental lift and ROI from Apple Messages for Business conversations and Conversational Cloud operational tools
- More easily allows Agents to read Custom Interactive Messages from Consumers
- Provides human and bot agents with context of the consumer’s iMessage app transactional and activity data, allowing them to have a more meaningful and effective conversation
- Notify the developer of conversational events so that they can take action with custom SDEs
@@ -29,7 +29,7 @@ After sending a [Custom Interactive Message (CIM)](apple-business-chat-templates
### Who is the SDK for?
-Firstly, the Apple Business Chat SDK is for brands that are using or intend to use the Apple Business Chat channel to connect with their consumers.
+Firstly, the Apple Messages for Business SDK is for brands that are using or intend to use the Apple Messages for Business channel to connect with their consumers.
The SDK has 2 distinctive contextual integration environments:
@@ -40,7 +40,7 @@ The SDK has 2 distinctive contextual integration environments:
#### Consumer Transaction over iMessage App
-1. Consumer is messaging an appliance brand via Business Chat
+1. Consumer is messaging an appliance brand via Messages for Business
2. Consumer is asking the agent to provide details on the delivery and installation offering for their ovens.
3. Agent gives the consumer all the details on the delivery and installation, and the consumer decides to buy both the oven and the delivery package.
4. Agent sends the consumer an iMessage app interaction that includes all products selected in the cart area, with payment flow.
@@ -59,7 +59,7 @@ Path B:
5. Consumer does not respond to the iMessage app transaction sent to him by the agent, and texts that agent that he still need some time to decide
6. Agent closes the conversation in Conversational Cloud
-7. After a couple of hours the consumer comes back to the ABC conversation and continues with the purchase flow on the iMessage app interaction — consumer does not message the brand, but only opens the iMessage app in the conversation thread
+7. After a couple of hours the consumer comes back to the Apple conversation and continues with the purchase flow on the iMessage app interaction — consumer does not message the brand, but only opens the iMessage app in the conversation thread
8. LE Conversation is updated with the transaction items and value via SDEs while the conversation is closed in Conversational Cloud
9. Agent manager generates a report that looks at the cross session conversation (transaction that reported after conversation closed in LE), to evaluate the correlation between consumer conversations and transactions, and to attribute incremental lift for LE conversation
@@ -68,8 +68,8 @@ Path B:
1. Consumer looks for a smart door lock on brand's app
2. Consumer adds two types of door locks to the cart
3. Brands report the product in cart and the value to LE unauthenticated SDEs
-4. After an hour, the consumer taps on a link in the app that opens the Apple Business Chat conversation thread
-5. Consumer starts to message brand via ABC, the conversation is triggered in Conversational Cloud
+4. After an hour, the consumer taps on a link in the app that opens the Apple Messages for Business conversation thread
+5. Consumer starts to message brand via AMB, the conversation is triggered in Conversational Cloud
6. The human or bot agent joins the conversation and reviews the products and value added by the consumer to the cart, and can manage the conversation with full context to the consumer’s needs.
7. The consumer decides on the product they would like to purchase and completes the payment funnel while in conversation with the agent.
1. Another scenario is when the consumer does not decide on the product while in conversation and closed the conversation with the brand. After a couple of hours the consumer goes to the app and completes the purchase flow.
diff --git a/pages/Documents/MessagingChannels/ConnectToMessaging/api.md b/pages/Documents/MessagingChannels/ConnectToMessaging/api.md
index 0ba0f3d626..5c7227634c 100644
--- a/pages/Documents/MessagingChannels/ConnectToMessaging/api.md
+++ b/pages/Documents/MessagingChannels/ConnectToMessaging/api.md
@@ -482,7 +482,7 @@ We recommend a request be retried (3 attempts with exponential retry with delay
3. Which channels are supported as of now?
-C2M supports SMS-Twilio, WhatsApp, Apple Business Chat, Google RCS and INAPP channels.
+C2M supports SMS-Twilio, WhatsApp, Apple Messages for Business, Google RCS and INAPP channels.
4. Is there a throughput limitation for the data that gets passed from Twilio to LP?
diff --git a/pages/Documents/Reporting/MessagingInteractionsAPI/Methods/conversations.md b/pages/Documents/Reporting/MessagingInteractionsAPI/Methods/conversations.md
index f6246c6b69..3458b3d473 100644
--- a/pages/Documents/Reporting/MessagingInteractionsAPI/Methods/conversations.md
+++ b/pages/Documents/Reporting/MessagingInteractionsAPI/Methods/conversations.md
@@ -70,7 +70,7 @@ Filter is sent in the POST data (body) with the following JSON structure.
|mcs {from,to} | Range of Meaningful Conversation Score in a particular conversation (including the boundaries). | numeric, numeric | Optional | Either "from" or "to" fields are mandatory. In case one of the fields is missing, its value will be set to the minimal or maximal possible values of MCS, respectively.
|alertedMcsValues | Alerted MCS of the conversation up until the most recent message. | Array `
+
+1. Agent or bot is notified via an engagement attribute if consumer device supports the Apple Auth feature.
+
+2. Send the Apple Auth template via an agent or bot with a Structured Content template.
+
+3. Authentication is done by your OAuth 2.0 provider.
+
+4. Upon successful or failed authentication, Conversational Cloud passes the authentication details back so that you may perform validation.
+
+### Setup
+
+1. Supply your private OAuth2 service details in your Apple management area (register.apple.com).
+
+The required details include:
+
+* Authentication endpoint URL
+
+* Token URL
+
+* Client Identifier
+
+#### Instructions on how to create a free OAuth2 service using [auth0](https://auth0.com/)
+
+If you do not yet have an OAuth2 service or if you need a test service, follow the instructions below:
+
+1. Create a [auth0 account](https://auth0.com/)
+
+2. Create a new Application Machine to Machine
+
+3. Put `https://auth.businesschat.apple.com` in Allowed Callback Urls
+
+4. Put `https://auth.businesschat.apple.com` in Allowed Origins & Allowed Web Origins
+
+5. On the same screen, go to the bottom and select advanced settings -> Endpoints
+
+6. Copy Auth URL, Token Url, Client Id (it is at the top) and place them in your register.apple.com portal
+
+7. Go to Grant Types tab in advanced settings and check Authorization Code, Password and other features you want to use.
+
+### Checking for Apple Auth device compatibility
+
+Before the agent or bot sends an authentication request to a consumer, they will need to know if the consumer device is compatible (that is, using iOS 12 or newer) with Apple Auth.
+
+In an Apple Messages for Business Conversation, the messaging channel will automatically send an authenticated "role" engagement attribute to Conversational Cloud:
+
+* If consumer Apple device supports authentication, this attribute's value will be: "Apple Authentication supported".
+
+* If consumer Apple device does not support authentication, this attribute's value will be: "Apple Authentication not supported".
+
+The agent or bot should read the consumer engagement attributes to check for this engagement attribute before sending the Apple Authentication request to the consumer.
+
+**Note:** If the consumer updates the iOS version from 11 to 12 when still in an active conversation in Conversational Cloud, the conversation will not be updated with the consumer’s new capability - to solve this, the conversation should be closed and opened again in Conversational Cloud.
+
+
+
+### Sending an Apple Authentication Request to a Consumer
+
+You will send two template payloads (Metadata and Body) for the Apple Auth request to the consumer.
+
+See [how to send Structured Content](structured-content-introduction-to-structured-content.html#how-to-send-structured-content-to-the-conversation) for a background on how to send these.
+
+The **body** template will only define how the Apple Auth bubble is displayed in the Conversational Cloud agent workspace. The **metadata** template will define how the bubble is displayed in the consumer's Messages thread.
+
+**Agent sends auth request to consumer via Agent Workspace SDK widget**
+
+
+
+**Consumer sees auth request bubble. Style here defined by metadata `receivedMessage`.**
+
+
+
+**Consumer fills out form from OAuth2 provider**
+
+
+
+**Consumer sees request confirmation bubble. Style here defined by metadata `replyMessage`.**
+
+
+
+#### Request Metadata
+
+**BusinessChatMessage - receivedMessage and replyMessage bubbles**
+
+The `BusinessChatMessage` object contains the `receivedMessage` and `replyMessage` objects, which define how the Authentication Interactive Message bubbles layout will be displayed when the message is received on the consumer’s device (`receivedMessage`) and once an authentication is submitted by the consumer (`replyMessage`).
+
+**ConnectorAuthenticationRequest**
+
+The `ConnectorAuthenticationRequest` object holds the `requestIdentifier` and `responseEncryptionKey` (public key), which allows you to identify the authentication request and map the OAuth token in the response to the request originator.
+
+{: .important}
+The requestIdentifier and responseEncryptionKey is optional, but the responseEncryptionKey is required to view the auth response from an agent widget.
+
+Please use the metadata template with the relevant fields, as presented in the example below:
+
+##### Metadata Template Example:
+
+```json
+[
+ {
+ "type": "BusinessChatMessage",
+ "receivedMessage": {
+ "title": "Sign In to LivePerson",
+ "subtitle": "Thank you",
+ "imageURL": "https://www.liveperson.com/sites/default/files/pictures/nav/Logo-LP-White.png",
+ "style": "small"
+ },
+ "replyMessage": {
+ "title": "You Signed in",
+ "subtitle": "Thank you",
+ "imageURL": "https://www.liveperson.com/sites/default/files/pictures/nav/Logo-LP-White.png",
+ "style": "small"
+ }
+ },
+ {
+ "type": "ConnectorAuthenticationRequest",
+ "requestIdentifier": "Insert Your Unique Request Key Here",
+ "apple": {
+ "oauth2": {
+ "responseEncryptionKey": "Insert Your Public Key Here"
+ }
+ }
+ }
+]
+```
+
+##### Metadata Object Properties
+
+| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| BusinessChatMessage | +Represents the Messages for Business bubbles view objects | +Object | +Y | +
| ConnectorAuthenticationRequest | +Represents a Messages for Business authentication request | +Object | +N | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| requestIdentifier | +Must be unique in every message. Used to identify the authentication request and map the to the request originator. | +string | +N | +
| apple.oauth2.responseEncryptionKey | +responseEncryptionKey is a public key which will be used to encrypt the oauth2 token. In order to decrypt the token you should have the corresponding private key to decrypt the token. If this is not sent, LivePerson will supply a public key for you. In order to view the auth response in the agent widget you must supply your own key. | +string | +N | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| Style | +The Style of the authentication interactive message reply bubble. Can be set to icon, small or large. Defaults to icon | +Enum - icon, small, large + | +N | +
| title | +The title of the bubble | +String | +Y | +
| subtitle | +Subtitle to be displayed under title | +String | +N | +
| imageURL | +Image to be placed in the authentication interactive message received bubble layout | +String | +N | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| style | +The Style of the authentication interactive message reply bubble. Can be set to icon, small or large. Defaults to icon | +Enum - icon, small, large + | +N | +
| title | +The title of the bubble | +String | +Y | +
| subtitle | +Subtitle to be displayed under title | +String | +N | +
| imageURL | +Image to be placed in the authentication interactive message reply message bubble layout | +String | +N | +
| Property Name | +Description | +Type | + + +
|---|---|---|
| encrypted | +True if you have provided the responseEncryptionKey, False if you have not | +Boolean | +
| status | +Status of the consumer authentication - can be only true (successful) or false (failed) | +Boolean | +
| token | +Token string - will be available only when authentication was successful | +String | +
| requestIdentifier | +Matches the authentication request that you sent. | +String | +
| errors | +Type of authentication error as received from Apple - will be available only when authentication failed | +Array | +
+
+1. Send the Apple Pay template via an agent or bot with the Structured Content framework and configuration (similar to list and time picker).
+
+2. Payment transactions will be performed by your payment gateway.
+
+3. Upon successful or failed payment, Conversational Cloud will support passing the payment details back to Conversational Cloud Conversational Metadata (via the [Agent SDK](messaging-agent-sdk-conversation-metadata-guide.html)) in order to allow you to perform validation on the payment information against the Apple Pay account
+
+### Setup
+
+1. The first step is to [configure your Apple developer account for Apple Pay](https://developer.apple.com/videos/play/tutorials/configuring-your-developer-account-for-apple-pay/).
+
+2. Register a Merchant Identifier (Merchant ID) in your Apple Developer Account to enable Apple Pay payments in Messages. For more information on creating your merchant ID, see [Configuring Your Environment.](https://developer.apple.com/library/content/ApplePay_Guide/Configuration.html#//apple_ref/doc/uid/TP40014764-CH2)
+
+3. Then, create a private Apple Pay account and supply your Apple Pay Merchant ID in your Apple management area [register.apple.com](register.apple.com).
+
+You will use your Merchant ID in the `merchantIdentifier` properties of the Apple Pay Request metadata template below so save it somewhere you can easily access.
+
+### Sending an Apple Pay Request to a Consumer
+
+
+You will send a metadata template and a body template for the Apple Pay request to the consumer.
+
+See [how to send Structured Content](structured-content-introduction-to-structured-content.html#how-to-send-structured-content-to-the-conversation) for more information on how to send these.
+
+The **body** template will only define how the Apple Pay bubble is displayed in the Conversational Cloud agent workspace. The **metadata** template will define how the bubble is displayed in the consumer's Messages thread.
+
+*Agent/bot generates Apple Pay Interactive Message to consumer (using structured content on Conversational Cloud)*
+
+
+
+*In the interim, consumer completes payment process and receives the reply message bubble with the payment status. Agent views Apple Pay Request in Conversational Cloud Agent Workspace*
+
+
+
+#### Request Metadata
+
+**BusinessChatMessage - receivedMessage bubbles**
+
+The `BusinessChatMessage` object holds the received message, which defines how the bubble element will be displayed when a message is received on the consumer’s device. The Apple Pay reply message on the consumer device is not configurable.
+
+**ConnectorPaymentRequest**
+
+The payment request holds the full Apple Pay transaction details (details of purchased services, payment capabilities, shipping methods, and transaction amounts). You can also request billing and shipping methods in this request.
+
+To edit the `ConnectorPaymentRequest` and `BusinessChatMessage` metadata template, please use the relevant properties, as presented in the example JSON below.
+
+##### Request Metadata example
+
+```json
+[
+ {
+ "type": "BusinessChatMessage",
+ "receivedMessage": {
+ "style": "icon",
+ "subtitle": "Buy now for $1",
+ "title": "iPhone XS Max",
+ "imageURL":"https://i.pinimg.com/280x280_RS/96/7f/ab/967fab3e38860638878f86b26bd756e3.jpg"
+ }
+ },
+ {
+ "type": "ConnectorPaymentRequest",
+ "signature": "| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| BusinessChatMessage | +Represents the Messages for Business bubbles view objects | +Object | +Y | +
| ConnectorPaymentRequest | +Represents a Messages for Business apple pay request | +Object | +Y | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| Style | +The Style of the apple pay Rich Message reply bubble. Can be set to icon, small or large. Defaults to icon | +Enum - icon, small, large | +N | +
| title | +The title of the bubble | +String | +Y | +
| subtitle | +Subtitle to be displayed under title | +String | +N | +
| imageURL | +Image to be placed in the apple pay Rich Message received bubble template | +String | +N | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| apple | +This is where you specify the "data" object | +object | +Y | +
| signature | +This is where you specify the "signature" value. For more information, see Apple Pay Signature Flow Guide | +string | +N | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| Data | +This is where you specify the "requestIdentifier", "payment" and the "version". | +object | +Y | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| requestIdentifier | +A UUID for the request. Messages for Business includes the identifier in its response to Conversational Cloud - this is an important property which allows you to correlate the payment response with your backend payment service | +string | +Y | +
| payment | +A dictionary with information about the payment request. For the full details list of the payment dictionary keys, see Apple’s Payment Request Dictionary. | +object | +Y | +
| version | +The version number of the message extension schema; the version should be 1.0. | +string | +Y | +
| Property Name | +Description | +Type | +Required | + + +
|---|---|---|---|
| paymentRequest | +This is where you specify the - apple pay identifiers, line items, total amount, country code, currency code, supported countries, shipping methods | +object | +Y | +
| merchantSession | +Containing the payment session provided by Apple Pay after requesting a new payment session. For more information, see Requesting an Apple Pay Payment Session. | +object | +Y | +
| endpoints | +The endpoints dictionary contains a list of URLs that Apple Pay calls during the payment process. Apple Pay requires the paymentGatewayUrl endpoint for use in asking the payment provider to process the payment; all other endpoints are optional. | +object | +Y | +
| Property Name | +Description | +Type | + + +
|---|---|---|
| Status | +Status of the payment response | +Boolean | +
| requestIdentifier | +UUID of the payment response. This information should be used to allow the bot to validate the payment against your payment backend. | +String | +
The URL passed in `ImageURL` of the received bubble must be whitelisted in Conversational Cloud. The image added in the RecievedMessage must be whitelisted in the structured content image whitelisting area. Contact your LP representative to whitelist images.
+
+### Limitations
+
+* In the current version of the Apple Pay template, only a bot in Conversational Cloud (using the Messaging Agent SDK) will be able to receive the payment response (using the Conversation Metadata). A Human Agent is currently not exposed to these events. There will be an option to receive payment response data without the Messaging Agent SDK in the near future.
diff --git a/pages/Documents/RichMessaging/AppleBusinessChatTemplates/custom-interactive-message-template.md b/pages/Documents/RichMessaging/AppleBusinessChatTemplates/custom-interactive-message-template.md
new file mode 100644
index 0000000000..e259b41a7e
--- /dev/null
+++ b/pages/Documents/RichMessaging/AppleBusinessChatTemplates/custom-interactive-message-template.md
@@ -0,0 +1,248 @@
+---
+pagename: Custom Interactive Message Template
+Keywords:
+sitesection: Documents
+categoryname: "Rich Messaging"
+documentname: Apple Messages for Business Templates
+permalink: apple-messages-for-business-templates-custom-interactive-message-template.html
+indicator: messaging
+---
+
+### Overview
+
+The Custom Interactive Message (CIM) Template for App Messages for Business allows you to invoke an iOS iMessage app / extension on the consumer device. This app can allow for a wide range of interactivity without requiring the consumer to leave the conversation.
+
+Sending the structured content templates (body and metadata) explained in this document will allow you to send the iMessage app / extension to the consumer device.
+
+For how to create an iMessage app / extension, see the Apple documentation [here](https://developer.apple.com/imessage/).
+
+### Body Template
+
+The structured content body will allow you to define the layout of the bubble representation in the agent workspace transcript as structured content basic elements.
+
+Please note that the structured content body layout will **not** be represented on the consumer device. The body will help you to create a visual representation in Conversational Cloud for conversational context, transcript and historic records, as well as ease of use for agents.
+
+In order to allow you to report on the number of times an iMessage app was sent from an agent widget during a conversation, make sure to add a unique identifier in the structured content body for each type of iMessage app you use. This will allow you to search transcripts and track how many times a specific app was sent.
+
+For the structured content body fields descriptions and different layout options please refer to [Getting Started with Structured Content.](getting-started-with-rich-messaging-introduction.html)
+
+### Metadata Template
+
+The structured content metadata will allow you to define which iMessage app / extension should be sent to the consumer and which custom data to pass into the iMessage app / extension when it loads.
+
+Using Metadata, you can also control the visual appearance of the bubble that displays to the consumer. This is done with the `receivedMessage` object within the metadata.
+
+#### Metadata Properties
+
+| Property Name | +Description | +Type | +Required | + + +
| type | +Type of metadata. Must be BusinessChatCustomMessage | +Enum | +Y | +
| appId | +The App Store identifier of the custom Messages framework extension | +Integer | +N | +
| appName | +The name of the custom Messages framework extension. | +String | +N | +
| bid | +Identifies the Messages framework extension that the customer interacts with while using Messages. It is composed along with the extension bundleID, and teamID | +String | +Y | +
| sessionIdentifier | +Valid UUID string, you must generate. This could represent a message or a group or messages that identifies the session or transaction | +String | +N | +
| useLiveLayout | +A flag that determines if Live Layout is enabled. The default is false. | +Boolean | +N | +
| receivedMessage | +Bubble displayed when interactive message is received and LiveLayout is set to false | +Object | +Y | +
| URL | +The URL to the data that is sent to the Messages framework extension. Should be sent encoded | +String | +Y | +
| Property Name | +Description | +Type | +Required | + + +
| title | +The title of the bubble | +String | +Y | +
| subtitle | +Subtitle to be displayed under title in bubble | +String | +N | +
| secondarySubtitle | +Title that is aligned right | +String | +N | +
| tertiarySubtitle | +Subtitle that is aligned right | +String | +N | +
| imageTitle | +The title of the image attachment. | +String | +N | +
| image Subtitle | +The subtitle of the image attachment. | +String | +N | +
| imageURL | +Image to be placed in the iMessage app bubble layout. Will be presented when LiveLayout is disabled or when consumer does not have your app installed on iPhone / latest version is not updated with iMessage app / extension | +String | +N | +
Defaults to icon. | String | N | | +| title | The title of the message | String | Y | 85 characters (30 is recommended by Apple) | +| Subtitle | Subtitle to be displayed under title of the message | String | N | 400 characters (85 is recommended by Apple) | +| imageURL | Image to be placed in the List Picker received and reply message template | String | N | JPG and PNG Only
The total image size in the list picker is limited to 0.5MB | +| secondarySubtitle | Title that is aligned right of the message | String | Y | | +| tertiarySubtitle | Subtitle that is aligned right of the message | String | Y | | + + +#### Metadata JSON Example + +```json +[ + { + "type": "BusinessChatMessage", + "multipleSelection":[true,false] + "receivedMessage": { + "style": "icon", + "subtitle": "Select your favorite", + "title": "Beautiful flowers", + "secondarySubtitle": "secondary subtitle", + "tertiarySubtitle": "tertiarySubtitle", + "imageURL": "https://i.pinimg.com/736x/a0/67/5e/a0675e5161d7ae5be2550987f397a641--flower-shops-paper-flowers.jpg" + }, + "replyMessage": { + "style": "large", + "subtitle": "", + "title": "Your selection", + "secondarySubtitle": "secondarySubtitle", + "tertiarySubtitle": "tertiarySubtitle", + "imageURL": "https://i.pinimg.com/736x/a0/67/5e/a0675e5161d7ae5be2550987f397a641--flower-shops-paper-flowers.jpg" + } + } +] +``` + +### Body - Overview + +The List Picker Body JSON is based on [this JSON template](#body-json-template). + +#### List Picker Body JSON Properties + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :---------------------------------------------- | :------- | :------- | :--------- | +| type | Type of the element.
Must be “vertical” | string | Y | | +| tag | Must be “list” | String | Y | | +| elements | List of Time Picker elements | Elements | Y | | + +View the [List Picker Header](#body---list-picker-header) and [List Picker Item](#body---list-picker-items) sections for details on how to construct the List Picker Body JSON. + +#### List Picker Body JSON Example + +```json +{ + "type": "vertical", + "tag": "list", + "elements": [ + { + "type": "vertical", + "elements": [ + { + "type": "text", + "text": "Flowers", + "tooltip": "text tooltip", + "style": { + "bold": true, + "size": "large" + } + }, + { + "type": "horizontal", + "elements": [ + { + "type": "image", + "url": "https://i.pinimg.com/736x/60/38/93/603893c655392b2c623a516f0a8c014c--wildflower-bouquet-dahlia-bouquet.jpg", + "tooltip": "Spring flowers" + }, + { + "type": "vertical", + "elements": [ + { + "type": "text", + "tag": "title", + "text": "Spring bouquet", + "tooltip": "Spring bouquet", + "style": { + "bold": true, + "size": "large" + } + }, + { + "type": "text", + "tag": "subtitle", + "text": "Wild flowers", + "tooltip": "Wild flowers" + }, + { + "type": "button", + "tooltip": "Add to cart", + "title": "Add to cart", + "click": { + "actions": [ + { + "type": "publishText", + "text": "Spring bouquet" + } + ], + "metadata": [ + { + "type": "ExternalId", + "id": "Spring bouquet" + } + ] + } + } + ] + } + ] + }, + { + "type": "horizontal", + "elements": [ + { + "type": "image", + "url": "http://www.gamttep.com/wp-content/uploads/2017/03/wedding-bouquets-flowers-pleasant-design-ideas-13-1000-ideas-about-on-pinterest.jpg", + "tooltip": "Spring flowers" + }, + { + "type": "vertical", + "elements": [ + { + "type": "text", + "tag": "title", + "text": "Bday flowers", + "tooltip": "Bday flowers", + "style": { + "bold": true, + "size": "large" + } + }, + { + "type": "text", + "tag": "subtitle", + "text": "Mix flowers", + "tooltip": "Mix flowers" + }, + { + "type": "button", + "tooltip": "Add to cart", + "title": "Add to cart", + "click": { + "actions": [ + { + "type": "publishText", + "text": "published text button tap" + } + ] + } + } + ] + } + ] + } + ] + } + ] +} +``` + +### Body - List Picker Header + +The List Picker Header consists of a Title and a Subtitle. + +The configuration of the header is done as part of the [List Picker Body JSON](#body-overview). + +#### List Picker Header Title + +##### Properties + +Based on the [Structured Content Basic Element Text](structured-content-introduction-to-structured-content.html#text) with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :------------------------------------------------------------------------------------------------------------ | :-------- | :------- | :--------- | +| type | Type of element.
Must be ‘text’ | Enum | Y | | +| style | Styling elements of the title. Must have the following properties:
{ "bold":true,
"size":"large"} | Container | N | | +| tag | Must be “title” | String | Y | | + +##### Example + +```json +{ + "type": "text", + "text": "Flowers", + "tag": "title", + "tooltip": "text tooltip", + "style": { + "bold": true, + "size": "large" + } +} +``` + +#### List Picker Header Subtitle + +##### Properties + +Based on the [Structured Content Basic Element Text](structured-content-introduction-to-structured-content.html#text) with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :-------------------------------------- | :----- | :------- | :--------- | +| type | Type of element.
Must be ‘text’ | Enum | Y | | +| tag | Must be “subtitle” | String | Y | | + +**Note: the subtitle section should not use style element** + +##### Example + +```json +{ + "type": "text", + "text": "Wild flowers", + "tag": "subtitle", + "tooltip": "text tooltip" +} +``` + +### Body - List Picker Items + +Each List Picker Item consists of an image (optional), a title, a subtitle and a button, ordered in a horizontal template. + +The configuration of the List Picker Item is done as part of the [List Picker Body JSON](#body-overview). + +#### List Picker Item Properties + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :--------------------------------------------------------------------------------------------- | :------- | :------- | :--------- | +| type | Type of template.
Must be ‘horizontal’ | Enum | Y | | +| elements | Array of elements: image (optional), title, subtitle and a button.
Must be in that order | Elements | Y | | + + +#### List Picker Item Elements Configurations + +The List Picker Item elements are based on the basic [Structured Content basic elements](structured-content-introduction-to-structured-content.html#basic-elements) with some limitations. + +The following section describes those elements and their specific configuration properties. + +##### Image Element Properties + +Based on the [Structured Content Basic Element Image](structured-content-introduction-to-structured-content.html#image) element with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :------------------------------------------------------------------ | :----- | :------- | :--------- | +| type | Type of element.
Must be 'image' | Enum | Y | | +| uri | Image URL.
Must be whitelisted by a LivePerson representative | String | Y | | + +**Note: The image section should not use style element** + +##### Title Element Properties + +Based on the [Structured Content Basic Element Text](structured-content-introduction-to-structured-content.html#text) element with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :------------------------------------------------------------------------------------------------------------ | :-------- | :------- | :--------- | +| type | Type of element.
Must be 'text' | Enum | Y | | +| style | Styling elements of the title. Must have the following properties:
{ "bold":true,
"size":"large"} | Container | Y | | +| tag | Must be “title” | String | Y | | + +##### Subtitle Element Properties + +Based on the [Structured Content Basic Element Text](structured-content-introduction-to-structured-content.html#text) element with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :------------------------------------ | :----- | :------- | :--------- | +| type | Type of element.
Must be 'text' | Enum | Y | | +| tag | Must be “subtitle” | String | Y | | + +**Note: The subtitle section should not use style element** + +##### Button Element Properties + +Based on the [Structured Content Basic Element Button](structured-content-introduction-to-structured-content.html#button) element with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :------------------------------------------------- | :--- | :------- | :--------- | +| type | Type of element.
Must be 'button' | Enum | Y | | +| click | Click operation must use “publishText” type only | Enum | Y | | + +**Note: The button section should not use style element** + + +#### List Picker Item JSON Example + +```json +{ + "Type": "horizontal", + "elements": [ + { + "type": "image", + "url": "https://cdn.macrumors.com/article-new/2017/09/Flowersexfrontback-800x573.jpg", + "tooltip": "Flowerse X" + }, + { + "type": "vertical", + "elements": [ + { + "type": "text", + "tag": "title", + "text": "Flowerse X", + "tooltip": "Title", + "style": { + "bold": true, + "size": "large" + } + }, + { + "type": "text", + "tag": "subtitle", + "text": "Black", + "tooltip": "Black" + }, + { + "type": "button", + "tooltip": "Add to cart", + "title": "Add to cart", + "click": { + "actions": [ + { + "type": "publishText", + "text": "Flowerse X Added" + } + ], + "metadata": [ + { + "type": "ExternalId", + "id": "Flowerse X" + } + ] + } + } + ] + } + ] +} +``` diff --git a/pages/Documents/RichMessaging/AppleBusinessChatTemplates/rich-links-template.md b/pages/Documents/RichMessaging/AppleBusinessChatTemplates/rich-links-template.md new file mode 100644 index 0000000000..47d41a2f9f --- /dev/null +++ b/pages/Documents/RichMessaging/AppleBusinessChatTemplates/rich-links-template.md @@ -0,0 +1,60 @@ +--- +pagename: Rich Links Template +Keywords: +sitesection: Documents +categoryname: "Rich Messaging" +documentname: Apple Messages for Business Templates +permalink: apple-messages-for-business-templates-rich-links-template.html +indicator: messaging +--- + +### Overview + +Apple has provided a new type of message that allows you to send rich links to the consumer device. + +When sending a plain URL link (eg. `https://www.apple.com`) through Apple Messages for Business, it will show "Tap to Load" by default on the consumer device. This requires the consumer to tap before seeing the preview in the message transcript. + +You can now override this default "Tap to Load" behavior by sending a rich link stuctured content template instead of a plain URL. + +Rich link configurable content includes: + +* Bubble title text +* Link preview image +* Link button URL + +*Consumer view of rich links template* + +
+
+*Agent view of rich links template*
+
+
+
+### Example Template
+
+Only the Structured Content body is needed for Rich Links.
+
+```json
+{
+ "type": "vertical",
+ "tag": "richLink",
+ "elements": [
+ {
+ "type": "image",
+ "url": "https://cdn.macrumors.com/article-new/2017/09/iphonexfrontback-800x573.jpg"
+ },
+ {
+ "type": "button",
+ "title": "Apple’s iPhone X",
+ "click": {
+ "actions": [
+ {
+ "type": "link",
+ "uri": "https://www.apple.com"
+ }
+ ]
+ }
+ }
+ ]
+}
+```
diff --git a/pages/Documents/RichMessaging/AppleBusinessChatTemplates/time-picker-template.md b/pages/Documents/RichMessaging/AppleBusinessChatTemplates/time-picker-template.md
new file mode 100644
index 0000000000..3953423707
--- /dev/null
+++ b/pages/Documents/RichMessaging/AppleBusinessChatTemplates/time-picker-template.md
@@ -0,0 +1,469 @@
+---
+pagename: Time Picker Template
+redirect_from:
+ - rich-messaging-connectors-abc-timepicker.html
+ - structured-content-apple-messages-for-business-templates-time-picker-template.html
+Keywords:
+sitesection: Documents
+categoryname: "Rich Messaging"
+documentname: Apple Messages for Business Templates
+permalink: apple-messages-for-business-templates-time-picker-template.html
+indicator: messaging
+---
+
+### Overview
+
+[Messages for Business Time Picker](https://developer.apple.com/documentation/businesschatapi/messages_sent/interactive_messages/time_picker) enables human or automated agents to send available time slots when consumers are looking to schedule an appointment with the brand’s various services. Time picker allows the consumer to select the relevant time slot, and reply back with the time selected.
+
+The following capabilities are supported:
+
+1. **receivedMessage and replyMessage** bubbles style structures (which are the templates for the bubbles that are received by the consumer and then sent back by the consumer). This allows the brand to create a Time Picker with bubbles containing title, subtitle, style size and image.
+
+2. **Timeslots** - Enables the agent to generate an array of time slots for the consumer’s options.
+
+3. **Time zone offset** - Represents the number of minutes from GMT, while specifying the timezone of the event’s location. If not set, times are shown according to the customer’s current time zone. If set, the times are shown according to the event’s time zone, regardless of the customer’s location.
+
+4. **Location** - Enables the brand to add a describer to the appointment location, allowing the consumer to immediately see the location once an appointment is saved in the calendar.
+
+By Using the using metadata properties, the brand can also define the received and reply bubble structures.
+
+Below is an example image of a Messages for Business time picker:
+
+ 
+
+### Basic Template Overview
+
+In order to comply with the Apple Messages for Business JSON structure, the below Conversational Cloud structured content JSON structure must be applied to any Time Picker template.
+
+Each Time Picker template has the following mandatory sections:
+
+1. [Business Event](#metadata---business-event) (part of the metadata JSON): defines the object as a time picker object for Apple Messages for Business. This section includes timing and location properties.
+
+2. [Messages for Business Message](#metadata---business-chat-message) (part of the metadata JSON): defines the received and reply messages.
+
+3. [Time Picker Items](#body---time-picker-items) (part of the JSON body): defines the dates available and the time slots for selection as part of the Time Picker.
+
+The following JSON metadata and body structures are templates for any Time Picker object:
+
+#### Metadata JSON template
+
+```json
+[
+ {
+ "type": "BusinessEvent",
+ "timing": {
+ "presentedTimezoneOffset": GMT TIME OFFSET IN MINUTES
+ },
+ "location": {
+ "title": "title",
+ "la": LATITUDE,
+ "lo": LONGITUDE,
+ "radius": RADIUS
+ },
+ "title": "TITLE OF THE CALENDAR MEETING"
+ },
+ {
+ "type": "BusinessChatMessage",
+ "receivedMessage": {
+ "title": "THIS IS THE TITLE",
+ "imageURL": "HTTPS URL OF THE IMAGE",
+ "style": "small",
+ "subtitle": "THIS IS THE SUBTITLE"
+ },
+ "replyMessage": {
+ "title": "THIS IS THE TITLE",
+ "style": "large",
+ "imageURL": "HTTPS URL OF THE IMAGE",
+ "subtitle": "THIS IS THE SUBTITLE"
+ }
+ }
+]
+```
+
+#### Body JSON Template
+
+```json
+{
+ "type": "vertical",
+ "tag": "datePicker",
+ "elements": [
+ {
+ ///TITLE OF THE TIME PICKER
+ "type": "text",
+ "text": "THIS IS THE TITLE",
+ "tag": "Title",
+ "style": {
+ "bold": true,
+ "size": "large"
+ }
+ },
+ {
+ ///SUBTITLE OF THE TIME PICKER
+ "type": "text",
+ "text": "THIS IS THE SUBTITLE",
+ "tag": "subtitle"
+ },
+ ///START TIME PICKER ITEM ###1
+ {
+ "type": "text",
+ "text": "ITEM TITLE AS A DATE"
+ },
+ {
+ "type": "horizontal",
+ "elements": [
+ ///LIST OF AVAILABLE TIME SLOTS FOR ITEM ###1
+ {
+ ///TIME SLOT ###1
+ "type": "button",
+ "title": "THIS IS THE TIME SLOT HOUR",
+ "click": {
+ "metadata": [
+ {
+ "type": "ExternalId",
+ "id": "ON-CLICK EXTERNAL ID"
+ },
+ {
+ "type": "BusinessEvent",
+ "timing": {
+ "startTime": "DATE OBJECT",
+ "duration": DURATION OF THE TIME SLOT IN SECONDS
+ }
+ }
+ ],
+ "actions": [
+ {
+ "type": "publishText",
+ "text": "ON-CLICK CONFIRMATION TEXT"
+ }
+ ]
+ }
+ }///END OF TIME SLOT ###1,
+ {
+ ///TIME SLOT ###2
+ },
+ {
+ ///TIME SLOT ###3
+ },
+ ///ETC
+ ]
+ }///END OF TIME PICKER ITEM ###1,
+ {
+ ///TIME PICKER ITEM ###2
+ },
+ {
+ ///TIME PICKER ITEM ###3
+ },
+ ///ETC
+ ]
+}
+```
+
+### Metadata - Messages for Business Message
+
+Part of the Time Picker Conversational Cloud Structured Content metadata JSON.
+
+#### Properties
+
+| Property Name | Description | Type | Required | Size Limit |
+| :-------------- | :------------------------------------------------------------------------------------ | :----- | :------- | :--------- |
+| type | Type of metadata. Must be 'BusinessChatMessage' | Enum | Y | | +| receivedMessage | Defines how the bubble template will be displayed when a message is received. | Object | Y | | +| replyMessage | Defines how the bubble will be displayed when a message is sent back by the consumer. | Object | N | | + + +#### Received and Reply messages + +The Received Message is the first card presented to the consumer, from which they access the available timeslots to choose from. It consists of an image, title, subtitle and style. + +The Reply Message is the reply card presented to the consumer after selecting the time from the picker. It consists of an image, title, subtitle and style. + +| Property Name | Description | Type | Required | Size Limit | +| :---------------- | :----------------------------------------------------------------------------------------------- | :----- | :------- | :-------------------------------------------------------------------------- | +| Style | Defines the size of the message.
Can be set to icon, small or large.
Defaults to icon. | String | N | | +| title | The title of the message | String | Y | 85 characters (30 is recommended by Apple) | +| Subtitle | Subtitle to be displayed under title of the message | String | N | 400 characters (85 is recommended by Apple) | +| imageURL | Image to be placed in the Time Picker received and reply message template | String | N | JPG and PNG Only
The image size in the Time Picker is limited to 0.5MB | +| secondarySubtitle | Title that is aligned to the right of the message | String | N | | +| tertiarySubtitle | Subtitle that is aligned to the right of the message | String | N | | + +#### Example + +```json +{ + "type": "BusinessChatMessage", + "receivedMessage": { + "title": "Available appointments", + "imageURL": "https://cdn.dribbble.com/users/85668/screenshots/1352116/dribblble_mock_1x.jpg", + "style": "small", + "subtitle": "Please select your preferred time" + }, + "replyMessage": { + "title": "Selected time", + "style": "large", + "imageURL": "https://cdn.dribbble.com/users/85668/screenshots/1352116/dribblble_mock_1x.jpg", + "subtitle": "Time selected!" + } +} +``` + +### Metadata - Business Event + +Part of the Time Picker Conversational Cloud Structured Content metadata JSON. Defines the object as a time picker object for Apple Messages for Business. This section includes timing and location properties. + +#### Properties + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :------- | :--------- | +| type | Type of metadata.
Must be 'BusinessEvent' | Enum | Y | | +| Timing | Defines the GMT time offset configuration | Object | N | | +| location | Enables the brand to add a descriptor to the appointment location, allowing the consumer to immediately see the location once appointment is saved in the calendar | Object | N | | +| title | Title of the calendar meeting | String | Y | | + + +#### Timing Object Properties + +| Property Name | Description | Type | Required | Size Limit | +| :---------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--- | :------- | :--------- | +| presentedTimezoneOffset | Time zone offset configuration. Represents the number of minutes from GMT, while specifying the timezone of the event’s location.
If not set, times are shown according to the customer’s current time zone. If set, the times are shown according to the event’s time zone, regardless of the customer’s location | Enum | N | | + + +#### Location Object Properties + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :-------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :------- | :--------- | +| title | Location name | String | N | | +| la | A double representing the latitude of the location | double | N | | +| lo | A double representing the longitude of the location | double | N | | +| radios | A double representing the location radius, in meters.
Messages for Business ignores this property when latitude and longitude are missing or empty. | double | N | | + +#### Example + +```json +{ + "type": "BusinessEvent", + "timing": { + "presentedTimezoneOffset": 120 + }, + "location": { + "title": "LivePerson ATC Mannheim", + "la": 49.4872955, + "lo": 8.4682869, + "radius": 10 + }, + "title": "Technician Visit" +} +``` + +### Body - Time Picker Items + +Part of the Time Picker Conversational Cloud Structured Content body JSON, enabling an agent to generate an array of time slots for the consumer’s options. + +The Time Picker item elements consists of a title element and a row of available time slots per specific date to choose from. + +They are based on the Structured Content [basic elements](structured-content-introduction-to-structured-content.html#basic-elements) with some limitations. + +The following section describes those elements and their specific configuration properties. + +#### Template Properties + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :----------------------------------------------- | :------- | :------- | :--------- | +| type | template of the element.
Must be “vertical” | string | Y | | +| tag | Must be “datePicker” | String | Y | | +| elements | List of time picker elements | Elements | Y | | + +#### Text Element Properties + +Based on [Structured Content Basic Element Text](structured-content-introduction-to-structured-content.html#text) with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :----------------------------------------- | :----- | :------- | :--------- | +| type | Type of the element.
Must be “text” | string | Y | | +| text | Must be “datePicker” | String | Y | | + +**Note: The text section should not use style element** + + +#### Time slot Element Properties + +Based on [Structured Content Basic Element Button](structured-content-introduction-to-structured-content.html#button) with the following restrictions: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :-------------------------------------------------------------------------------------- | :----- | :------- | :--------- | +| type | Type of the element.
Must be “button” | string | Y | | +| title | The hour of the time slot.
Only affects non-Apple Messages for Business rendering clients. | String | Y | | + +**Note: The button section should not use style element** + +
+Time Picker button has additional [Click Metadata](structured-content-introduction-to-structured-content.html#element-click-operations) parameters that are specific to Apple Messages for Business: + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :-------------------------------------------------------------------- | :----- | :------- | :--------- | +| type | Type of the element.
Must be “BusinessEvent” | string | Y | | +| timing | An object describing the start time and the duration of the time slot | Object | Y | | + + +**Timing Object Properties** + +| Property Name | Description | Type | Required | Size Limit | +| :------------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------ | :------- | :--------- | +| startTime | A UTC date string, represented by a valid date in ISO-8601 format and specified as absolute GMT +0000 date; for example, 2018-05-26T08:27:55+00:00, 2018-05-26T08:27:55+0000, or 2018-05-26T08:27:55Z | string | Y | | +| Duration | An integer representing the duration of the time slot, in seconds | integer | Y | | + + +#### Example + +```json +{ + "type": "text", + "text": "Tuesday, July 6" +}, +{ + "type": "horizontal", + "elements": [ + { + "type": "button", + "title": "11:30", + "click": { + "metadata": [ + { + "type": "ExternalId", + "id": "SlotIdentidier" + }, + { + "type": "BusinessEvent", + "timing": { + "startTime": "2019-07-06T11:30:00Z", + "duration": 3600 + } + } + ], + "actions": [ + { + "type": "publishText", + "text": "Technician visit: 7/6/2018 11:30 IST" + } + ] + } + } + ] +} +``` + +### Example + +#### Time Picker Metadata + +```json +[ + { + "type": "BusinessEvent", + "timing": { + "presentedTimezoneOffset": 120 + }, + "location": { + "title": "LivePerson ATC Mannheim", + "la": 49.4872955, + "lo": 8.4682869, + "radius": 10 + }, + "title": "Technician Visit" + }, + { + "type": "BusinessChatMessage", + "receivedMessage": { + "title": "Available appointments", + "imageURL": "https://cdn.dribbble.com/users/85668/screenshots/1352116/dribblble_mock_1x.jpg", + "style": "small", + "subtitle": "Please select your preferred time" + }, + "replyMessage": { + "title": "Selected time", + "style": "large", + "imageURL": "https://cdn.dribbble.com/users/85668/screenshots/1352116/dribblble_mock_1x.jpg", + "subtitle": "Time selected!" + } + } +] +``` + + +#### Time Picker Body + +```json +{ + "type": "vertical", + "tag": "datePicker", + "elements": [ + { + "type": "text", + "text": "Select Date", + "tag": "Title", + "style": { + "bold": true, + "size": "large" + } + }, + { + "type": "text", + "text": "Tuesday, July 6" + }, + { + "type": "horizontal", + "elements": [ + { + "type": "button", + "title": "11:30", + "click": { + "metadata": [ + { + "type": "ExternalId", + "id": "SlotIdentidier" + }, + { + "type": "BusinessEvent", + "timing": { + "startTime": "2019-07-06T11:30:00Z", + "duration": 3600 + } + } + ], + "actions": [ + { + "type": "publishText", + "text": "Technician visit: 7/6/2019 11:30 IST" + } + ] + } + }, + { + "type": "button", + "title": "12:00", + "click": { + "metadata": [ + { + "type": "ExternalId", + "id": "SlotIdentidier" + }, + { + "type": "BusinessEvent", + "timing": { + "startTime": "2019-07-06T12:00:00Z", + "duration": 3600 + } + } + ], + "actions": [ + { + "type": "publishText", + "text": "Technician visit: 7/6/2019 12:00 IST" + } + ] + } + } + ] + } + ] +} +``` diff --git a/pages/Documents/RichMessaging/AppleMessagesForBusinessTemplates/apple-auth-template.md b/pages/Documents/RichMessaging/AppleMessagesForBusinessTemplates/apple-auth-template.md index 0decf35f24..f47efbe729 100644 --- a/pages/Documents/RichMessaging/AppleMessagesForBusinessTemplates/apple-auth-template.md +++ b/pages/Documents/RichMessaging/AppleMessagesForBusinessTemplates/apple-auth-template.md @@ -133,11 +133,8 @@ Please use the metadata template with the relevant fields, as presented in the e "requestIdentifier": "Insert Your Unique Request Key Here", "apple": { "oauth2": { - "clientSecret": "A string indicating the secret provisioned by the authorization server.", - "scope": "Insert your scope here. Ex.['email','profile']", - "responseType": "A string indicating the type of authentication request" - "responseEncryptionKey": "Insert your public key here", - "state": "A string indicating the state of the authentication request." + "scope": "Insert Your scope here. Ex.['email','profile']", + "responseEncryptionKey": "Insert Your Public Key Here" } } } @@ -156,13 +153,13 @@ Please use the metadata template with the relevant fields, as presented in the e
Business Chat ignores this property when latitude and longitude are missing or empty. | double | N | | +| radios | A double representing the location radius, in meters.
Messages for Business ignores this property when latitude and longitude are missing or empty. | double | N | | #### Example diff --git a/pages/Documents/RichMessaging/GettingStartedwithRichMessaging/introduction.md b/pages/Documents/RichMessaging/GettingStartedwithRichMessaging/introduction.md index 14609ad2d0..73ef7b9d4c 100644 --- a/pages/Documents/RichMessaging/GettingStartedwithRichMessaging/introduction.md +++ b/pages/Documents/RichMessaging/GettingStartedwithRichMessaging/introduction.md @@ -214,7 +214,7 @@ Each structured content template will contain one or more **elements** in the `e | tag | Further specifies the template type | String | N | | elements | List of element objects | Array | Y | -All templates will consist of an object that holds the elements array. The object will always have a type and optionally have a tag. The tag is only relevant when using third party connectors like Facebook Messenger, Apple Business Chat, etc. +All templates will consist of an object that holds the elements array. The object will always have a type and optionally have a tag. The tag is only relevant when using third party connectors like Facebook Messenger, Apple Messages for Business, etc. There is an additional property for Horizontal type only: @@ -238,7 +238,7 @@ There is an additional property for Horizontal type only: Below you will find basic elements, their styling, and their click operations, that are common within all templates. -When you are comfortable with the basic elements, you can see them in action in the various templates for Mobile SDK and Web, Facebook Messenger, Apple Business Chat, etc. +When you are comfortable with the basic elements, you can see them in action in the various templates for Mobile SDK and Web, Facebook Messenger, Apple Messages for Business, etc. ### Basic Elements diff --git a/pages/Documents/RichMessaging/MobileSDKandWebTemplates/multiple-checklist-template.md b/pages/Documents/RichMessaging/MobileSDKandWebTemplates/multiple-checklist-template.md index 79d2bea940..02946a4366 100644 --- a/pages/Documents/RichMessaging/MobileSDKandWebTemplates/multiple-checklist-template.md +++ b/pages/Documents/RichMessaging/MobileSDKandWebTemplates/multiple-checklist-template.md @@ -115,7 +115,7 @@ The consumer selections will be displayed as a consumer message in the agent wor }, { "type": "checkbox", - "text": "Apple Business Chat", + "text": "Apple Messages for Business", "borderLine": true, "borderColor": "#d4d4d5", "click": { @@ -128,7 +128,7 @@ The consumer selections will be displayed as a consumer message in the agent wor "actions": [ { "type": "checked", - "publishText": "Apple Business Chat" + "publishText": "Apple Messages for Business" } ] } diff --git a/pages/Documents/Security&Authentication/AppleBusinessChatAuthentication/overview.md b/pages/Documents/Security&Authentication/AppleBusinessChatAuthentication/overview.md index 6885b3162c..4a18d34b14 100644 --- a/pages/Documents/Security&Authentication/AppleBusinessChatAuthentication/overview.md +++ b/pages/Documents/Security&Authentication/AppleBusinessChatAuthentication/overview.md @@ -8,6 +8,6 @@ permalink: apple-business-chat-authentication-overview.html indicator: messaging --- -In order to implement authentication for Apple Business Chat, you will need to use the [Apple Auth rich messaging template explained here](apple-business-chat-templates-apple-auth-template.html). +In order to implement authentication for Apple Messages for Business, you will need to use the [Apple Auth rich messaging template explained here](apple-messages-for-business-templates-apple-auth-template.html). When clicked, this rich messaging template will interact with your own OAuth 2.0 service. \ No newline at end of file