נציגי RBM מתקשרים עם המשתמשים באמצעות שליחה וקבלה של הודעות. כדי לשלוח הודעות למשתמשים, הנציג שולח הזמנות לצ'אט ל-RCS Business Messages API. כל בקשה יכולה לכלול טקסט, כרטיס מתקדם, תמונה או סרטון, וגם הצעות לתשובות והצעות לפעולות.
אם תשלחו הודעה למשתמש שהמכשיר שלו לא תומך ב-RCS או שלא הופעל RCS, פלטפורמת RBM תחזיר שגיאת 404. במקרה כזה אפשר לנסות להגיע למשתמש באמצעות השיטות החלופיות שמוגדרות בתשתית.
אם שולחים הודעה למשתמש RCS ברשת שבה הנציג עוד לא הופעל, או ברשת שלא אפשרה תנועת RCS, פלטפורמת RBM תחזיר שגיאת 403.
אם שולחים הודעה עם תכונות שלא נתמכות במכשיר של משתמש, פלטפורמת RBM תחזיר שגיאה ולא תעביר את ההודעה.
הגודל המקסימלי של כל ה-AgentMessage במחרוזת הוא 250KB.
מתבצעת שליחה למשתמש במצב אופליין
פלטפורמת RBM עדיין מקבלת הודעה למשלוח אם הנמען לא מחובר לאינטרנט. אתם מקבלים תגובה של 200 OK, ופלטפורמת RBM שומרת את ההודעה ומנסה לשלוח אותה שוב למשך 30 יום. אין צורך לבקש מ-RBM לשלוח שוב את ההודעה.
הודעות שלא נמסרו ב-RBM נמחקות 30 יום לאחר שנשלחו.
בהתאם לתרחיש לדוגמה של הנציג, כדאי לבטל הודעה שלא נמסרה לפני הזמן הקצוב של 30 יום. ביטול יכול למנוע ממשתמשים אופליין לקבל הודעה מיושנת כשהם חוזרים לאינטרנט. יש כמה דרכים לבטל הודעה:
- שולחים בקשת ביטול כדי להפעיל את הביטול.
- ניתן להגדיר תאריך תפוגה להודעה כדי לבטל את ההודעה באופן אוטומטי בזמן המתאים.
הגדרת תאריך תפוגה להודעה
האם ההודעה של הנציג רלוונטית לזמן? לדוגמה, סיסמאות חד-פעמיות תקפות רק לתקופה קצרה. המבצעים לזמן מוגבל. ותזכורות לפגישות לא רלוונטיות אחרי תאריך הפגישה. כדי להבטיח שההודעות יהיו עדכניות ורלוונטיות, הגדירו תאריך תפוגה להודעה. כך, משתמשים אופליין לא יוכלו לקבל תוכן לא פעיל כשהם חוזרים לאינטרנט. תפוגת התוקף היא גם סימן טוב להפעלת האסטרטגיה החלופית להעברת הודעות, כדי שהמשתמשים יקבלו את המידע שהם צריכים בזמן.
כדי להגדיר תאריך תפוגה להודעה, צריך לציין אחד מהשדות הבאים בהודעת הנציג:
expireTime
: השעה המדויקת לפי שעון UTC שבה יפוג תוקף ההודעה.ttl
(אורך חיים): משך הזמן שחולף לפני תפוגת ההודעה.
לאפשרויות עיצוב וערכים, ראו AgentMessage
.
אחרי שהתוקף של ההודעה יפוג, פלטפורמת RBM תפסיק לנסות להעביר את ההודעה והיא מבוטלת באופן אוטומטי. עם זאת, זה עלול להיכשל במקרים נדירים. לדוגמה, ה-API יכול להפעיל את הביטול בזמן שפלטפורמת RBM הייתה בתהליך העברת ההודעה. כדי לבדוק אם ההודעה שהתוקף שלה פג בוטלה, RBM ישלח אירוע התראה ל-webhook.
טקסט
ההודעות הפשוטות ביותר מורכבות מטקסט. הודעות טקסט מתאימות במיוחד להעברת מידע, ללא צורך באמצעים חזותיים, באינטראקציה מורכבת או בתגובה.
דוגמה
הקוד הבא שולח הודעת טקסט פשוטה. לאפשרויות עיצוב וערכים, ראו phones.agentMessages.create
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'text': 'Hello, world!' } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); let params = { messageText: 'Hello, world!', msisdn: '+12223334444', }; // Send a simple message to the device rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Send simple text message to user rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444" ); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a simple RBM text message message_text = messages.TextMessage('Hello, world!') # Send text message to the device messages.MessageCluster().append_message(message_text).send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", );הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
תוכן הודעה בסיסי - המרת SMS
ספקים יצרו מודלים לחיוב כדי לתמוך במעבר של הודעות SMS ל-RBM. הודעת RBM שמכילה עד 160 תווי UTF-8 נקראת Basic Message.
כשיוצרים בקשה לשליחת הודעה בסיסית, חשוב לזכור שהתווים נספרים כבייט אחד (UTF-8). כששולחים הודעה שמכילה תווים מיוחדים, כמו אמוג'י או מערכת תווים עם כמה בייטים, כל תו נספר כ-2 תווי UTF-8.
מזינים טקסט בתיבה כדי לבדוק את האורך שלה:
סיסמאות חד-פעמיות לאימות משתמשים
אפשר להשתמש ב-RBM כדי לשלוח סיסמאות חד-פעמיות (OTP) לאימות אוטומטי של משתמשים באמצעות API של SMS Retriever. ניתן לקרוא מידע נוסף על SMS Retriever ועל ממשקי API קשורים במסמכי התיעוד של SMS Retriever. בתרשים התהליך תוכלו לקרוא מידע נוסף על אימות אוטומטי של משתמשים באפליקציות שנרשמו ל-SMS Retriever API.
במהלך האימות, ה-API של SMS Retriever מקשיב להודעות RBM. ההודעה צריכה לכלול OTP וגיבוב שמזהה את האפליקציה. אחרי יצירת הגיבוב לאפליקציה, ה-OTP נשלף ומועבר לאפליקציה לצורך אימות אוטומטי של המשתמש.
דוגמה להודעת טקסט ב-RBM לאימות משתמשים: הקוד שלך הוא <OTP> <app hash>.
לדוגמה: Your code is 123456 M8tue43FGT.
מדיה וקובצי PDF
כשאתם שולחים הודעה עם תמונה, סרטון או קובץ PDF, הנציג צריך לספק כתובת URL של התוכן שגלויה לכולם או להעלות את הקובץ ישירות. לקובצי מדיה ניתן גם לציין תמונה ממוזערת שמאפשרת למשתמשים להציג את התוכן בתצוגה מקדימה לפני שלוחצים עליו.
פלטפורמת RBM שומרת קבצים במטמון למשך 60 יום, וה-API מחזיר מזהה קובץ שהנציג יכול לכלול בהודעות למשתמשים. אחרי 60 יום, RBM מסיר קבצים מהמטמון.
קראו את השיטות המומלצות כדי לקבל המלצות לגודל הקבצים ולמגבלות.
דוגמה לכתובת URL של קובץ
הקוד הבא שולח תמונה. לאפשרויות עיצוב וערכים, ראו AgentContentMessage
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'contentInfo': { 'fileUrl': 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif', 'forceRefresh': 'false' } } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); let params = { fileUrl: 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif', msisdn: '+12223334444', }; // Send an image/video to a device rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.AgentContentMessage; import com.google.api.services.rcsbusinessmessaging.v1.model.AgentMessage; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); String fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // create media only message AgentContentMessage agentContentMessage = new AgentContentMessage(); agentContentMessage.setContentInfo(new ContentInfo().setFileUrl(fileUrl)); // attach content to message AgentMessage agentMessage = new AgentMessage(); agentMessage.setContentMessage(agentContentMessage); rbmApiHelper.sendAgentMessage(agentMessage, "+12223334444"); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create media file attachment file_message = messages.FileMessage('http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif') messages.MessageCluster().append_message(file_message).send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); string fileUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // Create content info with the file url ContentInfo contentInfo = new ContentInfo { FileUrl = fileUrl }; // Attach content info to a message AgentContentMessage agentContentMessage = new AgentContentMessage { ContentInfo = contentInfo, }; // Attach content to message AgentMessage agentMessage = new AgentMessage { ContentMessage = agentContentMessage }; rbmApiHelper.SendAgentMessage(agentMessage, "+12223334444");הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
לחלופין, אפשר להעלות מדיה לפני ששולחים אותה בהודעה באמצעות files.create
.
דוגמה להעלאת קבצים
הקוד הבא מעלה קובץ וידאו וקובץ של תמונה ממוזערת, ולאחר מכן שולח את שני הקבצים בהודעה. למידע על אפשרויות העיצוב והערך, ראו files.create
ו-AgentContentMessage
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \ -H "Content-Type: video/mp4" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ --upload-file "FULL_PATH_TO_VIDEO_MEDIA_FILE"
# Capture server-specified video file name from response body JSON
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/upload/v1/files?agentId=AGENT_ID" \ -H "Content-Type: image/jpeg" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ --upload-file "FULL_PATH_TO_THUMBNAIL_MEDIA_FILE"
# Capture server-specified image file name from response body JSON
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'uploadedRbmFile': { 'fileName': 'SERVER-SPECIFIED_VIDEO_FILE_NAME' 'thumbnailName': 'SERVER-SPECIFIED_THUMBNAIL_FILE_NAME' } } }"
סוגי מדיה נתמכים
RBM תומך בסוגי המדיה הבאים:
סוג מדיה | סוג המסמך | Extension | פועל עם כרטיסי תצוגה עשירה |
---|---|---|---|
יישום/pdf | לא | ||
image/jpeg | JPEG | .jpeg, .jpg | כן |
image/gif | GIF | .gif | כן |
image/png | PNG | .png | כן |
וידאו/h263 | וידאו H263 | .h263 | כן |
וידאו/m4v | סרטון M4V | .m4v | כן |
video/mp4 | סרטון MP4 | .mp4 | כן |
סרטון/mpeg4 | וידאו MPEG-4 | .mp4, .m4p | כן |
סרטון/mpeg | וידאו בפורמט MPEG | .mpeg | כן |
וידאו/אינטרנט | סרטון WEBM | .webm | כן |
הצעות לתשובות
ההצעות לתשובות עוזרות להדריך את המשתמשים בשיחות באמצעות תשובות שהנציג יודע איך להגיב אליהן. הנציג ישלח הצעות לתשובות ברשימות של צ'יפים של הצעות או בכרטיסי חיפוש מתקדמים.
כשמשתמש מקיש על הצעה לתשובה, הנציג מקבל אירוע שמכיל את הטקסט של התשובה ואת נתוני הדיווח החוזר על ההמרה.
האורך המקסימלי של הצעות לתשובות הוא 25 תווים.
דוגמה
הקוד הבא שולח טקסט עם שתי הצעות לתשובות. למידע על אפשרויות עיצוב וערכים, ראו SuggestedReply
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'text': 'Hello, world!', 'suggestions': [ { 'reply': { 'text': 'Suggestion #1', 'postbackData': 'suggestion_1' } }, { 'reply': { 'text': 'Suggestion #2', 'postbackData': 'suggestion_2' } } ] } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); let suggestions = [ { reply: { 'text': 'Suggestion #1', 'postbackData': 'suggestion_1', }, }, { reply: { 'text': 'Suggestion #2', 'postbackData': 'suggestion_2', }, }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with suggestion chips to the device rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; import com.google.rbm.SuggestionHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); suggestions.add( new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply()); suggestions.add( new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply()); // Send simple text message to user rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggested replies for the message to send to the user cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1')) cluster.append_suggestion_chip(messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2')) # Send a simple message with suggestion chips to the device cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); List<Suggestion> suggestions = new List<Suggestion> { // Create suggestion chips new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(), new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply() }; // Send simple text message with suggestions to user rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
הצעות לפעולות
ההצעות לפעולות מנחים את המשתמשים במהלך השיחות על ידי השארת הפונקציונליות המקורית של המכשירים שלהם. הנציג יכול להציע למשתמשים לחייג מספר, לפתוח מיקום במפה, לשתף מיקום, לפתוח כתובת URL או ליצור אירוע ביומן. הנציג שולח הצעות לפעולות ברשימות של צ'יפים של הצעות או בכרטיסי חיפוש מתקדמים.
כשמשתמש מקיש על הצעה לפעולה, הסוכן שלכם מקבל אירוע שמכיל את נתוני הדיווח החוזר על ההמרה.
ההצעות לפעולות יכולות להכיל עד 25 תווים.
לאפשרויות עיצוב וערכים, ראו SuggestedAction
.
חיוג מספר
פעולת החיוג מכוונת את המשתמש לחייג למספר טלפון שמופיע בנציג. מספרי טלפון צריכים לכלול +
בהתחלה, את קידומת המדינה ואת קידומת האזור, אבל לא צריכים לכלול מפרידים. לדוגמה: +14155555555
.
דוגמה
הקוד הבא שולח פעולת חיוג. לאפשרויות עיצוב וערכים, ראו DialAction
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'text': 'Hello, world!', 'suggestions': [ { 'action': { 'text': 'Call', 'postbackData': 'postback_data_1234', 'fallbackUrl': 'https://www.google.com/contact/', 'dialAction': { 'phoneNumber': '+15556667777' } } } ] } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a dial suggested action let suggestions = [ { action: { text: 'Call', postbackData: 'postback_data_1234', dialAction: { phoneNumber: '+15556667777' } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a dial suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.DialAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a dial suggested action DialAction dialAction = new DialAction(); dialAction.setPhoneNumber("+15556667777"); // creating a suggested action based on a dial action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Call"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setDialAction(dialAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a dial suggested action suggestions = [ messages.DialAction('Call', 'reply:postback_data_1234', '+15556667777') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create a dial an agent suggested action DialAction dialAction = new DialAction { PhoneNumber = "+15556667777" }; // Creating a suggested action based on a dial action SuggestedAction suggestedAction = new SuggestedAction { Text = "Call", PostbackData = "postback_data_1234", DialAction = dialAction }; // Attach action to a suggestion Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
הצגת מיקום
הפעולה'הצגת מיקום' מציגה מיקום באפליקציית המפה שמוגדרת כברירת המחדל של המשתמש. ניתן לציין את המיקום לפי קו רוחב וקו אורך או באמצעות שאילתה על סמך המיקום הנוכחי של המשתמש. תוכלו גם להגדיר תווית מותאמת אישית לסיכה שמוצגת באפליקציית המפות.
דוגמה
הקוד הבא שולח פעולה של הצגת מיקום. לאפשרויות עיצוב וערכים, ראו ViewLocationAction
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'text': 'Hello, world!', 'suggestions': [ { 'action': { 'text': 'View map', 'postbackData': 'postback_data_1234', 'fallbackUrl': 'https://www.google.com/maps/@37.4220188,-122.0844786,15z', 'viewLocationAction': { 'latLong': { 'latitude': "37.4220188', 'longitude': "-122.0844786' }, 'label': 'Googleplex' } } } ] } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a view location suggested action let suggestions = [ { action: { text: 'View map', postbackData: 'postback_data_1234', viewLocationAction: { latLong: { latitude: 37.4220188, longitude: -122.0844786 }, label: 'Googleplex' } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a view location suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.ViewLocationAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a view location suggested action ViewLocationAction viewLocationAction = new ViewLocationAction(); viewLocationAction.setQuery("Googleplex, Mountain View, CA"); // creating a suggested action based on a view location action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("View map"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setViewLocationAction(viewLocationAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a view location suggested action suggestions = [ messages.ViewLocationAction('View map', 'reply:postback_data_1234', query='Googleplex, Mountain View, CA') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // create an view location action ViewLocationAction viewLocationAction = new ViewLocationAction { Query = "Googleplex Mountain View, CA" }; // Attach the view location action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { ViewLocationAction = viewLocationAction, Text = "View map", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
שיתוף מיקום
הפעולה 'שיתוף המיקום' מאפשרת למשתמש לשלוח מיקום לנציג שלכם. המיקום שהמשתמש מציין הוא לא בהכרח המיקום של המשתמש.
דוגמה
הקוד הבא שולח פעולת שיתוף מיקום. לאפשרויות עיצוב וערכים, ראו ShareLocationAction
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'text': 'Hello, world!', 'suggestions': [ { 'action': { 'text': 'Share your location', 'postbackData': 'postback_data_1234', 'shareLocationAction': {} } } ] } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a share location suggested action let suggestions = [ { action: { text: 'Share your location', postbackData: 'postback_data_1234', shareLocationAction: { } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a share location suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.ShareLocationAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a share location suggested action ShareLocationAction shareLocationAction = new ShareLocationAction(); // creating a suggested action based on a share location action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Share location"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setShareLocationAction(shareLocationAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a share location suggested action suggestions = [ messages.ShareLocationAction('Share location', 'reply:postback_data_1234') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create a share location action ShareLocationAction shareLocationAction = new ShareLocationAction(); // Attach the share location action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { ShareLocationAction = shareLocationAction, Text = "Share location", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
פתיחת כתובת URL
הפעולה 'פתיחת כתובת URL' פותחת את דפדפן האינטרנט של המשתמש אל כתובת ה-URL שצוינה. אם אפליקציה רשומה כ-handler שמוגדר כברירת מחדל לכתובת ה-URL, האפליקציה תיפתח במקום זאת והסמל של הפעולה הוא הסמל של האפליקציה.
דוגמה
הקוד הבא שולח פעולה פתוחה של כתובת URL. לאפשרויות עיצוב וערכים, ראו OpenUrlAction
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'text': 'Hello, world!', 'suggestions': [ { 'action': { 'text': 'Open Google', 'postbackData': 'postback_data_1234', 'openUrlAction': { 'url': 'https://www.google.com' } } } ] } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define an open URL suggested action let suggestions = [ { action: { text: 'Open Google', postbackData: 'postback_data_1234', openUrlAction: { url: 'https://www.google.com' } } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with an open URL suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.OpenUrlAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating an open url suggested action OpenUrlAction openUrlAction = new OpenUrlAction(); openUrlAction.setUrl("https://www.google.com"); // creating a suggested action based on an open url action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Open Google"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setOpenUrlAction(openUrlAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create an open url suggested action suggestions = [ messages.OpenUrlAction('Open Google', 'reply:postback_data_1234', 'https://www.google.com') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create an open url action OpenUrlAction openUrlAction = new OpenUrlAction { Url = "https://www.google.com" }; // Attach the open url action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { OpenUrlAction = openUrlAction, Text = "Open Google", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
יצירת אירוע ביומן
הפעולה 'יצירת אירוע יומן' פותחת את אפליקציית היומן של המשתמש ומתחילה ליצור אירוע חדש עם הפרטים שצוינו.
דוגמה
הקוד הבא שולח פעולה של יצירת אירוע ביומן. למידע על אפשרויות עיצוב וערכים, ראו CreateCalendarEventAction
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'text': 'Hello, world!', 'suggestions': [ { 'action': { 'text': 'Save to calendar', 'postbackData': 'postback_data_1234', 'fallbackUrl': 'https://www.google.com/calendar', 'createCalendarEventAction': { 'startTime': '2020-06-30T19:00:00Z', 'endTime': '2020-06-30T20:00:00Z', 'title': 'My calendar event', 'description': 'Description of the calendar event' } } } ] } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Define a create calendar event suggested action let suggestions = [ { action: { text: 'Save to calendar', postbackData: 'postback_data_1234', createCalendarEventAction: { startTime: '2020-06-30T19:00:00Z', endTime: '2020-06-30T20:00:00Z', title: 'My calendar event', description: 'Description of the calendar event', }, } }, ]; let params = { messageText: 'Hello, world!', msisdn: '+12223334444', suggestions: suggestions, }; // Send a simple message with a create calendar event suggested action rbmApiHelper.sendMessage(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.CreateCalendarEventAction; import com.google.api.services.rcsbusinessmessaging.v1.model.SuggestedAction; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.RbmApiHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); // creating a create calendar event suggested action CreateCalendarEventAction createCalendarEventAction = new CreateCalendarEventAction(); calendarEventAction.setTitle("My calendar event"); calendarEventAction.setDescription("Description of the calendar event"); calendarEventAction.setStartTime("2020-06-30T19:00:00Z"); calendarEventAction.setEndTime("2020-06-30T20:00:00Z"); // creating a suggested action based on a create calendar event action SuggestedAction suggestedAction = new SuggestedAction(); suggestedAction.setText("Save to calendar"); suggestedAction.setPostbackData("postback_data_1234"); suggestedAction.setCreateCalendarEventAction(createCalendarEventAction); // attaching action to a suggestion Suggestion suggestion = new Suggestion(); suggestion.setAction(suggestedAction); suggestions.add(suggestion); // Send simple text message with the suggestion action rbmApiHelper.sendTextMessage( "Hello, world!", "+12223334444", suggestions ); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Create a calendar event suggested action suggestions = [ messages.CreateCalendarEventAction('Save to Calendar', 'reply:postback_data_1234', '2020-06-30T19:00:00Z', '2020-06-30T20:00:00Z', 'My calendar event', 'Description of the calendar event') ] # Create text message to send to user text_msg = messages.TextMessage('Hello, world!') cluster = messages.MessageCluster().append_message(text_msg) # Append suggestions for the message to send to the user for suggestion in suggestions: cluster.append_suggestion_chip(suggestion) # Send a simple message with suggested action to the device cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Create a calendar event action CreateCalendarEventAction calendarEventAction = new CreateCalendarEventAction { Title = "My calendar event", Description = "Description of the calendar event", StartTime = "2020-06-30T19:00:00Z", EndTime = "2020-06-30T20:00:00Z" }; // Attach the calendar event action to a suggested action SuggestedAction suggestedAction = new SuggestedAction { CreateCalendarEventAction = calendarEventAction, Text = "Save to calendar", PostbackData = "postback_data_1234" }; // Attach the action to a suggestion object Suggestion suggestion = new Suggestion { Action = suggestedAction }; List<Suggestion> suggestions = new List<Suggestion> { suggestion }; rbmApiHelper.SendTextMessage( "Hello, world!", "+12223334444", suggestions );הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
רשימת צ'יפים של הצעות
כדי להנחות את המשתמשים לבצע את הפעולות הבאות, הנציג שולח הצעות לצ'יפים עם הודעות. רשימת הצ'יפים מופיעה רק כשההודעה המשויכת נמצאת בתחתית השיחה. כל ההודעות הבאות בשיחה (ממשתמש או מנציג) יחליפו את רשימת הצ'יפים.
הצ'יפים ברשימה הם הצעות לתשובות והצעות לפעולות.
רשימות צ'יפים יכולות להכיל עד 11 צ'יפים של הצעות, וכל תווית של צ'יפ יכולה להכיל עד 25 תווים.
לאפשרויות עיצוב וערכים, ראו AgentContentMessage
.
כרטיסים מתקדמים
אם אתם צריכים לשלוח קטע של מידע, מדיה או הצעות קשורים, כדאי לשלוח כרטיס מתקדם. כרטיסי תצוגה מתקדמים מאפשרים לנציג לשלוח כמה יחידות מידע בהודעה אחת.
כרטיסי חיפוש מתקדמים יכולים להכיל את הפריטים הבאים:
- תמונה/סרטון
- טקסט כותרת
- טקסט תיאור
- רשימה של הצעות לתשובות והצעות לפעולות (עד 4)
כרטיס מתקדם יכול להכיל את כל הפריטים שברשימה, אבל כרטיס תקף צריך להכיל לפחות תמונה, סרטון או כותרת. כרטיס מתקדם יכול להכיל עד ארבע הצעות לפעולות או הצעות לתשובות. הדוח לא יכול להכיל שילוב של הצעות לפעולות והצעות לתשובות בכרטיס אחד.
הסוכן יכול לשלוח כמה כרטיסי חיפוש מתקדמים יחד בקרוסלה של כרטיסים מתקדמים.
גובה הכרטיס
הכרטיסים מתרחבים אנכית כדי להתאים לתוכן שלהם. לכרטיסי תצוגה עשירה יש גובה מינימלי של 112DP וגובה מקסימלי של 344 DP. אם התוכן בכרטיס לא גדול מספיק כדי למלא את גובה הכרטיס המינימלי, הוא מתרחב וממלא את הגובה הנוסף ברווחים.
המדיה בכרטיסים מתקדמים חייבת להתאים לאחד מתוך שלושה גבהים:
- קצר: 112 DP
- בינוני: 168 DP
- גבוה: 264DP
אם המדיה לא מתאימה למידות בכרטיס בהתחשב בגובה שנבחר, התצוגה המקדימה של המדיה תיבחר על ידי שינוי מרחק התצוגה וחיתוך שלה.
דוגמה
הקוד הבא שולח כרטיס מתקדם עם תמונה והצעות לתשובות. לאפשרויות עיצוב וערכים, ראו RichCard
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'richCard': { 'standaloneCard': { 'thumbnailImageAlignment': 'RIGHT', 'cardOrientation': 'VERTICAL', 'cardContent': { 'title': 'Hello, world!', 'description': 'RBM is awesome!', 'media': { 'height': 'TALL', 'contentInfo':{ 'fileUrl': 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif', 'forceRefresh': 'false' } }, 'suggestions': [ { 'reply': { 'text': 'Suggestion #1', 'postbackData': 'suggestion_1' } }, { 'reply': { 'text': 'Suggestion #2', 'postbackData': 'suggestion_2' } } ] } } } } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Suggested replies to be used in the card let suggestions = [ { reply: { 'text': 'Suggestion #1', 'postbackData': 'suggestion_1', }, }, { reply: { 'text': 'Suggestion #2', 'postbackData': 'suggestion_2', }, }, ]; // Image to be displayed by the card let imageUrl = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif'; // Definition of the card parameters let params = { messageText: 'Hello, world!', messageDescription: 'RBM is awesome!', msisdn: '+12223334444', suggestions: suggestions, imageUrl: imageUrl, height: 'TALL', }; // Send rich card to device rbmApiHelper.sendRichCard(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.StandaloneCard; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.cards.CardOrientation; import com.google.rbm.cards.MediaHeight; import com.google.rbm.RbmApiHelper; import com.google.rbm.SuggestionHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); // Create suggestions for chip list List<Suggestion> suggestions = new ArrayList<Suggestion>(); suggestions.add( new SuggestionHelper("Suggestion #1", "suggestion_1").getSuggestedReply()); suggestions.add( new SuggestionHelper("Suggestion #2", "suggestion_2").getSuggestedReply()); String imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // Create a standalone rich card to send to the user StandaloneCard standaloneCard = rbmApiHelper.createStandaloneCard( "Hello, world!", "RBM is awesome!", imageUrl, MediaHeight.MEDIUM, CardOrientation.VERTICAL, suggestions ); rbmApiHelper.sendStandaloneCard(standaloneCard, "+12223334444"); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Suggested replies to be used in the card suggestions = [ messages.SuggestedReply('Suggestion #1', 'reply:suggestion_1'), messages.SuggestedReply('Suggestion #2', 'reply:suggestion_2') ] # Image to be displayed by the card image_url = 'http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif'; # Define rich card structure rich_card = messages.StandaloneCard('VERTICAL', 'Hello, world!', 'RBM is awesome!', suggestions, image_url, None, None, 'MEDIUM') # Append rich card and send to the user cluster = messages.MessageCluster().append_message(rich_card) cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; using RCSBusinessMessaging.Cards; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); List<Suggestion> suggestions = new List<Suggestion> { // Create suggestion chips new SuggestionHelper("Suggestion #1", "suggestion_1").SuggestedReply(), new SuggestionHelper("Suggestion #2", "suggestion_2").SuggestedReply() }; string imageUrl = "http://www.google.com/logos/doodles/2015/googles-new-logo-5078286822539264.3-hp2x.gif"; // Create rich card with suggestions StandaloneCard standaloneCard = rbmApiHelper.CreateStandaloneCard( "Hello, world!", "RBM is awesome", imageUrl, MediaHeight.TALL, CardOrientation.VERTICAL, suggestions ); // Send rich card to user rbmApiHelper.SendStandaloneCard(standaloneCard, "+12223334444");הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
קרוסלות עם כרטיסים מתקדמים
אם רוצים להציג למשתמש כמה אפשרויות לבחירה, כדאי להשתמש בקרוסלה של כרטיסים מתקדמים. קרוסלות מקובצות יחד עם מספר כרטיסים מתקדמים, כך שהמשתמשים יכולים להשוות בין פריטים ולהגיב לכל אחד מהם בנפרד.
קרוסלות יכולות להכיל לפחות שניים ולא יותר מעשרה כרטיסי חיפוש מתקדמים. הכרטיסים המתקדמים בקרוסלה צריכים לעמוד בדרישות הכלליות לכרטיסים מתקדמים לתוכן ולגובה.
חיתוך
כמו כרטיסים מתקדמים, גורמים רבים (כמו רזולוציית המסך, דחיסות הפיקסלים והעדפות המשתמש) משפיעים על האופן שבו כרטיסים נראים למשתמשי הקצה. עם זאת, בקרוסלה, הגובה של הכרטיסים הראשונים קובע את הגובה של כל הכרטיסים בקרוסלה, וגובה הכרטיס משפיע על קיצור השם, התיאור וההצעה.
אם אי אפשר להציג את כל הרכיבים של הכרטיס בגלל מגבלות תצוגה או גובה הכרטיס, RBM יקצר את הכרטיס עד שיהיה אפשר להציג אותו במכשיר, לפי הלוגיקה הבאה:
- יש לצמצם את התיאור בשורה אחת.
- יש להקטין את הכותרת לשורה אחת.
- אפשר להשמיט הצעות שלא מתאימות לכרטיס, החל מסוף הרשימה המוגדרת.
- אין להשמיט את התיאור.
- צריך להשמיט את הכותרת.
כדי שהכותרות והתיאורים לא ייחתכו, כדאי שיהיו כמה שיותר קצרים. למדיה גבוהה, כדאי להשתמש בשם ותיאור או בהצעה אחת. למדיה בינונית, השתמשו עד שתי הצעות. למדיה קצרה, אפשר להשתמש בעד שלוש הצעות. כדי להתאים לארבע הצעות, אל תכללו מדיה בכרטיס.
הכרטיסים צריכים להיות זהים מבחינת הגודל והאורך של התוכן, ואם צריך, כדאי לטעון את הקרוסלה מראש עם כרטיסים גדולים יותר כדי למנוע חיתוך בכרטיסים הבאים.
דוגמה
הקוד הבא שולח קרוסלה לכרטיסים מתקדמים. לאפשרויות עיצוב וערכים, ראו RichCard
.
cURL
curl -X POST "https://REGION-rcsbusinessmessaging.googleapis.com/v1/phones/PHONE_NUMBER/agentMessages?messageId=MESSAGE_ID&agentId=AGENT_ID" \ -H "Content-Type: application/json" \ -H "User-Agent: curl/rcs-business-messaging" \ -H "`oauth2l header --json PATH_TO_SERVICE_ACCOUNT_KEY rcsbusinessmessaging`" \ -d "{ 'contentMessage': { 'richCard': { 'carouselCard': { 'cardWidth':'MEDIUM', 'cardContents': [ { 'title':'Card #1', 'description':'The description for card #1', 'suggestions': [ { 'reply': { 'text':'Card #1', 'postbackData':'card_1' } } ], 'media': { 'height':'MEDIUM', 'contentInfo': { 'fileUrl':'https://storage.googleapis.com/kitchen-sink-sample-images/cute-dog.jpg', 'forceRefresh':'false' } } }, { 'title':'Card #2', 'description':'The description for card #2', 'suggestions': [ { 'reply': { 'text':'Card #2', 'postbackData':'card_2' } } ], 'media': { 'height':'MEDIUM', 'contentInfo': { 'fileUrl':'https://storage.googleapis.com/kitchen-sink-sample-images/elephant.jpg', 'forceRefresh': 'false' } } } ] } } } }"
Node.js
// Reference to RBM API helper const rbmApiHelper = require('@google/rcsbusinessmessaging'); // Images for the carousel cards let card1Image = 'https://storage.googleapis.com/kitchen-sink-sample-images/cute-dog.jpg'; let card2Image = 'https://storage.googleapis.com/kitchen-sink-sample-images/elephant.jpg'; // Define the card contents for a carousel with two cards, each with one suggested reply let cardContents = [ { title: 'Card #1', description: 'The description for card #1', suggestions: [ { reply: { text: 'Card #1', postbackData: 'card_1', } } ], media: { height: 'MEDIUM', contentInfo: { fileUrl: card1Image, forceRefresh: false, }, }, }, { title: 'Card #2', description: 'The description for card #2', suggestions: [ { reply: { text: 'Card #2', postbackData: 'card_2', } } ], media: { height: 'MEDIUM', contentInfo: { fileUrl: card2Image, forceRefresh: false, }, }, }, ]; // Definition of carousel card let params = { msisdn: '+12223334444', cardContents: cardContents, }; // Send the device the carousel card defined above rbmApiHelper.sendCarouselCard(params, function(response) { console.log(response); });הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Java
import com.google.api.services.rcsbusinessmessaging.v1.model.CardContent; import com.google.api.services.rcsbusinessmessaging.v1.model.Suggestion; import com.google.rbm.cards.CardOrientation; import com.google.rbm.cards.CardWidth; import com.google.rbm.cards.MediaHeight; import com.google.rbm.RbmApiHelper; import com.google.rbm.SuggestionHelper; … try { // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(); List cardContents = new ArrayList(); // Images for the carousel cards String card1Image = "https://storage.googleapis.com/kitchen-sink-sample-images/cute-dog.jpg"; // Create suggestions for first carousel card List card1Suggestions = new ArrayList(); card1Suggestions.add( new SuggestionHelper("Card #1", "card_1")); cardContents.add( new StandaloneCardHelper( "Card #1", "The description for card #1", card1Image, card1Suggestions) .getCardContent(MediaHeight.SHORT) ); // Images for the carousel cards String card2Image = "https://storage.googleapis.com/kitchen-sink-sample-images/elephant.jpg"; // Create suggestions for second carousel card List card2Suggestions = new ArrayList(); card2Suggestions.add( new SuggestionHelper("Card #2", "card_2")); cardContents.add( new StandaloneCardHelper( "Card #2", "The description for card #2", card2Image, card2Suggestions) .getCardContent(MediaHeight.SHORT) ); // Send the carousel to the user rbmApiHelper.sendCarouselCards(cardContents, CardWidth.MEDIUM, "+12223334444"); } catch(Exception e) { e.printStackTrace(); }הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
Python
# Reference to RBM Python client helper and messaging object structure from rcs_business_messaging import rbm_service from rcs_business_messaging import messages # Images for the carousel cards card_image_1 = 'https://storage.googleapis.com/kitchen-sink-sample-images/cute-dog.jpg'; card_image_2 = 'https://storage.googleapis.com/kitchen-sink-sample-images/elephant.jpg'; # Suggested replies to be used in the cards suggestions1 = [ messages.SuggestedReply('Card #1', 'reply:card_1') ] suggestions2 = [ messages.SuggestedReply('Card #2', 'reply:card_2') ] # Define the card contents for a carousel with two cards, # each with one suggested reply card_contents = [] card_contents.append(messages.CardContent('Card #1', 'The description for card #1', card_image_1, 'MEDIUM', suggestions1)) card_contents.append(messages.CardContent('Card #2', 'The description for card #2', card_image_2, 'MEDIUM', suggestions2)) # Send the device the carousel card defined above carousel_card = messages.CarouselCard('MEDIUM', card_contents) cluster = messages.MessageCluster().append_message(carousel_card) cluster.send_to_msisdn('+12223334444')הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.
C#
using Google.Apis.RCSBusinessMessaging.v1.Data; using RCSBusinessMessaging; using RCSBusinessMessaging.Cards; … // Create an instance of the RBM API helper RbmApiHelper rbmApiHelper = new RbmApiHelper(credentialsFileLocation, projectId); // Image references to be used in the carousel cards string card1Image = "https://storage.googleapis.com/kitchen-sink-sample-images/cute-dog.jpg"; string card2Image = "https://storage.googleapis.com/kitchen-sink-sample-images/elephant.jpg"; // Suggestion chip lists to be used in carousel cards List<Suggestion> suggestions1 = new List<Suggestion> { new SuggestionHelper("Card #1", "card_1").SuggestedReply() }; List<Suggestion> suggestions2 = new List<Suggestion> { new SuggestionHelper("Card #2", "card_2").SuggestedReply() }; // Create the card content for the carousel List<CardContent> cardContents = new List<CardContent> { // Add items as card content new StandaloneCardHelper( "Card #1", "The description for card #1", card1Image, suggestions1).GetCardContent(), new StandaloneCardHelper( "Card #2", "The description for card #2", card2Image, suggestions2).GetCardContent() }; // Send the carousel to the user rbmApiHelper.SendCarouselCards(cardContents, CardWidth.MEDIUM, msisdn);הקוד הזה הוא קטע מתוך סוכן לדוגמה של RBM.