משאב: AgentMessage
הודעה שנשלחה מהנציג למשתמש.
ייצוג ב-JSON |
---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
שדות | |
---|---|
name |
השדה הזה מוגדר על ידי פלטפורמת RBM. אין לכלול אותו כשיוצרים הודעה של נציג. השדה מקבל את הערך 'phones/{E.164}/agentMessages/{messageId}', כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164 ו-{messageId} הוא המזהה שהוקצה על ידי הנציג להודעת הנציג. |
send |
השדה הזה מוגדר על ידי הפלטפורמה של RBM. אין לכלול אותו כשיוצרים הודעה של נציג. השדה מתייחס לשעה שבה ההודעה נשלחת למשתמש. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
content |
תוכן ההודעה של הנציג. |
שדה האיחוד
|
|
expire |
זה שינוי אופציונלי. חותמת זמן בשעון UTC של מועד התפוגה של המשאב. הערך הזה מסופק בפלט אם הוא מוגדר או אם שדה ה-TTL מוגדר. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
ttl |
זה שינוי אופציונלי. קלט בלבד. משך הזמן שבו ההודעה תהיה פעילה לפני שהיא תבוטל באופן אוטומטי. משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-' |
AgentContentMessage
תוכן ההודעה שנשלחה מהנציג למשתמש.
ייצוג ב-JSON |
---|
{ "suggestions": [ { object ( |
שדות | |
---|---|
suggestions[] |
רשימה של הצעות לתשובות ולהפעלות, שמופיעות כרשימה של צ'יפים של הצעות אחרי הודעת הנציג המשויכת. עד 11 הצעות. הצ'יפים מוצגים רק כשההודעה המשויכת של הנציג היא ההודעה האחרונה בשיחה (כולל הודעות של הנציג ושל המשתמש). המשתמש יכול להקיש על הצעה לתשובה כדי לשלוח את התשובה בטקסט חזרה לנציג, או להקיש על הצעה לפעולה כדי להתחיל פעולה מקומית במכשיר. עד 11 הצעות. |
שדה האיחוד content . תוכן ההודעה של הנציג content יכול להיות רק אחת מהאפשרויות הבאות: |
|
text |
טקסט בקידוד UTF-8. 3,072 תווים לכל היותר. |
fileName |
השם הייחודי של קובץ. כשנציג מעלה קובץ, פלטפורמת RBM מחזירה שם של קובץ. הוצא משימוש לטובת uploadedRbmFile בהמשך |
uploaded |
מכיל מזהי קובץ ותצוגה ממוקטנת שהועלו לשרת RBM ונשלחו דרכו |
rich |
כרטיס מתקדם עצמאי. |
content |
מידע על קובץ, כולל כתובת ה-URL של הקובץ וכתובת ה-URL של התמונה הממוזערת של הקובץ. פלטפורמת RBM מציגה תוכן מהמטמון, אבל נציג יכול לאלץ את פלטפורמת RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
UploadedRbmFile
הודעה שמכילה מידע על קובץ ועל תמונה ממוזערת
ייצוג ב-JSON |
---|
{ "fileName": string, "thumbnailName": string } |
שדות | |
---|---|
file |
שם הקובץ, שהוחזר על ידי הפלטפורמה של RBM כשהקובץ הועלה. |
thumbnail |
השם של התמונה הממוזערת, שהוחזר על ידי פלטפורמת RBM כשהתמונה הממוזערת הועלתה. |
RichCard
כרטיס מתקדם עצמאי או קרוסלה של כרטיסים מתקדמים שנשלחים מהנציג למשתמש.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד card . כרטיס עצמאי או קרוסלה של כרטיסים. הערך של card יכול להיות רק אחת מהאפשרויות הבאות: |
|
carousel |
קרוסלה של כרטיסים. |
standalone |
כרטיס עצמאי. |
CarouselCard
קרוסלה של צ'אטים אינטראקטיביים.
ייצוג ב-JSON |
---|
{ "cardWidth": enum ( |
שדות | |
---|---|
card |
רוחב הכרטיסים בקרוסלה. |
card |
רשימת התוכן של כל כרטיס בקרוסלה. קרוסלה יכולה לכלול 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, סרטון) שרוצים לכלול בכרטיס. |
suggestions[] |
(אופציונלי) רשימת ההצעות שרוצים לכלול בכרטיס. עד 10 הצעות. |
מדיה
קובץ מדיה בתוך כרטיס מתקדם.
ייצוג ב-JSON |
---|
{ "height": enum ( |
שדות | |
---|---|
height |
הגובה של המדיה בכרטיס עשיר עם פריסה אנכית. בכרטיס עצמאי עם פריסה אופקית, לא ניתן להתאים אישית את הגובה והמערכת מתעלמת מהשדה הזה. |
שדה איחוד content . תוכן המדיה content יכול להיות רק אחת מהאפשרויות הבאות: |
|
fileName |
השם הייחודי של הקובץ, שהוחזר על ידי הפלטפורמה של RBM כשהקובץ הועלה. הוצא משימוש לטובת uploadedRbmFile בהמשך |
uploaded |
מכיל מזהי קובץ ותצוגה ממוקטנת שהועלו לשרת RBM ונשלחו דרכו |
content |
מידע על קובץ, כולל כתובת ה-URL שלו וכתובת ה-URL של התמונה הממוזערת שלו. פלטפורמת RBM מציגה תוכן מהמטמון, אבל נציג יכול לאלץ את פלטפורמת RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
ContentInfo
הודעה שמכילה את פרטי התוכן.
ייצוג JSON |
---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
שדות | |
---|---|
file |
כתובת ה-URL של הקובץ שגלויה לכולם. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ מהשדה content-type בכותרות ה-HTTP כשהפלטפורמה מאחזרת את הקובץ. השדה content-type חייב להופיע בתשובת ה-HTTP מכתובת ה-URL, והוא חייב להיות מדויק. מומלץ להעלות קבצים בגודל מקסימלי של 100MB. |
thumbnail |
(אופציונלי, לקובצי תמונה, אודיו וסרטון בלבד) כתובת URL של התמונה הממוזערת שגלויה לכולם. גודל מקסימלי של 100KB. אם לא תספקו כתובת URL של תמונה ממוזערת, פלטפורמת RBM תציג תמונה ממוזערת ריקה של placeholder עד שהקובץ יוריד למכשיר של המשתמש. בהתאם להגדרות של המשתמש, יכול להיות שהקובץ לא יורד באופן אוטומטי והמשתמש יצטרך להקיש על לחצן הורדה. |
force |
אם ההגדרה הזו מוגדרת, פלטפורמת 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 תווים לכל היותר. |
postback |
המטען הייעודי (payload) בקידוד base64 שהסוכן מקבל באירוע של משתמש כשהמשתמש מקיש על התשובה המוצעת. |
SuggestedAction
כשמקישים עליו, הוא מפעיל את הפעולה המקורית התואמת במכשיר.
ייצוג ב-JSON |
---|
{ "text": string, "postbackData": string, "fallbackUrl": string, // Union field |
שדות | |
---|---|
text |
הטקסט שמוצג בהצעה לפעולה. 25 תווים לכל היותר. |
postback |
עומס נתונים (מקודד ב-base64) שיישלח לנציג באירוע המשתמש שנוצר כשהמשתמש מקשיב על הפעולה המוצעת. 2048 תווים לכל היותר. |
fallback |
(אופציונלי) כתובת URL חלופית לשימוש אם לקוח לא תומך בהצעה לפעולה. כתובות ה-URL החלופיות נפתחות בחלונות דפדפן חדשים. חייב להיות URI תקין כפי שהוגדר ב-RFC 3986. 2048 תווים לכל היותר. |
שדה האיחוד action . הפעולה המובנית שמתחילה במכשיר כשהמשתמש מקייש על הפעולה המוצעת action יכולה להיות רק אחת מהפעולות הבאות: |
|
dial |
הפעולה הזו פותחת את אפליקציית החיוג שמוגדרת כברירת מחדל אצל המשתמש, עם מספר הטלפון שצוין על ידי הנציג. |
view |
הפקודה פותחת את אפליקציית המפה שמוגדרת כברירת מחדל אצל המשתמש ובוחרת את המיקום שצוין על ידי הסוכן, או מבצעת חיפוש בסביבת המיקום של המשתמש לפי שאילתה שצוינה על ידי הסוכן. |
create |
הפקודה פותחת את אפליקציית היומן שמוגדרת כברירת מחדל אצל המשתמש, ומתחילה את תהליך היצירה של האירוע ביומן עם נתוני האירוע שצוינו על ידי הנציג. |
open |
פתיחת אפליקציית דפדפן האינטרנט שמוגדרת כברירת מחדל של המשתמש בכתובת ה-URL שצוינה. אם למשתמש מותקנת אפליקציה שרשומה כ-handler שמוגדר כברירת מחדל לכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת והסמל שלה ישמש בממשק המשתמש של ההצעות לפעולות. |
share |
פתיחת הבורר של המיקום באפליקציית RCS כדי שהמשתמש יוכל לבחור מיקום לשליחה לנציג. |
compose |
כתיבה ושליחה של הודעה ליעד שהוגדר מראש באמצעות צ'אטבוט. |
DialAction
הפעולה הזו פותחת את אפליקציית החיוג שמוגדרת כברירת מחדל אצל המשתמש, עם מספר הטלפון שצוין על ידי הנציג.
ייצוג ב-JSON |
---|
{ "phoneNumber": string } |
שדות | |
---|---|
phone |
מספר הטלפון בפורמט E.164, לדוגמה, +12223334444. |
ViewLocationAction
הפקודה פותחת את אפליקציית המפה שמוגדרת כברירת מחדל אצל המשתמש ובוחרת את המיקום שצוין על ידי הסוכן, או מבצעת חיפוש בסביבת המיקום של המשתמש לפי שאילתה שצוינה על ידי הסוכן.
ייצוג ב-JSON |
---|
{
"latLong": {
object ( |
שדות | |
---|---|
lat |
(אופציונלי) קו הרוחב וקו האורך של המיקום שצוין. |
label |
(אופציונלי) התווית של הסיכה שהוצמדה ב-latLong. |
query |
(אופציונלי, נתמך רק בלקוחות Android Messages) במקום לציין קואורדינטות (ולחלופין תווית), הנציג יכול לציין מחרוזת שאילתה. באפליקציות מפות שמוגדרות כברירת מחדל שתומכות בפונקציית חיפוש (כולל מפות Google), הקשה על ההצעה הזו גורמת לחיפוש מיקום שמתמקד במיקום הנוכחי של המשתמש. אם השאילתה ספציפית מספיק, הנציגים יכולים להשתמש בה כדי לבחור כל מיקום בעולם. לדוגמה, אם תגדירו את מחרוזת השאילתה כ-"Growing Tree Bank" (בנק עצים, תוכלו לראות את כל מיקומי הבנקים של עצים המתפתחים באזור של המשתמש). הגדרת מחרוזת השאילתה בתור ' 1600 Amphitheater Parkway, Mountain View, CA 94043' תבחר בכתובת הספציפית הזו, בלי קשר למיקום של המשתמש. |
LatLng
אובייקט שמייצג צמד קואורדינטות של רוחב וקו אורך. הוא מופיע כצמד של מספרים שלמים (double) שמייצגים מעלות של קו רוחב ומעלות של קו אורך. אלא אם צוין אחרת, האובייקט הזה חייב לעמוד בתקן 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 } |
שדות | |
---|---|
start |
שעת ההתחלה של האירוע. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
end |
שעת הסיום של האירוע. חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: |
title |
שם האירוע. 100 תווים לכל היותר. |
description |
תיאור האירוע. עד 500 תווים. |
OpenUrlAction
פותח את אפליקציית ברירת המחדל של המשתמש לדפדפן האינטרנט לכתובת ה-URL שצוינה. אם למשתמש מותקנת אפליקציה שרשומה כ-handler שמוגדר כברירת מחדל לכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת והסמל שלה ישמש בממשק המשתמש של ההצעות לפעולות.
ייצוג ב-JSON |
---|
{ "url": string, "application": enum ( |
שדות | |
---|---|
url |
בכתובת האתר הבאה. צריך להיות מזהה URI חוקי כפי שמוגדר ב-RFC 3986. 2048 תווים לכל היותר. |
application |
כתובת URL פותחת אפליקציה, דפדפן או תצוגת אינטרנט. כדי לבדוק אם המכשיר של המשתמש תומך במצב Webview, צריך קודם להריץ בדיקת יכולות. פרטים נוספים זמינים במסמכי התיעוד: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webview |
מצב תצוגה ל-WebView |
description |
תיאור נגישות של Webview. |
OpenUrlApplication
סוג האפליקציה לפתיחת כתובת ה-URL
טיפוסים בני מנייה (enum) | |
---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
לא צוין, המערכת תשתמש בדפדפן כדי לפתוח את הקובץ. |
BROWSER |
פותחים את כתובת ה-URL בדפדפן. |
WEBVIEW |
פתיחת כתובת URL בחלון משולב של תצוגת אינטרנט |
WebviewViewMode
סוג מצב התצוגה של תצוגת האינטרנט.
טיפוסים בני מנייה (enum) | |
---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
לא צוין. כדי להשתמש ב-WebView, צריך להגדיר מצב תצוגה. |
FULL |
נדרשת שכבת-על במסך מלא עם שיחה עם צ'אט בוט שמסומנת בשורת הסטטוס. |
HALF |
נדרשת שכבת-על של חצי מסך. |
TALL |
נדרשת שכבת-על של שלוש-רבעים מהמסך. |
ComposeAction
כתיבת שליחת הודעה ליעד שהוגדר מראש על ידי צ'אטבוט. כדי לבדוק אם המכשיר של המשתמש תומך בפעולה הזו, צריך קודם להריץ בדיקת יכולות. מידע נוסף זמין בתיעוד: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.
ייצוג ב-JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה האיחוד הערך של |
|
compose |
כותבים הודעות טקסט ושולחים אותן. |
compose |
להתחיל את ההקלטה והשליחה של הודעת אודיו או וידאו. |
ComposeAction.ComposeTextMessage
כותבים הודעות טקסט ושולחים אותן.
ייצוג ב-JSON |
---|
{ "phoneNumber": string, "text": string } |
שדות | |
---|---|
phone |
מספר טלפון יעד שמולא מראש על ידי צ'אט בוט. |
text |
'טיוטה' כדי לעבור לשדה הטקסט לשליחת ההודעה. |
ComposeAction.ComposeRecordingMessage
להתחיל את ההקלטה והשליחה של הודעת אודיו או וידאו.
ייצוג ב-JSON |
---|
{
"phoneNumber": string,
"type": enum ( |
שדות | |
---|---|
phone |
מספר הטלפון של היעד שהוזן מראש על ידי צ'אט בוט. |
type |
סוג פעולת ההקלטה. |
ComposeRecordingActionType
סוג הפעולה של הקלטת הלחן.
טיפוסים בני מנייה (enum) | |
---|---|
COMPOSE_RECORDING_ACTION_TYPE_UNSPECIFIED |
לא צוין. |
ACTION_TYPE_AUDIO |
סוג האודיו. |
ACTION_TYPE_VIDEO |
סוג הסרטון. |
StandaloneCard
כרטיס עצמאי
ייצוג ב-JSON |
---|
{ "cardOrientation": enum ( |
שדות | |
---|---|
card |
כיוון הכרטיס. |
thumbnail |
יישור התצוגה המקדימה של התמונה בכרטיסים עצמאיים בפריסה אופקית. |
card |
תוכן הכרטיס. |
StandaloneCard.CardOrientation
כיוון הכרטיס.
טיפוסים בני מנייה (enum) | |
---|---|
CARD_ORIENTATION_UNSPECIFIED |
לא צוין. |
HORIZONTAL |
פריסה אופקית. אם השדה |
VERTICAL |
פריסה אנכית. |
StandaloneCard.ThumbnailImageAlignment
יישור התצוגה המקדימה של התמונה בכרטיסים עצמאיים בפריסה אופקית.
טיפוסים בני מנייה (enum) | |
---|---|
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED |
לא צוין. |
LEFT |
התצוגה המקדימה של הקובץ מותאמת לצד ימין. |
RIGHT |
התצוגה המקדימה של הקובץ מותאמת לצד שמאל. |
שיטות |
|
---|---|
|
שליחת הודעה מהנציג למשתמש. |
|
ביטול הודעה שנשלחה על ידי נציג תמיכה אבל עדיין לא נמסרה. |