Deploy Messenger

Prerequisites
  • To view Configure Messenger:
    • Genesys Cloud User 2, Genesys Cloud User 3, Genesys Cloud Digital Upgrade
    • Web Deployments Configurations All permission
    • Web Deployments Deployments > All permission
    • An inbound messaging flow
  • To view Brand Logo upload field:
    • uploads > publicAsset > upload
  • To view Knowledge Base selection field:
    • knowledge > knowledgebase > view
  • To view Co-browse field:
    • conversation cobrowse add

    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 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

    1. Click Admin.
    2. Under Message, click Messenger Deployments.
    3. Click New Deployment.
    4. Enter a name and description.
    5. Under Status, 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.
    6. Under 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 you want to assign.
      3. Click Save.
    7. 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.
    8. Under Select your Architect Flow, select a published inbound message flow.
    9. 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

    1. Click Admin.
    2. Under Message, click Messenger Deployments.
    3. Navigate to the Messenger deployment you want to deploy and click the name in the Deployment Name column.
    4. Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
    5. Paste the snippet to the <head> tag of all of your webpages.
    6. To use the Deployment Key with your custom messaging client, configure it in your SDK.

    1. Click Admin.
    2. Under Message, click Messenger Deployments.
    3. Navigate to the Messenger deployment you want to deploy and click the name in the Deployment Name column.
    4. Under Deploy your snippet, click Copy to Clipboard to copy the snippet.
    5. In Google Tag Manager, create a new Custom HTML tag.
    6. Paste the snippet into the body of the Custom HTML tag.
    7. Enclose the JavaScript code with <script> tags. Be sure to unescape the snippet code to remove the \n new line escaped characters.
    8. Save the tag.
    9. Select the All Pages trigger.
    10. Save the tag with a meaningful name, such as Messenger Tag.
    11. Click Submit
    12. Click Publish to publish the tag to all pages on your website.

    Note: In order 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.