Updates: Check the release notes for new features and product updates.

RCS Business Messaging API

Service: rcsbusinessmessaging.googleapis.com

All URIs are relative to:

  • https://asia-rcsbusinessmessaging.googleapis.com
  • https://europe-rcsbusinessmessaging.googleapis.com
  • https://us-rcsbusinessmessaging.googleapis.com

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 RBM-related capabilities of a user.

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