CapabilityCallbackResponse

היכולת של המשתמש להשתמש ב-RBM. התגובה הזו היא תוצאה של בקשת capability.requestCapabilityCallback מהסוכן.

התשובה CapabilityCallbackResponse מופיעה בשדה data של האובייקט message שהסוכן מקבל מהמינוי שלו ל-Google Pub/Sub. השדה 'data' הוא מחרוזת בקידוד base64 שהסוכן צריך לפענח כדי להתאים למבנה של CapabilityCallbackResponse. הוצא משימוש: כבר לא בשימוש.

ייצוג ב-JSON
{
  "requestId": string,
  "phoneNumber": string,
  "rbmEnabled": boolean,
  "features": [
    enum (Feature)
  ],
  "status": {
    object (Status)
  }
}
שדות
requestId

string

המזהה הייחודי האוניברסלי (UUID) שהוקצה על ידי הסוכן לבקשה capability.requestCapabilityCallback.

phoneNumber

string

מספר הטלפון של המשתמש בפורמט E.164.

rbmEnabled

boolean

האם המשתמש יכול להשתתף בשיחות RBM עם נציגים.

features[]

enum (Feature)

רשימה של כל התכונות של RBM שנתמכות במספר הטלפון הזה

status

object (Status)

הסטטוס של התגובה. אם בדיקת היכולת נכשלת, היא כוללת הודעות שגיאה.

סטטוס

הסוג Status מגדיר מודל שגיאות לוגי שמתאים לסביבות תכנות שונות, כולל ממשקי API ל-REST ול-RPC. היא משמשת את gRPC. כל הודעת Status מכילה שלושה פריטי נתונים: קוד שגיאה, הודעת שגיאה ופרטי שגיאה.

מידע נוסף על מודל השגיאות הזה ועל אופן השימוש בו זמין ב-API Design Guide.

ייצוג ב-JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
שדות
code

integer

קוד הסטטוס, שצריך להיות ערך enum של google.rpc.Code.

message

string

הודעת שגיאה שמוצגת למפתח, שצריכה להיות באנגלית. כל הודעת שגיאה שמוצגת למשתמש צריכה להיות מותאמת לשפה המקומית ולהישלח בשדה google.rpc.Status.details, או להיות מותאמת לשפה המקומית על ידי הלקוח.

details[]

object

רשימה של הודעות שכוללות את פרטי השגיאה. יש קבוצה משותפת של סוגי הודעות לשימוש בממשקי API.

אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף "@type" מכיל URI שמזהה את הסוג. דוגמה: { "id": 1234, "@type": "types.example.com/standard/id" }