@google/rbm-businesscommunications

Business Communications Helper for RBM - node.js

RCS Business Messaging makes use of the Business Communications API to manage RBM agents. Developers can create RBM agents and submit them to carriers for approval and launch. Carriers can use the API to manage RBM agents on their network.

This library provides a simplification of RBM-related operations for node.js Javascript developers.

Documentation

The documentation for the Business Communications API can be found here.

Quickstart

Before you begin

Register with RCS Business Messaging.

If you wish to perform carrier operations such as approving agents you will need to contact RBM Support to have your account configured to access a specific carriers data.

Adding a dependency

Add the following to the dependencies section in your package.json :

"dependencies": {
  ...
  "@google/rbm-businesscommunications": "1.0"
  ...
},

We recommend you use the latest version available in the npm repository.

Initialisation

You initialise the library by providing your service account key and agentId.

const businessCommunicationsApiHelper =
  require('@google/rbm-businesscommunications');

const privateKey =
	require('../resources/businesscommunications-service-account-credentials.json');

businessCommunicationsApiHelper.initBusinessCommunucationsApi(privateKey);

Example usage

Refer to the RBM Management API and RBM Operations API examples.