How to Use
- Configure an Agent Copilot URL using the pattern:
https://${AICopilotBaseUrl}/?userId=${userId}&sessionId=${sessionId}&URLToken=${URLToken}. - Pass this URL along with the handover to the human agent.
- For native integrations, the link is passed automatically.
- For custom integrations, include the link in your handover configuration.
- If you work with voice use case, check the Transfer Node in your Flow.
- Configure the Transfer Node:
- Fill in the Transcription Webhook field with your Agent Copilot URL.
- Activate Enable Copilot.
- Specify the header that carries the UUIValue in the Copilot Headers Key field. The default is
X-Custom-Header. This header will be sent to the Agent Copilot transcription webhook, while the UUIValue is also forwarded via SIP headers when transferring the call to the human agent.
Secure Access with JWT
You can secure access to Agent Copilot by passing a JWT in the URL. This approach ensures that only authenticated users can open the Agent Copilot workspace.auth is the JWT used for authentication.
For the authentication to work, the contact center and Cognigy.AI need to share a 256-bit long JWT secret that is used by the Agent Copilot backend.
The contact center integration needs to proceed as follows:
- Creates values for
userIdandsessionId. - Uses
URLTokenfrom the respective Cognigy.AI Endpoint. - Reads the JWT secret from an internal storage.
- Signs a JWT with payload containing the
userIdandsessionId.
- Checks if the
authparameter is passed in the URL. - If
authis passed, the value is treated as a JWT and the Agent Copilot backend verifies the JWT signature. - During the verification of the JWT signature, Agent Copilot decodes the payload of the JWT to retrieve the
userId,sessionId, andURLTokenparameters.