new_releases Updates: Check the
release notes for new features and product updates.
Method: phones.getCapabilities
Stay organized with collections
Save and categorize content based on your preferences.
Get the RBM-related capabilities of a user.
The returned payload specifies whether a user can be reached with RBM and, if so, which RBM features the user supports.
Error Handling: a 404 NOT_FOUND error is returned when the user cannot be reached with RBM. This includes multiple scenarios: (1) The user's device does not support RCS or has RCS disabled. (2) The user is on a mobile network where the agent is not launched or where RCS traffic is not enabled. (3) An unlaunched agent requests the capabilities of a user who is not a tester.
HTTP request
GET https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*}/capabilities
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
This field resolves to "phones/{E.164}/capabilities", where {E.164} is the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting endpoint is https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities.
|
Query parameters
| Parameters |
requestId |
string
The unique ID of the request, assigned by the agent. This must be a UUID, as defined in https://tools.ietf.org/html/rfc4122. If the request ID matches an ID that the agent used for a previous request, the RBM platform ignores the new request.
|
agentId |
string
Required. The agent's unique identifier.
|
Request body
The request body must be empty.
Response body
List of supported features by the user
If successful, the response body contains data with the following structure:
| JSON representation |
{
"features": [
enum (Feature)
]
} |
| Fields |
features[] |
enum (Feature)
List of RBM features that this device supports.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/rcsbusinessmessaging
For more information, see the OAuth 2.0 Overview.
Feature
Types of RBM features that the user supports.
| Enums |
FEATURE_UNSPECIFIED |
Not specified. |
RICHCARD_STANDALONE |
Standalone rich cards. |
RICHCARD_CAROUSEL |
Carousel of rich cards. |
ACTION_CREATE_CALENDAR_EVENT |
Suggested action to create a calendar event. |
ACTION_DIAL |
Suggested action to dial a number. |
ACTION_OPEN_URL |
Suggested action to open a URL in browser. |
ACTION_SHARE_LOCATION |
Suggested action to share a location. |
ACTION_VIEW_LOCATION |
Suggested action to view a location in a map app. |
ACTION_OPEN_URL_IN_WEBVIEW |
Suggested action to open a URL in webview. |
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-07-25 UTC.
[null,null,["Last updated 2025-07-25 UTC."],[[["\u003cp\u003eThis API endpoint retrieves the RBM capabilities of a specified user, indicating whether they can be reached via RBM and which features they support.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using a GET method with the user's phone number in E.164 format as a path parameter and an agent ID and request ID as query parameters.\u003c/p\u003e\n"],["\u003cp\u003eA 404 NOT_FOUND error is returned if the user cannot be reached via RBM, which can be due to the user's device not supporting RCS, the user being on a network where the agent isn't launched, or an unlaunched agent requesting capabilities of a non-tester user.\u003c/p\u003e\n"],["\u003cp\u003eThe response body, if successful, includes a list of supported RBM features, such as rich cards, carousels, and suggested actions like opening URLs or creating calendar events.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this API requires the \u003ccode\u003ehttps://www.googleapis.com/auth/rcsbusinessmessaging\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,["# Method: phones.getCapabilities\n\nGet the RBM-related capabilities of a user.\n\nThe returned payload specifies whether a user can be reached with RBM and, if so, which RBM features the user supports.\n\nError Handling: a 404 NOT_FOUND error is returned when the user cannot be reached with RBM. This includes multiple scenarios: (1) The user's device does not support RCS or has RCS disabled. (2) The user is on a mobile network where the agent is not launched or where RCS traffic is not enabled. (3) An unlaunched agent requests the capabilities of a user who is not a tester.\n\n### HTTP request\n\n`GET https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*}/capabilities`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` This field resolves to \"phones/{E.164}/capabilities\", where {E.164} is the user's phone number in E.164 format. For example, for a user with the US phone number +1-222-333-4444, the resulting endpoint is \u003chttps://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/capabilities\u003e. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `requestId` | `string` The unique ID of the request, assigned by the agent. This must be a UUID, as defined in \u003chttps://tools.ietf.org/html/rfc4122\u003e. If the request ID matches an ID that the agent used for a previous request, the RBM platform ignores the new request. |\n| `agentId` | `string` Required. The agent's unique identifier. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nList of supported features by the user\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"features\": [ enum (/business-communications/rcs-business-messaging/reference/rest/v1/phones/getCapabilities#Feature) ] } ``` |\n\n| Fields ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `features[]` | `enum (`[Feature](/business-communications/rcs-business-messaging/reference/rest/v1/phones/getCapabilities#Feature)`)` List of RBM features that this device supports. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/rcsbusinessmessaging`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nFeature\n-------\n\nTypes of RBM features that the user supports.\n\n| Enums ||\n|--------------------------------|---------------------------------------------------|\n| `FEATURE_UNSPECIFIED` | Not specified. |\n| `RICHCARD_STANDALONE` | Standalone rich cards. |\n| `RICHCARD_CAROUSEL` | Carousel of rich cards. |\n| `ACTION_CREATE_CALENDAR_EVENT` | Suggested action to create a calendar event. |\n| `ACTION_DIAL` | Suggested action to dial a number. |\n| `ACTION_OPEN_URL` | Suggested action to open a URL in browser. |\n| `ACTION_SHARE_LOCATION` | Suggested action to share a location. |\n| `ACTION_VIEW_LOCATION` | Suggested action to view a location in a map app. |\n| `ACTION_OPEN_URL_IN_WEBVIEW` | Suggested action to open a URL in webview. |"]]