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

Agents

Business information

An agent is a conversational entity for a business or a specific business function. Messages between a user and an agent appear in an RCS-enabled messaging app, such as the Messages app, on the user's device. The Messages app displays branding and profile information for your agent, including name, logo, description, contact information, and URLs.

You could create an agent for Growing Tree Bank that allows users to interact with various aspects of the bank, such as the Customer Care and Mortgage department. Alternatively, you could create an agent for each department, for example, Growing Tree Bank Customer Care and Growing Tree Bank Mortgages. Before creating multiple agents for one business, consider the user experience implications and refer to the conversational best practices.

Create an agent

RBM agents use the RCS Business Messaging API to send messages, events, and other requests to users. When you create an agent, you enable access to the RBM API and define your agent's colors and branding information.

Prerequisites

Before you can register, you need to gather some information about your agent:

Identify the agent's region

The RBM API supports three regional endpoints to help businesses comply with regional and business requirements. Likewise, RBM agents can exist in one of three regions:

  • North America
  • Europe
  • Asia Pacific

When you create your agent, choose your agent's region based on applicable regulations, requirements, and proximity to end users. Region determines where your agent operates from and where it stores its data.

If you or your intended users don't fit within those regions, choose the region that is closest to you to minimize latency. For example, if you're in Latin America, choose the North America region, or if you're in Africa, choose the Europe region.

All regions have equal access to carriers worldwide. Don't decide your agent's region based on your target carriers.

Create the agent

  1. Open the Business Communications Developer Console and sign in with your RBM Platform Google account.
  2. Click Create agent.
  3. Enter your agent's name and region, then click Create agent.
  4. When your agent is available, click your agent's name.

Next steps

Now that you have a working agent, you can edit agent information, create a service account key, and configure your agent to receive messages.

Edit agent information

After you create your agent, you can edit the agent's information on the Agent information page:

  • Name
  • Description
  • Color (with a minimum 4.5:1 contrast ratio to white, for example, #FF0000)
  • Website
  • Email
  • Phone number
  • Privacy Policy URL
  • Terms of Service URL
  • A logo (224x224 px, no larger than 50 KB)

    In a conversations, logos display as 224 px diameter circles. Make sure that your logo displays well as a circle.

  • A hero image (1440x448 px JPEG, no larger than 200 KB)

The Overview and Agent information pages preview how your agent appears in the Messages app.

Understanding contrast ratio

Contrast ratio is a comparison of the contrast and ease of distinction between two colors. A high contrast ratio between two colors, such as between a background and text, increases readability in bad lighting and for people with accessibility considerations. WCAG 2.0 defines 4.5:1 as a minimum contrast ratio for text.

You can verify that the agent color you identified has at least a 4.5:1 contrast ratio to white using online tools like the WebAIM Contrast Checker.

Create a service account key

When you make calls to the RBM API, you authenticate the calls with a service account key. Service account keys allow you to send messages, events, and requests as your agent and interact with the API.

  1. Open the Business Communications Developer Console, sign in with your RBM Platform Google account, and click your agent.
  2. In the left navigation, click Service account.
  3. Click Create key, then click Create. Your browser downloads a service account key for your agent.

Next steps

Now that you have a service account key, you can invite test devices, send messages, make other calls from the API reference, or use a sample agent.

Delete an agent

When you delete an agent, the RBM platform deletes all agent data, including branding information, agent configurations, and test devices. The RBM platform doesn't delete messages sent by your agent that are in transit to or stored on a user's device. Messages to users aren't agent data.

To delete an agent,

  1. Open the Business Communications Developer Console, sign in with your RBM Google account, and click your agent.
  2. At the bottom of the Overview page, click Delete agent.
  3. Enter "DELETE", then click Delete agent.

If you delete your RBM Platform Google account before you delete your agent, your agent data isn't automatically deleted. Contact us to manually delete your agent data.