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} הוא מספר הטלפון של המשתמש בפורמט E.164 ו-{messageId} הוא המזהה שהוקצה על ידי הנציג להודעה של הנציג.
sendTime

string (Timestamp format)

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

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

object (AgentContentMessage)

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

שדה איחוד expiration.

expiration יכול להיות רק אחד מהבאים:
expireTime

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

טיפוסים בני מנייה (enums)
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 כשהפלטפורמה מאחזרת את הקובץ. השדה content-type חייב להיות קיים ומדויק בתגובת ה-HTTP מכתובת ה-URL. גודל הקובץ המקסימלי המומלץ הוא 100MB.
thumbnailUrl

string

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

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

boolean

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

Media.Height

גובה מדיה

טיפוסים בני מנייה (enums)
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

(אופציונלי) התווית של הסיכה נופלת בקו הרוחב.
query

string

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

לדוגמה, אם מגדירים את מחרוזת השאילתה "Growing Tree Bank", המערכת תציג את כל המיקומים של הבנק הלאומי של עצים באזור המשתמש. אם תגדירו את מחרוזת השאילתה ל-" 1600 A Amphitheatre 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, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

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

חותמת זמן בפורמט "זולו" RFC3339 UTC, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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

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

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

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

StandaloneCard.ThumbnailImageAlignment

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

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

שיטות

create

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

delete

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