CapabilityCallbackResponse

  • The CapabilityCallbackResponse indicates a user's RBM capability and is received by agents via a Pub/Sub subscription, base64-encoded in the "data" field of the message object.

  • This response includes details such as the requestId, phoneNumber, rbmEnabled status, and a list of features supported by the phone number.

  • The response also contains a status object, which details the response status, and includes error messages if the capability check failed.

  • The Status object adheres to the gRPC logical error model, containing an error code, an error message, and an array of error details.

  • The error details can contain a type identification and specific fields, as well as the actual error messages.

The RBM capability of a user. This response is the result of a capability.requestCapabilityCallback request from the agent.

The CapabilityCallbackResponse appears in the "data" field of the "message" object that the agent receives from its Google Pub/Sub subscription. The "data" field is a base64-encoded string that the agent must decode to match the CapabilityCallbackResponse structure. Deprecated: No longer used.

JSON representation 
{
  "requestId": string,
  "phoneNumber": string,
  "rbmEnabled": boolean,
  "features": [
    enum (Feature)
  ],
  "status": {
    object (Status)
  }
}
Fields
requestId

string

The UUID assigned by the agent to the capability.requestCapabilityCallback request.
phoneNumber

string

Phone number of the user in E.164 format.
rbmEnabled

boolean

Whether the user is capable of participating in RBM conversations with agents.
features[]

enum (Feature)

List of all RBM features which are supported for this phone number
status

object (Status)

Status of the response. If the capability check fails, includes error messages.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

JSON representation 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Fields
code

integer

The status code, which should be an enum value of google.rpc.Code.
message

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
details[]

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.