https://docs-voice.uk.xarios.cloud/en-gb/ Recent content in Introduction on ~.Dimensions.~ Hugo -- gohugo.io https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/avaya/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/avaya/ Avaya Phones # ~.Dimensions.~ integrates directly with the Avaya DES service. Any new Avaya phones added to ~.Dimensions.~ will automatically provision. If adding a phone which has been used previously on another platform, it may need to be reset using the instructions below. Defaulting an Avaya Phone # Avaya phones can be reset to defaults from their admin menu. Select 'Administration' in the admin menu on the phone and enter the phone's PIN (default 27238). https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/intro/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/intro/ Call Management & Analytics # This call analytics portal provides a range of tools to analyse the call experience of your customers and monitor staff performance, both historically and in real-time. The system collects information about all telephone calls, tracking where calls have routed to (including Call Routing Announcements/Auto Attendants) and storing DDI, contact information and internal information such as users and agents. User Interface # This section provides an overview of the portals user interface, outlining what each area is for. https://docs-voice.uk.xarios.cloud/en-gb/config/contactdirectories/contacts/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/contactdirectories/contacts/ Contact Management # Each directory configured on the system has its own permissions and custom fields which can be tailored for specific uses. Each directory also has a set of fixed fields (like telephone numbers and name) which are used within the system for specific purposes. Settings # Property Description Name A friendly name to the directory will be know by within clients. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/crmintegration/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/crmintegration/ CRM Integration # If a customer is using one of the ~.UcClient.~ CRM User Add-Ons, there may be some additional configuration needed to ensure they can login into the plugin successfully. In order to maintain a high level of security, ~.Dimensions.~ only supports login through an iFrame if it is from a known source. If a customer using one of the CRM providers standard domains (e.g. https://Salesforce.com or https://freshdesk.com), no additional configuration is necessary. https://docs-voice.uk.xarios.cloud/en-gb/config/ci/customdictionary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/ci/customdictionary/ Custom Dictionary # If there are words in the conversation that are not being transcribed correctly, you can add them to the custom dictionary. This allows the system to recognize these words and transcribe them accurately in future calls. Generally mis-transcribed words are product names or services that used by the customer that the transcription engine has no knowledge of. To add a word to the dictionary, press the 'Add Custom Dictionary Entry' button and then populate the following settings on the form: https://docs-voice.uk.xarios.cloud/en-gb/realtime/rtui/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/rtui/ Dashboard/Wallboard User Interfaces # Both the dashboard & wallboard have similar user interfaces. Each supports different views which can be configured to show different statistics/filters based on different user or departmental requirements. Views # Each view is a collection of tiles which can be configured to show a range of statistics. Multiple views1 can be created within the dashboard and wallboard areas of the workspace. Selection # The view selector provides a quick way to switch between configured views: https://docs-voice.uk.xarios.cloud/en-gb/config/general/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/general/ General Settings # These settings control various system level aspects of the portal. Portal - Feature Visibility # By default, all features of the solution are displayed to users. In order to simplify the interface for users, specific areas of the solution can be hidden if they are not relevant. To hide a specific feature, simply uncheck the relevant options. Location # Setting Description Default Country The country selected here will control how phone numbers are formatted in reports and any other regional based changes. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorygetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorygetall/ Get All Directories # Gets a list of all directories configured on your account. Once a list of all directories has been retrieved, specific details about directory items can be retrieved using the other available interfaces. GET /v1.0/contactdirectories Example # This request will get a list of all directories configured on your ~.Dimensions.~ account. Request # GET <https://api.uk.myreports.cloud/api/v1.0/contactdirectories> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportsgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportsgetall/ Get All Reports # Gets a list of all reports configured in a specific workspace. Once a list of all reports has been retrieved, it can be execute and data retrieved using a specific reportId. GET /v1.0/workspaces/{WORKSPACE_ID}/reports Example # This request will get a list of all reports configured within the specified workspace. Request # GET <https://api.uk.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 3, "page_index": 0, "data": [{ "id": "00000000-0000-0000-0000-000000000001", "name": "Call List (Segmented)" }, { "id": "00000000-0000-0000-0000-000000000002", "name": "Calls by Queue Name" }, { "id": "00000000-0000-0000-0000-000000000003", "name": "Calls by User" } ][{ "id": "00000000-0000-0000-0000-000000000001", "name": "Call List (Segmented)" }, { "id": "00000000-0000-0000-0000-000000000002", "name": "Calls by Queue Name" }, { "id": "00000000-0000-0000-0000-000000000003", "name": "Calls by User" } ], "status": "success", "timestamp": "2019-05-01T10:00:00. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/workspacesgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/workspacesgetall/ Get All Workspaces # Gets a list of all workspaces configured on your account. Once a list of all workspaces has been retrieved, report queries can be made against a specific workspace using its unique identifier. GET /v1.0/workspaces Example # This request will get a list of all workspaces configured on your ~.Dimensions.~ account. Request # GET <https://api.uk.myreports.cloud/api/v1.0/workspaces> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1. https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes/ Release Notes # The following sections outline the release history of the solution and provides information on new features as they are added to the product. Information Circle info Documentation version - 1.108.3 Releases # 1.108.0 - April 7th, 2026 # Features Area Description Conversational Intelligence Personally Identifiable Information (PII) redaction support addedMulti-language transcription support (en/es/it/fr/de) addedNew 'Karaoke' mode for transcriptions during recording playback Conversations Conversations view now available for recorded callsUser interface updated to show transcriptions in 'Chat' bubble style Provisioning PBX alerts now shown on the Phone Systems -> Connections gridYealink - Support for T74U/T74W/T88W modelsDevices grid now shows current firmware versionNew 1 month storage retention option Reporting New 'Long Calls' viewNew 'Lost Calls' viewNew 'Repeat Calls' viewPower BI connector in preview (Requires REST API access)New 'Calls by Business Area' reporting templateNew 'Calls by Topic' reporting templateNew reporting fields for 'Longest/Shortest Talk Time' percentilesNew reporting fields for 'Repeat' callsNew reporting fields for 'User Effort' Voice New option to disable voicemail for usersPBX now disabled when disabling/terminating a customer Wallboard Support for TCL 4k UHD Fire TVs Webhooks Additional 'Answered / Last Answered User Email' fields in the webhook payload ~. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/calltagging/phone/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/calltagging/phone/ Tagging calls from a phone # The table below shows which phones provisioned by ~.Dimensions.~ support the Tag Call softkey: Make Tag Call Supported Mitel 53xx ✘ Mitel 68xx ✔ Poly ✔ Yealink ✔ Information Circle info This may be supported on Generic SIP phones as well. Please follow the instructions for Tagging calls from an external application for more information. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/trainingvideos/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/trainingvideos/ Training Videos # The following videos provide a walk through if the user interface and the primary features of the solution. User Interface Introduction # An introduction to logging onto the system and navigating the user interface: # Reports # The following videos provide information on how to create, run and customise historical reports: Introduction Creating & Editing For more information, please refer to the Reports section. https://docs-voice.uk.xarios.cloud/en-gb/config/usermanagement/users/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/usermanagement/users/ Users # The users sections provides access to manage ~.Dimensions.~ Voice users. This includes adding/removing using from the communications platform as well as managing users who just have access to call analytics features. Adding/Editing Users # Any user with the 'Manage Users' permission will be able to add or edit other users on the system. There are two types of access type that can be granted when creating users: https://docs-voice.uk.xarios.cloud/en-gb/reports/reportview/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/reports/reportview/ Viewing Reports # The following sections cover the report viewer interface and explain how to re-format a report, change the date range or apply a filter. Report Interface # The report view displays a completed report in a grid format. Each of the fields specified in the report's configuration are displayed in the order defined. For more information on the data displayed in a particular field, hover the mouse over a field heading to display the field's description. https://docs-voice.uk.xarios.cloud/en-gb/statistics/stats_all/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/stats_all/ All Fields # The table below provides a description of each field available on the system and an overview of which reports/tiles can display the field. Active Calls # While the stats below may be listed as working on a specific Tile/Grid, visibility of 'Active Call' stats are also restricted by customer license level and user roles. Field Name Description Communications Service Availability Reports Tiles Grids Charts Active Calls The total number of active calls (any call whether ringing, queued, held or in progress, external calls only). https://docs-voice.uk.xarios.cloud/en-gb/config/ci/businessareas/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/ci/businessareas/ Business Areas # The business areas section provides a way to categorise and organise your customer interactions based on the business function or department they relate to. This can help you gain insights into which areas of your business are generating the most customer interactions, and identify trends or patterns in customer behaviour. The descriptions entered against each business area are used within the AI prompts to provide context on the type of interactions that should be categorised within each business area, so it is important to ensure they are descriptive and accurate. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callanalytics/segmentation/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callanalytics/segmentation/ Call Segmentation # Call segmentation is the name given to how the system models telephone calls. Understanding how calls are modelled is important in understanding the data which is displayed on reports and wallboards. The following section explains how the system models calls, the difference between single/multi segment calls and what effect they have on the data displayed. What is Call Segmentation? # Telephone calls can range from being relatively simple with just two connections involved, to increasingly complex cases such as multiple transfers or conference calls. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/cisco/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/cisco/ Cisco Phones # ~.Dimensions.~ integrates directly with the Cisco CDA service. Any new Cisco phones added to ~.Dimensions.~ will automatically provision. If adding a phone which has been used previously on another platform, it may need to be reset using the instructions below. Information Circle info Only 78xx and 88xx series phones are supported on the CDA for automatic provisioning. 68xx and SPA series phones must be manually provisioned. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/config/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/config/ Configuration Options # The sections below outline the various phone configuration options which are available for each device. Device # Information # The details below show information about the device which where provided when it was created or assign. The name of the device is configurable and is used internally on reports and in the directories etc. Configuration Description Name The SIP username for this specific device Device (Read Only) The MAC address for the device Manufacturer (Read Only) The manufacturer of the device Model (Read Only) The model number of the device Device Type (Read Only) The type of device (User, Hotdesk or Phone Only) Status # The details below show information about the device which where provided when it was created or assign. https://docs-voice.uk.xarios.cloud/en-gb/reports/reportcustomization/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/reports/reportcustomization/ Creating & Editing Reports # Each report configured on the system can be configured to more closely meet specific requirements. A report is defined by the following settings: Details Filters Field Sorting When creating a new report instance, a report template must be selected and the report instance must be given a name to uniquely identify it within the workspace. Details # Template Selection # Report templates define what data the report will be accessing and how the data will be modelled. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryget/ Get Directory # Get details of a specific directory. GET /v1.0/contactdirectories/{DIRECTORY_ID} Example # This request will retrieve the directory details for a specific directory id. Request # GET <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/octet-stream; charset=utf-8 Content-Length: xx { "page_size": 1, "data": \[{ "id": "00000000-0000-0000-0000-000000000000", "name": "My Global", "description": "This is my global directory", "fields": ["title", "fullName", "companyName", "jobTitle", "phone1", "phone2", "phone3", "phone4", "email", "crmId", "field1", "field2", "field3", "field4", "field5", "field6", "field7", "field8", "field9", "field10", "avatar"]["title", "fullName", "companyName", "jobTitle", "phone1", "phone2", "phone3", "phone4", "email", "crmId", "field1", "field2", "field3", "field4", "field5", "field6", "field7", "field8", "field9", "field10", "avatar"] } ], "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/en-gb/config/contactdirectories/import/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/contactdirectories/import/ Importing Contact Data # The easiest and quickest way to populate a directory is to import that data using a CSV file. Format # Any CSV file needs to have the contact fields in the correct order for the import to be successful. The field order required for the CSV is displayed on the 'Import' form: 'Title,Full Name,Company Name,Job Title,Telephone 1,Telephone 2,Telephone 3,Telephone 4,Email,CRM ID,Field 1,Field 2,Field 3,Field 4,Field 5,Field 6,Field 7,Field 8,Field 9,Field 10' https://docs-voice.uk.xarios.cloud/en-gb/realtime/rttileedit/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/rttileedit/ Managing Dashboards & Wallboards # This section outlines the settings available to customise a dashboard/wallboard view with new tiles, filers and colours. Tiles # Each view can be customised with a range of supported tiles to display the information required. Depending on workspace permissions, users can add and remove tiles, change the appearance, filter and relocate tiles at any time. Information Circle info Up to 64 tiles can be added to a view. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportrequest/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportrequest/ Post Report Request # Post a request to run a report for a specific time period (dateFilter). POST /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/requests Example using a Preset Date Filter # This request will run a report for the current quarter. The return body contains as 'requestId' which can be used to query the status of the report and retrieve the dataset. Request # POST <https://api.uk.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests> HTTP/1.1 Content-Type: application/json Authorization: Bearer {TOKEN} Connection: keep-alive { "reportId": "00000000-0000-0000-0000-000000000001", "filterId": "00000000-0000-0000-0000-000000000001", "dateFilter": { "presetName": "ThisQuarter" } } Information Circle info https://docs-voice.uk.xarios.cloud/en-gb/about/requirements/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/about/requirements/ Requirements # Browsers # The website is designed to work on most modern browsers. This includes: Chrome Firefox Edge (New Chromium version) Safari Ensure you are running the latest version of your chosen browser to avoid compatibility issues. Amazon FireTV # To access the Wallboard from an Amazon Fire TV, the following requirements must be met: FireTV OS 6 or higher Mains USB Power Internet Access (via WiFi or using the optional FireTV Ethernet Adapter) TV must meet FireTV requirements (HDMI input, 1080 resolution etc. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/calltagging/zswitch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/calltagging/zswitch/ Tagging calls with a Call Flow # Calls can be tagged directly from ~.pbx.kazoo.name.~ Call Flows, allowing calls to be tagged with categories (Sales, Support...) or flags (VIP...) as they route through the communications platform. To tag a call from a call flow, add a 'Webhook' to the call flow from the 'Advanced' menu: Then configure the webhook with the following parameters: URL: Copy the URL from the Tag page and paste here, remembering to exchange the {value} placeholder with value you wish to tag the call with. https://docs-voice.uk.xarios.cloud/en-gb/config/usermanagement/usergroups/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/usermanagement/usergroups/ User Groups # This section provides access to see all of the user groups that have been configured on the product and manage which users are a member of each. User groups provide a away to logically group users on the system together. This grouping can then be used within reports to monitor performance or to filter for specific calls. Group membership is not compulsory for users and they can be made a member of multiple groups (for future use). https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/usersettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/usersettings/ User Settings # For each user who access to the system there are some basic setting that apply only to them. The user based settings can be accessed by selecting the 'My Profile' option from the user context menu at the bottom of the portal navigation options: The settings outlined below can be updated as required by the logged in user. Your Details # This section contains basic user information. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_lostcallsbyday/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_lostcallsbyday/ Abandoned Calls by Day # The table below shows which fields are available on the Abandoned Calls by Day template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_lostcallsbydayandtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_lostcallsbydayandtime/ Abandoned Calls by Day & Time # The table below shows which fields are available on the Abandoned Calls by Day & Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_lostcallsbytime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_lostcallsbytime/ Abandoned Calls by Time # The table below shows which fields are available on the Abandoned Calls by Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentawayreasonsummary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentawayreasonsummary/ Agent Away Reason Summary # The table below shows which fields are available on the Agent Away Reason Summary template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Agent Times # Field Name Description Default Field? Away Reason Away Reason ✔ First Away Time The first time that an agent entered the Away state. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentstatusdetail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentstatusdetail/ Agent Status Detail # The table below shows which fields are available on the Agent Status Detail template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Agent Times # Field Name Description Default Field? Agent State The availability state of an agent at a particular time. ✔ Away Reason Away Reason ✔ Duration The length of time an agent was in a particular state. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentstatussummary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentstatussummary/ Agent Status Summary # The table below shows which fields are available on the Agent Status Summary template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Agent Times # Field Name Description Default Field? First Away Time The first time that an agent entered the Away state. First Logon Time The first time that an agent logged onto the telephone system. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentsummary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_agentsummary/ Agent Summary # The table below shows which fields are available on the Agent Summary template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Agent Times # Field Name Description Default Field? First Away Time The first time that an agent entered the Away state. First Logon Time The first time that an agent logged onto the telephone system. https://docs-voice.uk.xarios.cloud/en-gb/statistics/stats_filter/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/stats_filter/ All Filter Fields # The table below provides a description of each filter field available on the system and details of which reports they can be used on. Agent Times # Field Name Description Communications Service Availability Reports Agent State The availability state of an agent at a particular time. AllAgent Away Reason Summary, Agent Status Detail Duration The length of time an agent was in a particular state. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/gettingstarted/authentication/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/gettingstarted/authentication/ Authentication Process # Requests to the API are secured via a JWT access token. This token needs to be generated using the OAuth v2 Authorisation Code grant flow. The image below provides an outline of the process involved in generating the required tokens and keeping them alive: Please refer to the links below for detailed technical information and code examples of the Authorisation Code grant flow: Authorisation Code Grant Example Flow To progress with the steps below, you will need: https://docs-voice.uk.xarios.cloud/en-gb/config/reporting/browserconfig/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/reporting/browserconfig/ Browser Configuration # When using the Dashboards or Wallboards within the user portal, certain browsers may require configuration changes to ensure that the tabs they are open on are not put to sleep when inactive or minimised. Google Chrome # Under the 'Settings/Performance' section, ensure that the ~.Dimensions.~ Url is added to the 'Always keep these sites active' list. Microsoft Edge # Under the 'Settings/System and Performance' section, ensure that the ~. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumbercosted/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumbercosted/ Call Cost by Number # The table below shows which fields are available on the Call Cost by Number template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Caller ID Name The name provided by the network provider as being associated with the Caller ID. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumbertypecosted/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumbertypecosted/ Call Cost by Number Type # The table below shows which fields are available on the Call Cost by Number Type template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Number Type The type (Local, National or International) for the Caller ID number. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsratedbyuserrated/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsratedbyuserrated/ Call Cost by User # The table below shows which fields are available on the Call Cost by User template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistlost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistlost/ Call List (Abandoned Calls) # The table below shows which fields are available on the Call List (Abandoned Calls) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistinternal/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistinternal/ Call List (Internal) # The table below shows which fields are available on the Call List (Internal) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistnonsegmented/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistnonsegmented/ Call List (Non-Segmented) # The table below shows which fields are available on the Call List (Non-Segmented) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistqueuecalls/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistqueuecalls/ Call List (Queue Calls) # The table below shows which fields are available on the Call List (Queue Calls) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistnonsegmentedcosted/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistnonsegmentedcosted/ Call List (Rated Calls Non-Segmented) # The table below shows which fields are available on the Call List (Rated Calls Non-Segmented) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistsegmentedcosted/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistsegmentedcosted/ Call List (Rated Calls Segmented) # The table below shows which fields are available on the Call List (Rated Calls Segmented) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistrecorded/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistrecorded/ Call List (Recorded Calls) # The table below shows which fields are available on the Call List (Recorded Calls) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistsegmented/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistsegmented/ Call List (Segmented) # The table below shows which fields are available on the Call List (Segmented) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllisttrunktrunk/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllisttrunktrunk/ Call List (Trunk-Trunk) # The table below shows which fields are available on the Call List (Trunk-Trunk) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistlostunreturnednofilter/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistlostunreturnednofilter/ Call List (Unreturned Abandoned Calls - no filter) # The table below shows which fields are available on the Call List (Unreturned Abandoned Calls - no filter) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistlostunreturned/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistlostunreturned/ Call List (Unreturned Abandoned Calls) # The table below shows which fields are available on the Call List (Unreturned Abandoned Calls) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistrecordedbyusersegmented/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistrecordedbyusersegmented/ Call List (User Recorded Calls) # The table below shows which fields are available on the Call List (User Recorded Calls) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistbyusersegmented/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calllistbyusersegmented/ Call List (User) # The table below shows which fields are available on the Call List (User) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/reports/segmentview/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/reports/segmentview/ Call Session View # When viewing any of the call list reports, an additional call session view can be accessed which provides clear details of each telephone call. A telephone call (session) can involve multiple segments which can in turn involve multiple users/devices on the system (connections). Information Circle info For more information on the difference between call sessions, segments and connections, please refer to the Call Segmentation section. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calltagsummary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_calltagsummary/ Call Tag Summary # The table below shows which fields are available on the Call Tag Summary template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysite/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysite/ Calls by Account # The table below shows which fields are available on the Calls by Account template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyareacode/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyareacode/ Calls by Area Code # The table below shows which fields are available on the Calls by Area Code template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Area Code The area code for the Caller ID number. ✔ Call Rates # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbybillingcode/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbybillingcode/ Calls by Billing Code # The table below shows which fields are available on the Calls by Billing Code template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info Calls grouped by the billing code entered when the call was made. Information Circle info Calls grouped by the billing code entered when the call was made. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbybusinessfunction/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbybusinessfunction/ Calls by Business Area # The table below shows which fields are available on the Calls by Business Area template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbycountry/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbycountry/ Calls by Country # The table below shows which fields are available on the Calls by Country template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info Calls where the country has not been identified will not be displayed on the report. Information Circle info https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyday/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyday/ Calls by Day # The table below shows which fields are available on the Calls by Day template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydayandtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydayandtime/ Calls by Day & Time # The table below shows which fields are available on the Calls by Day & Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydayofweek/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydayofweek/ Calls by Day of Week # The table below shows which fields are available on the Calls by Day of Week template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydayofweekandtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydayofweekandtime/ Calls by Day of Week & Time # The table below shows which fields are available on the Calls by Day of Week & Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyddi/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyddi/ Calls by DDI # The table below shows which fields are available on the Calls by DDI template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? DDI Name The name provided by the communications system as being associated with the Direct Inward Dial number for the call. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyextension/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyextension/ Calls by Device # The table below shows which fields are available on the Calls by Device template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyduration/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyduration/ Calls by Duration # The table below shows which fields are available on the Calls by Duration template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyholdtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyholdtime/ Calls by Hold Time # The table below shows which fields are available on the Calls by Hold Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbylocation/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbylocation/ Calls by Location # The table below shows which fields are available on the Calls by Location template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Location The location for the Caller ID number. ✔ Call Rates # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbymonth/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbymonth/ Calls by Month # The table below shows which fields are available on the Calls by Month template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumber/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumber/ Calls by Number # The table below shows which fields are available on the Calls by Number template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Caller ID Name The name provided by the network provider as being associated with the Caller ID. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumbertype/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbynumbertype/ Calls by Number Type # The table below shows which fields are available on the Calls by Number Type template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Number Type The type (Local, National or International) for the Caller ID number. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyparkedslot/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyparkedslot/ Calls by Parking Slot # The table below shows which fields are available on the Calls by Parking Slot template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbytopic/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbytopic/ Calls by Primary Topic # The table below shows which fields are available on the Calls by Primary Topic template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyqueuename/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyqueuename/ Calls by Queue Name # The table below shows which fields are available on the Calls by Queue Name template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyqueue/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyqueue/ Calls by Queue Number # The table below shows which fields are available on the Calls by Queue Number template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyringtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyringtime/ Calls by Ring Time # The table below shows which fields are available on the Calls by Ring Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysecondarytopics/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysecondarytopics/ Calls by Secondary Topics # The table below shows which fields are available on the Calls by Secondary Topics template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysentimentcustomer/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysentimentcustomer/ Calls by Sentiment (Customer) # The table below shows which fields are available on the Calls by Sentiment (Customer) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysentimentuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysentimentuser/ Calls by Sentiment (User) # The table below shows which fields are available on the Calls by Sentiment (User) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydestinationnumber/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbydestinationnumber/ Calls by Service Number # The table below shows which fields are available on the Calls by Service Number template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? DDI Name/Presentation Name The DDI name or the presentation number name. ✔ DDI/Presentation Number The DDI number or the presentation number. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysilencetime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbysilencetime/ Calls by Silence Time # The table below shows which fields are available on the Calls by Silence Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbystate/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbystate/ Calls by State/Province # The table below shows which fields are available on the Calls by State/Province template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info Calls where the state has not been identified will not be displayed on the report. Information Circle info https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbytalktime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbytalktime/ Calls by Talk Time # The table below shows which fields are available on the Calls by Talk Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbytime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbytime/ Calls by Time # The table below shows which fields are available on the Calls by Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyuser/ Calls by User # The table below shows which fields are available on the Calls by User template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyusergroup/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyusergroup/ Calls by User Group # The table below shows which fields are available on the Calls by User Group template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyvoicemailbox/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyvoicemailbox/ Calls by Voicemail Box # The table below shows which fields are available on the Calls by Voicemail Box template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info This report template is only available on the following communication services: ~.pbx.kazoo.name.~ Call Info (Advanced) # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyweek/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyweek/ Calls by Week # The table below shows which fields are available on the Calls by Week template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callscompletedbyagent/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callscompletedbyagent/ Calls Completed by Agent # The table below shows which fields are available on the Calls Completed by Agent template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callscompletedbyuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callscompletedbyuser/ Calls Completed by User # The table below shows which fields are available on the Calls Completed by User template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/config/usermanagement/clientprofiles/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/usermanagement/clientprofiles/ Client Profiles # Client Profiles are used to control specific features of ~.UcClient.~ clients, allowing them to be restricted from certain users or customised. Default Client Profile # Each account is configured with a System default client profile which is assigned to all users by default. This profile cannot be removed or customised, it exposes all features of the ~.UcClient.~ clients. All new users added to the system without an explicit client profile, will be assigned this one. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/genericsip/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/genericsip/ Generic SIP Phones # Although not automatically provisioned, generic SIP phones can still be used on ~.Dimensions.~, but they will need to be manually provisioned. This applies to both hard phones or third-party softphone solutions. Provisioning Generic SIP Devices # To add a generic SIP device to the ~.Dimensions.~, follow the normal process on the Devices page but select 'SIP' as the manufacturer: A new device will be created with a random MAC address. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorycrmitems/directorycrmitemget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorycrmitems/directorycrmitemget/ Get CRM Item # Gets any directory items matching the supplied filter. GET /v1.0/contactdirectories/{DIRECTORY_ID}/crmitems/{CRM_ID} Example # This request will get specific items from the directory using the crmId. Request # GET <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/crmitems/00000000-0000-0000-0000-000000000001> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 1, "data": [{ "id": "00000000-0000-0000-0000-000000000123", "fields": { "title": "Mr", "fullName": "CRM2", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } } ][{ "id": "00000000-0000-0000-0000-000000000123", "fields": { "title": "Mr", "fullName": "CRM2", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } } ], "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemget/ Get Item # Gets a specific directory item. GET /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID} Example # This request will get a specific item from a directory us its id. Request # GET <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 1, "data": [{ "id": "00000000-0000-0000-0000-000000000123", "fields": { "title": "Mr", "fullName": "CRM2", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } } ][{ "id": "00000000-0000-0000-0000-000000000123", "fields": { "title": "Mr", "fullName": "CRM2", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } } ], "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemsget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemsget/ Get Items # Gets any directory items matching the supplied filter. GET /v1.0/contactdirectories/{DIRECTORY_ID}/items?filter={FILTER}&fields={FIELDS} Hand Left warning Remember to URL Encode any parameters being passed in the 'filter' parameter. Document note When searching on 'phoneX' fields, the numbers are stored in E.164 format. Example # This request will query all items with a phone field containing +44XXXXXXXXXX Color Wand tip https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportstatusget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportstatusget/ Get Status # This request accepts a report 'requestId' and returns the status of the request. GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID} Example - In Progress Request # This request returns the status of a report request that is still running. Request # GET <https://api.uk.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/results/00000000-0000-0000-0000-000000000005> HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "dateCreated": "2025-09-22T15:27:40.1946146Z", "tenantId": "f8322e65-ddac-4f5c-1f6c-08db2fa7b464", "requestId": "65224fa5-f4c6-4796-b3c8-c4f67d504971", "reportId": "2aafb829-91aa-4d17-a5d3-bb6fde34ca10", "status": "Complete", "statusMessage": "Report processing complete", "reportTemplateName": "CallListByUserSegmented" }, "status": "success", "timestamp": "2019-05-01T10:00:00. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_incomingcallsbyroutepathname/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_incomingcallsbyroutepathname/ Incoming Calls by Route Path Name # The table below shows which fields are available on the Incoming Calls by Route Path Name template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info This report template is only available on the following communication services: ~.pbx.kazoo.name.~, Teams Call Info # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_incomingcallsbyroutepathnumber/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_incomingcallsbyroutepathnumber/ Incoming Calls by Route Path Number # The table below shows which fields are available on the Incoming Calls by Route Path Number template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info This report template is only available on the following communication services: ~.pbx.kazoo.name.~, Teams Call Info # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/config/ci/keywords/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/ci/keywords/ Keywords # The Keywords feature provides a way to search for specific words or phrases within transcribed conversations. This can be useful fo: Checking that users answer calls with the correct greeting Ensuring that specific information is collected during the call (e.g. customer name, reason for call) Monitoring for specific phrases that may indicate a positive or negative customer experience (e.g. 'thank you', 'cancel my subscription') Identifying calls that may require follow-up (e. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyoutgoingname/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyoutgoingname/ Outgoing Calls by Caller Id Name # The table below shows which fields are available on the Outgoing Calls by Caller Id Name template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Outgoing Caller ID The telephone number presented on an outgoing call. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyoutgoingnumber/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_callsbyoutgoingnumber/ Outgoing Calls By Caller Id Number # The table below shows which fields are available on the Outgoing Calls By Caller Id Number template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Outgoing Caller ID The telephone number presented on an outgoing call. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queuecallsbyday/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queuecallsbyday/ Queue Calls by Day # The table below shows which fields are available on the Queue Calls by Day template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queuecallsbydayandtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queuecallsbydayandtime/ Queue Calls by Day & Time # The table below shows which fields are available on the Queue Calls by Day & Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queuecallsbytime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queuecallsbytime/ Queue Calls by Time # The table below shows which fields are available on the Queue Calls by Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queueperformance/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_queueperformance/ Queue Performance # The table below shows which fields are available on the Queue Performance template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/config/reporting/clients/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/reporting/clients/ Real-Time Clients # The real-time clients area of the solution provides administrators with a way to manage any real-time client connections that have been configured by users of the system. These clients include: Amazon FireTV Wallboard The reporting clients area displays a list of client connections along with information on current status and who configured the connection. Information Circle info This area of the portal may not be available if your user account does not have permission to access it. https://docs-voice.uk.xarios.cloud/en-gb/config/contactdirectories/routing/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/contactdirectories/routing/ Routing Contacts # ~.Dimensions.~ provides a contact directory webhook lookup which can be used as part of the communication platform's routing strategy to bypass the normal routing and send a call to a contact specific destination. URL Parameters # Parameters Description ~.pbx.kazoo.name.~ 3CX tenantID The unique id for your customer instance. In the portal, click on your user icon and select 'Diagnostic Info' to view your tenantId. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbysite/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbysite/ Service Level by Account # The table below shows which fields are available on the Service Level by Account template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbyday/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbyday/ Service Level by Day # The table below shows which fields are available on the Service Level by Day template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbydayandtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbydayandtime/ Service Level by Day & Time # The table below shows which fields are available on the Service Level by Day & Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbytime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_servicelevelbytime/ Service Level by Time # The table below shows which fields are available on the Service Level by Time template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Rates # Field Name Description Default Field? All Calls Rate The call rate for the period of the report for the total number of calls (external calls only). https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callanalytics/summarizeddata/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callanalytics/summarizeddata/ Summarised & Aggregated Data # This section reviews how call data is aggregated/summarised when viewing reports based on segmented/non-segmented data. Aggregation The combining of the data from multiple call segments into a single call session to view the call as a whole rather than individual segments. This is done on Non-Segmented call lists and allows the user to view a call as a whole rather than the multiple call segments that may be involved. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/calltagging/3CX/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/calltagging/3CX/ Tagging calls with Call Flow # Calls can be tagged directly from 3CX Call Flows, allowing calls to be tagged with categories (Sales, Support...) or flags (VIP...) as they route through the communications platform. On 3CX, you can also prompt incoming callers for information (Ticket Numbers, Case References..) and add this information to the call data for future reference. To tag a call from a call flow: Download the Dimensions Call Tag component. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscalllistnonsegmented/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscalllistnonsegmented/ Teams Call List # The table below shows which fields are available on the Teams Call List template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info This report template is only available on the following communication services: Teams Call Info # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscalllistbyusersegmented/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscalllistbyusersegmented/ Teams Call List (User) # The table below shows which fields are available on the Teams Call List (User) template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Abandoned An incoming call that was not answered by an device/agent/user or relevant Mailbox/Voicemail. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscallsbyexternaltenant/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscallsbyexternaltenant/ Teams Calls by External Tenant # The table below shows which fields are available on the Teams Calls by External Tenant template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Information Circle info This report template is only available on the following communication services: Teams Call Info (Advanced) # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscallsbyconference/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscallsbyconference/ Teams Calls by Meeting # The table below shows which fields are available on the Teams Calls by Meeting template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscallsbyuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_teamscallsbyuser/ Teams Calls by User # The table below shows which fields are available on the Teams Calls by User template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info (Advanced) # Field Name Description Default Field? Account ID The ID of the communication system being monitored. Account Name The name of the communication system being monitored. https://docs-voice.uk.xarios.cloud/en-gb/realtime/rttiles/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/rttiles/ Tile Types # The following table shows the types of tile that are available, what sort of data they can display and which licence they are supported on. Tile Type Data Limits Filtering Dashboard Wallboard Licence Single Stat - Aggregated (Totals/Averages/Percentages) - Minimum/Maximum Values - Manual Text N/A ✔1 ✔ ✔ - Insights - Analytics - Live Analytics - Contact Centre Circular Gauge - Aggregated (Totals/Averages/Percentages) https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_topdiallednumbers/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_topdiallednumbers/ Top Dialed Numbers # The table below shows which fields are available on the Top Dialed Numbers template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Caller ID Name The name provided by the network provider as being associated with the Caller ID. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_topreceivednumbers/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_topreceivednumbers/ Top Received Numbers # The table below shows which fields are available on the Top Received Numbers template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Info # Field Name Description Default Field? Caller ID Name The name provided by the network provider as being associated with the Caller ID. https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_trunkusage/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/templates/stats_trunkusage/ Trunk Usage # The table below shows which fields are available on the Trunk Usage template Information Circle info Fields with a tick in the 'Default Field' column are automatically added to a report when using this template. Call Times # Field Name Description Default Field? Start Time The time the call or call segment started ringing. ✔ Trunk Usage # Field Name Description Default Field? https://docs-voice.uk.xarios.cloud/en-gb/config/integration/webhooks/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/webhooks/ Webhooks # Post call webhooks provide information about each call that completed on the system. This information can be used to update external systems or start work-flow automations, using products like Azure Logic Apps or Zapier. Example use cases: Add a call history event against a CRM record Add call recording playback details to a CRM record Record successful Dispositions in a CRM Track customer complaints in an external system Information Circle info https://docs-voice.uk.xarios.cloud/en-gb/realtime/drilldown/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/drilldown/ Click-Through to Reports # When viewing Dashboard statistics, it can be useful to see the source data that the statistic is calculated from. For example, seeing which calls were lost or looking at why the service level has dropped. This is where 'Click-Through' comes in. Any tile which is built using completed call data supports clicking directly through from the tile to a report which displays the data used for the tile. https://docs-voice.uk.xarios.cloud/en-gb/reports/charts/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/reports/charts/ Chart View # The chart view is an extension of the reporter viewer. It provides a chart based view of the currently open report. The view switch can be used to toggle the report between grid or chart view: Information Circle info Currently the fields on the chart view are fixed and cannot be edited by the user. Full configuration of charts will be available in upcoming product releases. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorycrmitems/directorycrmitempost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorycrmitems/directorycrmitempost/ Create CRM Item # Creates a new directory item in the supplied directory. POST /v1.0/contactdirectories/{DIRECTORY_ID}/crmitems Example # This request will create a new directory item. Request # POST <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/crmitems> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive { "fields": { "title": "Mr", "fullName": "CRM3a", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } } Response # HTTP/1. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitempost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitempost/ Create Item # Creates a new directory item in the supplied directory. POST /v1.0/contactdirectories/{DIRECTORY_ID}/items Example # This request will create a new directory item. Request # POST <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive { "fields": { "title": "Mr", "fullName": "CRM3a", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } } Response # HTTP/1. https://docs-voice.uk.xarios.cloud/en-gb/statistics/stats_realtime/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/statistics/stats_realtime/ Dashboard/Wallboard Fields # The table below shows which fields are available in each of the dashboard/wallboard tiles. Agent Status # While the stats below may be listed as working on a specific Tile/Grid, visibility of 'Agent/User/Queue Status' stats are also restricted by customer license level and user roles. Field Name Communications Service Tiles Grids Charts Singe / Multi / Dual Stat Cycling / Ticker Circular Gauge Unreturned Call User Agent Queue Over Time Agents in Away state All ✔ ✔ ✔ Agents Busy on ACD calls All ✔ ✔ ✔ Agents Busy on Non ACD calls All ✔ ✔ ✔ Agents Logged on All ✔ ✔ ✔ Agents in Ready state All ✔ ✔ ✔ Agents in Wrap state All ✔ ✔ ✔ Queues All ✔ Time On Duty All ✔ Time In Status All ✔ Queue Names Logged In All ✔ Queue Numbers Logged In All ✔ Queue Names Member Of All ✔ Queue Numbers Member Of All ✔ Active Calls # While the stats below may be listed as working on a specific Tile/Grid, visibility of 'Active Call' stats are also restricted by customer license level and user roles. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/keymaps/devicesoftkeys/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/keymaps/devicesoftkeys/ Device Softkeys # Each supported device can be provided with a keymap during provisioning. Each key provided to the phone will override any keys that have been manually configured on the phone itself. Key Type Description (Default) Not configured, any key configured locally on the phone will not be overridden. ACD Login This key can be used to login and out of ACD queues. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/dispositions/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/dispositions/ Dispositions # Dispositions are effectively call results, they are used to provide details of the success or failure of each call. Dispositions work in a similar way to Call Tags, but are enforced. this means that for each disposition rule created, an accompanying filter is required to control which calls the disposition should be applied to. Information Circle info Dispositions are available with an 'Analytics' customer licence. Details on how to configuration dispositions can be found here. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportresultget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/workspaces/reports/reportresultget/ Get Results # This request accepts a report 'requestId' and returns the results of the report if complete. GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID}/data Example # This request returns the result data of a report request that is complete. Request # GET <https://api.uk.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/results/00000000-0000-0000-0000-000000000005/data> HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "requestId": "00000000-0000-0000-0000-000000000005", "tenantId": "00000000-0000-0000-0000-000000000000", "request": { "requestId": "00000000-0000-0000-0000-000000000005", "dateCreated": "2025-09-22T15:27:40.1946146Z", "tenantId": "00000000-0000-0000-0000-000000000000", "reportId": "00000000-0000-0000-0000-000000000001", "reportTemplateName": "CallListByUserSegmented", "filterConditions": \[ { "fieldName": "start", "operator": ">=", "values": ["2025-01-01T00:00:00. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/grandstream/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/grandstream/ Grandstream Phones # ~.Dimensions.~ integrates directly with the Grandstream GDMS service. Any new Grandstream phones added to ~.Dimensions.~ will automatically provision. If adding a phone which has been used previously on another platform, it may need to be reset using the instructions below. Information Circle info Some V1 Grandstream devices are not supported on GDMS and will need to be pointed at ~.Dimensions.~ manually. https://docs-voice.uk.xarios.cloud/en-gb/realtime/rtmodel/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/rtmodel/ Modelling by Session/Segment # Each telephone call consists of a single 'Call Session' and one or more 'Call Segments', as the call is transferred or diverted between different users/devices within the communications platform. Each tile displaying call analytics data can be configured to one of two modelling modes; 'Model by Call Session' or 'Model by Call Segment'. Document note Call Sessions and Call Segments are defined in the Call Segmentation area of the documentation. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemput/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemput/ Replace Item # Replaces and existing directory item. PUT /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID} Example # This request will update an existing directory item. Request # PUT <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive { "fields": { "title": "Mr", "fullName": "CRM3a", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } } Response # HTTP/1.1 201 Created Content-Type: application/json; charset=utf-8 Content-Length: xx Location: <https://api. https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2020/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2020/ Archived Release Notes # 2020 Releases # 1.56.0 - Dec 21st, 2020 # Reports Call Direction now a filter on Calls by User reports. Modelling now able to identify calls to fax machine. Wallboard Wallboard will dynamically refresh on configuration changes in another browser. Issue resolved where config updates could cause inconsistent agent numbers. RoutePath information now updated when call hits a user, not just end of call. https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2021/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2021/ Archived Release Notes # 2021 Releases # 1.72.0 - Dec 7th, 2021 # Handset Provisioning Support for auto-provisioning of Mitel 68xx phones New wallpaper & screen savers are now provided to auto-provisioned phones Support for older Yealink devices that don't support HTTPS Handset Keymap Softkey Features The following softkey updates have been implemented: ACD login toggle ACD state toggle DND softkeys are now user-based instead of device-based FWD softkeys are now user-based instead of device-based Pull -> Allows users to move active calls between their phones Pickup -> Allows users to pickup ringing calls on other phones Remote forward (inc user password configuration) -> Control the forward destination of another phone ~. https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2022/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2022/ Archived Release Notes # 2022 Releases # 1.81.0 - Nov 8th, 2022 # Dimensions Voice Fixes Restrict the number of BLFs on 53xx phones to 20 (Ticket #49864) Show assigned name on Phone Only devices Reporting Features Allow ring duration interval to be configured for 'Calls By Ring Time' report Fixes Call tagging reports failed to run within a schedule (Ticket #49817) ~. https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2023/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2023/ Archived Release Notes # 2023 Releases # 1.89.0 - December 12th, 2023 # Features Area Description Customer Portal Improved filtering - Pick lists added for users, groups etcLocalisation Update - French & Spanish Dashboard Click through support from tiles to reportsAway state control, supervisor support for non-PBX usersSupervisor agent control now requires the new 'Supervisor Agent Control' roleAlarms - Native browser notification supportActive call stats and primary user groups now available on User/agent grids Reporting Number of ring duration thresholds increased from 6 to 12CRM linked tag data now shows as URLs in the Call Session view ~. https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2024/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/about/releasenotes2024/ Archived Release Notes # 2024 Releases # 1.96.0 - November 26th, 2024 # Features Area Description Portal New 'Dispositions' feature Reporting Call Tags - Post call tagging now availableCall Tags - Disable tag instance now available Provisioning ~.pbx.kazoo.name.~ - Re-apply configurations to a device on save.~.pbx.kazoo.name.~ - SIP registration status exposed~.pbx.kazoo.name.~ - Ability to disabled device~.pbx.kazoo.name.~ - Reboot device option~. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callanalytics/concepts/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callanalytics/concepts/ Call Concepts # The following concepts apply to call analytics and have an effect on how call data can be analysed. It is important to understand these concepts to help with configuration and to ensure the system is used to its full potential. Glossary # The following table outlines terms used in the context of communications platforms and analytics. Name Description Account A communication server/PBX instance ACD Automatic Call Distribution, a way of distributing incoming calls to agents Agent A user that can log in to receive calls from Queues that provide ACD features Call A telephone call between two or more parties. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/directories/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/directories/ Contact Directories # ~.Dimensions.~ provides a contact database feature which allow customer or CRM records to added. These contacts can then be used throughout the solution to provide the following features: For information on how to configure a contact directory, refer to the Settings section. Reports # Contact information is saved alongside call information and can be used treated as other call information when running reports. Contact fields can be added to call list reports to provide additional information. https://docs-voice.uk.xarios.cloud/en-gb/filters/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/filters/ Filters # Filtering is used throughout the system to enable users to find specific calls or groups of calls. The system stores different types of information about each call which can be used to identify it. This information can then be used in saved and quick filters to ensure that reports and wallboards show the data required. Filters can be edited/created in the Filters section of the website. To create a new filter, click the 'Create Filter' button in the top-right of the screen. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/mitel53xx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/mitel53xx/ Mitel 53xx Phones # Mitel 53xx phones are supplied in MiNET mode by default and need to be defaulted and switched to SIP mode before they can be used on ~.Dimensions.~. Document note Ensure that all phones have been added to ~.Dimensions.~ before setting them up in SIP mode. SIP Mode # The handset needs to be factory defaulted, and then changed into SIP mode by holding *7 at boot until the display confirms SIP mode has been enabled. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitempatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitempatch/ Patch Item # Updates a specific set of properties of a directory item. This uses the JSON Patch format for any changes. PATCH /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID} Example # This request will add anew phone field to an existing directory item. Request # PATCH <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1 Content-Type: application/json accept-charges: true Authorisation: Bearer {TOKEN} Connection: keep-alive { "path": "/fields/phone2", "op": "add", "value": "+44YYYYYYYYYY" } Response # HTTP/1.1 201 Created Content-Type: application/json; charset=utf-8 Content-Length: xx Location: <https://api. https://docs-voice.uk.xarios.cloud/en-gb/reports/templates/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/reports/templates/ Report Templates # The system provides a series of report templates that can be used to create and run reports. The choice of template defines the following report attributes: Call Data Type -> Which type of call data is reported on, Session, Segment or Connection Fields -> What fields are available to select by the user Grouping -> How the data should be grouped and summarised (if at all). https://docs-voice.uk.xarios.cloud/en-gb/realtime/rtalarms/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/rtalarms/ Tile Alarms # Tile alarms provide a way to bring attention to aspects of the telephone system that are running outside of acceptable parameters. Each tile on the system can have one or more real-time alarms configured. To add an alarm, navigate to the 'Alarms' tab while editing a tile, then press the 'New Alarm' button. Once the alarm properties have been configured, remember to save the tile as well as the newly added alarm. https://docs-voice.uk.xarios.cloud/en-gb/config/calltags/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/calltags/ Call Tags # Call tagging is a flexible feature designed to allow custom information to be added to call records, giving them context outside the communications platform and improving call reports. This section provides information on the call tag configuration options. For information on how call tags can be used, refer here. Creating Call Tags # Call tags can be managed from the 'Settings' area of the portal. Any user with the 'Manage Customer Settings' permission can add or edit tags. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorycrmitems/directorycrmitemdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directorycrmitems/directorycrmitemdelete/ Delete CRM Item # Deletes an existing item from a directory. Request # DELETE /v1.0/contactdirectories/{DIRECTORY_ID}/crmitems/{CRM_ID} Example # This request will delete the specific item within the directory. Request # DELETE <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/crmitems/00000000-0000-0000-0000-000000000001> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "00000000-0000-0000-0000-000000000123", "fields": { "title": "Mr", "fullName": "CRM3a", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/integration/api/reference/directories/directoryitems/directoryitemdelete/ Delete Item # Deletes an existing item from a directory. Request # DELETE /v1.0/contactdirectories/{DIRECTORY_ID}/items/{DIRECTORY_ITEM_ID} Example # This request will delete the specific item within the directory. Request # DELETE <https://api.uk.myreports.cloud/api/v1.0/contactdirectories/00000000-0000-0000-0000-000000000000/items/00000000-0000-0000-0000-000000000123> HTTP/1.1 Authorisation: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "00000000-0000-0000-0000-000000000123", "fields": { "title": "Mr", "fullName": "CRM3a", "companyName": "Company", "jobTitle": "Job Title", "phone1": "+44XXXXXXXXXX", "email": "Email Address", "field1": "field1", "field2": "field2", "crmId": "00000000-0000-0000-0000-000000000001" } }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/en-gb/reports/powerbi/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/reports/powerbi/ Microsoft Power BI Integration (Preview) # Report outputs can be accessed directly via Microsoft Power BI using the REST API. This allows for communications reporting to be combined with other data sources using the Power BI platform. Information Circle info To access reports via Power BI, the REST API must be enabled on the reseller and customer accounts. Please refer to the API Documentation for more information. Hand Left warning https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/mitel68xx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/mitel68xx/ Mitel 68xx Phones # Mitel 68xx need to be running in SIP mode in order to connect to ~.Dimensions.~. To connect a phone which is currently running a MiNET firmware, update to a SIP firmware before attempting provisioning. Automatic Provisioning # After a factory default, 68xx phones will follow the auto-provisioning process just once. In order for automatic provisioning to work, ensure that the phone has been added to ~. https://docs-voice.uk.xarios.cloud/en-gb/schedules/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/schedules/ Schedules # Schedules provide an easy way for users to have access to data when they need it, without having to log in and manually run reports. Each schedule created can run multiple reports, each with different date range and filter options. When the schedule runs, links to the reports are sent to the specified users, allowing them to view the output without having to wait for the reports to run. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/clients/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/clients/ ~.UcClient.~ Clients # ~.UcClient.~ clients provide users with access to control over their phone, including access to call history, voicemail, contacts and where available softphone features. Document note Access to ~.UcClient.~ clients is licence controlled. If there is no reference to client permissions in the portal, access to ~.UcClient.~ clients are not enabled. Client Types # The table below outlines the different ~.UcClient.~ clients which are available, a brief description and a link to the client's dedicated documentation: https://docs-voice.uk.xarios.cloud/en-gb/realtime/personal/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/personal/ Personal Dashboard # The Personal Dashboard is a cut-down version of a full dashboard that is designed to be used by individual users. It provides details about the user's own performance and allows them to track their progress against KPIs. One or more Personal Dashboard views can be configured within a Workspace, allowing different users to access different configurations if required. If you have permission to manage them, you will see the Personal Dashboards option within the Workspace menu along with Dashboards, Filters etc. https://docs-voice.uk.xarios.cloud/en-gb/config/dispositions/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/dispositions/ Dispositions # Dispositions is feature designed require certain types of calls to be given call results. These 'Dispositions' (or lack of) can then be reported on through the reporting and dashboard/wallboard features. This section provides information on how dispositions work and how they are configured. How Dispositions Work # Dispositions work in a similar way to call tag lists, but instead of being optional, they are required. Each disposition instance created requires a filter to be provided. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/poly/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/poly/ Poly Phones # New Poly phones should automatically provision if they have been added to ~.Dimensions.~. If adding a phone which has been used on another platform, it may need to be reset using the instructions below. Defaulting a Poly Phone - Password Known # If you know a phone's admin password, you can reset the phone to factory defaults through the on screen menus. Press the 'Menu/Home' Key Select 'Settings' Select 'Advanced' from the menu and enter the admin password for the phone Select 'Administration Settings' Select 'Reset to Defaults' Select 'Reset to Factory' Select 'Yes for Are you Sure' Once these steps have been completed, the phone should reboot, allowing the normal automatic provisioning process to be followed. https://docs-voice.uk.xarios.cloud/en-gb/realtime/firetv/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/realtime/firetv/ Wallboard for Amazon FireTV # The Wallboard for Amazon FireTV is an application designed to display wallboards on a large screen TV. The application is designed to be easy to configure and maintain. To operate, the application needs to be linked to a user account. Once linked, the application can render any wallboard from any workspace that the linked user has access to. FireTV Wallboard Setup # The following section outlines how to setup the Wallboard application for Amazon Fire TV. https://docs-voice.uk.xarios.cloud/en-gb/config/workspaces/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/workspaces/ Workspaces # This section provides access to manage the different workspaces that have been created for users. Workspaces provide environments for users to create and share reports with other users of the system. Document note Access to create additional Workspaces is controlled by your licence level. For information about specific features, please refer to the Workspaces section of the documentation. https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/yealink/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/config/phonemanagement/devices/hardware/yealink/ Yealink Phones # ~.Dimensions.~ integrates directly with the Yealink RPS service. Any new Yealink phones added to ~.Dimensions.~ will automatically provision. If adding a phone which has been used previously on another platform, it may need to be reset using the instructions below. Defaulting a Yealink Phone # Yealink phones are straight forward to default to factory settings. With the phone powered on and fully booted, hold down the centre of the cursor control on the keypad until the factory reset message appears. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callrecording/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/callrecording/ Call Recording # If it has been enabled against your account, ~.Dimensions.~ can provide access for users to playback telephone calls. Access to call recordings is directly through the reporting interface using the Call Session click through feature. Which Calls Are Recorded? # ~.Dimensions.~ can record all calls by default or it can be managed on a user or device basis. The image below shows the flow used when deciding if a call should be recorded. https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/pbxtypes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/en-gb/gettingstarted/pbxtypes/ Platform Types # The feature matrix below highlights the differences in the features available on each platform type ~.Dimensions.~ supports: Type Live Call Data Call Recording Playback Reporting Limitations User Interaction ~.pbx.kazoo.name.~ ✔ ✔ No Limitations All Interactions Supported Microsoft Teams ✘ ✔ No Ring/Hold Time ReportingNo Transfer ReportingNo Voicemail Reporting No Interactions Supported Information Circle info