משאב: AgentMessage
הודעה שנשלחת מהנציג למשתמש.
| ייצוג ב-JSON |
|---|
{ "name": string, "sendTime": string, "contentMessage": { object ( |
| שדות | |
|---|---|
name |
השדה הזה מוגדר על ידי פלטפורמת RCS for Business. אל תכללו אותו כשאתם יוצרים הודעה של נציג. השדה פותר את "phones/{E.164}/agentMessages/{messageId}", כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164 ו-{messageId} הוא המזהה שהנציג הקצה להודעה של הנציג. |
sendTime |
השדה הזה מוגדר על ידי פלטפורמת RCS for Business. אל תכללו אותו כשאתם יוצרים הודעה של נציג. השדה הזה מציג את השעה שבה ההודעה נשלחת למשתמש. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
contentMessage |
התוכן של ההודעה מהסוכן. |
messageTrafficType |
סוג התנועה של ההודעות. |
richMessageClassification |
פלט בלבד. סיווג ההודעה לפי מודל החיוב בארה"ב. פרטים על כל סוג סיווג זמינים במדריך בנושא מודל החיוב בארה"ב. השדה הזה מאוכלס רק במספרי טלפון בארה"ב. |
totalPayloadSizeBytes |
פלט בלבד. הגודל הכולל של ההודעה בבייטים. המטען הייעודי סופר את כל הקבצים המצורפים בהודעת RCS for Business, שיכולים להיות וידאו, תמונות, קובצי PDF וכו', למעט הטקסט של ההודעה או ההצעות. נכון לעכשיו, השדה הזה מאוכלס רק במספרי טלפון בארה"ב. |
carrier |
פלט בלבד. פרטי הספק שמספר הטלפון של המשתמש שייך אליו, לפי שירותי הקצה של Google RCS. נכון לעכשיו, השדה הזה מאוכלס רק במספרי טלפון בארה"ב. |
| ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
expireTime |
זה שינוי אופציונלי. חותמת זמן ב-UTC של המועד שבו המשאב הזה נחשב כלא בתוקף. צריך להמתין לפחות שש שניות אחרי שליחת ההודעה. אם מציינים חותמת זמן עתידית של פחות מ-6 שניות אחרי השליחה, הפלטפורמה משנה אותה אוטומטית ל-6 שניות. כל חותמת זמן שזהה לזמן שליחת ההודעה או מוקדמת ממנו מחזירה שגיאה מסוג הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
ttl |
זה שינוי אופציונלי. קלט בלבד. משך הזמן שההודעה תהיה פעילה לפני שהיא תבוטל באופן אוטומטי. הערך המינימלי הוא שש שניות. אם מציינים משך זמן חיובי של פחות מ-6 שניות, הפלטפורמה משנה אותו באופן אוטומטי ל-6 שניות ומציגה את הערך המותאם בשדה משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
| סוף השדות שמוציאים זה את זה. | |
AgentContentMessage
התוכן של הודעה שנשלחה מהנציג למשתמש.
| ייצוג ב-JSON |
|---|
{ "suggestions": [ { object ( |
| שדות | |
|---|---|
suggestions[] |
רשימה של הצעות לתשובות והצעות לפעולות שמופיעות כרשימה של הצעות קשורות אחרי ההודעה המשויכת של הנציג. עד 11 הצעות. הצ'יפים מוצגים רק כשההודעה המשויכת של הנציג היא ההודעה האחרונה בשיחה (כולל הודעות של הנציג ושל המשתמש). המשתמש יכול ללחוץ על הצעה לתשובה כדי לשלוח את התשובה בטקסט חזרה לנציג, או ללחוץ על הצעה לפעולה כדי להתחיל פעולה מקורית במכשיר. יש שני סוגים של דפוסי הצעות: הצעות קבועות והצעות זמניות. מידע נוסף מופיע במאמר בנושא הצעות. |
| התוכן של ההודעה מהסוכן. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
text |
טקסט בקידוד UTF-8. מקסימום 3,072 תווים. |
fileName |
השם הייחודי של הקובץ. פלטפורמת RCS for Business מחזירה שם קובץ כשנציג מעלה קובץ. הוצא משימוש והוחלף ב-uploadedRbmFile שבהמשך. |
uploadedRbmFile |
מכיל מזהים של קובץ ותמונה ממוזערת שהועלו לשרת של RCS for Business ומוצגים על ידו. |
richCard |
צ'אט אינטראקטיבי נפרד. |
contentInfo |
מידע על קובץ, כולל כתובת ה-URL של הקובץ וכתובת ה-URL של התמונה הממוזערת של הקובץ. הפלטפורמה של RCS for Business מציגה תוכן מהמטמון, אבל נציג יכול לאלץ את הפלטפורמה של RCS for Business לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
| סוף השדות שמוציאים זה את זה. | |
UploadedRbmFile
הודעה שמכילה מידע על הקובץ ועל התמונה הממוזערת
| ייצוג ב-JSON |
|---|
{ "fileName": string, "thumbnailName": string } |
| שדות | |
|---|---|
fileName |
שם הקובץ, שמוחזר על ידי פלטפורמת RCS for Business כשהקובץ מועלה. |
thumbnailName |
שם התמונה הממוזערת, שמוחזר על ידי פלטפורמת 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 |
כרטיס עצמאי. |
| סוף השדות שמוציאים זה את זה. | |
CarouselCard
קרוסלה של צ'אטים אינטראקטיביים.
| ייצוג ב-JSON |
|---|
{ "cardWidth": enum ( |
| שדות | |
|---|---|
cardWidth |
רוחב הכרטיסים בקרוסלה. |
cardContents[] |
רשימת התכנים של כל כרטיס בקרוסלה. קרוסלה יכולה להכיל בין 2 ל-10 כרטיסים. |
CarouselCard.CardWidth
רוחב הכרטיסים בקרוסלה.
| טיפוסים בני מנייה (enum) | |
|---|---|
CARD_WIDTH_UNSPECIFIED |
לא צוין. |
SMALL |
120 נקודות לדקה. |
MEDIUM |
232 נקודות לד"א. |
CardContent
תוכן הכרטיס
| ייצוג ב-JSON |
|---|
{ "title": string, "description": string, "media": { object ( |
| שדות | |
|---|---|
title |
(אופציונלי) כותרת הכרטיס. מקסימום 200 תווים. |
description |
(אופציונלי) תיאור של הכרטיס. עד 2,000 תווים. |
media |
(אופציונלי) מדיה (תמונה, קובץ GIF, סרטון, קובץ PDF) שרוצים לכלול בכרטיס. |
suggestions[] |
(אופציונלי) רשימת הצעות שיופיעו בכרטיס. עד 4 הצעות. |
מדיה
קובץ מדיה בתוך צ'אט אינטראקטיבי.
| ייצוג ב-JSON |
|---|
{ "height": enum ( |
| שדות | |
|---|---|
height |
הגובה של המדיה בצ'אט אינטראקטיבי עם פריסה אנכית. בכרטיס עצמאי עם פריסה אופקית, צריך להשתמש ב- |
contentDescription |
זה שינוי אופציונלי. מתאר את תוכן המדיה לצורכי נגישות, ומספק טקסט חלופי. אפשר להזין עד 200 תווים של טקסט פשוט. |
| תוכן מדיה: הרשימה הבאה כוללת שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
fileName |
השם הייחודי של הקובץ, שמוחזר על ידי פלטפורמת RCS for Business כשהקובץ מועלה. הוצא משימוש והוחלף ב-uploadedRbmFile שבהמשך. |
uploadedRbmFile |
מכיל מזהים של קובץ ותמונה ממוזערת שהועלו לשרת של RCS for Business ומוצגים על ידו. |
contentInfo |
מידע על קובץ, כולל כתובת ה-URL של הקובץ וכתובת ה-URL של התמונה הממוזערת של הקובץ. הפלטפורמה של RCS for Business מציגה תוכן מהמטמון, אבל נציג יכול לאלץ את הפלטפורמה של RCS for Business לאחזר גרסה חדשה של התוכן ולרענן את המטמון. |
| סוף השדות שמוציאים זה את זה. | |
ContentInfo
הודעה שמכילה את פרטי התוכן.
| ייצוג ב-JSON |
|---|
{ "fileUrl": string, "thumbnailUrl": string, "forceRefresh": boolean } |
| שדות | |
|---|---|
fileUrl |
כתובת URL של הקובץ שנגישה לכולם. פלטפורמת RCS for Business קובעת את סוג ה-MIME של הקובץ לפי השדה content-type בכותרות ה-HTTP כשהפלטפורמה מאחזרת את הקובץ. השדה content-type חייב להיות קיים ומדויק בתגובת ה-HTTP מכתובת ה-URL. גודל הקובץ המקסימלי המומלץ הוא 100MB. הערה: אין תמיכה בהפניות אוטומטיות בכתובות URL של קבצים. אם נדרשת הפניה אוטומטית, צריך להשתמש ב-CreateFileRequest. |
thumbnailUrl |
(אופציונלי, לקובצי תמונה, אודיו ווידאו בלבד) כתובת URL של התמונה הממוזערת שנגישה לכולם. גודל מקסימלי של 100KB. אם לא תספקו כתובת URL של תמונה ממוזערת, פלטפורמת RCS for Business תציג תמונה ממוזערת ריקה כפלייסהולדר עד שהמכשיר של המשתמש יוריד את הקובץ. בהתאם להגדרות של המשתמש, יכול להיות שהקובץ לא ירד באופן אוטומטי והמשתמש יצטרך ללחוץ על כפתור ההורדה. הערה: אין תמיכה בהפניות אוטומטיות בכתובות URL של קבצים. אם נדרשת הפניה אוטומטית, צריך להשתמש ב-CreateFileRequest. |
forceRefresh |
אם מגדירים את הפרמטר הזה, פלטפורמת RCS for Business מאחזרת את הקובץ ואת התמונה הממוזערת מכתובות ה-URL שצוינו, גם אם יש בפלטפורמה עותקים של הקובץ (או של התמונה הממוזערת) במטמון. |
Media.Height
גובה מדיה
| טיפוסים בני מנייה (enum) | |
|---|---|
HEIGHT_UNSPECIFIED |
לא צוין. |
SHORT |
112 DP. |
MEDIUM |
168 DP. |
TALL |
264 פיקסלים לא תלויים במכשיר. |
הצעה
הצעה לתשובה או הצעה לפעולה שכלולה בצ'אט אינטראקטיבי או ברשימה של הצעות קשורות.
| ייצוג ב-JSON |
|---|
{ "suggestionDisplay": enum ( |
| שדות | |
|---|---|
suggestionDisplay |
זה שינוי אופציונלי. ההגדרה הזו קובעת איך ההצעה תוצג. רלוונטי רק להודעות טקסט פשוט שנשלחות ללקוחות Google Messages (גרסה 20260225.00 ואילך). צריך להגדיר את השדה הזה רק בהצעות עצמאיות שמשויכות להודעות טקסט פשוט. השרת ידחה את ההודעה אם השדה הזה יוחל על הצעות בצ'אטים אינטראקטיביים או על הצעות נפרדות עם העברות קבצים. ההגדרה הזו עוברת סריאליזציה רק ב-Google Messages. לקוחות אחרים (כמו iOS או סמסונג) מתעלמים ממנה. |
| הצעה לתשובה או הצעה לפעולה. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
reply |
המשתמשים יכולים ללחוץ על אחת מהצעות לתשובות כדי לשלוח את התשובה בטקסט לנציג. |
action |
המשתמשים יכולים ללחוץ על פעולה מוצעת כדי להפעיל את הפעולה המקומית המתאימה במכשיר. |
| סוף השדות שמוציאים זה את זה. | |
SuggestedReply
כשלוחצים על הכפתור, התשובה הכתובה נשלחת בחזרה לסוכן.
| ייצוג ב-JSON |
|---|
{ "text": string, "postbackData": string } |
| שדות | |
|---|---|
text |
הטקסט שמוצג בהצעה לתשובה ונשלח בחזרה לנציג כשהמשתמש לוחץ עליו. מקסימום 25 תווים. |
postbackData |
המטען הייעודי (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 ( |
| שדות | |
|---|---|
text |
הטקסט שמוצג בהצעה לפעולה. מקסימום 25 תווים. |
postbackData |
מטען ייעודי (payload) (בקידוד base64) שיישלח לנציג באירוע המשתמש שנוצר כשהמשתמש מקיש על הפעולה המוצעת. 2048 תווים לכל היותר. |
fallbackUrl |
(אופציונלי) כתובת URL לגיבוי, למקרה שהלקוח לא תומך בפעולה המוצעת. כתובות URL חלופיות נפתחות בחלונות חדשים בדפדפן. הערך צריך להיות מזהה URI תקין, כפי שמוגדר ב-RFC 3986. 2048 תווים לכל היותר. |
| הפעולה המקורית שמתחילה במכשיר כשהמשתמש לוחץ על הפעולה המוצעת. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים: | |
dialAction |
פתיחת אפליקציית החייגן שמוגדרת כברירת מחדל אצל המשתמש, עם מספר הטלפון שהנציג ציין. |
viewLocationAction |
פותחת את אפליקציית המפות שמוגדרת כברירת מחדל אצל המשתמש ובוחרת את המיקום שצוין על ידי הנציג, או מחפשת בסביבת המיקום של המשתמש לפי שאילתה שצוינה על ידי הנציג. |
createCalendarEventAction |
פתיחת אפליקציית היומן שמוגדרת כברירת מחדל במכשיר של המשתמש, והתחלת התהליך ליצירת אירוע חדש ביומן עם מילוי אוטומטי מראש של נתוני האירוע שצוינו על ידי הנציג. |
openUrlAction |
פותחת את אפליקציית דפדפן האינטרנט שמוגדרת כברירת מחדל אצל המשתמש בכתובת ה-URL שצוינה. אם למשתמש יש אפליקציה שרשומה כ-handler שמוגדר כברירת מחדל לכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת, והסמל שלה ישמש בממשק המשתמש של הפעולה המוצעת. |
shareLocationAction |
פתיחת בורר המיקום של אפליקציית ה-RCS כדי שהמשתמש יוכל לבחור מיקום ולשלוח אותו לנציג. |
| סוף השדות שמוציאים זה את זה. | |
DialAction
פתיחת אפליקציית החייגן שמוגדרת כברירת מחדל אצל המשתמש, עם מספר הטלפון שהנציג ציין.
| ייצוג ב-JSON |
|---|
{ "phoneNumber": string } |
| שדות | |
|---|---|
phoneNumber |
מספר הטלפון בפורמט E.164, לדוגמה, +12223334444. |
ViewLocationAction
פותחת את אפליקציית המפות שמוגדרת כברירת מחדל אצל המשתמש ובוחרת את המיקום שצוין על ידי הנציג, או מחפשת בסביבת המיקום של המשתמש לפי שאילתה שצוינה על ידי הנציג.
| ייצוג ב-JSON |
|---|
{
"latLong": {
object ( |
| שדות | |
|---|---|
latLong |
(אופציונלי) קו הרוחב וקו האורך של המיקום שצוין. |
label |
(אופציונלי) התווית של הסיכה שהוצבה ב-latLong. |
query |
(אופציונלי) במקום לציין latLong (ואופציונלית, תווית), הנציג יכול לציין מחרוזת שאילתה. באפליקציות מפות שמוגדרות כברירת מחדל ותומכות בפונקציונליות של חיפוש (כולל מפות Google), לחיצה על הפעולה המוצעת הזו גורמת לחיפוש מיקום שמתמקד במיקום הנוכחי של המשתמש. אם השאילתה מספיק ספציפית, הנציגים יכולים להשתמש בה כדי לבחור כל מיקום בעולם. לדוגמה, אם מגדירים את מחרוזת השאילתה "בנק הפועלים", יוצגו כל הסניפים של בנק הפועלים בסביבת המשתמש. אם מגדירים את מחרוזת השאילתה לערך "1600 Amphitheater Parkway, Mountain View, CA 94043", המערכת תבחר את הכתובת הספציפית הזו, בלי קשר למיקום של המשתמש. |
LatLng
אובייקט שמייצג זוג של קו רוחב וקו אורך. המיקום מיוצג על ידי זוג ערכים מסוג double שמייצגים את המעלות של קו הרוחב וקו האורך. אם לא צוין אחרת, האובייקט הזה חייב לעמוד ב תקן WGS84. הערכים צריכים להיות בטווחים מנורמלים.
| ייצוג ב-JSON |
|---|
{ "latitude": number, "longitude": number } |
| שדות | |
|---|---|
latitude |
קו הרוחב במעלות. הוא חייב להיות בטווח [-90.0, +90.0]. |
longitude |
קו האורך במעלות. הוא חייב להיות בטווח [-180.0, +180.0]. |
CreateCalendarEventAction
פתיחת אפליקציית היומן שמוגדרת כברירת מחדל במכשיר של המשתמש, והתחלת התהליך ליצירת אירוע חדש ביומן עם מילוי אוטומטי מראש של נתוני האירוע שצוינו על ידי הנציג.
| ייצוג ב-JSON |
|---|
{ "startTime": string, "endTime": string, "title": string, "description": string } |
| שדות | |
|---|---|
startTime |
שעת ההתחלה של האירוע. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
שעת הסיום של האירוע. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
title |
שם האירוע. 100 תווים לכל היותר. |
description |
תיאור האירוע. עד 500 תווים. |
OpenUrlAction
פתיחת אפליקציית דפדפן האינטרנט שמוגדרת כברירת המחדל של המשתמש בכתובת ה-URL שצוינה. אם למשתמש יש אפליקציה שרשומה כ-handler שמוגדר כברירת מחדל לכתובת ה-URL, האפליקציה הזו תיפתח במקום זאת, והסמל שלה ישמש בממשק המשתמש של הפעולה המוצעת.
| ייצוג ב-JSON |
|---|
{ "url": string, "application": enum ( |
| שדות | |
|---|---|
url |
כתובת ה-URL שתיפתח. החל מ-1 בנובמבר 2025, סכמת כתובת ה-URL חייבת להיות https:// או http://. אחרי התאריך הזה, בקשות API שמשתמשות בסכמות אחרות (למשל: tel:, mailto:, sms:) יידחו עם השגיאה 400 Bad Request. כתובת ה-URL חייבת להיות מזהה URI תקין, כפי שמוגדר ב-RFC 3986. 2048 תווים לכל היותר. |
application |
כתובת URL לפתיחת אפליקציה, דפדפן או תצוגת אינטרנט. כדי לבדוק אם המכשיר של המשתמש תומך במצב WebView, צריך קודם להריץ בדיקת יכולת. פרטים נוספים זמינים במסמכי התיעוד: https://developers.google.com/business-communications/rcs-business-messaging/guides/build/capabilities. |
webviewViewMode |
מצב תצוגה ל-WebView. |
description |
תיאור הנגישות של WebView. |
OpenUrlApplication
סוג האפליקציה לפתיחת כתובת ה-URL
| טיפוסים בני מנייה (enum) | |
|---|---|
OPEN_URL_APPLICATION_UNSPECIFIED |
לא צוין, ייפתח באמצעות הדפדפן. |
BROWSER |
צריך להשתמש בדפדפן כדי לפתוח את כתובת ה-URL. |
WEBVIEW |
פתיחה של כתובת ה-URL בחלון משולב של תצוגת אינטרנט |
WebviewViewMode
סוג מצב התצוגה של ה-WebView.
| טיפוסים בני מנייה (enum) | |
|---|---|
WEBVIEW_VIEW_MODE_UNSPECIFIED |
לא צוין. כדי להשתמש ב-webview, צריך לציין מצב תצוגה. |
FULL |
נדרשת שכבת-על במסך מלא עם תווית לשיחה עם הצ'אט בוט בשורת הסטטוס. |
HALF |
נדרשת שכבת-על של חצי מסך. |
TALL |
נדרשת שכבת-על בגודל שלושה רבעים מהמסך. |
Suggestion.SuggestionDisplay
ההתנהגות של הצעות הטקסט העצמאיות בתצוגה.
| טיפוסים בני מנייה (enum) | |
|---|---|
SUGGESTION_DISPLAY_UNSPECIFIED |
הלקוחות מפעילים את התנהגות ברירת המחדל של התצוגה:
|
PERSISTENT |
ההצעה תמשיך להופיע בבועת ההודעה, גם אם יתווספו הודעות חדשות לשיחה. |
StandaloneCard
כרטיס עצמאי
| ייצוג ב-JSON |
|---|
{ "cardOrientation": enum ( |
| שדות | |
|---|---|
cardOrientation |
כיוון הכרטיס. |
thumbnailImageAlignment |
יישור של תצוגה מקדימה של תמונה בכרטיסים נפרדים עם פריסה אופקית. |
cardContent |
תוכן הכרטיס. |
StandaloneCard.CardOrientation
כיוון הכרטיס.
| טיפוסים בני מנייה (enum) | |
|---|---|
CARD_ORIENTATION_UNSPECIFIED |
לא צוין. |
HORIZONTAL |
פריסה אופקית. אם השדה |
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 ( |
| שדות | |
|---|---|
classificationType |
|
segmentCount |
מספר המקטעים של 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 |
|
|---|---|
|
שליחת הודעה מהנציג למשתמש. |
|
ביטול הודעה של נציג שנשלחה אבל עדיין לא נמסרה. |