Widget URL
To load MiraBridge Phone in your CRM, you must embed a widget URL that points to the MiraBridge API with your deployment parameters.
Base URL
The widget URL follows this pattern, where {deploymentId} is your deployment identifier:
https://phone.mirabridge.cloud/api/v1/deployment/{deploymentId}/init
Required Parameters
The following parameters are required to construct your widget URL:
| Parameter | Description |
|---|---|
deploymentId | Provided by MiraBridge. Identifies the widget configuration to be loaded. This goes in the URL path. |
clientId | The OAuth Client ID created in Genesys Cloud for authentication. |
region | Identifies your Genesys Cloud region. See region table. |
Note: deploymentId is part of the URL path, while clientId and region are query parameters.
Region Codes
Use the domain that matches your Genesys Cloud organization’s login URL:
| Region | Domain (region value) |
|---|---|
| Americas (Canada) | cac1.pure.cloud |
| Americas (Sao Paulo) | sae1.pure.cloud |
| Americas (US East) | mypurecloud.com |
| Americas (US West) | usw2.pure.cloud |
| FedRAMP (US East 2) | use2.us-gov-pure.cloud |
| Asia Pacific (Mumbai) | aps1.pure.cloud |
| Asia Pacific (Osaka) | apne3.pure.cloud |
| Asia Pacific (Seoul) | apne2.pure.cloud |
| Asia Pacific (Sydney) | mypurecloud.com.au |
| Asia Pacific (Tokyo) | mypurecloud.jp |
| EMEA (Dublin) | mypurecloud.ie |
| EMEA (Frankfurt) | mypurecloud.de |
| EMEA (London) | euw2.pure.cloud |
| EMEA (Zurich) | euc2.pure.cloud |
| Middle East (UAE) | mec1.pure.cloud |
ℹ️ If you’re unsure which region to use, refer to your Genesys Cloud organization region or ask your Genesys administrator.
Optional Parameters
| Parameter | Description |
|---|---|
enableDebug | Enables verbose logging in the browser console. |
enableDiagnostics | Enables runtime diagnostics to be sent to the MiraBridge backend. |
Example
Let’s say the MiraBridge team provided you with the following:
deploymentId:mainclientId:12345678-1234-1234-1234-123456789abcregion:mypurecloud.de
Your full widget URL will be:
https://phone.mirabridge.cloud/api/v1/deployment/main/init?region=mypurecloud.de&clientId=12345678-1234-1234-1234-123456789abc
You can optionally append:
&enableDebug=true&enableDiagnostics=true