new_releases Updates: Check the
release notes for new features and product updates.
RCS Business Messaging API
Stay organized with collections
Save and categorize content based on your preferences.
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
| Methods |
create |
POST /v1/files
POST /upload/v1/files
Uploads a file for use in media or rich card messages. |
| Methods |
getCapabilities |
GET /v1/{name=phones/*}/capabilities
Get the RBM-related capabilities of a user. |
| Methods |
create |
POST /v1/{parent=phones/*}/agentEvents
Sends an event from the agent to a user. |
| 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. |
| Methods |
requestCapabilityCallback
(deprecated) |
POST /v1/{name=phones/*}/capability:requestCapabilityCallback
Requests a callback containing the capabilities of a user. |
| Methods |
create |
POST /v1/{parent=phones/*}/dialogflowMessages
Prompts a Dialogflow agent to send messages through an RBM agent. |
| Methods |
create |
POST /v1/{parent=phones/*}/testers
Invites a user to test an agent. |
| Methods |
batchGet |
POST /v1/users:batchGet
Gets the RCS-enabled phone numbers for a list of users. |
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 2024-11-14 UTC.
[null,null,["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eThe service \u003ccode\u003ercsbusinessmessaging.googleapis.com\u003c/code\u003e uses a Discovery Document for API specifications, with a specific document available at \u003ccode\u003e<https://rcsbusinessmessaging.googleapis.com/$discovery/rest?version=v1>\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe service endpoint for \u003ccode\u003ercsbusinessmessaging.googleapis.com\u003c/code\u003e is \u003ccode\u003ehttps://rcsbusinessmessaging.googleapis.com\u003c/code\u003e, serving as the base URL for all relative URIs.\u003c/p\u003e\n"],["\u003cp\u003eThe API supports various methods for interacting with files, including uploading files via \u003ccode\u003ePOST /v1/files\u003c/code\u003e or \u003ccode\u003ePOST /upload/v1/files\u003c/code\u003e, in addition to managing agent-to-user messages and events, and checking user capabilities.\u003c/p\u003e\n"],["\u003cp\u003eThis API also enables interactions with Dialogflow agents and allows for managing testers for the agent.\u003c/p\u003e\n"],["\u003cp\u003eThe API offers methods to retrieve RCS-enabled phone numbers from a list of users using \u003ccode\u003ePOST /v1/users:batchGet\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# RCS Business Messaging API\n\nService: rcsbusinessmessaging.googleapis.com\n--------------------------------------------\n\nTo call this service, we recommend that you use the Google-provided [samples](/business-communications/rcs-business-messaging/samples). If your application needs to use your own libraries to call this service, use the following information when you make the API requests.\n\n### Discovery document\n\nA [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) 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:\n\n- \u003chttps://rcsbusinessmessaging.googleapis.com/$discovery/rest?version=v1\u003e\n\n### Service endpoint\n\nA [service endpoint](https://cloud.google.com/apis/design/glossary#api_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:\n\n- `https://rcsbusinessmessaging.googleapis.com`\n\nREST Resource: [v1.files](/business-communications/rcs-business-messaging/reference/rest/v1/files)\n--------------------------------------------------------------------------------------------------\n\n| Methods ||\n|------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/files/create) | `POST /v1/files` `POST /upload/v1/files` Uploads a file for use in media or rich card messages. |\n\nREST Resource: [v1.phones](/business-communications/rcs-business-messaging/reference/rest/v1/phones)\n----------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------|\n| [getCapabilities](/business-communications/rcs-business-messaging/reference/rest/v1/phones/getCapabilities) | `GET /v1/{name=phones/*}/capabilities` Get the RBM-related capabilities of a user. |\n\nREST Resource: [v1.phones.agentEvents](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentEvents)\n----------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|-------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentEvents/create) | `POST /v1/{parent=phones/*}/agentEvents` Sends an event from the agent to a user. |\n\nREST Resource: [v1.phones.agentMessages](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages)\n--------------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages/create) | `POST /v1/{parent=phones/*}/agentMessages` Sends a message from the agent to a user. |\n| [delete](/business-communications/rcs-business-messaging/reference/rest/v1/phones.agentMessages/delete) | `DELETE /v1/{name=phones/*/agentMessages/*}` Revokes an agent message that has been sent but not yet delivered. |\n\nREST Resource: [v1.phones.capability](/business-communications/rcs-business-messaging/reference/rest/v1/phones.capability)\n--------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| [requestCapabilityCallback](/business-communications/rcs-business-messaging/reference/rest/v1/phones.capability/requestCapabilityCallback)` ` **(deprecated)** | `POST /v1/{name=phones/*}/capability:requestCapabilityCallback` Requests a callback containing the capabilities of a user. |\n\nREST Resource: [v1.phones.dialogflowMessages](/business-communications/rcs-business-messaging/reference/rest/v1/phones.dialogflowMessages)\n------------------------------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|--------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.dialogflowMessages/create) | `POST /v1/{parent=phones/*}/dialogflowMessages` Prompts a [Dialogflow](https://dialogflow.com) agent to send messages through an RBM agent. |\n\nREST Resource: [v1.phones.testers](/business-communications/rcs-business-messaging/reference/rest/v1/phones.testers)\n--------------------------------------------------------------------------------------------------------------------\n\n| Methods ||\n|---------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|\n| [create](/business-communications/rcs-business-messaging/reference/rest/v1/phones.testers/create) | `POST /v1/{parent=phones/*}/testers` Invites a user to test an agent. |\n\nREST Resource: [v1.users](/business-communications/rcs-business-messaging/reference/rest/v1/users)\n--------------------------------------------------------------------------------------------------\n\n| Methods ||\n|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------|\n| [batchGet](/business-communications/rcs-business-messaging/reference/rest/v1/users/batchGet) | `POST /v1/users:batchGet` Gets the RCS-enabled phone numbers for a list of users. |"]]