Method: phones.getCapabilities

הצגת יכולות שקשורות ל-RBM של משתמש.

המטען הייעודי (payload) שמוחזר מציין אם אפשר להגיע למשתמש באמצעות RBM, ואם כן, באילו תכונות של RBM הוא תומך. אם אי אפשר להגיע למשתמש באמצעות RBM, פלטפורמת RBM תחזיר את הערך 404 NOT_FOUND.

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

בקשת HTTP

GET https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*}/capabilities

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים

פרמטרים
`name`	`string` השדה הזה מקבל את הערך 'phones/{E.164}/capabilities', כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164. לדוגמה, למשתמש עם מספר הטלפון בארה"ב הוא +1-222-333-4444, נקודת הקצה שתתקבל היא https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

name

string

השדה הזה מקבל את הערך 'phones/{E.164}/capabilities', כאשר {E.164} הוא מספר הטלפון של המשתמש בפורמט E.164. לדוגמה, למשתמש עם מספר הטלפון בארה"ב הוא +1-222-333-4444, נקודת הקצה שתתקבל היא https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.

פרמטרים של שאילתה

פרמטרים

פרמטרים
`requestId`	`string` המזהה הייחודי של הבקשה, שהוקצה על ידי הנציג. המזהה חייב להיות מזהה ייחודי אוניברסלי (UUID), כפי שמוגדר בכתובת https://tools.ietf.org/html/rfc4122. אם מזהה הבקשה תואם למזהה שבו הסוכן השתמש בבקשה קודמת, הפלטפורמה של RBM תתעלם מהבקשה החדשה.
`agentId`	`string` חובה. המזהה הייחודי של הנציג.

requestId

string

המזהה הייחודי של הבקשה, שהוקצה על ידי הנציג. המזהה חייב להיות מזהה ייחודי אוניברסלי (UUID), כפי שמוגדר בכתובת https://tools.ietf.org/html/rfc4122. אם מזהה הבקשה תואם למזהה שבו הסוכן השתמש בבקשה קודמת, הפלטפורמה של RBM תתעלם מהבקשה החדשה.

agentId

string

חובה. המזהה הייחודי של הנציג.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

רשימת התכונות שנתמכות על ידי המשתמש

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON
{ "features": [ enum (`Feature`) ] }

שדות

שדות
`features[]`	`enum (Feature)` רשימה של תכונות RBM שנתמכות במכשיר הזה.

features[]

enum (Feature)

רשימה של תכונות RBM שנתמכות במכשיר הזה.

היקפי הרשאות

נדרש היקף OAuth הבא:

https://www.googleapis.com/auth/rcsbusinessmessaging

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

התכונה

סוגי התכונות של RBM שנתמכות על ידי המשתמש.

טיפוסים בני מנייה (enums)
`FEATURE_UNSPECIFIED`	לא צוין.
`REVOCATION`	ביטול. אם המשתמש תומך בביטול, הנציג יכול לבטל את ההודעה שהוא שלח לפני שפלטפורמת RBM מעבירה את ההודעה.
`RICHCARD_STANDALONE`	כרטיסי חיפוש מתקדמים עצמאיים.
`RICHCARD_CAROUSEL`	קרוסלה של כרטיסי חיפוש מתקדמים.
`ACTION_CREATE_CALENDAR_EVENT`	הצעה לפעולה ליצירת אירוע ביומן.
`ACTION_DIAL`	פעולה מומלצת לחיוג מספר.
`ACTION_OPEN_URL`	הצעה לפעולה לפתיחת כתובת URL.
`ACTION_SHARE_LOCATION`	הצעה לפעולה לשיתוף מיקום.
`ACTION_VIEW_LOCATION`	פעולה מומלצת להצגת מיקום באפליקציית מפות.