The RBM Management API

  • The RBM Management API mirrors the RBM Developer Console's functions, enabling seamless RBM integration for campaign platforms.

  • Developers can use the RBM Management API, a REST API, to programmatically manage RBM agents, including creating, editing, and submitting them for verification and launch.

  • The RBM Management API is accessible as RCS extensions within Google's Business Communications API, offering a programmatic interface for RBM agent management.

  • Authentication to the API requires a Service Account created in the Developer Console, allowing any RBM developer to use the API's features.

  • The 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.

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):

Client libraries

Client libraries handle authentication and API marshalling and unmarshalling to simplify your development. They are published in multiple languages:

Workflow

To create and launch an agent with the RBM Management API, follow these steps:

  1. Create a brand.
  2. Create an agent in the brand.
  3. Submit the agent for verification.
  4. Submit the agent for launch with one or more carriers.
  5. Check the launch status.
Next
List carriers (regions)