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

Register with Business Messages

When you register as a partner with Business Messages, you can enable conversations between users and brands by creating agents—conversational entities that represent business functions, such as website support, and brand locations.

When a user finds a brand that you manage in Google Search or Google Maps, the search results display a Message option. When the user clicks Message, they can send messages to the brand's agent. The agent lets you receive and respond to the user's messages.

Register as a partner

By registering as a partner with Business Messages, creating agents for brands, and leveraging the APIs that power your agent, you can enable messaging experiences for customer services, sales, and other business applications.

Prerequisites

Before you get started, you need the following information:

  • A Google account
  • Partner name

Additionally, you need to install oauth2l on your development machine.

Create a Google Cloud Platform project

To enable the supported messaging APIs, you need to create and register a Google Cloud Platform (GCP) project.

  1. Sign in to Google Cloud Platform with your Google account.
  2. Create a new project. Enter your company name for Project name, then click Create.

  3. In Project info, note the Project number value. You need this value to register your GCP project.

    Sample project information

Submit your information

To register your GCP project with Google, fill out this form. You'll receive a email once Google registers your project, which can take up to three days.

Store important information

After Google registers your project, Google sends you a confirmation email with your partner information, including a Partner ID and an Partner key (formerly "CRM key" or "authorization key").

The email address you specified is your Business Messages Google account. You'll need it to make API calls and access restricted parts of the documentation.

Enable the APIs

Business Messages agents use two APIs: one to send and receive messages, and one to manage agents.

After Google registers your project with Business Messages, you can enable the Business Messages API to send messages as your brands' agents and enable the Business Communications API to manage your agents.

  1. Sign in to Google Cloud Platform and open your project.
  2. Open Business Messages API in the API Library.
  3. Click Enable.
  4. Open Business Communications API in the API Library.
  5. Click Enable.
  6. Open Service accounts.

    When you create a service account, you can generate a service account key that, together with the oauth2l command line tool, securely authenticates API calls.

  7. Click Create service account.

  8. For Service account name, enter your agent's name, then click Create.

  9. For Select a role, choose Project > Editor, the click Continue.

  10. Click Done.

  11. Locate the new service account in the table, then click > Create key.

  12. Choose JSON, then click Create.

    Your browser downloads the service account key.

  13. Click Done.

Set your webook

Now that the Business Messages and Business Communications API is enabled for your project, you must specify your webhook URL in order to start receiving messages.

  1. Open the Business Communications Developer Console and sign in with your Business Messages Google account.
  2. Click Account settings.
  3. Make sure the correct partner account is selected.
  4. Enter your Business Messages webhook URL.
  5. Click Save.

See Example: Update webhook URL to see how to configure your webhook with the Business Communication APIs.

Get partner information

To get your current partner information, you can query the Business Communications API, as long as you have your Partner ID (which you should have stored).

Run the following command. Replace PARTNER_ID with your Partner ID.

Update partner information

To update your partner information, run the following command. Replace PARTNER_ID with your Partner ID, and replace UPDATED_FIELDS with the field names you update.

For formatting and value options, see partners.patch.

If you don't know your Partner ID, refer to your partner registration confirmation email.

Example: Update display name

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/brands/12345/partners/67890?updateMask=displayName" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \
-d "{
    'displayName': 'XYZ Messaging',
}"

Example: Update webhook URL

curl -X PATCH \
"https://businesscommunications.googleapis.com/v1/partners/12345?updateMask=productCapabilities" \
-H "Content-Type: application/json" \
-H "$(oauth2l header --json /path/to/service/account/key businesscommunications)" \
-d "{
  'productCapabilities': [
    {
      'product': 'BUSINESS_MESSAGES',
      'businessMessagesCapability': {
        'webhookUrl': 'https://xyz.messaging.com/webhook',
      },
    },
  ],
}"

Next steps

Now that you're a registered partner and have enabled the APIs, you can start developing with Business Messages. To get started quickly, see Prerequisite setup and Create your first agent.

Otherwise, learn how to create agents to represent your brands in conversations and configure your webhook to receive messages from users.