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. If the user can't be reached with RBM, the RBM platform returns 404 NOT_FOUND.

An agent that isn't launched can only request capabilities for users who are testers of that agent. If an unlaunched agent requests the capabilities of a non-tester, the RBM platform returns 403 PERMISSION_DENIED.

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.
REVOCATION Revocation. If the user supports revocation, the agent can revoke a message it sent before the RBM platform delivers the message.
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.
ACTION_SHARE_LOCATION Suggested action to share a location.
ACTION_VIEW_LOCATION Suggested action to view a location in a map app.