Method: phones.getCapabilities

קבלת היכולות שקשורות ל-RCS לעסקים של משתמש.

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

טיפול בשגיאות: שגיאה מסוג 404 NOT_FOUND מוחזרת כשאי אפשר ליצור קשר עם המשתמש באמצעות RCS לעסקים. זה כולל כמה תרחישים: (1) המכשיר של המשתמש לא תומך ב-RCS או שה-RCS מושבת בו. ‫(2) המשתמש נמצא ברשת סלולרית שבה הסוכן לא מופעל או שבה תנועת הנתונים של RCS לא מופעלת. ‫(3) סוכן שלא הושק מבקש את היכולות של משתמש שלא משתתף בבדיקות.

בקשת HTTP

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

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

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

פרמטרים
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. אם מזהה הבקשה זהה למזהה שהסוכן השתמש בו בבקשה קודמת, פלטפורמת RCS לעסקים מתעלמת מהבקשה החדשה.
agentId

string

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

גוף הבקשה

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

גוף התשובה

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

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

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

enum (Feature)

רשימה של תכונות RCS לעסקים שהמכשיר הזה תומך בהן.

היקפי הרשאה

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

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

ניתן למצוא מידע נוסף כאן: OAuth 2.0 Overview.

תכונה

סוגי התכונות של RCS לעסקים שהמשתמש תומך בהן.

טיפוסים בני מנייה (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.