Deploy Messenger

AI-generated summary

Genesys Cloud Messenger enables web and mobile messaging through predefined and customizable interfaces for customer interactions with bots and agents. Web deployment requires creating a Messenger deployment and deploying a snippet to the website through either manual integration or Google Tag Manager, while mobile deployment utilizes the headless Transport SDK for developers to build custom messaging clients. To establish a Messenger deployment, users access Menu > Digital and Telephony > Message > Messenger Deployments and configure essential settings including deployment name, description, active status, Messenger configuration version, Supported Content Profile assignment, and published inbound message flow selection. Domain access can remain unrestricted for testing environments or be restricted to specific domains to prevent unauthorized usage. Push notification integration supports both Apple Push Notification Service (APNS) and Firebase Cloud Messaging (FCM). Deployment management includes modifying assigned Messenger configurations, managing web messaging and supported content profiles, and disabling or deleting deployments as needed. Prerequisites encompass appropriate Genesys Cloud CX licensing (CX 2, CX 3, CX 4, or Digital Add-on variants), specific permissions across Web Deployments, Messaging, Knowledge, and Conversation modules, and a configured inbound messaging flow. Upon completion, the system provides the Messenger snippet and deployment key for website integration. For manual deployment, administrators retrieve the Deployment Key from the Deployment Options section within the target deployment and configure identity resolution through external source and merge contact settings. The deployment snippet is inserted into the `<head>` tag of all webpages, with the Deployment Key configured in the SDK for custom messaging clients. Google Tag Manager deployment involves creating a Custom HTML tag, pasting the snippet with proper `<script>` tag enclosure, unescaping the JavaScript code to remove line-escaped characters, assigning the All Pages trigger, and publishing to all website pages. Both deployment methods require viewport meta tag configuration (`<meta name="viewport" content="width=device-width, initial-scale=1">`) for mobile browser support and may necessitate Content Security Policy (CSP) updates to permit Messenger resources, ensuring organizations can integrate Genesys Cloud messaging capabilities while maintaining security and functionality standards.

PrerequisitesClick to expand

To view Messenger configuration:
- Genesys Cloud CX 2, Genesys Cloud CX 3, Genesys Cloud CX 4, Genesys Cloud CX 2 Digital, Genesys Cloud CX 3 Digital, or Genesys Cloud CX 1 Digital Add-on II license
- All permissions under Web Deployments > Configurations
- All permissions under Web Deployments > Deployments
- An inbound messaging flow

To view the Brand Logo upload field: Uploads > Public Asset – Upload permission
To view the Knowledge Base selection field: Knowledge > Knowledgebase – View permission
To view the Co-browse field: Conversation > C obrowse – Add permission
To view and update the content profile: Messaging > Supported Content – Add, Delete, Edit, and View permission

Messenger enables web messaging by providing a predefined Messenger window that customers use to interact with bots and agents. Before you create a Messenger deployment, configure Messenger and save a version of the configuration.

Messenger also enables mobile messaging via the headless Transport SDK. With the Transport SDK, mobile developers can easily build a custom mobile messaging client.

To deploy Messenger to your website:

Create a Messenger deployment.
Deploy the Messenger snippet to your website. You can manually deploy the Messenger snippet or use Google Tag Manager to deploy the Messenger snippet.

To deploy Messenger to your mobile platform (custom mobile messenger):

Configure the deployment domain and ID in the Transport SDK.

To manage your Messenger deployment, you can:

Create a Messenger deployment

Click Admin.
Under Message, click Messenger Deployments.
Click Menu > Digital and Telephony > Message > Messenger Deployments.
Click New Deployment.
Enter a name and description.
Under the Status section, use the toggle to set the status of the Messenger deployment.
1. To enable the Messenger deployment on your website or in your mobile application, turn on the toggle. The status shows as Active.
2. To disable the Messenger deployment on your website or in your mobile application, turn off the toggle. The status shows as Inactive.
Under the Select your Configuration, click Select Configuration to select a version of a Messenger configuration to assign to this deployment.
1. In the Assignment pane, navigate to the Messenger configuration you want to assign to the configuration and click the name of the Messenger configuration.
2. Select the version that you want to assign.
3. Click Save.
Under Select your Supported Content Profile, click the list to select a Content Profile to assign to this deployment. You can also add new Supported Content Profiles, if necessary.
Under Restrict domain access, determine whether to allow all domains or restrict the domains on which you want to deploy the snippet.
1. To allow all domains, select the Allow all domains option. Use this option for testing and development purposes.
2. To restrict domains, enter a domain and click Add Domain. You can add multiple domains to the list. Restrict domains to prevent unauthorized usage of your snippet from unknown domains. If you restrict a domain, then Messenger does not run on that website and rejects API requests from that domain.
Under Select your Architect Flow, select a published inbound message flow. If a flow is not selected, messaging functions will not be available.
Under Push Integrations, select the integration type you want to use to configure mobile push notifications for the Apple Push Notification Service (APNS) and the Firebase Cloud Messaging (FCM). If you do not select a push integration, push notifications are not sent.
Click Save. The Messenger Deployments page now displays the snippet and deployment key. Next, copy the Messenger snippet and deploy the Messenger snippet to your website. If you are building a custom Messenger, copy the deployment key.

Deploy the Messenger snippet to your website

Manually deploy the Messenger snippetClick to expand

Click Admin.
Under Message, click Messenger Deployments.
Click Menu > Digital and Telephony > Messenger Deployments.
Navigate to the Messenger deployment that you want to deploy and click the name in the Deployment Name column.
In the Deployment Options section, view the Deployment Key in the Get your Deployment Key field.
In the Identity Resolution field, configure your external source and merge contact settings to ensure that identity resolution works as expected. For more information, see Configure identity resolution from the Admin page.
Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
Paste the snippet to the <head> tag of all of your webpages.
To use the Deployment Key with your custom messaging client, configure it in your SDK.

Use Google Tag Manager to deploy the Messenger snippetClick to expand

Click Admin.
Under Message, click Messenger Deployments.
Click Menu > Digital and Telephony > Messenger Deployments.
Navigate to the Messenger deployment that you want to deploy and click the name in the Deployment Name column.
Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
In Google Tag Manager, create a new Custom HTML tag.
Click the image to enlarge.
Paste the snippet into the body of the Custom HTML tag.
Enclose the JavaScript code with <script> tags. Be sure to unescape the snippet code to remove the new line escaped characters.
Click the image to enlarge.
Save the tag.
Select the All Pages trigger.
Save the tag with a meaningful name, such as Messenger Tag.
Click the image to enlarge.
Click Submit
Click Publish to publish the tag to all pages on your website.
Click the image to enlarge.

Note:

To have proper support in mobile browsers, your website should include ideal viewport settings in <meta> tag. For example: <meta name="viewport" content="width=device-width, initial-scale=1">. For more information on using viewport meta tag to control layout on mobile browsers, see here.
Consider whether your Content Security Policy (CSP) may need to be updated to allow Messenger resources to be set up on your website. For more information about the security policies, see Content Security Policy.

[NEXT] Was this article helpful?

Get user feedback about articles.

Create a Messenger deployment

Click Admin.

Under Message, click Messenger Deployments.

Click Menu > Digital and Telephony > Message > Messenger Deployments.

Click New Deployment.

Enter a name and description.

Under the Status section, use the toggle to set the status of the Messenger deployment.

To enable the Messenger deployment on your website or in your mobile application, turn on the toggle. The status shows as Active.
To disable the Messenger deployment on your website or in your mobile application, turn off the toggle. The status shows as Inactive.

Under the Select your Configuration, click Select Configuration to select a version of a Messenger configuration to assign to this deployment.

In the Assignment pane, navigate to the Messenger configuration you want to assign to the configuration and click the name of the Messenger configuration.
Select the version that you want to assign.
Click Save.

Under Select your Supported Content Profile, click the list to select a Content Profile to assign to this deployment. You can also add new , if necessary.

Under Restrict domain access, determine whether to allow all domains or restrict the domains on which you want to deploy the snippet.

To allow all domains, select the Allow all domains option. Use this option for testing and development purposes.
To restrict domains, enter a domain and click Add Domain. You can add multiple domains to the list. Restrict domains to prevent unauthorized usage of your snippet from unknown domains. If you restrict a domain, then Messenger does not run on that website and rejects API requests from that domain.

Under Select your Architect Flow, select a published inbound message flow. If a flow is not selected, messaging functions will not be available.

Under Push Integrations, select the integration type you want to use to configure mobile push notifications for the Apple Push Notification Service (APNS) and the Firebase Cloud Messaging (FCM). If you do not select a push integration, push notifications are not sent.

Click Save. The Messenger Deployments page now displays the snippet and deployment key. Next, copy the Messenger snippet and deploy the Messenger snippet to your website. If you are building a custom Messenger, copy the deployment key.

Deploy the Messenger snippet to your website

Manually deploy the Messenger snippetClick to expand

Click Admin.
Under Message, click Messenger Deployments.
Click Menu > Digital and Telephony > Messenger Deployments.
Navigate to the Messenger deployment that you want to deploy and click the name in the Deployment Name column.
In the Deployment Options section, view the Deployment Key in the Get your Deployment Key field.
In the Identity Resolution field, configure your external source and merge contact settings to ensure that identity resolution works as expected. For more information, see Configure identity resolution from the Admin page.
Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
Paste the snippet to the <head> tag of all of your webpages.
To use the Deployment Key with your custom messaging client, configure it in your SDK.

Use Google Tag Manager to deploy the Messenger snippetClick to expand

Click Admin.
Under Message, click Messenger Deployments.
Click Menu > Digital and Telephony > Messenger Deployments.
Navigate to the Messenger deployment that you want to deploy and click the name in the Deployment Name column.
Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
In Google Tag Manager, create a new Custom HTML tag.
Click the image to enlarge.
Paste the snippet into the body of the Custom HTML tag.
Enclose the JavaScript code with <script> tags. Be sure to unescape the snippet code to remove the new line escaped characters.
Click the image to enlarge.
Save the tag.
Select the All Pages trigger.
Save the tag with a meaningful name, such as Messenger Tag.
Click the image to enlarge.
Click Submit
Click Publish to publish the tag to all pages on your website.
Click the image to enlarge.

Note:

To have proper support in mobile browsers, your website should include ideal viewport settings in <meta> tag. For example: <meta name="viewport" content="width=device-width, initial-scale=1">. For more information on using viewport meta tag to control layout on mobile browsers, see here.
Consider whether your Content Security Policy (CSP) may need to be updated to allow Messenger resources to be set up on your website. For more information about the security policies, see Content Security Policy.

Deploy Messenger

Create a Messenger deployment

Deploy the Messenger snippet to your website

[NEXT] Was this article helpful?

Loading...

Deploy Messenger

Create a Messenger deployment

Deploy the Messenger snippet to your website

[NEXT] Was this article helpful?