Method: phones.getCapabilities

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.
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.
ACTION_COMPOSE

Suggested action to compose a text/audio/video message.

Caution: Carriers have raised concerns about the current definition and implementation of the Compose action as outlined in the GSMA specification. Given these concerns, and to ensure a consistent and reliable experience for users and the ecosystem, we have made the exceptional decision to pause the rollout of the Compose action. We'll remove the documentation about Compose actions on June 05, 2025. We understand that rolling back an API feature is not standard practice; this decision reflects the importance we place on addressing partner feedback and maintaining the stability and integrity of the RBM platform. Please reach out to your Google RBM contact if the Compose action is important for your use cases.