משאב: AgentMessage
הודעה שנשלחת מהנציג למשתמש.
ייצוג ב-JSON |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
שדות | |
---|---|
name |
השדה הזה מוגדר על ידי פלטפורמת RBM. אל תכללו אותו כשאתם יוצרים הודעה מסוכן. השדה פותר את המחרוזת 'phones/{E.164}/agentMessages/{messageId}', כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164 ו-{messageId} הוא המזהה שהוקצה על ידי הנציג להודעה מהנציג. |
sendTime |
השדה הזה מוגדר על ידי פלטפורמת RBM. אל תכללו אותו כשאתם יוצרים הודעה מסוכן. השדה הזה מייצג את השעה שבה ההודעה נשלחה למשתמש. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד Z. דוגמאות: |
contentMessage |
התוכן של ההודעה מהנציג. |
messageTrafficType |
סוג התנועה של ההודעה. |
שדה איחוד הערך |
|
expireTime |
אופציונלי. חותמת זמן בשעון UTC שמציינת מתי המשאב הזה נחשב כמשאב שתוקפו פג. הערך הזה מסופק בפלט אם הוא מוגדר או אם השדה TTL מוגדר. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד Z. דוגמאות: |
ttl |
אופציונלי. קלט בלבד. כמה זמן ההודעה תהיה פעילה לפני שהגישה אליה תבוטל אוטומטית. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-' |
AgentContentMessage
התוכן של הודעה שנשלחה מהנציג למשתמש.
ייצוג ב-JSON |
---|
{ "suggestions": [ { object ( |
שדות | |
---|---|
suggestions[] |
רשימה של תשובות מהירות והצעות לפעולות שמופיעות כרשימה של צ'יפים של הצעות אחרי ההודעה הרלוונטית של הנציג. עד 11 הצעות. הצ'יפים מוצגים רק כשההודעה המשויכת של הנציג היא ההודעה האחרונה בשיחה (כולל הודעות של הנציג ושל המשתמש). המשתמש יכול להקיש על תשובה מוצעת כדי לשלוח את התשובה הטקסטואלית לסוכן, או להקיש על פעולה מוצעת כדי להתחיל פעולה מקומית במכשיר. עד 11 הצעות. |
שדה איחוד content . התוכן של הודעת הנציג content יכול להיות רק אחת מהאפשרויות הבאות: |
|
text |
טקסט בקידוד UTF-8. 3,072 תווים לכל היותר. |
fileName |
השם הייחודי של קובץ. פלטפורמת RBM מחזירה שם קובץ כשנציג מעלה קובץ. הוצא משימוש לטובת uploadedRbmFile שמופיע בהמשך |
uploadedRbmFile |
מכיל מזהים של קובץ ותמונה ממוזערת שהועלו לשרת RBM ומוצגים ממנו |
richCard |
כרטיס מתקדם עצמאי. |
contentInfo |
מידע על קובץ, כולל כתובת ה-URL של הקובץ וכתובת ה-URL של התמונה הממוזערת של הקובץ. פלטפורמת RBM מציגה תוכן ממטמון, אבל נציג יכול לחייב את פלטפורמת RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
UploadedRbmFile
הודעה שמכילה מידע על קובץ ותמונה ממוזערת
ייצוג ב-JSON |
---|
{ "fileName": string, "thumbnailName": string } |
שדות | |
---|---|
fileName |
השם של הקובץ, שמוחזר על ידי פלטפורמת RBM כשהקובץ מועלה. |
thumbnailName |
השם של התמונה הממוזערת, שמוחזר על ידי פלטפורמת RBM כשהתמונה הממוזערת הועלתה. |
RichCard
כרטיס מתקדם עצמאי או קרוסלה של כרטיסים מתקדמים שנשלחו מהסוכן למשתמש.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד card . כרטיס עצמאי או קרוסלה של כרטיסים. הערך card יכול להיות רק אחד מהבאים: |
|
carouselCard |
קרוסלה של כרטיסים. |
standaloneCard |
כרטיס עצמאי. |
CarouselCard
קרוסלה של כרטיסים.
ייצוג ב-JSON |
---|
{ "cardWidth": enum ( |
שדות | |
---|---|
cardWidth |
רוחב הכרטיסים בקרוסלה. |
cardContents[] |
רשימת התוכן של כל כרטיס בקרוסלה. קרוסלה יכולה לכלול מינימום 2 כרטיסים ומקסימום 10 כרטיסים. |
CarouselCard.CardWidth
רוחב הכרטיסים בקרוסלה.
טיפוסים בני מנייה (enum) | |
---|---|
CARD_WIDTH_UNSPECIFIED |
לא צוין. |
SMALL |
120 DP. שימו לב שאי אפשר להשתמש במדיה אנכית. |
MEDIUM |
232 DP. |
CardContent
תוכן הכרטיס
ייצוג ב-JSON |
---|
{ "title": string, "description": string, "media": { object ( |
שדות | |
---|---|
title |
(אופציונלי) כותרת הכרטיס. עד 200 תווים. |
description |
(אופציונלי) תיאור של הכרטיס. עד 2,000 תווים. |
media |
(אופציונלי) מדיה (תמונה, GIF, סרטון, PDF) שרוצים לכלול בכרטיס. |
suggestions[] |
(אופציונלי) רשימת הצעות שרוצים לכלול בכרטיס. עד 10 הצעות. |
מדיה
קובץ מדיה בכרטיס מתקדם.
ייצוג ב-JSON |
---|
{ "height": enum ( |
שדות | |
---|---|
height |
הגובה של המדיה בכרטיס אינטראקטיבי עם פריסה אנכית. בכרטיס עצמאי עם פריסה אופקית, אי אפשר להתאים אישית את הגובה, והמערכת מתעלמת מהשדה הזה. |
שדה איחוד content . תוכן מדיה content יכול להיות רק אחד מהערכים הבאים: |
|
fileName |
השם הייחודי של הקובץ, שמוחזר על ידי פלטפורמת RBM כשהקובץ הועלה. הוצא משימוש לטובת uploadedRbmFile שמופיע בהמשך |
uploadedRbmFile |
מכיל מזהים של קובץ ותמונה ממוזערת שהועלו לשרת RBM ומוצגים ממנו |
contentInfo |
מידע על קובץ, כולל כתובת ה-URL של הקובץ וכתובת ה-URL של התמונה הממוזערת של הקובץ. פלטפורמת RBM מציגה תוכן ממטמון, אבל נציג יכול לחייב את פלטפורמת RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
ContentInfo
ההודעה שמכילה את פרטי התוכן.
ייצוג ב-JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
שדות | |
---|---|
fileUrl |
כתובת URL של הקובץ שנגישה לכולם. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ משדה סוג התוכן בכותרות ה-HTTP כשהפלטפורמה מאחזרת את הקובץ. השדה content-type חייב להופיע בתגובת ה-HTTP מכתובת ה-URL, והערך שלו צריך להיות מדויק. גודל הקובץ המקסימלי המומלץ הוא 100MB. הערה: אין תמיכה בהפניות לכתובות URL אחרות בקובץ. אם נדרשת הפניה אוטומטית, צריך להשתמש ב-CreateFileRequest. |
thumbnailUrl |
(אופציונלי, רק לקובצי תמונה, אודיו ווידאו) כתובת URL שאפשר לגשת אליה באופן ציבורי של התמונה הממוזערת. גודל מקסימלי של 100KB. אם לא תספקו כתובת URL של תמונה ממוזערת, פלטפורמת RBM תציג תמונה ממוזערת של placeholder ריק עד שהקובץ יורד למכשיר של המשתמש. יכול להיות שהקובץ לא יורד אוטומטית, והמשתמש יצטרך להקיש על לחצן ההורדה, בהתאם להגדרה של המשתמש. הערה: אין תמיכה בהפניות לכתובות URL אחרות בקובץ. אם נדרשת הפניה אוטומטית, צריך להשתמש ב-CreateFileRequest. |
forceRefresh |
אם ההגדרה הזו מוגדרת, פלטפורמת RBM מאחזרת את הקובץ ואת התמונה הממוזערת מכתובות ה-URL שצוינו, גם אם בפלטפורמה יש עותקים של הקובץ (או של התמונה הממוזערת) ששמורים במטמון. |
Media.Height
גובה מדיה
טיפוסים בני מנייה (enum) | |
---|---|
HEIGHT_UNSPECIFIED |
לא צוין. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 DP. התכונה לא זמינה לקרוסלות של כרטיסים עשירים כשהרוחב של הכרטיס מוגדר כקטן. |
הצעה
הצעה לתשובה או הצעה לפעולה שמופיעות בכרטיס עשיר או ברשימת צ'יפים של הצעות.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד option . ההצעה לתשובה או לפעולה option יכולה להיות רק אחת מהאפשרויות הבאות: |
|
reply |
המשתמשים יכולים להקיש על הצעה לתשובה כדי לשלוח את התשובה הטקסטואלית לסוכן. |
action |
המשתמשים יכולים להקיש על פעולה מוצעת כדי להפעיל את הפעולה המקבילה במכשיר. |
SuggestedReply
כשלוחצים על התשובה, היא נשלחת בחזרה לנציג.
ייצוג ב-JSON |
---|
{ "text": string, "postbackData": string } |
שדות | |
---|---|
text |
הטקסט שמוצג בהצעה לתשובה ונשלח בחזרה לסוכן כשהמשתמש מקיש עליו. עד 25 תווים. |
postbackData |
המטען הייעודי (payload) שמקודד ב-Base64 שהסוכן מקבל באירוע משתמש כשהמשתמש מקיש על התשובה המוצעת. |
SuggestedAction
כשמקישים על הלחצן, מתחילה הפעולה המקורית התואמת במכשיר.
ייצוג ב-JSON |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
שדות | |
---|---|
text |
הטקסט שמוצג בהצעה לפעולה. עד 25 תווים. |
postbackData |
מטען ייעודי (בקידוד base64) שיישלח לנציג באירוע המשתמש שמתקבל כשהמשתמש מקיש על הפעולה המוצעת. 2048 תווים לכל היותר. |
fallbackUrl |
(אופציונלי) כתובת URL חלופית לשימוש אם לקוח לא תומך בפעולה מוצעת. כתובות URL חלופיות נפתחות בחלונות חדשים בדפדפן. חובה להזין מזהה משאבים אחיד (URI) תקין כפי שמוגדר ב-RFC 3986. 2048 תווים לכל היותר. |
שדה איחוד action . הפעולה המקורית שמופעלת במכשיר כשמשתמש מקיש על הפעולה המוצעת action יכולה להיות רק אחת מהפעולות הבאות: |
|
dialAction |
אפליקציית החייגן שמוגדרת כברירת מחדל אצל המשתמש תיפתח עם מספר הטלפון שצוין על ידי הנציג. |
viewLocationAction |
פותחת את אפליקציית המפה שמוגדרת כברירת מחדל אצל המשתמש, ובוחרת את המיקום שצוין על ידי הסוכן או מחפשת בסביבת המיקום של המשתמש לפי שאילתה שצוינה על ידי הסוכן. |
createCalendarEventAction |
האפליקציה פותחת את אפליקציית היומן שמוגדרת כברירת מחדל אצל המשתמש, ומתחילה את התהליך של יצירת אירוע חדש ביומן עם נתוני האירוע שצוינו על ידי הסוכן. |
openUrlAction |
פותח את אפליקציית דפדפן האינטרנט שמוגדרת כברירת מחדל אצל המשתמש לכתובת ה-URL שצוינה. אם למשתמש יש אפליקציה מותקנת שרשומה כ-handler ברירת המחדל של כתובת ה-URL, האפליקציה הזו תיפתח במקום זאת, והסמל שלה ישמש בממשק המשתמש של הפעולה המוצעת. |
shareLocationAction |
נפתח חלון לבחירת מיקום באפליקציית RCS, כדי שהמשתמש יוכל לבחור מיקום לשליחה לנציג. |
DialAction
אפליקציית החייגן שמוגדרת כברירת מחדל אצל המשתמש תיפתח עם מספר הטלפון שצוין על ידי הנציג.
ייצוג ב-JSON |
---|
{ "phoneNumber": string } |
שדות | |
---|---|
phoneNumber |
מספר הטלפון בפורמט E.164, לדוגמה, +12223334444. |
ViewLocationAction
פותחת את אפליקציית המפה שמוגדרת כברירת מחדל אצל המשתמש, ובוחרת את המיקום שצוין על ידי הסוכן או מחפשת בסביבת המיקום של המשתמש לפי שאילתה שצוינה על ידי הסוכן.
ייצוג ב-JSON |
---|
{
"latLong": {
object ( |
שדות | |
---|---|
latLong |
(אופציונלי) קו הרוחב וקו האורך של המיקום שצוין. |
label |
(אופציונלי) התווית של הסיכה שהוצבה במיקום latLong. |
query |
(אופציונלי, נתמך רק בלקוחות של Android Messages) במקום לציין latLong (ואופציונלית, תווית), הנציג יכול לציין מחרוזת שאילתה. באפליקציות מפות שמוגדרות כברירת מחדל ותומכות בפונקציית חיפוש (כולל מפות Google), הקשה על ההצעה הזו לפעולה תגרום לחיפוש מיקום שמבוסס על המיקום הנוכחי של המשתמש. אם השאילתה מספיק ספציפית, נציגים יכולים להשתמש בה כדי לבחור מיקום כלשהו בעולם. לדוגמה, אם מגדירים את מחרוזת השאילתה ל-Growing Tree Bank, יוצגו כל המיקומים של הבנק הזה שנמצאים בסביבת המשתמש. הגדרת מחרוזת השאילתה ל-1600 Amphitheater Parkway, Mountain View, CA 94304 תבחר את הכתובת הספציפית הזו, ללא קשר למיקום של המשתמש. |
LatLng
אובייקט שמייצג זוג של קווי רוחב ואורך. הערך הזה מבוטא כזוג מספרים ממשיים שמייצגים מעלות של קו רוחב ומעלות של קו אורך. אלא אם צוין אחרת, האובייקט הזה חייב להיות תואם ל תקן WGS84. הערכים צריכים להיות בטווחים מנורמלים.
ייצוג ב-JSON |
---|
{ "latitude": number, "longitude": number } |
שדות | |
---|---|
latitude |
קו הרוחב במעלות. הערך צריך להיות בטווח [-90.0, +90.0]. |
longitude |
קו האורך במעלות. הערך חייב להיות בטווח [-180.0, +180.0]. |
CreateCalendarEventAction
האפליקציה פותחת את אפליקציית היומן שמוגדרת כברירת מחדל אצל המשתמש, ומתחילה את התהליך של יצירת אירוע חדש ביומן עם נתוני האירוע שצוינו על ידי הסוכן.
ייצוג ב-JSON |
---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
שדות | |
---|---|
startTime |
שעת ההתחלה של האירוע. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד Z. דוגמאות: |
endTime |
שעת הסיום של האירוע. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד Z. דוגמאות: |
title |
שם האירוע. 100 תווים לכל היותר. |
description |
תיאור האירוע. עד 500 תווים. |
OpenUrlAction
פתיחה של אפליקציית דפדפן האינטרנט שמוגדרת כברירת מחדל אצל המשתמש לכתובת ה-URL שצוינה. אם למשתמש יש אפליקציה מותקנת שרשומה כ-handler ברירת המחדל של כתובת ה-URL, האפליקציה הזו תיפתח במקום זאת, והסמל שלה ישמש בממשק המשתמש של הפעולה המוצעת.
ייצוג ב-JSON |
---|
{ "url": string, "application": enum ( |
שדות | |
---|---|
url |
בכתובת האתר הבאה. חובה להזין מזהה משאבים אחיד (URI) תקין כפי שמוגדר ב-RFC 3986. 2048 תווים לכל היותר. |
application |
אפליקציה, דפדפן או תצוגת אינטרנט לפתיחת כתובת URL. כדי לבדוק אם המכשיר של המשתמש תומך במצב תצוגת אינטרנט, צריך להריץ קודם בדיקת יכולות. פרטים נוספים זמינים במסמכי התיעוד: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webviewViewMode |
מצב תצוגה של WebView |
description |
תיאור נגישות לתצוגת אינטרנט. |
OpenUrlApplication
סוג האפליקציה שפותחת את כתובת ה-URL
טיפוסים בני מנייה (enum) | |
---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
לא צוין, המערכת תשתמש בדפדפן כדי לפתוח את הקישור. |
BROWSER |
משתמשים בדפדפן כדי לפתוח את כתובת ה-URL. |
WEBVIEW |
פתיחה של כתובת URL בחלון משולב של תצוגת אינטרנט |
WebviewViewMode
סוג מצב התצוגה של תצוגת האינטרנט.
טיפוסים בני מנייה (enum) | |
---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
לא צוין. כדי להשתמש ב-WebView, צריך לציין מצב תצוגה. |
FULL |
נדרשת שכבת-על במסך מלא עם שיחת הצ'אטבוט שמתויגת בשורת הסטטוס. |
HALF |
נדרשת שכבת-על של חצי מסך. |
TALL |
נדרשת שכבת-על של שלושה רבעים מהמסך. |
StandaloneCard
כרטיס עצמאי
ייצוג ב-JSON |
---|
{ "cardOrientation": enum ( |
שדות | |
---|---|
cardOrientation |
הכיוון של הכרטיס. |
thumbnailImageAlignment |
יישור של תצוגה מקדימה של תמונה בכרטיסים עצמאיים עם פריסה אופקית. |
cardContent |
תוכן הכרטיס. |
StandaloneCard.CardOrientation
הכיוון של הכרטיס.
טיפוסים בני מנייה (enum) | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
לא צוין. |
HORIZONTAL |
פריסה אופקית. אם |
VERTICAL |
פריסה אנכית. |
StandaloneCard.ThumbnailImageAlignment
יישור של תצוגה מקדימה של תמונה בכרטיסים עצמאיים עם פריסה אופקית.
טיפוסים בני מנייה (enum) | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
לא צוין. |
LEFT |
התצוגה המקדימה של הקובץ מיושרת לימין. |
RIGHT |
התצוגה המקדימה של הקובץ מיושרת לימין. |
MessageTrafficType
סוגי תנועת הודעות נתמכים. ה-enum יורחב כדי לתמוך בסוגי תנועה נוספים.
טיפוסים בני מנייה (enum) | |
---|---|
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED |
התנהגות ברירת המחדל: סוג התנועה של ההודעה נקבע לפי תרחיש השימוש של הסוכן. לעדכן את סוג התנועה לפי הצורך על סמך תוכן ההודעה. לסוכנים לשימוש חוזר, לא מסופקת ברירת מחדל. צריך להגדיר את סוג התנועה באופן ידני (למשל, TRANSACTION, PROMOTION). |
AUTHENTICATION |
להודעות אימות בתרחיש לדוגמה של סוכן OTP. |
TRANSACTION |
להודעות טרנזקציונליות בתרחישי שימוש של נציג טרנזקציונלי או נציג רב-תכליתי. |
PROMOTION |
להודעות שיווקיות בתרחישי שימוש של סוכנים שיווקיים או סוכנים רב-תכליתיים. |
SERVICEREQUEST |
להודעות לגבי שירותים שהמשתמש הסכים לקבל. משמש בתרחישי שימוש של סוכנים חד-פעמיים, סוכנים לעסקאות, סוכנים לקידום מכירות או סוכנים לשימוש רב. |
ACKNOWLEDGEMENT |
הודעות שמאשרות את בקשת המשתמש לביטול ההרשמה. משמש בתרחישי שימוש של סוכנים חד-פעמיים, סוכנים לעסקאות, סוכנים לקידום מכירות או סוכנים לשימוש רב. |
Methods |
|
---|---|
|
הנציג שולח הודעה למשתמש. |
|
ביטול של הודעה מנציג שנשלחה אבל עדיין לא נמסרה. |