CapabilityCallbackResponse

用户的 RBM 功能。此响应是代理发出的 capability.requestCapabilityCallback 请求的结果。

CapabilityCallbackResponse 会显示在代理从其 Google Pub/Sub 订阅接收的“message”对象的“data”字段中。“data”字段是使用 base64 编码的字符串,代理必须对其进行解码,才能与 CapabilityCallbackResponse 结构相匹配。

JSON 表示法
{
  "requestId": string,
  "phoneNumber": string,
  "rbmEnabled": boolean,
  "features": [
    enum (Feature)
  ],
  "status": {
    object (Status)
  }
}
字段
requestId

string

代理为 capability.requestCapabilityCallback 请求分配的 UUID。

phoneNumber

string

用户的电话号码(采用 E.164 格式)。

rbmEnabled

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" }