Last updated: 05 May 2025 • Version 1.2
Objective
This guide outlines the required configuration steps within Genesys Cloud for customers migrating from VideoEngager with Web Chat (Chat V2) to VideoEngager with Web Messenger.
Audience
-
Genesys Cloud Administrators
-
Technical Leads supporting frontend and QA integration
Disclaimer & Scope
Purpose: This Quick Start Guide is intended to support initial integration and testing activities by customer development and QA teams.
Out of Scope:
This document does not cover:
-
Production Architect flows with business logic
-
Error handling or advanced routing
-
Backend or third-party integrations
Key Configuration Data
Provide the following to the frontend team integrating the VideoEngager widget:
Parameter | Value (To Be Supplied) |
---|---|
Genesys Cloud Region | e.g., mypurecloud.ie , mypurecloud.com , etc. |
Deployment ID | Generated in Step 1.2: Create Messenger Deployment |
Allowed Domains | Domains where the widget will be embedded |
Example |
yourcompany.com , test.yourcompany.com , *.dev.yourcompany.com
|
1. Genesys Messenger Configuration & Deployment
Step 1.1: Create Messenger Configuration
-
Go to Admin → Message → Messenger Configurations
-
Click Create New
-
Set values as follows:
-
Messaging: Enabled
-
Clear Conversation: Enabled
-
Conversation Disconnect: Display status and disconnect session
-
User Interface: Off
-
Launcher Button Visibility: Hidden
-
Automatically Start Conversations: Enabled
-
-
Click Save
📘 Reference: Genesys Cloud Messenger Configuration Documentation
Step 1.2: Create Messenger Deployment
-
Go to Admin → Message → Messenger Deployments
-
Click Create New
-
Select the Messenger Configuration from Step 1.1
-
Assign deployment settings
-
Assign the Architect flow (after Step 2.6)
-
Click Save
📝 Record the generated Deployment ID — it's required by the frontend team.
Step 1.3: Configure Allowed Domains
-
In the Messenger Deployment (see Step 1.2), locate Allowed Domains
-
Add all domains where the VideoEngager widget will be embedded:
-
Production
-
Testing and Development
-
-
Click Save
Example:
yourcompany.com
test.yourcompany.com
*.dev.yourcompany.com
2. Genesys Architect Flow Configuration (Quick Start)
Step 2.1: Create Inbound Message Flow
-
Go to Admin → Architect → Inbound Message Flows
-
Click Add New
-
Fill in:
-
Flow Name: e.g.,
VideoEngager Web Messenger Routing
-
Default Language
-
Default Queue: Fallback queue for errors
-
-
Click Create Flow
Step 2.2: Create Minimal Pass-Through Flow
-
In the Architect flow editor:
-
Drag Transfer to ACD under the Start node
-
Configure:
-
Queue: e.g.,
VideoCall queue
(define in your org) -
Skills & Language: Leave blank
-
-
Add Disconnect to the Failure path
-
📷 Start → Transfer to ACD → Disconnect
✅ This flow enables basic message routing for integration validation.
Step 2.3: Configure Error Handling
-
Go to Event Handling → Error Event Handling
-
Set to Transfer to Queue and select a valid fallback queue
Step 2.4: (Optional) Set a Default Queue
-
Open the Data section in the flow
-
If using
Flow.foundQueue
, set its Initial Value to your default queue name
Step 2.5: (For Production) Enable Custom Attribute Routing
Not required for the minimal flow, but necessary for production.
Routing Attributes Used by VideoEngager:
Message.Attributes["context.queue"]
Message.Attributes["context.skills"]
Message.Attributes["context.language"]
Recommended Flow Additions:
-
Use Get Participant Data to extract attributes
-
Use Find Skill / Language actions
-
Add Decision Blocks for fallback logic
-
Route via Transfer to ACD with resolved data
📌 Confirm expected attribute names with your frontend team
Step 2.6: Save and Publish the Flow
-
Click Validate to check
-
Click Publish to deploy
Step 2.7: Assign Architect Flow to Deployment
-
Go back to Messenger Deployments (Step 1.2)
-
Edit the deployment
-
Under Architect Flow, select the published flow
-
Click Save
🕒 Changes may take a few minutes to reflect in Genesys Cloud
📄 Legal Notice
The information in this document is accurate as of its publication date and is subject to change without notice.
VideoEngager acknowledges the proprietary rights of other companies to their trademarks, product names, and other intellectual property mentioned herein.
Comments
0 comments
Please sign in to leave a comment.