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

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

string

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

לדוגמה, אם מגדירים את מחרוזת השאילתה כ-Growing Tree Bank, יוצגו כל המיקומים של 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, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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

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