RCS Business Messaging API

  • The service rcsbusinessmessaging.googleapis.com uses a Discovery Document for API specifications, with a specific document available at <https://rcsbusinessmessaging.googleapis.com/$discovery/rest?version=v1>.

  • The service endpoint for rcsbusinessmessaging.googleapis.com is https://rcsbusinessmessaging.googleapis.com, serving as the base URL for all relative URIs.

  • The API supports various methods for interacting with files, including uploading files via POST /v1/files or POST /upload/v1/files, in addition to managing agent-to-user messages and events, and checking user capabilities.

  • This API also enables interactions with Dialogflow agents and allows for managing testers for the agent.

  • The API offers methods to retrieve RCS-enabled phone numbers from a list of users using POST /v1/users:batchGet.

Service: rcsbusinessmessaging.googleapis.com

To call this service, we recommend that you use the Google-provided samples. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://rcsbusinessmessaging.googleapis.com

REST Resource: v1.files

Methods
create POST /v1/files
POST /upload/v1/files
Uploads a file for use in media or rich card messages.

REST Resource: v1.phones

Methods
getCapabilities GET /v1/{name=phones/*}/capabilities
Get the user's capabilities for RCS for Business.

REST Resource: v1.phones.agentEvents

Methods
create POST /v1/{parent=phones/*}/agentEvents
Sends an event from the agent to a user.

REST Resource: v1.phones.agentMessages

Methods
create POST /v1/{parent=phones/*}/agentMessages
Sends a message from the agent to a user.
delete DELETE /v1/{name=phones/*/agentMessages/*}
Revokes an agent message that has been sent but not yet delivered.

REST Resource: v1.phones.capability

Methods
requestCapabilityCallback
(deprecated)		 POST /v1/{name=phones/*}/capability:requestCapabilityCallback
Requests a callback containing the capabilities of a user.

REST Resource: v1.phones.dialogflowMessages

Methods
create POST /v1/{parent=phones/*}/dialogflowMessages
Prompts a Dialogflow agent to send messages through an RCS for Business agent.

REST Resource: v1.phones.testers

Methods
create POST /v1/{parent=phones/*}/testers
Invites a user to test an agent.

REST Resource: v1.users

Methods
batchGet POST /v1/users:batchGet
Gets the RCS-enabled phone numbers for a list of users.