REST Resource: phones.agentMessages

משאב: AgentMessage

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "expireTime": string,
  "ttl": string
  // End of mutually exclusive fields.
}
שדות
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. נכון לעכשיו, השדה הזה מאוכלס רק במספרי טלפון בארה"ב.

ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
expireTime

string (Timestamp format)

זה שינוי אופציונלי. חותמת זמן ב-UTC של המועד שבו המשאב הזה נחשב כלא בתוקף. צריך להמתין לפחות שש שניות אחרי שליחת ההודעה. אם מציינים חותמת זמן עתידית של פחות מ-6 שניות אחרי השליחה, הפלטפורמה משנה אותה אוטומטית ל-6 שניות. כל חותמת זמן שזהה לזמן שליחת ההודעה או מוקדמת ממנו מחזירה שגיאה מסוג 400 INVALID_ARGUMENT. הערך הזה מוחזר בפלט אם expireTime או 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)

זה שינוי אופציונלי. קלט בלבד. משך הזמן שההודעה תהיה פעילה לפני שהיא תבוטל באופן אוטומטי. הערך המינימלי הוא שש שניות. אם מציינים משך זמן חיובי של פחות מ-6 שניות, הפלטפורמה משנה אותו באופן אוטומטי ל-6 שניות ומציגה את הערך המותאם בשדה expireTime של התגובה. כל משך זמן לא חיובי (אפס או פחות) מחזיר שגיאת 400 INVALID_ARGUMENT.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. לדוגמה: "3.5s".

סוף השדות שמוציאים זה את זה.

AgentContentMessage

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

ייצוג ב-JSON
{
  "suggestions": [
    {
      object (Suggestion)
    }
  ],

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "richCard": {
    object (RichCard)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of mutually exclusive fields.
}
שדות
suggestions[]

object (Suggestion)

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

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

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

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

סוף השדות שמוציאים זה את זה.

UploadedRbmFile

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

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

string

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

thumbnailName

string

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

RichCard

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

ייצוג ב-JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "carouselCard": {
    object (CarouselCard)
  },
  "standaloneCard": {
    object (StandaloneCard)
  }
  // End of mutually exclusive fields.
}
שדות
כרטיס נפרד או קרוסלה של כרטיסים. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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 נקודות לדקה.
MEDIUM ‫232 נקודות לד"א.

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),
  "contentDescription": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fileName": string,
  "uploadedRbmFile": {
    object (UploadedRbmFile)
  },
  "contentInfo": {
    object (ContentInfo)
  }
  // End of mutually exclusive fields.
}
שדות
height

enum (Media.Height)

הגובה של המדיה בצ'אט אינטראקטיבי עם פריסה אנכית. בכרטיס עצמאי עם פריסה אופקית, צריך להשתמש ב-TALL במקום ב-HEIGHT_UNSPECIFIED כדי שתהיה תאימות ל-iOS.

contentDescription

string

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

תוכן מדיה: הרשימה הבאה כוללת שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
fileName
(deprecated)

string

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

uploadedRbmFile

object (UploadedRbmFile)

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

contentInfo

object (ContentInfo)

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

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

סוף השדות שמוציאים זה את זה.

ContentInfo

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

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

string

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

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

thumbnailUrl

string

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

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

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

forceRefresh

boolean

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

Media.Height

גובה מדיה

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

הצעה

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  }
  // End of mutually exclusive fields.
}
שדות
suggestionDisplay

enum (Suggestion.SuggestionDisplay)

זה שינוי אופציונלי. ההגדרה הזו קובעת איך ההצעה תוצג. רלוונטי רק להודעות טקסט פשוט שנשלחות ללקוחות Google Messages (גרסה 20260225.00 ואילך). צריך להגדיר את השדה הזה רק בהצעות עצמאיות שמשויכות להודעות טקסט פשוט. השרת ידחה את ההודעה אם השדה הזה יוחל על הצעות בצ'אטים אינטראקטיביים או על הצעות נפרדות עם העברות קבצים. ההגדרה הזו עוברת סריאליזציה רק ב-Google Messages. לקוחות אחרים (כמו iOS או סמסונג) מתעלמים ממנה.

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "dialAction": {
    object (DialAction)
  },
  "viewLocationAction": {
    object (ViewLocationAction)
  },
  "createCalendarEventAction": {
    object (CreateCalendarEventAction)
  },
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "shareLocationAction": {
    object (ShareLocationAction)
  }
  // End of mutually exclusive fields.
}
שדות
text

string

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

postbackData

string

מטען ייעודי (payload) (בקידוד base64) שיישלח לנציג באירוע המשתמש שנוצר כשהמשתמש מקיש על הפעולה המוצעת. 2048 תווים לכל היותר.

fallbackUrl

string

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

הפעולה המקורית שמתחילה במכשיר כשהמשתמש לוחץ על הפעולה המוצעת. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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

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

לדוגמה, אם מגדירים את מחרוזת השאילתה "בנק הפועלים", יוצגו כל הסניפים של בנק הפועלים בסביבת המשתמש. אם מגדירים את מחרוזת השאילתה לערך "1600 Amphitheater Parkway, Mountain View, CA 94043", המערכת תבחר את הכתובת הספציפית הזו, בלי קשר למיקום של המשתמש.

LatLng

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

application

enum (OpenUrlApplication)

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

webviewViewMode

enum (WebviewViewMode)

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

description

string

תיאור הנגישות של WebView.

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

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

RichMessageClassification

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

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

enum (RichMessageClassificationType)

segmentCount

integer

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

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

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

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

RichMessageClassificationType

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

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

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

Methods

create

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

delete

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