REST Resource: phones.agentMessages

משאב: AgentMessage

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

ייצוג ב-JSON 
{
  "name": string,
  "sendTime": string,
  "contentMessage": {
    object (AgentContentMessage)
  },
  "messageTrafficType": enum (MessageTrafficType),
  "richMessageClassification": {
    object (RichMessageClassification)
  },
  "totalPayloadSizeBytes": string,
  "carrier": string,

  // 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

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

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
contentMessage

object (AgentContentMessage)

התוכן של ההודעה מהסוכן.
messageTrafficType

enum (MessageTrafficType)

סוג התנועה של ההודעה.
richMessageClassification

object (RichMessageClassification)

פלט בלבד. מסווגת את ההודעה בהתאם למודל החיוב בארה"ב. פרטים על כל סוג סיווג מופיעים במדריך מודל החיוב בארה"ב. השדה הזה מאוכלס רק עבור מספרי טלפון בארה"ב.
totalPayloadSizeBytes

string (int64 format)

פלט בלבד. הגודל הכולל של מטען הייעודי של ההודעה בבייטים. המטען הייעודי כולל את כל הקבצים המצורפים בהודעת RCS for Business, שיכולים להיות סרטונים, תמונות, קובצי PDF וכו', למעט הטקסט של ההודעה או ההצעות. בשלב הזה, השדה הזה מאוכלס רק עבור מספרי טלפון בארה"ב.
carrier

string

פלט בלבד. פרטי הספק שאליו משויך מספר הטלפון של המשתמש, לפי מערכות העורף של Google RCS. בשלב הזה, השדה הזה מאוכלס רק עבור מספרי טלפון בארה"ב.

שדה איחוד expiration.

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

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
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. ‫3,072 תווים לכל היותר.
fileName
(deprecated)

string

השם הייחודי של קובץ. פלטפורמת RCS for Business מחזירה שם קובץ כשסוכן מעלה קובץ. השיטה הזו הוצאה משימוש לטובת השיטה uploadedRbmFile שמופיעה בהמשך.
uploadedRbmFile

object (UploadedRbmFile)

הקובץ מכיל מזהים של קובץ ותמונה ממוזערת שהועלו לשרת RCS for Business ומוצגים ממנו.
richCard

object (RichCard)

כרטיס מתקדם עצמאי.
contentInfo

object (ContentInfo)

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

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

UploadedRbmFile

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

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

string

השם של הקובץ, שמוחזר על ידי פלטפורמת RCS for Business כשהקובץ מועלה.
thumbnailName

string

השם של התמונה הממוזערת, שמוחזר על ידי פלטפורמת RCS for Business כשהתמונה הממוזערת הועלתה.

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, סרטון, PDF) שרוצים לכלול בכרטיס.
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

השם הייחודי של הקובץ, שמוחזר על ידי פלטפורמת RCS for Business כשהקובץ מועלה. השיטה הזו הוצאה משימוש לטובת השיטה uploadedRbmFile שמופיעה בהמשך.
uploadedRbmFile

object (UploadedRbmFile)

הקובץ מכיל מזהים של קובץ ותמונה ממוזערת שהועלו לשרת RCS for Business ומוצגים ממנו.
contentInfo

object (ContentInfo)

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

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

ContentInfo

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

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

string

כתובת URL של הקובץ שנגישה לכולם. פלטפורמת RCS לעסקים קובעת את סוג ה-MIME של הקובץ מהשדה content-type בכותרות ה-HTTP כשהפלטפורמה מאחזרת את הקובץ. השדה content-type חייב להופיע בתגובת ה-HTTP מכתובת ה-URL, והערך שלו צריך להיות מדויק. גודל הקובץ המקסימלי המומלץ הוא 100MB.

הערה: הפניות לכתובות URL בקובץ אינן אפשריות. אם נדרשת הפניה אוטומטית, צריך להשתמש ב-CreateFileRequest.
thumbnailUrl

string

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

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

הערה: הפניות לכתובות URL בקובץ אינן אפשריות. אם נדרשת הפניה אוטומטית, צריך להשתמש ב-CreateFileRequest.
forceRefresh

boolean

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

Media.Height

גובה מדיה

טיפוסים בני מנייה (enum)
HEIGHT_UNSPECIFIED לא צוין.
SHORT ‫112 DP.
MEDIUM ‫168 DP.
TALL ‫264 DP.

הצעה

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

ייצוג ב-JSON 
{
  "suggestionDisplay": enum (Suggestion.SuggestionDisplay),

  // 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.
}
שדות
suggestionDisplay

enum (Suggestion.SuggestionDisplay)

אופציונלי. שליטה בהתנהגות התצוגה של ההצעה. רלוונטי רק להודעות טקסט פשוטות שנשלחות ללקוחות של Google Messages (גרסה 20260225.00 ואילך). השדה הזה צריך להיות מוגדר רק בהצעות עצמאיות שמשויכות להודעות בטקסט פשוט. השרת ידחה את ההודעה אם השדה הזה יוחל על הצעות בצ'אט אינטראקטיבי או על הצעות עצמאיות עם העברות קבצים. ההגדרה הזו עוברת סריאליזציה רק ב-Google Messages. לקוחות אחרים (כמו iOS או Samsung) מתעלמים ממנה.
שדה איחוד 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) שיישלח לסוכן באירוע המשתמש שמתקבל כשהמשתמש מקיש על הצעה לפעולה. 2048 תווים לכל היותר.
fallbackUrl

string

(אופציונלי) כתובת URL חלופית לשימוש אם לקוח לא תומך בהצעה לפעולה. כתובות URL חלופיות נפתחות בחלונות דפדפן חדשים. חובה להזין מזהה משאבים אחיד (URI) תקין כפי שמוגדר ב-RFC 3986. 2048 תווים לכל היותר.
שדה איחוד 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)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
title

string

שם האירוע. 100 תווים לכל היותר.
description

string

תיאור האירוע. עד 500 תווים.

OpenUrlAction

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

ייצוג ב-JSON 
{
  "url": string,
  "application": enum (OpenUrlApplication),
  "webviewViewMode": enum (WebviewViewMode),
  "description": string
}
שדות
url

string

כתובת ה-URL לפתיחה. החל מ-1 בנובמבר 2025, סכימת כתובת ה-URL חייבת להיות https:// ‎ או http://‎. אחרי התאריך הזה, בקשות ל-API שמשתמשות בסכימות אחרות (למשל, tel:, mailto:, sms:) יידחו עם השגיאה 400 בקשה שגויה. כתובת ה-URL חייבת להיות מזהה משאבים אחיד (URI) תקין, כפי שמוגדר ב-RFC 3986. 2048 תווים לכל היותר.
application

enum (OpenUrlApplication)

אפליקציה, דפדפן או תצוגת אינטרנט לפתיחת כתובת URL. כדי לבדוק אם המכשיר של המשתמש תומך במצב תצוגת אינטרנט, צריך קודם להריץ בדיקת יכולות. פרטים נוספים זמינים במסמכי התיעוד: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities.
webviewViewMode

enum (WebviewViewMode)

מצב תצוגה של WebView.
description

string

תיאור הנגישות של תצוגת האינטרנט.

OpenUrlApplication

סוג האפליקציה שפותחת את כתובת ה-URL

טיפוסים בני מנייה (enum)
OPEN_URL_APPLICATION_UNSPECIFIED לא צוין, המערכת תשתמש בדפדפן כדי לפתוח את הקישור.
BROWSER משתמשים בדפדפן כדי לפתוח את כתובת ה-URL.
WEBVIEW פתיחה של כתובת URL בחלון משולב של תצוגת אינטרנט

WebviewViewMode

סוג מצב התצוגה של ה-WebView.

טיפוסים בני מנייה (enum)
WEBVIEW_VIEW_MODE_UNSPECIFIED לא צוין. כדי להשתמש ב-WebView, צריך לציין מצב תצוגה.
FULL נדרשת שכבת-על במסך מלא עם שיחת הצ'אטבוט שמתויגת בשורת הסטטוס.
HALF נדרשת שכבת-על במסך של חצי מסך.
TALL נדרשת שכבת-על במסך של שלושה רבעים.

ShareLocationAction

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

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

Suggestion.SuggestionDisplay

התנהגות התצוגה של הצעות טקסט עצמאיות.

טיפוסים בני מנייה (enum)
SUGGESTION_DISPLAY_UNSPECIFIED

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

  • ‫Google Messages להודעות טקסט פשוטות עצמאיות: ההצעות נעלמות אחרי ששולחים או מקבלים הודעות חדשות.
  • ‫iOS להודעות טקסט רגילות עצמאיות: ההצעות נעלמות רק אחרי שהמשתמש מקיש עליהן.
  • כל הלקוחות של כרטיסים עשירים: ההצעות תמיד קבועות. הגדרת suggestionDisplay בכרטיסים עשירים תגרום לשגיאה 400.
PERSISTENT ההצעה תמשיך להופיע בבועת ההודעה, גם אם יתווספו לשיחה הודעות חדשות.

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 התצוגה המקדימה של הקובץ מיושרת לימין.

MessageTrafficType

סוגי תנועת הודעות נתמכים. הספירה תורחב כדי לתמוך בסוגי תנועה נוספים.

טיפוסים בני מנייה (enum)
MESSAGE_TRAFFIC_TYPE_UNSPECIFIED התנהגות ברירת המחדל: סוג התנועה של ההודעה נקבע לפי תרחיש השימוש של הסוכן. לעדכן את סוג התנועה לפי הצורך על סמך תוכן ההודעה. לסוכנים לשימוש רב, לא מסופקת ברירת מחדל. צריך להגדיר את סוג התנועה באופן ידני (לדוגמה, TRANSACTION, ‏ PROMOTION).
AUTHENTICATION להודעות אימות בתרחיש לדוגמה של סוכן OTP.
TRANSACTION להודעות טרנזקציונליות בתרחישי שימוש של נציג טרנזקציונלי או נציג רב-תכליתי.
PROMOTION להודעות שיווקיות בתרחישי שימוש של סוכנים שיווקיים או סוכנים רב-תכליתיים.
SERVICEREQUEST להודעות לגבי שירותים שהמשתמש הסכים לקבל. משמש בתרחישי שימוש של סוכנים חד-פעמיים, טרנזקציונליים, שיווקיים או רב-פעמיים.
ACKNOWLEDGEMENT הודעות שמאשרות את בקשת המשתמש לביטול ההרשמה. משמש בתרחישי שימוש של סוכנים חד-פעמיים, טרנזקציונליים, שיווקיים או רב-פעמיים.

RichMessageClassification

לחיוב בארה"ב בלבד: פרטים על סיווג ההודעות שמשמש לחיוב.

ייצוג ב-JSON 
{
  "classificationType": enum (RichMessageClassificationType),
  "segmentCount": integer
}
שדות
classificationType

enum (RichMessageClassificationType)
segmentCount

integer

מספר המקטעים של 160 בייט בטקסט של ההודעה, תמיד מעוגל כלפי מעלה.

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

לדוגמה, הודעת טקסט באורך 300 בייט כוללת segmentCount של 2.

השדה הזה מאוכלס רק עבור סוגי הודעות RICH_MESSAGE.

RichMessageClassificationType

לחיוב בארה"ב בלבד: מציין את סיווג ההודעה לצורך חיוב.

חשוב: ספקי הסלולר בארה"ב קובעים את המחיר לסוגי ההודעות שניתנות לחיוב שמתוארים בדף הזה. ספקי הסלולר בארה"ב גם קובעים את החיוב הסופי של המפתחים על שליחת הודעות ב-RCS for Business. לקבלת מידע נוסף על תמחור או פרטי חיוב, אפשר לפנות לנציגים המתאימים של הספק.

טיפוסים בני מנייה (enum)
RICH_MESSAGE_CLASSIFICATION_TYPE_UNSPECIFIED לא רוצה להגדיר
RICH_MESSAGE הודעה מסווגת כהודעה עשירה בתנאים הבאים: 1. הוא לא מכיל צ'אטים אינטראקטיביים. 2. היא לא מכילה קבצים מצורפים. 3. כל ההצעות לפעולות שמופיעות בה צריכות להיות פעולת חיוג או פעולה של פתיחת כתובת URL שלא משתמשת ב-WebView.
RICH_MEDIA_MESSAGE כל הודעה שלא עומדת בקריטריונים של RICH_MESSAGE. ההודעות האלה כוללות כרטיס עשיר, קובץ מדיה או כל הצעה לפעולה מלבד חיוג או פתיחת כתובת URL בדפדפן.
SUGGESTED_ACTION_CLICK מייצג הקשה של משתמש על הצעה לפעולה (לא על הצעה לתשובה). הסיווג הזה חל רק על פעולות של משתמשים והוא מופיע רק במטען הייעודי (payload) של הודעת המשתמש ב-webhook. היא לא חלה על הודעות A2P.

Methods

create

 הסוכן שולח הודעה למשתמש.

delete

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