GETTING STARTED
Kore.ai XO Platform
Virtual Assistants Overview
Natural Language Processing (NLP)
Concepts and Terminology
Quick Start Guide
Accessing the Platform
Navigating the Kore.ai XO Platform
Building a Virtual Assistant
Help & Learning Resources
Release Notes
Current Version
Recent Updates
Previous Versions
Deprecations
Request a Feature
CONCEPTS
Design
Storyboard
Overview
FAQs
Conversation Designer
Overview
Dialog Tasks
Mock Scenes
Dialog Tasks
Overview
Navigate Dialog Tasks
Build Dialog Tasks
Node Types
Overview
Intent Node
Dialog Node
Dynamic Intent Node
GenAI Node
GenAI Prompt
Entity Node
Form Node
Confirmation Node
Message Nodes
Logic Node
Bot Action Node
Service Node
Webhook Node
Script Node
Process Node
Agent Transfer
Node Connections
Node Connections Setup
Sub-Intent Scoping
Entity Types
Entity Rules
User Prompts or Messages
Voice Call Properties
Knowledge AI
Introduction
Knowledge Graph
Introduction
Terminology
Build a Knowledge Graph
Manage FAQs
Knowledge Extraction
Import or Export Knowledge Graph
Prepare Data for Import
Importing Knowledge Graph
Exporting Knowledge Graph
Auto-Generate Knowledge Graph
Knowledge Graph Analysis
Answer from Documents
Alert Tasks
Small Talk
Digital Skills
Overview
Digital Forms
Digital Views
Introduction
Widgets
Panels
Session and Context Variables
Context Object
Intent Discovery
Train
NLP Optimization
ML Engine
Overview
Model Validation
FM Engine
KG Engine
Traits Engine
Ranking and Resolver
Training Validations
NLP Configurations
NLP Guidelines
LLM and Generative AI
Introduction
LLM Integration
Kore.ai XO GPT Module
Prompts & Requests Library
Co-Pilot Features
Dynamic Conversations Features
Intelligence
Introduction
Event Handlers
Contextual Memory
Contextual Intents
Interruption Management
Multi-intent Detection
Amending Entities
Default Conversations
Conversation Driven Dialog Builder
Sentinment Management
Tone Analysis
Default Standard Responses
Ignore Words & Field Memory
Test & Debug
Overview
Talk to Bot
Utterance Testing
Batch Testing
Conversation Testing
Conversation Testing Overview
Create a Test Suite
Test Editor
Test Case Assertion
Test Case Execution Summary
Glossary
Health and Monitoring
NLP Health
Flow Health
Integrations
Actions
Actions Overview
Asana
Configure
Templates
Azure OpenAI
Configure
Templates
BambooHR
Configure
Templates
Bitly
Configure
Templates
Confluence
Configure
Templates
DHL
Configure
Templates
Freshdesk
Configure
Templates
Freshservice
Configure
Templates
Google Maps
Configure
Templates
Here
Configure
Templates
HubSpot
Configure
Templates
JIRA
Configure
Templates
Microsoft Graph
Configure
Templates
Open AI
Configure
Templates
Salesforce
Configure
Templates
ServiceNow
Configure
Templates
Stripe
Configure
Templates
Shopify
Configure
Templates
Twilio
Configure
Templates
Zendesk
Configure
Templates
Agents
Agent Transfer Overview
Custom (BotKit)
Drift
Genesys
Intercom
NiceInContact
NiceInContact(User Hub)
Salesforce
ServiceNow
Configure Tokyo and Lower versions
Configure Utah and Higher versions
Unblu
External NLU Adapters
Overview
Dialogflow Engine
Test and Debug
Deploy
Channels
Publishing
Versioning
Analyze
Introduction
Dashboard Filters
Overview Dashboard
Conversations Dashboard
Users Dashboard
Performance Dashboard
Custom Dashboards
Introduction
Custom Meta Tags
Create Custom Dashboard
Create Custom Dashboard Filters
LLM and Generative AI Logs
NLP Insights
Task Execution Logs
Conversations History
Conversation Flows
Conversation Insights
Feedback Analytics
Usage Metrics
Containment Metrics
Universal Bots
Introduction
Universal Bot Definition
Universal Bot Creation
Training a Universal Bot
Universal Bot Customizations
Enabling Languages
Store
Manage Assistant
Team Collaboration
Plan & Usage
Overview
Usage Plans
Templates
Support Plans
Invoices
Authorization
Conversation Sessions
Multilingual Virtual Assistants
Get Started
Supported Components & Features
Manage Languages
Manage Translation Services
Multiingual Virtual Assistant Behavior
Feedback Survey
Masking PII Details
Variables
Collections
IVR Settings
General Settings
Assistant Management
Manage Namespace
Data
Overview
Data Table
Table Views
App Definitions
Data as Service
HOW TOs
Build a Travel Planning Assistant
Travel Assistant Overview
Create a Travel Virtual Assistant
Design Conversation Skills
Create an ‘Update Booking’ Task
Create a Change Flight Task
Build a Knowledge Graph
Schedule a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Train the Assistant
Use Traits
Use Patterns
Manage Context Switching
Deploy the Assistant
Use Bot Functions
Use Content Variables
Use Global Variables
Use Web SDK
Build a Banking Assistant
Design Conversation Skills
Create a Sample Banking Assistant
Create a Transfer Funds Task
Create a Update Balance Task
Create a Knowledge Graph
Set Up a Smart Alert
Design Digital Skills
Configure Digital Forms
Configure Digital Views
Add Data to Data Tables
Update Data in Data Tables
Add Data from Digital Forms
Train the Assistant
Composite Entities
Use Traits
Use Patterns for Intents & Entities
Manage Context Switching
Deploy the Assistant
Configure an Agent Transfer
Use Assistant Functions
Use Content Variables
Use Global Variables
Intent Scoping using Group Node
Analyze the Assistant
Create a Custom Dashboard
Use Custom Meta Tags in Filters
Migrate External Bots
Google Dialogflow Bot
APIs & SDKs
API Reference
API Introduction
Rate Limits
API List
koreUtil Libraries
SDK Reference
SDK Introduction
Web SDK
How the Web SDK Works
SDK Security
SDK Registration
Web Socket Connect and RTM
Tutorials
Widget SDK Tutorial
Web SDK Tutorial
BotKit SDK
BotKit SDK Deployment Guide
Installing the BotKit SDK
Using the BotKit SDK
SDK Events
SDK Functions
Tutorials
BotKit - Blue Prism
BotKit - Flight Search Sample VA
BotKit - Agent Transfer
  1. Home
  2. Docs
  3. Virtual Assistants
  4. Channel Enablement
  5. Adding the Google Business Messaging Channel

Adding the Google Business Messaging Channel

 

Warning! Google announced the discontinuation of the Google Business Messages channel from July 31st. This channel will be phased out in the coming weeks. If you have alternative chat channels, consider inviting your customers to continue conversations there. For more details, please refer to the Google announcement.

Modern business applications require agent integrations on web/mobile devices to enable seamless customer communication via SMS/chats.

The Kore.ai XO Platform now helps you create rich and asynchronous messaging experiences within apps and during calls through the GBM channel enablement. This feature helps seamlessly integrate real-time business agents to Virtual Assistants through your own account or your GBM Partner account.

Google Business Messaging (GBM) is a mobile conversational channel that combines digital customer touchpoints or entry points on Google Maps, Search, and brand websites.

How does it work?

When Google Business Messaging is configured as a Channel on the XO Platform, the conversations between the customers and brands is enabled by creating agents. You can manage agents with either your own account or a GBM Partner Account. The process to create an agent differs in each scenario.

  • If you have a GBM Partner Account, the XO Platform registers each Business as a partner. You can enable conversations for brands you manage by creating Business Messages agents directly on GBM Developer Console.
  • If you have your own account, you can enable conversations for brands you manage by creating Business Messages agents using Business Communications APIs.

Important Information on Agents and GBM’s Messaging Infrastructure

  • An Agent is a conversational entity that users interact with.
  • You must create one agent for each brand you manage.
  • You can create and manage agents with the Business Communications API.
  • You can control messaging for your agents with the Business Messages API.
  • An agent encompasses a brand’s business functions, such as online support, and physical locations (if any).
  • Each message contains the context from which the user initiated the conversation.
  • Your message routing infrastructure can detect if the user viewed a specific business location or looked for general support, and it can route messages to the correct destination.

Customers can send messages to your brand or its locations through these agents.

With Business Messages, you can place messaging buttons for brands managed by Kore AI within organic Google search results.

The Messaging Flow

  1. When a customer clicks the button, a conversation is initiated with the brand’s virtual agent on the device.
  2. Google delivers the message defined as a JSON payload to the Webhook that Kore.ai provides.
  3. The agent uses this Webhook and the Conversational Agent API to receive and respond to the customer’s messages.

Set up on the GBM Channel

The important steps to set up the GBM channel are summarized below:

  1. Creating a Google Cloud Platform (GCP) project.
  2. Submitting the partner information to Google.
  3. Enabling the Conversational Agent API.

Prerequisites

  • An active Google account.
  • The Partner Name field appears in the Google My Business (GMB) Console for locations associated with the agents you manage.
  • A webhook endpoint URL that can accept messages (Kore.ai generates the webhook URL, which will be associated with a virtual assistant built on the platform).

Create a Google Cloud Platform Project

You must create and register a Google Cloud Platform (GCP) project to enable the Google Cloud API service for your partner account. Learn more.

Important: Please note the project number to register as a partner.

GBM Channel Enablement on the Platform

To set up the GBM channel on the Kore.ai XO Platform and launch the agent, follow the steps below:

  1. Register as a Google Business Messaging Partner.
  2. Create an agent for your account.
  3. If Business Helper Bot is Disabled, set an Agent-level Webhook.
  4. Create a Service Account Key.
  5. Configure the Virtual Assistant for the service account.

Step1: Register as a GBM Partner

When you register as a partner with Google 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. This helps enable seamless messaging experiences for customer services, sales, and other business applications. To register as a partner, follow the steps below:

  1. Open the Business Communications Developer Console.
  2. Under Business Messages, click Create partner account.
  3. Enter the values for the following fields in the Create a Business Messages partner account window:
    • Your Name: Your full name.
    • Partner Name: Your organization’s name.
    • Partner Website: Your organization’s website.
    • Region: The region you want to host the Business Messages service.

Important: To launch a production agent with Business Messages, please register with a corporate email, not a personal email.

  1. Review and Accept the Business Messages Terms of Service.
  2. Click Create.

You are now registered as a Business Messages partner and have access to the Business Messages and Business Communications APIs. The Business Messages API sends messages to users, while the Business Communications API manages agents.

Step 2: Create an Agent for your Account

After you register as a partner, you can enable conversations for brands you manage by creating Business Messages agents for them.

When creating an agent, you can enable the Business Messages Helper Bot that lets you quickly start a conversation with your agent by leveraging the available features and resources. This is especially useful when creating your first agent.

Also, to create an agent for your GBM Partner account, you must submit information on the brand and the agent on the Business Communications Developer Console.

Important: To manage multiple brands, you must create an agent for each brand.

Expectations Before Creating Agents

  • Agents should follow the design guidance outlined in Conversation design for Business Messages.
  • Agents should have human representatives available to answer questions when automation is unable to fulfill a request or when requested by users.
  • Without human representatives, your agent can’t be launched from location-based entry points or non-local entry points. Specify a human interaction type for your agent, so it can surface on Google-managed entry points.
  • Agents should maintain a customer satisfaction rating (CSAT) of at least 80% and a merchant response rate (MRR) of at least 95% as outlined in Metrics.

Prerequisites

  1. If you registered for a partner account before March 7, 2022, you need to enable the Business Messages API before creating your first agent. See Enable the Business Communications API and Business Messages API.
  2. Please ensure you have the following values for each brand you manage before you create an agent:
  • Brand name
  • Agent name to appear in conversations with users.

Steps to Create an Agent

Once you’ve gathered the above information, to create an agent follow the steps below:

Note: If you manage multiple brands, repeat the steps to create an agent for each brand.

  1. Sign in to your account on the Business Communications Developer Console.
  2. Click Create Agent.
  3. For Agent type, select Business Messages.
  1. Enter the values for the Brand name and Agent name fields.
  1. Do one of the following:
  • To experience a conversation with your agent by leveraging the rich features of the GBM Platform, select Enable Business Messages Helper Bot. The Helper Bot allows you to Explore rich features, learn how to implement features, and find resources for agent setup. When the Helper Bot is enabled, it sends and receives messages for your agent, and No Webhook is required.
  • To customize your agent and prepare it for message handling, deselect Enable the Business Messages Helper Bot.
  1. Click Create Agent.

If you enabled the Business Messages Helper Bot, you can start a conversation with your agent immediately. Otherwise, proceed to set your Webhook (Step 3).

Note: Once your agent is available, you can add the business and branding information.

Step 3: If Business Helper Bot is Disabled, Set an Agent-level Webhook

To customize your agent and how it handles messaging, you must set an agent Webhook on the Google Business Messages platform. You will receive messages sent to your agent at this Webhook. For setting up the Webhook, you must copy the Webhook URL from the XO platform and generate the Client Token for the agent to integrate for messaging and events.

To set up the agent Webhook, follow the steps below:

  1. Open the Business Communications Developer Console and sign in with your Business Messages Google account.
  2. Click on the panel with your agent’s name.
  3. On the Business Communications page, click Integrations on the left menu.
  4. For the Webhook option, click the Configure link.
  5. Copy the Webhook URL from the Kore.ai XO Platform under Deploy > Channels > Google Business Messaging > Configurations.
  6. Paste the copied link for the Webhook endpoint URL field in the Configure your webhook window on the Business Communications Developer Console.
  7. Click the Refresh icon for the clientToken field to generate the Client token. Note your clientToken value. You need it to verify that messages you receive are coming from Google.
  8. In the console, click Verify.

The GBM platform sends a POST request to Webhook you configured on the XO Platform with the specified ClientToken parameter and sends a success response with the value of the Secret Key parameter as verification before sending/receiving messages.

Step 4: Create a Service Account Key

To send messages and events as your agent, you need to authenticate API calls with a service account key. The Business Communications Developer Console creates a service account for you, but you need to create a unique key to access your agent with the steps below:

  1. On the left menu, click Service account.
  2. Click the Create key button.
  3. Click Create on the confirmation window to download the JSON file with the service account key.
  4. Rename the downloaded file to rbm-agent-service-account-credentials.json.
  5. Store the key securely to recover it if required.

Step 5: Configure the Virtual Assistant for the Service Account

To configure the virtual assistant for the service account on the Kore.ai XO Platform, follow the steps below:

  1. Copy the client_email, client_id, client_token (alphanumeric value), and private_key values from the downloaded JSON file.

Important: For the private key, please copy only the key value within the BEGIN PRIVATE KEY and END PRIVATE KEY header tags. The XO Platform adds these tags by default.

  1. Paste the values in the respective fields under Deploy > Channels > Enterprise Channels > Google Business Messaging > Configurations.


  1. Select Yes for the Enable Channel option.
  2. Click Save

After enabling the channel and verifying all the configurations, you can test the new channel integration by publishing your virtual assistant. Learn more.

To learn more about working with messaging channels within the Kore.ai XO Platform, please see Channel Enablement.

Adding the Google Business Messaging Channel

 

Warning! Google announced the discontinuation of the Google Business Messages channel from July 31st. This channel will be phased out in the coming weeks. If you have alternative chat channels, consider inviting your customers to continue conversations there. For more details, please refer to the Google announcement.

Modern business applications require agent integrations on web/mobile devices to enable seamless customer communication via SMS/chats.

The Kore.ai XO Platform now helps you create rich and asynchronous messaging experiences within apps and during calls through the GBM channel enablement. This feature helps seamlessly integrate real-time business agents to Virtual Assistants through your own account or your GBM Partner account.

Google Business Messaging (GBM) is a mobile conversational channel that combines digital customer touchpoints or entry points on Google Maps, Search, and brand websites.

How does it work?

When Google Business Messaging is configured as a Channel on the XO Platform, the conversations between the customers and brands is enabled by creating agents. You can manage agents with either your own account or a GBM Partner Account. The process to create an agent differs in each scenario.

  • If you have a GBM Partner Account, the XO Platform registers each Business as a partner. You can enable conversations for brands you manage by creating Business Messages agents directly on GBM Developer Console.
  • If you have your own account, you can enable conversations for brands you manage by creating Business Messages agents using Business Communications APIs.

Important Information on Agents and GBM’s Messaging Infrastructure

  • An Agent is a conversational entity that users interact with.
  • You must create one agent for each brand you manage.
  • You can create and manage agents with the Business Communications API.
  • You can control messaging for your agents with the Business Messages API.
  • An agent encompasses a brand’s business functions, such as online support, and physical locations (if any).
  • Each message contains the context from which the user initiated the conversation.
  • Your message routing infrastructure can detect if the user viewed a specific business location or looked for general support, and it can route messages to the correct destination.

Customers can send messages to your brand or its locations through these agents.

With Business Messages, you can place messaging buttons for brands managed by Kore AI within organic Google search results.

The Messaging Flow

  1. When a customer clicks the button, a conversation is initiated with the brand’s virtual agent on the device.
  2. Google delivers the message defined as a JSON payload to the Webhook that Kore.ai provides.
  3. The agent uses this Webhook and the Conversational Agent API to receive and respond to the customer’s messages.

Set up on the GBM Channel

The important steps to set up the GBM channel are summarized below:

  1. Creating a Google Cloud Platform (GCP) project.
  2. Submitting the partner information to Google.
  3. Enabling the Conversational Agent API.

Prerequisites

  • An active Google account.
  • The Partner Name field appears in the Google My Business (GMB) Console for locations associated with the agents you manage.
  • A webhook endpoint URL that can accept messages (Kore.ai generates the webhook URL, which will be associated with a virtual assistant built on the platform).

Create a Google Cloud Platform Project

You must create and register a Google Cloud Platform (GCP) project to enable the Google Cloud API service for your partner account. Learn more.

Important: Please note the project number to register as a partner.

GBM Channel Enablement on the Platform

To set up the GBM channel on the Kore.ai XO Platform and launch the agent, follow the steps below:

  1. Register as a Google Business Messaging Partner.
  2. Create an agent for your account.
  3. If Business Helper Bot is Disabled, set an Agent-level Webhook.
  4. Create a Service Account Key.
  5. Configure the Virtual Assistant for the service account.

Step1: Register as a GBM Partner

When you register as a partner with Google 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. This helps enable seamless messaging experiences for customer services, sales, and other business applications. To register as a partner, follow the steps below:

  1. Open the Business Communications Developer Console.
  2. Under Business Messages, click Create partner account.
  3. Enter the values for the following fields in the Create a Business Messages partner account window:
    • Your Name: Your full name.
    • Partner Name: Your organization’s name.
    • Partner Website: Your organization’s website.
    • Region: The region you want to host the Business Messages service.

Important: To launch a production agent with Business Messages, please register with a corporate email, not a personal email.

  1. Review and Accept the Business Messages Terms of Service.
  2. Click Create.

You are now registered as a Business Messages partner and have access to the Business Messages and Business Communications APIs. The Business Messages API sends messages to users, while the Business Communications API manages agents.

Step 2: Create an Agent for your Account

After you register as a partner, you can enable conversations for brands you manage by creating Business Messages agents for them.

When creating an agent, you can enable the Business Messages Helper Bot that lets you quickly start a conversation with your agent by leveraging the available features and resources. This is especially useful when creating your first agent.

Also, to create an agent for your GBM Partner account, you must submit information on the brand and the agent on the Business Communications Developer Console.

Important: To manage multiple brands, you must create an agent for each brand.

Expectations Before Creating Agents

  • Agents should follow the design guidance outlined in Conversation design for Business Messages.
  • Agents should have human representatives available to answer questions when automation is unable to fulfill a request or when requested by users.
  • Without human representatives, your agent can’t be launched from location-based entry points or non-local entry points. Specify a human interaction type for your agent, so it can surface on Google-managed entry points.
  • Agents should maintain a customer satisfaction rating (CSAT) of at least 80% and a merchant response rate (MRR) of at least 95% as outlined in Metrics.

Prerequisites

  1. If you registered for a partner account before March 7, 2022, you need to enable the Business Messages API before creating your first agent. See Enable the Business Communications API and Business Messages API.
  2. Please ensure you have the following values for each brand you manage before you create an agent:
  • Brand name
  • Agent name to appear in conversations with users.

Steps to Create an Agent

Once you’ve gathered the above information, to create an agent follow the steps below:

Note: If you manage multiple brands, repeat the steps to create an agent for each brand.

  1. Sign in to your account on the Business Communications Developer Console.
  2. Click Create Agent.
  3. For Agent type, select Business Messages.
  1. Enter the values for the Brand name and Agent name fields.
  1. Do one of the following:
  • To experience a conversation with your agent by leveraging the rich features of the GBM Platform, select Enable Business Messages Helper Bot. The Helper Bot allows you to Explore rich features, learn how to implement features, and find resources for agent setup. When the Helper Bot is enabled, it sends and receives messages for your agent, and No Webhook is required.
  • To customize your agent and prepare it for message handling, deselect Enable the Business Messages Helper Bot.
  1. Click Create Agent.

If you enabled the Business Messages Helper Bot, you can start a conversation with your agent immediately. Otherwise, proceed to set your Webhook (Step 3).

Note: Once your agent is available, you can add the business and branding information.

Step 3: If Business Helper Bot is Disabled, Set an Agent-level Webhook

To customize your agent and how it handles messaging, you must set an agent Webhook on the Google Business Messages platform. You will receive messages sent to your agent at this Webhook. For setting up the Webhook, you must copy the Webhook URL from the XO platform and generate the Client Token for the agent to integrate for messaging and events.

To set up the agent Webhook, follow the steps below:

  1. Open the Business Communications Developer Console and sign in with your Business Messages Google account.
  2. Click on the panel with your agent’s name.
  3. On the Business Communications page, click Integrations on the left menu.
  4. For the Webhook option, click the Configure link.
  5. Copy the Webhook URL from the Kore.ai XO Platform under Deploy > Channels > Google Business Messaging > Configurations.
  6. Paste the copied link for the Webhook endpoint URL field in the Configure your webhook window on the Business Communications Developer Console.
  7. Click the Refresh icon for the clientToken field to generate the Client token. Note your clientToken value. You need it to verify that messages you receive are coming from Google.
  8. In the console, click Verify.

The GBM platform sends a POST request to Webhook you configured on the XO Platform with the specified ClientToken parameter and sends a success response with the value of the Secret Key parameter as verification before sending/receiving messages.

Step 4: Create a Service Account Key

To send messages and events as your agent, you need to authenticate API calls with a service account key. The Business Communications Developer Console creates a service account for you, but you need to create a unique key to access your agent with the steps below:

  1. On the left menu, click Service account.
  2. Click the Create key button.
  3. Click Create on the confirmation window to download the JSON file with the service account key.
  4. Rename the downloaded file to rbm-agent-service-account-credentials.json.
  5. Store the key securely to recover it if required.

Step 5: Configure the Virtual Assistant for the Service Account

To configure the virtual assistant for the service account on the Kore.ai XO Platform, follow the steps below:

  1. Copy the client_email, client_id, client_token (alphanumeric value), and private_key values from the downloaded JSON file.

Important: For the private key, please copy only the key value within the BEGIN PRIVATE KEY and END PRIVATE KEY header tags. The XO Platform adds these tags by default.

  1. Paste the values in the respective fields under Deploy > Channels > Enterprise Channels > Google Business Messaging > Configurations.


  1. Select Yes for the Enable Channel option.
  2. Click Save

After enabling the channel and verifying all the configurations, you can test the new channel integration by publishing your virtual assistant. Learn more.

To learn more about working with messaging channels within the Kore.ai XO Platform, please see Channel Enablement.

Menu