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. מקבל את הערך 'שיחות/{messageId}/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 של הקובץ משדה סוג התוכן בכותרות ה-HTTP כאשר הפלטפורמה מאחזרת את הקובץ. השדה content-type חייב להופיע בתגובת ה-HTTP מכתובת ה-URL ולוודא שהוא מדויק.

עד 5MB.

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

string

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

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

עד 25KB.

סוגי התוכן הנתמכים: image/jpeg, image/jpg, image/png, image/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 של התמונה הממוזערת שלו.

גובה

גובה מדיה

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

פתיחת כתובת האתר שצוינה.
dialAction

object (DialAction)

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

OpenUrlAction

פתיחת כתובת האתר שצוינה.

ייצוג 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

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

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

שיטות

create

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

updateReceipt

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