new_releases Updates: Check the
release notes for new features and product updates.
The RBM Management API
Stay organized with collections
Save and categorize content based on your preferences.
The RBM Management API replicates the capabilities of the
RBM Developer Console.
This API is especially useful for aggregators and partners who
operate their own campaign platforms and want to seamlessly integrate RBM as
a channel.
The RBM Management API is a REST API that allows developers
to programmatically do the following:
- Create and edit RBM agent definitions and upload assets.
- Submit RBM agents for verification and launch.
- Retrieve verification and launch information.
The RBM Management API is exposed as RCS extensions to Google's
Business Communications API.
Authentication credentials
Any RBM developer can access the RBM Management API. When calling the API, you
authenticate using a Service Account you have created in the
Developer Console.
Sample code
To better understand how to use the RBM Management API, download the sample code
in Java or Javascript (node.js):
Workflow
To create and launch an agent with the RBM Management API, follow these steps:
- Create a brand.
- Create an agent in the brand.
- Submit the agent for verification.
- Submit the agent for launch with one or more carriers.
- Check the launch status.
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 2025-03-12 UTC.
[null,null,["Last updated 2025-03-12 UTC."],[[["\u003cp\u003eThe RBM Management API mirrors the RBM Developer Console's functions, enabling seamless RBM integration for campaign platforms.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use the RBM Management API, a REST API, to programmatically manage RBM agents, including creating, editing, and submitting them for verification and launch.\u003c/p\u003e\n"],["\u003cp\u003eThe RBM Management API is accessible as RCS extensions within Google's Business Communications API, offering a programmatic interface for RBM agent management.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication to the API requires a Service Account created in the Developer Console, allowing any RBM developer to use the API's features.\u003c/p\u003e\n"],["\u003cp\u003eThe workflow for creating and launching an agent with the RBM Management API involves creating a brand, creating an agent within the brand, submitting it for verification and launch, and finally checking launch status.\u003c/p\u003e\n"]]],[],null,["# The RBM Management API replicates the capabilities of the\n[RBM Developer Console](/business-communications/rcs-business-messaging/guides/build/agents).\nThis API is especially useful for aggregators and partners who\noperate their own campaign platforms and want to seamlessly integrate RBM as\na channel.\n\nThe RBM Management API is a REST API that allows developers\nto programmatically do the following:\n\n- Create and edit RBM agent definitions and upload assets.\n- Submit RBM agents for verification and launch.\n- Retrieve verification and launch information.\n\nThe RBM Management API is exposed as RCS extensions to Google's\n[Business Communications API](/business-communications/rcs-business-messaging/reference/business-communications/rest).\n\nAuthentication credentials\n--------------------------\n\nAny RBM developer can access the RBM Management API. When calling the API, you\nauthenticate using a [Service Account](/business-communications/rcs-business-messaging/guides/get-started/partner-account#set_up_service_account_to_authenticate_api_calls) you have created in the\n[Developer Console](https://business-communications.cloud.google.com/console/partner-console/partner/service-account).\n\nSample code\n-----------\n\nTo better understand how to use the RBM Management API, download the sample code\nin Java or Javascript (node.js):\n\n- Download [Java samples](https://github.com/rcs-business-messaging/rbm-api-examples/tree/master/java/rbm-mgmt-api)\n- Download [Node.js samples](https://github.com/rcs-business-messaging/rbm-api-examples/tree/master/nodejs/rbm-mgmt-api)\n\nWorkflow\n--------\n\nTo create and launch an agent with the RBM Management API, follow these steps:\n\n1. Create a brand.\n2. Create an agent in the brand.\n3. Submit the agent for verification.\n4. Submit the agent for launch with one or more carriers.\n5. Check the launch status."]]