Wildix

Wildix #

~.Dimensions.~ can model your Wildix PBX communications in order to provide a complete overview of your business communications.

Wildix Configuration #

Below is a guide on configuring Wildix to support ~.Dimensions.~ and allow it to communicate.

Required Information #

The following information is required when adding a Wildix PBX connection to ~.Dimensions.~ customer account. Create the necessary Company API Key and Application within Wildix before completing the normal ~.Dimensions.~ new customer process.

Item Description
System Name The name of the system that is being connected to ~.Dimensions.~
Company API Key A Company API key that is generated in the Wildix system to allow ~.Dimensions.~ access to the API.
Application Client Id, Secret and Redirect URI These are required to allow ~.Dimensions.~ access to the Wildix system via the OAuth2 authentication process.
Hand Left warning
The Company API Key and OAuth 2.0 application client need to be recreated and re-entered into the ~.Dimensions.~ portal before they expire to avoid data loss. ~.Dimensions.~ will generate an Alert to help remind you when the Company API Key and OAuth 2.0 application client are due to expire.

System Name #

System Name can be found in the Wildix WMS dashboard in 'Tools and Utilities -> Activation / Licences -> System name'.

Find and save the 'System name' for use when adding the Wildix PBX connection to ~.Dimensions.~.

Company API Key #

The Company API Key can be generated in the Wildix WMS dashboard in 'PBX -> Integrations -> Company API Keys'.

To add a key, press the 'Create API Key' button and provide the following information:

Data Description
API Key Name A name to identify the API Key in the Wildix system. This is only used with Wildix for identification purposes.
Expires At The date and time that the API Key will expire. It is recommended to leave this blank to generate the longest lasting API Key to reduce management overhead.
Scopes The scopes that the API Key will have access to. For ~.Dimensions.~ the following scopes are required:
  • history:GetCallTranscription
  • insights:CreateProjection
  • insights:DeleteProjection
  • insights:GetCallInsights
  • insights:GetProjection
  • insights:ListProjections
  • insights:UpdateProjection
  • integrations:CreateIntegration
  • integrations:DeleteIntegration
  • integrations:ListIntegrations
Document note
There should be 10 scopes in total for the API Key. If any are missing, ~.Dimensions.~ will not be able to access the Wildix system correctly.

Application Setup #

An 'Application' can be added in the Wildix WMS dashboard in 'PBX -> Integrations -> Applications -> OAuth 2.0'.

To add an application, press the '+ Add' button (below the Applications table) and populate the following information:

Data Description
Application name A name to identify the Application in the Wildix system. This is only used with Wildix for identification purposes.
Redirect URI The redirect URI for the Wildix connection on ~.Dimensions.~. This will be provided to you when you add the Wildix connection to the customers account on ~.Dimensions.~
Expire date The expiry time for the application. It is advised to select 365 days to reduce the management overhead.

After providing the information above, click 'Save'. You will be provided with the 'Client Id' and 'Client Secret' for the application. These will be required when adding the Wildix PBX connection to ~.Dimensions.~.

Document note
If there is no area for the 'Redirect URI' and you are being prompted for a 'PBX user', you are creating the wrong application. Ensure you have clicked into the 'OAuth 2.0' section.

Call Groups & Paging #

The Wildix API doesn't natively provide the information on the call groups and paging groups that calls are routed to. To allow ~.Dimensions.~ to model the call groups and paging groups, you will need to add a 'Tag' to each dial plan rule point when a call is routed to a call group or page group in the Wildix system.

Use on f the tag formats below to add the necessary information for ~.Dimensions.~ to model the call groups and paging groups:

  • Call Group: hg:[call group name][call group name]
    • e.g. hg:Sales
  • Paging Group: hg:[paging group name][paging group name]
    • e.g. pg:Reception

Here is an example of what the tag looks like on a dial plan section which routes the call to a call group called Support:

image.png

Networked Systems #

If connecting to a customer with more than 1 Wildix system networked, you will need to add a separate Wildix PBX connection for each system. Each system will have its own System Name, Company API Key and Application Client Id/Secret.