Skip to content

Google Business Message

Business Messages is a mobile conversational channel that combines entry points on Google Maps, Search, and brand websites to create rich, asynchronous messaging experiences that delight customers and drive business results.

We are going to show here how to integrate Google Business Message into OpenCUI and deploy the chatbot to a OpenCUI hosted environment. For the private deployment, please consult systems in your organization.

Follow these steps to configure:

Set up Google Business Message

Register as a partner

  1. Open the Business Communications Developer Console.
  2. Under Business Messages, click Create partner account.
  3. Enter your partner information:
Your nameYour full name
Partner nameYour organization's name
Partner websiteYour organization's website
RegionThe region you want to host the Business Messages service
  1. Click Create.


Create a service account

  1. On the Console home page, click Partner account settings.
  2. In the left navigation, click Service account.
  3. Click Create key, then click Create.

Your browser downloads the service account key. Store it in a secure location. You'll need this key later to deploy your chatbot.

create key

Create a brand and an agent

  1. Open the Console and sign in with your Business Messages Google account.
  2. Click Create agent.
  3. Enter values for Brand name and Agent name.
  4. Deselect Enable the Business Messages Helper Bot.
  5. Click Create agent.

create agent

Configure Google Business Message from OpenCUI

  1. On OpenCUI platform, go to service component

    1. Click Import button on the second topbar.
    2. Select the chatbot you want to configure Google Business Message channel and Save.

    import channel component

  2. Once you have done, switch to your chatbot to wire Google Business Message channel:

    1. On STRUCT level, head to Settings page, in the Integrations tab, select the service you just import. In this case, please select
    2. A configuration dialog opens, at Service Provider field, select io.opencui.googleBusinessMessage to wiring Google Business Message channel.

    select the serviceSelect service

    select a channelWire Google Business Message channel

  3. Continue inside the dialog, configure Google Business Message integration as following:

    • Label: Enter channel label, should be unique.
    • Client Token: Enter any private token you desire. 📋 Copy this value. This will be used to configure the Google Business Message Webhook.
    • Credential: Copy and paste the service account key you downloaded from Business Communications Developer Console.
    • Locale: Select locale which determines the default language used by your bot.
    • Callback URL: 📋 Copy this value after setting the label and locale. This will be used to configure the Google Business Message Webhook.

    add channel

  4. Before you go to next step, don't forget to merge your changes into master and deploy your chatbot.

Finish Google Business Message setup

A webhook is a partner-created HTTPS callback that specifies how your agent should respond to messages and events. You can set your webhook either at the partner level or at the agent level. Partner-level webhooks apply to every agent you maintain, while agent-level webhooks each apply to one individual agent.

Set your partner-level webhook

  1. Open the Account settings in the Console.
  2. Make sure the correct partner account is selected.
  3. Set Technical point of contact.
  4. For Webhook, click Configure.
  5. Click Verify and click Save in the top right corner.

set webhook

Set an agent-level webhook

  1. Click your agent.
  2. In the left navigation, click Integrations.
  3. For Webhook, click Configure.
  4. Click Verify.

set webhook agent

Test your chatbot

  1. Open the Business Communications Developer Console.
  2. Under Agent test URLs, click the Android button or iOS button.
    • Scan the QR code with the corresponding mobile device, or click Copy Android URL or Copy iOS URL to copy the agent's test URL.
    • You can also click Send to send the URLs to your email address.
  3. Open the URL in your mobile device. (iOS devices require the Google Maps app.)
  4. Now you can start a conversation with your chatbot. 🎉