REST Resource: conversations.messages

משאב: הודעה

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

ייצוג JSON 
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
שדות
name

string

שם ההודעה, כפי שהוגדר על ידי Business Messages. מסתיים כך: 'conversations/{conversationId}/messages/{messageId}', כאשר {conversationId} הוא המזהה הייחודי של השיחה ו-{messageId} הוא המזהה הייחודי של ההודעה.
messageId

string

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

object (Representative)

פרטים על הנציג (אדם או צ'אט בוט) ששלח את ההודעה.
suggestions[]

object (Suggestion)

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

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

string

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

boolean

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

string

הודעת טקסט. 3,072 תווים לכל היותר.
image

object (Image)

הודעת תמונה.
richCard

object (RichCard)

הודעת כרטיס עשיר.

תמונה

תמונה.

ייצוג JSON 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
שדות
שדה איחוד content. תוכן התמונה. content יכול להיות רק אחת מהאפשרויות הבאות:
contentInfo

object (ContentInfo)

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

ContentInfo

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

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

string

כתובת ה-URL של הקובץ שגלויה לכולם. הפלטפורמה קובעת את סוג ה-MIME של הקובץ מהשדה Content-type (סוג התוכן) בכותרות ה-HTTP, כשהפלטפורמה מאחזרת את הקובץ. השדה של סוג התוכן חייב להיות נוכח ומדויק בתגובת ה-HTTP מכתובת האתר.

הקובץ לא יכול להיות גדול מ-5MB.

סוגי תוכן נתמכים: image/jpeg, תמונה/jpg, תמונה/png, תמונה/webp
thumbnailUrl

string

זה שינוי אופציונלי. כתובת ה-URL של התמונה הממוזערת שגלויה לכולם.

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

הקובץ לא יכול להיות גדול מ-25KB.

סוגי תוכן נתמכים: image/jpeg, תמונה/jpg, תמונה/png, תמונה/webp
forceRefresh

boolean

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

string

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

RichCard

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

ייצוג JSON 
{

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

object (StandaloneCard)

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

object (CarouselCard)

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

StandaloneCard

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

ייצוג JSON 
{
  "cardContent": {
    object (CardContent)
  }
}
שדות
cardContent

object (CardContent)

תוכן הכרטיס.

CardContent

תוכן הכרטיס.

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

string

זה שינוי אופציונלי. כותרת הכרטיס. עד 200 תווים.
description

string

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

object (Media)

זה שינוי אופציונלי. מדיה שתופיע בכרטיס.
suggestions[]

object (Suggestion)

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

מדיה

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

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

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

enum (Height)

גובה המדיה בתוך כרטיס מתקדם.
שדה איחוד content. תוכן מדיה. content יכול להיות רק אחת מהאפשרויות הבאות:
contentInfo

object (ContentInfo)

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

גובה

גובה מדיה

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

הצעה

הצעה ברשימת צ'יפים.

ייצוג JSON 
{

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

object (SuggestedReply)

הצעה למשתמש להשיב עם טקסט שצוין.
action

object (SuggestedAction)

הצעה לפעולה שמפעילה פעולה מובנית במכשיר.
liveAgentRequest

object (LiveAgentRequest)

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

object (AuthenticationRequest)

בקשה להתחלת תהליך האימות.

SuggestedReply

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

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

string

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

string

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

SuggestedAction

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

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

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

string

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

string

המחרוזת שהסוכן מקבל כשמשתמש מקיש על הפעולה המוצעת. 2,048 תווים לכל היותר.
שדה איחוד action. הפעולה המותאמת שמופעלת במכשיר כשהמשתמש מקיש על הפעולה המוצעת. action יכול להיות רק אחת מהאפשרויות הבאות:
openUrlAction

object (OpenUrlAction)

פתיחת כתובת ה-URL שצוינה.
dialAction

object (DialAction)

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

OpenUrlAction

פתיחת כתובת ה-URL שצוינה.

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

string

כתובת URL

DialAction

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

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

string

חובה. מספר הטלפון שצוין, בפורמט RFC 3966. לדוגמה, +1-201-555-0123.

LiveAgentRequest

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

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

AuthenticationRequest

בקשה לאימות שיחה.

ייצוג JSON 
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
שדות
שדה איחוד authentication_type. סוג האימות. authentication_type יכול להיות רק אחת מהאפשרויות הבאות:
oauth

object (Oauth)

פרטי אימות דרך OAuth.

OAuth

פרטי אימות דרך OAuth.

ייצוג JSON 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
שדות
clientId

string

חובה. המזהה של האפליקציה שמבקשת הרשאה.
codeChallenge

string

חובה. אתגר הקוד המשמש להחלפת אסימוני גישה.
scopes[]

string

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

string

זה שינוי אופציונלי. השיטה לאימות הקוד ששימשה ליצירת אתגר הקוד. אם לא משמיטים את הפרמטר הזה, השרת מניח ש-plain.

CarouselCard

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

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

enum (CardWidth)

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

object (CardContent)

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

CardWidth

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

טיפוסים בני מנייה (enum)
CARD_WIDTH_UNSPECIFIED לא רוצה להגדיר
SMALL 136 DP. לא ניתן לכלול מדיה בפורמט גבוה.
MEDIUM 280 DP.

שיטות

create

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

updateReceipt

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