new_releases Updates: Check the
release notes for new features and product updates.
CapabilityCallbackResponse
Stay organized with collections
Save and categorize content based on your preferences.
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" }.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-24 UTC.
[null,null,["Last updated 2025-06-24 UTC."],[[["\u003cp\u003eThe 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.\u003c/p\u003e\n"],["\u003cp\u003eThis response includes details such as the \u003ccode\u003erequestId\u003c/code\u003e, \u003ccode\u003ephoneNumber\u003c/code\u003e, \u003ccode\u003erbmEnabled\u003c/code\u003e status, and a list of \u003ccode\u003efeatures\u003c/code\u003e supported by the phone number.\u003c/p\u003e\n"],["\u003cp\u003eThe response also contains a \u003ccode\u003estatus\u003c/code\u003e object, which details the response status, and includes error messages if the capability check failed.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eStatus\u003c/code\u003e object adheres to the gRPC logical error model, containing an error \u003ccode\u003ecode\u003c/code\u003e, an error \u003ccode\u003emessage\u003c/code\u003e, and an array of error \u003ccode\u003edetails\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe error details can contain a type identification and specific fields, as well as the actual error messages.\u003c/p\u003e\n"]]],[],null,["# CapabilityCallbackResponse\n\n| This item is deprecated!\nThe RBM capability of a user. This response is the result of a capability.requestCapabilityCallback request from the agent.\n\nThe 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.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"requestId\": string, \"phoneNumber\": string, \"rbmEnabled\": boolean, \"features\": [ enum (/business-communications/rcs-business-messaging/reference/rest/v1/phones/getCapabilities#Feature) ], \"status\": { object (/business-communications/rcs-business-messaging/reference/rest/v1/CapabilityCallbackResponse#Status) } } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestId` | `string` The UUID assigned by the agent to the capability.requestCapabilityCallback request. |\n| `phoneNumber` | `string` Phone number of the user in E.164 format. |\n| `rbmEnabled` | `boolean` Whether the user is capable of participating in RBM conversations with agents. |\n| `features[]` | `enum (`[Feature](/business-communications/rcs-business-messaging/reference/rest/v1/phones/getCapabilities#Feature)`)` List of all RBM features which are supported for this phone number |\n| `status` | `object (`[Status](/business-communications/rcs-business-messaging/reference/rest/v1/CapabilityCallbackResponse#Status)`)` Status of the response. If the capability check fails, includes error messages. |\n\nStatus\n------\n\nThe `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](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------|\n| ``` { \"code\": integer, \"message\": string, \"details\": [ { \"@type\": string, field1: ..., ... } ] } ``` |\n\n| Fields ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `code` | `integer` The status code, which should be an enum value of `google.rpc.Code`. |\n| `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](/business-communications/rcs-business-messaging/reference/rest/v1/CapabilityCallbackResponse#Status.FIELDS.details) field, or localized by the client. |\n| `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\" }`. |"]]