Method: phones.getCapabilities

אחזור היכולות של משתמש שקשורות ל-RBM.

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
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

חובה. המזהה הייחודי של הסוכן.

גוף הבקשה

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

גוף התשובה

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

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

ייצוג ב-JSON 
{
  "features": [
    enum (Feature)
  ]
}
שדות
features[]

enum (Feature)

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

היקפי הרשאה

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

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

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

תכונה

סוגי התכונות של RBM שהמשתמש תומך בהן.

טיפוסים בני מנייה (enum)
FEATURE_UNSPECIFIED לא צוין.
RICHCARD_STANDALONE כרטיסים מתקדמים עצמאיים.
ACTION_CREATE_CALENDAR_EVENT הצעה לפעולה ליצירת אירוע ביומן.
ACTION_DIAL הצעה לפעולה של חיוג מספר.
ACTION_OPEN_URL הצעה לפעולה לפתיחת כתובת URL בדפדפן.
ACTION_SHARE_LOCATION הצעה לשיתוף מיקום.
ACTION_VIEW_LOCATION הצעה לפעולה להצגת מיקום באפליקציית מפות.
ACTION_OPEN_URL_IN_WEBVIEW הצעה לפעולה לפתיחת כתובת URL ב-WebView.
ACTION_COMPOSE הצעה לפעולה של כתיבת הודעה בטקסט, באודיו או בסרטון.