This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
V8.0 Page 1 of 23
CR009R02 RCC.07 Rich Cards and Suggested Chip Lists Maintenance
Document Information Document Author Michael Thiel (Google)
Additional Contributors
Document Status Approved
Type of Change New Feature Major
Change Bug fix x Editorial
Target Document
RCC.07 x RCC.08 RCC.09 RCC.10
RCC.11 RCC.13 RCC.14 RCC.15
RCC.20 RCC.61 NG.102 IR.90
Other
Impact on other documents
RCC.07 RCC.08 RCC.09 RCC.10
RCC.11 RCC.13 RCC.14 RCC.15
RCC.20 RCC.61 NG.102 IR.90
Other
Related CRs Document Summary and Reason for Change
Minor changes to Rich Cards and Suggested Chip Lists: - Introducing file sizes for media objects within Rich Cards; - Introducing content description for media objects within Rich Cards (to improve accessibility e. g. for
use with screen readers); - Introducing support for location search queries (e. g. “restaurants”) for the ‘showLocation’ suggested
action; - Changing postback JSON object to be optional instead of mandatory for suggestions
Version History (to be completed by editor) Date Version Author / Comments 2017-07-28 R00 Michael Thiel (Google) / Initial version
2017-08-02 R01 Michael Thiel (Google) / Integrated first round of feedback from GSG meeting on 2017-08-01
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
V8.0 Page 2 of 23
Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
Version 8.0 28 June 2017
This is a Non-binding Permanent Reference Document of the GSMA
Security Classification: Non-confidential Access to and distribution of this document is restricted to the persons permitted by the security classification. This document is confidential to the Association and is subject to copyright protection. This document is to be used only for the purposes for which it has been supplied and information contained in it must not be disclosed or in any other way made available, in whole or in part, to persons other than those permitted under the security classification without the prior written approval of the Association.
Disclaimer The GSM Association (“Association”) makes no representation, warranty or undertaking (express or implied) with respect to and does not accept any responsibility for, and hereby disclaims liability for the accuracy or completeness or timeliness of the information contained in this document. The information contained in this document may be subject to change without prior notice.
Antitrust Notice The information contain herein is in full compliance with the GSM Association’s antitrust compliance policy.
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
V8.0 Page 15 of 23
] } }, "required": ["deviceAction"] }, "settingsAction": { "title": "Suggested actions for interacting with app settings", "properties": { "settingsAction": { "type": "object", "oneOf": [{ "properties": { "disableAnonymization": { "title": "Ask the user to disable the anonymization setting.", "type": "object" } }, "required": ["disableAnonymization"] }, { "properties": { "enableDisplayedNotifications": { "title": "Ask the user to enable sending displayed notifications.", "type": "object" } }, "required": ["enableDisplayedNotifications"] } ] } }, "required": ["settingsAction"] } } }, "sharedData": { "deviceSpecifics": { "title": "Device specifics shared by the client with the chatbot platform.", "type": "object", "properties": { "deviceModel": { "title": "Short description of the device model (e. g. 'SmartPhone8').", "type": "string", "minLength": 1, "maxLength": 20 }, "platformVersion": { "title": "Version information about the device platform (e. g. 'Android-7.1.2-N481G3').", "type": "string", "minLength": 1, "maxLength": 25 }, "clientVendor": { "title": "Short code for client vendor, same as used during RCS autoconfiguration (e. g. 'VNDR').", "type": "string", "minLength": 1, "maxLength": 4
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
V8.0 Page 16 of 23
}, "clientVersion": { "title": "Version information about the client, same as used during RCS autoconfiguration (e. g. 'RCSAndrd-1.0')", "type": "string", "minLength": 1, "maxLength": 15 }, "batteryRemainingMinutes": { "title": "Remaining battery use of device in minutes (e. g. '517')", "type": "integer", "minimum": 0 } } } } } }
Table 1: JSON message payloads schema
3.6.10.5 Types of Rich Cards
3.6.10.5.1 Single Rich Card
3.6.10.5.1.1 JSON data format diagram
3.6.10.5.1.2 Example JSON payload
The following payload is an example for a Single Rich Card including suggested replies and suggested actions: { "message": { "generalPurposeCard": { "layout": { "cardOrientation": "HORIZONTAL", "imageAlignment": "LEFT" }, "content": { "media": { "mediaUrl": "https://cdn.server/path/media.mp4", "mediaContentType": "video/mp4", "mediaFileSize": 2718288, "thumbnailUrl": "https://cdn.server/path/media.png", "thumbnailContentType": "image/png", "thumbnailFileSize": 314159, "height": "MEDIUM_HEIGHT", "contentDescription": "Textual description of media content, e. g. for use with screen readers." }, "title": "This is a single rich card.", "description": "This is the description of the rich card. It's the first field that will be truncated if it exceeds the maximum width or height of a card.", "suggestions": [{ "reply": { "displayText": "No", "postback": { "data": "set_by_chatbot_reply_no"
Table 2: Chatbot communication Single Rich Card example
3.6.10.5.2 Carousel of Rich Cards
3.6.10.5.2.1 JSON data format diagram
3.6.10.5.2.2 Example JSON payload
Two or more (up to ten) cards can be combined into a carousel. The following payload is an example for a carousel of cards including suggested replies and suggested actions: { "message": { "generalPurposeCardCarousel": { "layout": { "cardWidth": "MEDIUM_WIDTH" }, "content": [{ "media": { "mediaUrl": "https://cdn.server/path/media.mp4", "mediaContentType": "video/mp4", "mediaFileSize": 2718288, "thumbnailUrl": "https://cdn.server/path/media.png", "thumbnailContentType": "image/png",
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
V8.0 Page 18 of 23
"thumbnailFileSize": 314159, "height": "SHORT_HEIGHT", "contentDescription": "Textual description of media content, e. g. for use with screen readers." }, "title": "This is the first rich card in a carousel.", "description": "This is the description of the rich card. It's the first field that will be truncated if it exceeds the maximum width or height of a card.", "suggestions": [{ "action": { "mapAction": { "showLocation": { "location": { "latitude": 37.4220041, "longitude": -122.0862515, "label": "Googleplex" }, "fallbackUrl": "https://www.google.com/maps/@37.4219162,-122.078063,15z" } }, "displayText": "Show location on a map", "postback": { "data": "set_by_chatbot_open_map" } } }, { "action": { "calendarAction": { "createCalendarEvent": { "startTime": "2017-03-14T00:00:00Z", "endTime": "2017-03-14T23:59:59Z", "title": "Meeting", "description": "GSG review meeting" } }, "displayText": "Schedule Meeting", "postback": { "data": "set_by_chatbot_create_calendar_event" } } } ] }, { "title": "This is the second rich card in the carousel.", "description": "Carousel cards need to specify a card width in the 'layout' section. For small width cards, only short and medium height media are supported.", "[...]": "[...]" } ] } } }
Table 3: Chatbot Communication Carousel Rich card Example
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
V8.0 Page 19 of 23
3.6.10.5.3 Client Processing of Card Media of Rich Cards
3.6.10.6 Suggested Chip List
3.6.10.6.1 Payload from Chatbot Platform to Clients
3.6.10.6.1.1 Suggested Replies
3.6.10.6.1.2 Suggested Actions
Suggested Actions are grouped into seven different categories supporting a total of twelve different suggested actions:
urlAction
openUrl — opens a web site or app via deep linking
dialerAction
dialPhoneNumber — calls a phone number via the user's dialler app dialEnrichedCall — start an Enriched Call via the user’s dialler app dialVideoCall — start a video call via the user’s dialler app
mapAction
showLocation — show location(s) on a map for given coordinates or search query requestLocationPush — request for a one-time geo location push
calendarAction
createCalendarEvent — creates a new event on the user's calendar
composeAction
composeTextMessage — compose a draft text message composeRecordingMessage — compose a draft message and start recording
audio or video
deviceAction
requestDeviceSpecifics — request for a one-time share of device specifics (device model, operating system version, messaging client identifier and version, and remaining battery charge in minutes)
settingsAction
disableAnonymization — ask the user to disable the anonymization setting enableDisplayedNotifications — ask the user to enable sending displayed
notifications
This design allows for easily extending action categories and concrete actions in the future.
Most actions allow fallback URLs in case a user does not have any app of the required type installed. Chatbot platforms can use the fallback URL to suggest an appropriate app to the user.
GSM Association Non-confidential Official Document RCC.07 - Rich Communication Suite 7.0 Advanced Communications Services and Client Specification
V8.0 Page 20 of 23
3.6.10.6.1.3 Example JSON payload
The following payload defines a Suggested Chip List with two suggested replies and all currently supported actions: { "suggestions": [{ "reply": { "displayText": "Yes", "postback": { "data": "set_by_chatbot_reply_yes" } } }, { "reply": { "displayText": "No", "postback": { "data": "set_by_chatbot_reply_no" } } }, { "action": { "urlAction": { "openUrl": { "url": "https://www.google.com" } }, "displayText": "Open website or deep link", "postback": { "data": "set_by_chatbot_open_url" } } }, { "action": { "dialerAction": { "dialPhoneNumber": { "phoneNumber": "+1650253000" } }, "displayText": "Call a phone number", "postback": { "data": "set_by_chatbot_dial_phone_number" } } }, { "action": { "dialerAction": { "dialEnrichedCall": { "phoneNumber": "+1650253000", "subject": "The optional subject for the enriched call" } }, "displayText": "Start enriched call", "postback": { "data": "set_by_chatbot_dial_enriched_call"