CapabilityCallbackResponse

قابلیت RBM یک کاربر. این پاسخ نتیجه یک درخواست capability.requestCapabilityCallback از نماینده است.

CapabilityCallbackResponse در قسمت "داده" شی "پیام" که نماینده از اشتراک Google Pub/Sub دریافت می کند ظاهر می شود. فیلد "داده" یک رشته رمزگذاری شده با base64 است که عامل باید آن را رمزگشایی کند تا با ساختار CapabilityCallbackResponse مطابقت داشته باشد.

نمایندگی JSON 
{
  "requestId": string,
  "phoneNumber": string,
  "rbmEnabled": boolean,
  "features": [
    enum (Feature)
  ],
  "status": {
    object (Status)
  }
}
فیلدها
request Id

string

UUID اختصاص داده شده توسط عامل به capability.requestCapabilityCallback درخواست.

phone Number

string

شماره تلفن کاربر با فرمت E.164.

rbm Enabled

boolean

آیا کاربر قادر به شرکت در مکالمات RBM با نمایندگان است یا خیر.

features[]

enum ( Feature )

فهرست تمام ویژگی‌های RBM که برای این شماره تلفن پشتیبانی می‌شوند

status

object ( Status )

وضعیت پاسخ. اگر بررسی قابلیت ناموفق باشد، شامل پیام‌های خطا می‌شود.

وضعیت

نوع Status یک مدل خطای منطقی را تعریف می کند که برای محیط های برنامه نویسی مختلف، از جمله REST API و RPC API مناسب است. توسط gRPC استفاده می شود. هر پیام Status شامل سه داده است: کد خطا، پیام خطا و جزئیات خطا.

در راهنمای طراحی API می‌توانید درباره این مدل خطا و نحوه کار با آن اطلاعات بیشتری کسب کنید.

نمایندگی JSON 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
فیلدها
code

integer

کد وضعیت، که باید مقداری از google.rpc.Code باشد.

message

string

یک پیغام خطای برنامه‌نویس، که باید به زبان انگلیسی باشد. هر پیام خطای کاربر باید بومی سازی شده و در قسمت google.rpc.Status.details ارسال شود یا توسط مشتری بومی سازی شود.

details[]

object

لیستی از پیام هایی که حاوی جزئیات خطا هستند. مجموعه ای متداول از انواع پیام ها برای استفاده API ها وجود دارد.

یک شی حاوی فیلدهایی از نوع دلخواه. یک فیلد اضافی "@type" حاوی یک URI است که نوع را مشخص می کند. مثال: { "id": 1234, "@type": "types.example.com/standard/id" } .