REST Resource: phones.agentMessages

משאב: AgentMessage

הודעה שנשלחה מהנציג למשתמש.

ייצוג JSON
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
שדות
name

string

השדה הזה מוגדר על ידי הפלטפורמה של RBM. חשוב לא לכלול אותה כשיוצרים הודעה לנציג תמיכה. הערך בשדה יהיה 'phones/{E.164}/agentMessages/{messageId}', כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164 ו-{messageId} הוא המזהה שהוקצה על ידי הסוכן של ההודעה לנציג.

sendTime

string (Timestamp format)

השדה הזה מוגדר על ידי הפלטפורמה של RBM. חשוב לא לכלול אותה כשיוצרים הודעה לנציג תמיכה. השדה הזה מציין את השעה שבה ההודעה נשלחת למשתמש.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

contentMessage

object (AgentContentMessage)

תוכן ההודעה של הנציג.

שדה איחוד expiration.

expiration יכול להיות רק אחת מהאפשרויות הבאות:

expireTime

string (Timestamp format)

זה שינוי אופציונלי. חותמת הזמן לפי שעון UTC שמציינת שהתוקף של המשאב הזה פג. הערך הזה מופיע בפלט אם הוא מוגדר או אם השדה TTL מוגדר.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

ttl

string (Duration format)

זה שינוי אופציונלי. קלט בלבד. משך הזמן שבו ההודעה תוצג עד שהיא תבוטל באופן אוטומטי.

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. לדוגמה: "3.5s".

AgentContentMessage

תוכן ההודעה שנשלחה מהנציג למשתמש.

ייצוג JSON
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],

  // Union field content can be only one of the following:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
שדות
suggestions[]

object (Suggestion)

רשימה של הצעות לתשובות והצעות לפעולות שמופיעות כרשימה של צ'יפים של הצעות אחרי ההודעה של הנציג הרלוונטי. עד 11 הצעות.

הצ'יפים מוצגים רק כשההודעה המשויכת לנציג היא ההודעה האחרונה בשיחה (כולל הודעות לנציג וגם הודעות למשתמשים). המשתמש יכול להקיש על הצעה לתשובה כדי לשלוח את התשובה בהודעת הטקסט לנציג, או להקיש על הצעה לפעולה להפעלת פעולה מותאמת במכשיר.

שדה איחוד content. התוכן של ההודעה לנציג content יכול להיות רק אחד מהפריטים הבאים:
text

string

הטקסט מקודד ב-UTF-8.

fileName
(deprecated)

string

השם הייחודי של קובץ. כשנציג מעלה קובץ, פלטפורמת RBM מחזירה שם של קובץ. הוצא משימוש לטובת UploadRbmFile למטה

uploadedRbmFile

object (UploadedRbmFile)

יש מזהים של קובץ ותמונה ממוזערת שהועלו לשרת של RBM והוצגו על ידיו.

richCard

object (RichCard)

צ'אט אינטראקטיבי נפרד.

contentInfo

object (ContentInfo)

מידע על קובץ, כולל כתובת ה-URL שלו וכתובת ה-URL של התמונה הממוזערת שלו.

הפלטפורמה של RBM מציגה תוכן מהמטמון, אבל סוכן יכול לאלץ את הפלטפורמה של RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון.

UploadedRbmFile

הודעה שמכילה מידע על הקובץ והתמונה הממוזערת

ייצוג JSON
{
  "fileName": string,
  "thumbnailName": string
}
שדות
fileName

string

שם הקובץ, שהוחזר על ידי הפלטפורמה של RBM כשהקובץ הועלה.

thumbnailName

string

שם התמונה הממוזערת, שהוחזר על ידי הפלטפורמה של RBM כאשר התמונה הממוזערת הועלתה.

RichCard

צ'אט אינטראקטיבי נפרד או קרוסלה של כרטיסי חיפוש מתקדמים שנשלחים מהנציג למשתמש.

ייצוג JSON
{

  // Union field card can be only one of the following:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of list of possible types for union field card.
}
שדות
שדה איחוד card. כרטיס עצמאי או קרוסלה של כרטיסים. card יכול להיות רק אחת מהאפשרויות הבאות:
carouselCard

object (CarouselCard)

קרוסלה של כרטיסים.

standaloneCard

object (StandaloneCard)

כרטיס להצגה באופן עצמאי.

CarouselCard

קרוסלה של כרטיסים.

ייצוג JSON
{
  "cardWidth": enum (CarouselCard.CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
שדות
cardWidth

enum (CarouselCard.CardWidth)

רוחב הכרטיסים בקרוסלה.

cardContents[]

object (CardContent)

רשימת התוכן לכל כרטיס בקרוסלה. קרוסלה יכולה לכלול עד 2 כרטיסים ועד 10 כרטיסים.

CarouselCard.CardWidth

רוחב הכרטיסים בקרוסלה.

טיפוסים בני מנייה (enum)
CARD_WIDTH_UNSPECIFIED לא צוין.
SMALL 120 DP. הערה: אי אפשר להשתמש במדיה גבוהה.
MEDIUM 232 DP.

CardContent

תוכן הכרטיס

ייצוג JSON
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
שדות
title

string

(אופציונלי) כותרת הכרטיס. עד 200 תווים.

description

string

(אופציונלי) תיאור הכרטיס. עד 2,000 תווים.

media

object (Media)

(אופציונלי) מדיה (תמונה, GIF, סרטון) שיש לכלול בכרטיס.

suggestions[]

object (Suggestion)

(אופציונלי) רשימת הצעות שייכללו בכרטיס. עד 4 הצעות.

מדיה

קובץ מדיה בתוך כרטיס מתקדם.

ייצוג JSON
{
  "height": enum (Media.Height),

  // Union field content can be only one of the following:
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
שדות
height

enum (Media.Height)

גובה המדיה בתוך כרטיס מתקדם בפריסה אנכית. בכרטיס עצמאי עם פריסה אופקית, לא ניתן להתאים אישית את הגובה והמערכת מתעלמת מהשדה הזה.

שדה איחוד content. תוכן המדיה content יכול להיות רק אחת מהאפשרויות הבאות:
fileName
(deprecated)

string

השם הייחודי של הקובץ, שהוחזר על ידי הפלטפורמה של RBM כשהקובץ הועלה. הוצא משימוש לטובת UploadRbmFile למטה

uploadedRbmFile

object (UploadedRbmFile)

יש מזהים של קובץ ותמונה ממוזערת שהועלו לשרת של RBM והוצגו על ידיו.

contentInfo

object (ContentInfo)

מידע על קובץ, כולל כתובת ה-URL שלו וכתובת ה-URL של התמונה הממוזערת שלו.

הפלטפורמה של RBM מציגה תוכן מהמטמון, אבל סוכן יכול לאלץ את הפלטפורמה של RBM לאחזר גרסה חדשה של התוכן ולרענן את המטמון.

ContentInfo

הודעה שמכילה את פרטי התוכן.

ייצוג JSON
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean
}
שדות
fileUrl

string

כתובת ה-URL של הקובץ שגלויה לכולם. פלטפורמת RBM קובעת את סוג ה-MIME של הקובץ מהשדה של סוג התוכן בכותרות ה-HTTP כשהפלטפורמה מאחזרת את הקובץ. השדה של סוג התוכן חייב להיות נוכח ומדויק בתגובת ה-HTTP מכתובת האתר. גודל הקובץ המקסימלי המומלץ: 100MB.

thumbnailUrl

string

(אופציונלי, בקובצי תמונה, אודיו ווידאו בלבד) כתובת URL של התמונה הממוזערת שגלויה לכולם. גודל מקסימלי של 100kB.

אם לא תספקו כתובת URL של תמונה ממוזערת, פלטפורמת RBM תציג תמונה ממוזערת ריקה כ-placeholder, עד שהמכשיר של המשתמש יוריד את הקובץ. בהתאם להגדרת המשתמש, ייתכן שההורדה של הקובץ לא תתבצע אוטומטית והמשתמש יצטרך להקיש על לחצן ההורדה.

forceRefresh

boolean

אם המדיניות מוגדרת, פלטפורמת RBM מאחזרת את הקובץ ואת התמונה הממוזערת מכתובות ה-URL שצוינו, גם אם יש בפלטפורמה עותקים של הקובץ (ו/או של התמונה הממוזערת) שנשמרו במטמון.

Media.Height

גובה מדיה

טיפוסים בני מנייה (enum)
HEIGHT_UNSPECIFIED לא צוין.
SHORT 112 DP.
MEDIUM 168 DP.
TALL 264 DP. האפשרות הזו לא זמינה לקרוסלות עם כרטיסים מתקדמים אם רוחב הכרטיס מוגדר לקטן.

הצעה

הצעה לתשובה או הצעה לפעולה בתוך כרטיס מתקדם או ברשימת צ'יפים של הצעות.

ייצוג JSON
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of list of possible types for union field option.
}
שדות
שדה איחוד option. הצעה לתשובה או הצעה לפעולה option יכולות להיות רק אחת מהאפשרויות הבאות:
reply

object (SuggestedReply)

המשתמשים יכולים להקיש על הצעה לתשובה כדי לשלוח את התשובה בהודעת הטקסט לנציג.

action

object (SuggestedAction)

המשתמשים יכולים להקיש על הצעה לפעולה כדי להפעיל את הפעולה המקורית התואמת במכשיר.

SuggestedReply

כשמקישים על הלחצן, התשובה נשלחת בחזרה לנציג.

ייצוג JSON
{
  "text": string,
  "postbackData": string
}
שדות
text

string

טקסט שמוצג בתשובה המוצעת ונשלח חזרה לנציג כאשר המשתמש יקיש עליו. 25 תווים לכל היותר.

postbackData

string

המטען הייעודי (payload) בקידוד base64 שהסוכן מקבל באירוע של משתמש כשהמשתמש מקיש על התשובה המוצעת.

SuggestedAction

הקשה על הלחצן מפעילה את הפעולה המותאמת במכשיר.

ייצוג JSON
{
  "text": string,
  "postbackData": string,
  "fallbackUrl": string,

  // Union field action can be only one of the following:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  }
  // End of list of possible types for union field action.
}
שדות
text

string

הטקסט שמוצג בפעולה המוצעת. 25 תווים לכל היותר.

postbackData

string

מטען ייעודי (payload) (בקידוד base64) שיישלח לסוכן באירוע של המשתמש שמתרחש כשהמשתמש יקיש על הפעולה המוצעת

fallbackUrl

string

(אופציונלי) כתובת URL חלופית לשימוש אם הלקוח לא תומך בפעולה מוצעת. כתובות URL חלופיות נפתחות בחלונות חדשים בדפדפן.

שדה איחוד action. הפעולה המותאמת שמופעלת במכשיר כשהמשתמש מקיש על ההצעה לפעולה action יכולה להיות רק אחת מהאפשרויות הבאות:
dialAction

object (DialAction)

פתיחה של אפליקציית החייגן שמוגדרת כברירת מחדל כאשר ממולא מספר הטלפון שצוין על ידי הסוכן.

viewLocationAction

object (ViewLocationAction)

פותח את אפליקציית המפות שמוגדרת כברירת מחדל ובוחר את המיקום שצוין בסוכן או מחפש מידע על המיקום של המשתמש בהתאם לשאילתה שצוינה בסוכן.

createCalendarEventAction

object (CreateCalendarEventAction)

פותח את אפליקציית היומן שמוגדרת כברירת מחדל ומתחיל תהליך חדש של אירועים ביומן כאשר נתוני האירוע שצוינו על ידי הסוכן ממולאים מראש.

openUrlAction

object (OpenUrlAction)

פותח את אפליקציית ברירת המחדל של המשתמש לדפדפן האינטרנט לכתובת ה-URL הנתונה. אם למשתמש יש אפליקציה מותקנת ורשומה כ-handler ברירת המחדל לכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת והסמל שלה ישמש בממשק המשתמש של הפעולות המומלצות.

shareLocationAction

object (ShareLocationAction)

פותח את בוחר המיקום של אפליקציית RCS כדי שהמשתמש יוכל לבחור מיקום לשלוח לנציג.

DialAction

פתיחה של אפליקציית החייגן שמוגדרת כברירת מחדל כאשר ממולא מספר הטלפון שצוין על ידי הסוכן.

ייצוג JSON
{
  "phoneNumber": string
}
שדות
phoneNumber

string

מספר הטלפון בפורמט E.164, למשל +12223334444.

ViewLocationAction

פותח את אפליקציית המפות שמוגדרת כברירת מחדל ובוחר את המיקום שצוין בסוכן או מחפש מידע על המיקום של המשתמש בהתאם לשאילתה שצוינה בסוכן.

ייצוג JSON
{
  "latLong": {
    object (LatLng)
  },
  "label": string,
  "query": string
}
שדות
latLong

object (LatLng)

(אופציונלי) קו הרוחב וקו האורך של המיקום שצוין.

label

string

(אופציונלי) התווית של הסיכה הופחתה ב-latLong.

query

string

(אופציונלי, האפשרות נתמכת רק בלקוחות Android Messages) במקום לציין latLong (ואפשר גם להוסיף תווית), הסוכן יכול לציין מחרוזת שאילתה. באפליקציות מיפוי שמוגדרות כברירת מחדל שתומכות בפונקציונליות חיפוש (כולל מפות Google), הקשה על ההצעה הזו לפעולה מובילה לחיפוש מיקום שמבוסס על המיקום הנוכחי של המשתמש. אם השאילתה ספציפית מספיק, הנציגים יוכלו להשתמש בה כדי לבחור כל מיקום בעולם.

לדוגמה, הגדרת מחרוזת השאילתה כ-"Growing Tree Bank" יציג את כל המיקומים של בנק עצים שנמצאים בקרבת המשתמש. הגדרת מחרוזת השאילתה ל"1600 Amphitheater Parkway, Mountain View, CA 94043" יבחר את הכתובת הספציפית הזו, בלי קשר למיקום של המשתמש.

LatLng

אובייקט שמייצג צמד של קו רוחב/קו אורך. הערך הזה מבוטאת כצמד של כפולים כדי לייצג מעלות קו רוחב ומעלות קו אורך. האובייקט חייב לעמוד ב תקן WGS84, אלא אם צוין אחרת. הערכים חייבים להיות בטווחים מנורמלים.

ייצוג JSON
{
  "latitude": number,
  "longitude": number
}
שדות
latitude

number

קו הרוחב במעלות. הוא חייב להיות בטווח [-90.0, +90.0].

longitude

number

קו האורך במעלות. הוא חייב להיות בטווח [-180.0, +180.0].

CreateCalendarEventAction

פותח את אפליקציית היומן שמוגדרת כברירת מחדל ומתחיל תהליך חדש של אירוע ביומן כאשר נתוני האירוע שצוינו על ידי הסוכן ממולאים מראש.

ייצוג JSON
{
  "startTime": string,
  "endTime": string,
  "title": string,
  "description": string
}
שדות
startTime

string (Timestamp format)

שעת ההתחלה של האירוע.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

שעת הסיום של האירוע.

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

title

string

כותרת האירוע.

description

string

תיאור האירוע.

OpenUrlAction

פותח את אפליקציית ברירת המחדל של המשתמש לדפדפן האינטרנט לכתובת ה-URL שצוינה. אם למשתמש יש אפליקציה מותקנת ורשומה כ-handler שמוגדר כברירת מחדל בכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת, והסמל שלה ישמש בממשק המשתמש של הפעולות המומלצות.

ייצוג JSON
{
  "url": string
}
שדות
url

string

כתובת URL

ShareLocationAction

אין שדות בסוג הזה.

פותח את הכלי לבחירת מיקום של אפליקציית RCS, כדי שהמשתמש יוכל לבחור מיקום ולשלוח אותו חזרה לנציג.

StandaloneCard

כרטיס עצמאי

ייצוג JSON
{
  "cardOrientation": enum (StandaloneCard.CardOrientation),
  "thumbnailImageAlignment": enum (StandaloneCard.ThumbnailImageAlignment),
  "cardContent": {
    object (CardContent)
  }
}
שדות
cardOrientation

enum (StandaloneCard.CardOrientation)

כיוון הכרטיס.

thumbnailImageAlignment

enum (StandaloneCard.ThumbnailImageAlignment)

יישור התצוגה המקדימה של התמונות לכרטיסים נפרדים עם פריסה אופקית.

cardContent

object (CardContent)

תוכן הכרטיס.

StandaloneCard.CardOrientation

כיוון הכרטיס.

טיפוסים בני מנייה (enum)
CARD_ORIENTATION_UNSPECIFIED לא צוין.
HORIZONTAL

פריסה אופקית.

אם השדה object(CardContent) בכרטיס צ'אט אופקי מכיל את השדה media, הוא צריך לכלול גם את השדה title, description או suggestions[] לפחות.

VERTICAL פריסה אנכית.

StandaloneCard.ThumbnailImageAlignment

יישור התצוגה המקדימה של התמונות לכרטיסים נפרדים עם פריסה אופקית.

טיפוסים בני מנייה (enum)
THUMBNAIL_IMAGE_ALIGNMENT_UNSPECIFIED לא צוין.
LEFT התצוגה המקדימה של הקובץ מיושרת לשמאל.
RIGHT התצוגה המקדימה של הקובץ מיושרת לימין.

שיטות

create

ההודעות נשלחות מהנציג למשתמש.

delete

ביטול הודעה שנשלחה לנציג תמיכה אבל עדיין לא נמסרה.