https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/ Recent content in ~.Dimensions.~ Reseller Portal on Reseller Portal Hugo -- gohugo.io https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/gettingstarted/authentication/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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 Authorization 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 Authorization Code grant flow: Authorization Code Grant Example Flow To progress with the steps below, you will need: https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/avaya/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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/reseller-portal/en-us/customers/voice/callflows/callflowactions/basic/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/basic/ # Play Media - plays an audio file as part of the callflow. See Play Media. Ring Group - connects the call to a ring group, prompting multiple phones to ring until one phone answers. The ring group settings enable you to name the group, specify if the phones should ring all at once or in order, establish ringback settings, timeouts, and so on. See Groups. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/billing/billinghistory/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/billing/billinghistory/ Billing History # Invoices and billing data for each month are available in this section of the enterprise portal. Billing entries for each period are listed with the following details: Item Description Period The date that the billing period relates to. Invoice Number The unique invoice number. Type The type of invoice; Periodic or Ad hoc Downloads Links to download the Invoice PDF and Invoice Data Example Invoice Types # There are two types of invoice that will appear in the billing history section: https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/contactdirectories/contacts/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/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 withing 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/reseller-portal/en-us/customers/conversationalintelligence/customdictionary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/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/reseller-portal/en-us/customers/voice/smartpbx/dashboard/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/dashboard/ SmartPBX Dashboard # Below is an overview of what the SmartPBX dashboard is showing about your account configuration. Dashboard # Header Information # This information provides quick access to some of the main features of your account. The top left displays the account name you are viewing and is read-only. The tabs to the right are clickable and provide access to the following settings: Account Default Caller ID Number # Here you can set what number is used as the default Caller ID for outbound calls from the account. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/faxes/faxes_overview/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/faxes/faxes_overview/ Faxes Overview # Use the Fax Manager app to view details of all inbound and outbound faxes on any faxbox in your account. Document note You can set up faxboxes in the Callflows application - Fax Boxes. Users can view their individual fax log in the User Portal. Key Features Review inbound and outbound faxes Check email-to-fax logs Retrieve stored faxes Access Fax Manager Log in to Hosted PBX. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportsgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/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 Authorization: Bearer {TOKEN} tenant-id: {TENANT_ID} Response # HTTP/1. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/workspacesgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/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 Authorization: Bearer {TOKEN} tenant-id: {TENANT_ID} Response # HTTP/1. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/crm/hubspot/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/crm/hubspot/ HubSpot # The HubSpot server-side integration connects ~.Dimensions.~ directly to a customer's HubSpot CRM, enabling automatic contact lookup on calls and pushing call activity data into HubSpot without any browser add-on required for end users. Once configured, ~.Dimensions.~ will: Automatically look up the caller's phone number against HubSpot contacts when a call is received or made Create a call activity record in HubSpot when a call completes, populated with the call details Push transcriptions and follow-up tasks to HubSpot where Conversational Intelligence is enabled Prerequisites # Before configuring the integration, ensure the following are in place: https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/overview/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/overview/ Overview # Customer support agents and managers can use the call center app to create different call queues that define how calls are routed when a customer calls in. Key Features Queue setup | Queue routing | Manage agents | Queue manager Access Call Center Log in to Hosted PBX. Select Call Center from the Your Apps page. Document note If you can't see Call Center in "Your Apps", go to the App Exchange and select it from all applications. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/users/customerusergroups/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/users/customerusergroups/ Customer 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/reseller-portal/en-us/customers/voice/callflows/callflowactions/advanced/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/advanced/ Setting up an advanced callflow # Device - connects the caller to a specific device See Device. Distinctive Ring - if distinctive ringtones are configured for internal and external calls, see Internal and External Ringtone, then this action enables you to put an alert in the callflow to identify the appropriate ringtone. Callflow - transfers this callflow to another callflow. This is useful for building complicated callflows, or creating a loop. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/agents/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/agents/ Agents # Using the Call Center app, agents can log in and out of their queue, mark themselves ready to take calls, and provide call resolution reasons to record call queue activity. Managers have some additional options, see Managers. Agent status Your status displays at the top right of your screen. This status setting is a global setting and applies to all queues. You can also set your default answering device here. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/storage/aws/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/storage/aws/ Amazon Web Services Storage # The following documentation outlines how to setup an AWS S3 bucket in storage area of ~.Dimensions.~. Required Information The following information from you S3 bucket are required when adding as a storage configuration: BUCKET REGION1 KEY KEYSECRET Alongside the information above, a Storage Name needs to be provided. This is how the storage will be referenced within ~.Dimensions.~. Once this information has been entered into a ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/billing/billingdatajson/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/billing/billingdatajson/ Billing Data JSON # The information below provides details of the JSON data provided when downloading the data for a specific invoice. The JSON data provides the most granular level of information, including entries for each user license used and summary entries providing information on invoice totals and applicable taxes. Invoice Details Schema # The main JSON entry provides details about the invoice number, period and date. It also contains an array of the individual invoice items which relate to each license being invoiced for. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/businessareas/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/businessareas/ Business Areas # The business areas section provides a way to categorize and organize 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 behavior. The descriptions entered against each business area are used within the AI prompts to provide context on the type of interactions that should be categorized within each business area, so it is important to ensure they are descriptive and accurate. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/phonesystems/customercarrier/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/phonesystems/customercarrier/ Carrier Strategy # In order to make and receive external calls, each ~.Dimensions.~ customer must have a carrier strategy configured. Carrier # Depending on requirements, customers can be configured to use one of the following carrier types: ~.Dimensions.~ Reseller Customer specific The options available to configure will be different depending on the services that have been available to you. For information on using ~.Dimensions.~ or configuring a custom carrier specifically for a customer, please contact ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/charges/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/charges/ Charges # When a request is made via the API that may incur any additional charges, this will return with a HTTP status response of: 402 Payment Required The request will not have been actioned. In order to action this an identical request should be made with an additional header value of: accept-charges: true Example # This request will attempt to create a new Customer with the following details without accepting charges: https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/cisco/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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/reseller-portal/en-us/customers/users/customerclientprofiles/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/users/customerclientprofiles/ Client Profiles # Client Profiles are used to control specific features of ~.UcClient.~ clients, allowing them to be restricted from certain users or customized. 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 customized, 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/reseller-portal/en-us/gettingstarted/clients/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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 license controlled. If there is no reference to client permissions in the customer 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/reseller-portal/en-us/phones/keymaps/devicesoftkeys/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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 The is key can be used to login and out of ACD queues. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/faxes/faxes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/faxes/faxes/ Fax History and Storage # In the Fax Manager app, you can review inbound and outbound fax history and the stored attachments. Viewing Inbound Faxes From the Inbound Faxes page, you can review a list of all inbound faxes received to a specific faxbox. From the drop-down menu, select the faxbox that you want to view. Filter your results by date if required. You can review the following details: Received - date the fax was received From - number that the fax was sent from Receiving Faxbox - name of the receiving faxbox Receiving number - number that received the fax Pages - number of pages received Viewing Outbound Faxes From the Outbound Faxes page, you can review a list of all outbound faxes sent from a specific faxbox. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/featurecodes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/featurecodes/ Setting Up Features From Your Device # From the Feature Codes tab, you can find the short codes for the various features available on your VoIP phone. Go to 'Smart PBX > Feature Codes'. Use the short codes to access and manage the features directly from your phone. Document note The following features are available by default. You cannot disable any of the features. Administrators can configure the shortcode for all features in 'Callflows > Feature Codes', see Callflows for more information. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetall/ Get All (Invoices) # Gets a list of all invoices. Once a list of all invoices has been retrieved, specific details about invoices can be retrieved using Get Invoice, Get Invoice Detail or Get Invoice Summary. GET /v1.0/billingdata Example # This request will get a list of all invoices. Request # GET /api/v1.0/billingdata HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 4, "data": [{ "tenantId":"{RESELLER_TENANT_ID}", "invoiceid":"{INVOICE_ID}", "invoiceNumber":"{INVOICE_NUMBER}", "customerName":"Reseller 1", "billingPeriodStart":"2020-01-01T00:00:00. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersgetall/ Get All (Customers) # Gets all Customers for a Reseller GET /v1.0/customers?pageIndex={pageIndex}&pageSize={pageSize}&filter={filter} Parameters Description pageIndex 0 based index to allow querying of pages pageSize Page size to be returned by the request. Max 1,000 filter Optional filter parameter to search for customers by 'name' and 'reference' fields. A 'Contains' search is performed on any string provided. Color Wand tip https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetall/ Get All (PBX) # Gets all PbxConnectionProfiles for a Customer tenant. GET /v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs Example # This request will get all the PbxConnectionProfile of the given Customer tenant. Request # GET https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 2, "data": [{ "id": "{PBX_ID_1}", "name": "Pbx 1", "_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" }, { "id": "{PBX_ID_2}", "name": "Pbx 2", "_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" } ], "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/profiles/profilesgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/profiles/profilesgetall/ Get All (Tenant Profile) # Gets all Tenant Profiles available on your Reseller Account. GET /v1.0/customers/{CUSTOMER_TENANT_ID}/tenantprofiles Example # This request will get all the tenant profiles. Request # GET https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/tenantprofiles HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 4, "data": [ { "id": "TenantProfileType_clientonly", "name": "ClientOnly", "description": "This is the Client Only profile" }, { "id": "TenantProfileType_insights", "name": "Insights", "description": "This is the Insights profile" }, { "id": "TenantProfileType_analytics", "name": "Analytics", "description": "This is the Analytics profile" } ], "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersgetall/ Get All (Users) # Gets all Users for a Customer tenant. GET /v1.0/customers/{CUSTOMER_TENANT_ID}/users Example # This request will get all the Users of the given Customer tenant. Request # GET https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "page_size": 2, "data": [{ "id": "{USER_ID_1}", "displayName": "User 1", "email": "user1@example.com", "primaryTenant": "{CUSTOMER_TENANT_ID}", "isParent": false }, { "id": "{USER_ID_2}", "displayName": "User 2", "email": "user2@example. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/contactdirectories/import/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/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 import 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/reseller-portal/en-us/customers/voice/smartpbx/numbers/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/numbers/ Numbers # From the Numbers tab, you can view the pool of numbers that are associated with your account. You can see numbers that are in use and also access a list of spare numbers. Viewing Numbers In Use Go to Smart PBX > Numbers Under Numbers in Use, you can view where your numbers are used and see a list of numbers for your sub-accounts. The table indicates if the number is local or international. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportrequest/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/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} tenant-id: {TENANT_ID} Connection: keep-alive { "reportId": "00000000-0000-0000-0000-000000000001", "dateFilter": { "presetName": "ThisQuarter" } } Information Circle info https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/gettingstarted/postman/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/gettingstarted/postman/ Postman # To help with getting authenticated and using the API, a Postman Collection it available to download. Generating Started with Postman # Follow the steps below to get start with the ~.Dimensions.~ API using Postman. Download and import the collection and environment files into Postman. Configure the Environment Variables with the values from the Rest API section of the portal: OAUTH-CLIENTID OAUTH-CLIENTSECRET Within the collection, use one of the available authentication flows to obtain a token: Authorization Code Flow: Requires user interaction to log in and obtain a token. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/provisioning/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/provisioning/ Provisioning # There are 2 ways to provision customer accounts or manage existing ones, through the 'Customers' interface of the Reseller Portal or through the provisioning API. This section of the documentation outlines how to provision customers through the Reseller Portal. For more information on using the API for provisioning, please refer to the API documentation. Creating a New Customer # A new customer account can be created by clicking the '+ Create New Customer' button in the top right of the page. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/releasenotes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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.111.0 Releases # 1.111.0 - August 5th, 2026 (UK Region Only) # Features Area Description Conversational Intelligence Reduced the number of similarly named topic clustersEmail alerts are now sent when 'Analytics Credit' is lowA message is now shown when 'Topic Clusters' have not yet been generated Customer Portal New HubSpot Server-side Integration - HubSpot - Direct contact directory lookup supportNew HubSpot Server-side Integration - Call activities, transcriptions, and follow-up tasks can now be pushed to HubSpot Platform 3CX - Added the 'First Rung User Email' and 'Last Rung User Email' fields to call session dataHorizon - Added an email link for updating the Horizon PBX configurationHorizon - Passwords are now rotated only once every seven daysSynthflow - Added the Synthflow PBX collectorWildix - Added presence synchronization support Reporting Improved report viewsUpdated the group view in the 'Long Calls' report Reseller Portal Added a new customer-level 'Manage Billable Items' control Voice Callflows+ - Added cell phone and landline devicesThe Caller ID 'Default' label is now editableCaller ID numbers can now be reordered ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customersettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customersettings/ Customer Settings # The settings displayed here are customer specific settings which control some of the features of the solution. These settings are also available for Admin users of the customer to change once they are logged into the Customer portal. Setting Description Default Time Zone When running reports, call/status times will be converted to this time zone. Time Zone of your Customer Account Session Timeout Users will be logged out of the portal if inactive beyond this duration 120 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/users/usersettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/users/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 user name from the context menu in the top right corner of the portal: 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/reseller-portal/en-us/pbxtemplates/zswitch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/zswitch/ ~.pbx.kazoo.name.~ Connection # This page is not applicable in this version of ~.Dimensions.~ Supported Versions # Configuration Requirements # API Key # Account ID # API Connections # Crossbar REST API URL # Blackhole WebSocket URL # DNS SRV # ~.pbx.kazoo.name.~ Platform Requirements/Restrictions # Sub Accounts # Rate Limiting # WebSocket Events # Crossbar API Requests # Platform Restrictions # https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/3cx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/3cx/ 3CX Connection # This page is not applicable in this version of ~.Dimensions.~ Requirements # Installation # Step 1 - 3CX User Account Setup # Step 2 - ~.Dimensions.~ Customer Account Creation # Step 3 - ~.Dimensions.~ 3CX Collector Installation # Step 4 - Customizations # Upgrade # Automatically # Manually # Uninstall # Installing a Specific Version # If instructed by support, you may need to install a specific release of the collector (to support an older 3CX version or test a patch for example). https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/3cxfailover/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/3cxfailover/ 3CX Passive Failover Support # 3CX supports an Active/Passive failover environment where a copy of the 3CX installation is maintained on a secondary server. In the event of a failure on the primary server, the secondary server can be activated to take over operations. When installing ~.Dimensions.~ into this environment, there are specific considerations to ensure that data collection continues in the event of a failover. 3CX Server ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/accountsettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/accountsettings/ Account Settings # In Account Settings, you can set the caller ID, activate a blacklist, and configure other callflow settings for your PBX account. Setting Account Caller-ID Go to 'Callflows > Account Settings'. Click on Caller-ID tab. Enter the information that should display when calls are made on the network, off the network, and when emergency calls are made from the account. Click Update. Activating Blacklists Click on the Blacklist tab. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/storage/azure/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/storage/azure/ Azure Blob Storage # The following documentation outlines how to setup Azure Blob Storage for use with ~.Dimensions.~. Required Information The following information from you Azure blob store are required when adding as a storage configuration: Azure Storage Account Name Container Azure Storage Access Key Alongside the information above, a Storage Name needs to be provided. This is how the storage will be referenced within ~.Dimensions.~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/billing/billingdatacsv/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/billing/billingdatacsv/ Billing Data CSV # The information below provides details of the CSV data provided when downloading the data for a specific invoice. The CSV data provides information on each user license used but does not provide any invoice summary information. CSV Invoice Item Schema # Each entry in the CSV billing data provides the parameters listed below. Key Description Type id A unique id for the individual purchase string quantity1 The quantity used double value The monetary cost of the item double fromdate The date from which the item is being billed for string todate The date to which the item is being billed for string productname The name of the feature/product the Invoice Item is for. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/blacklist/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/blacklist/ Blacklist # In Blacklist, you can create a list of numbers that should be blocked. If a caller is trying to call anyone in your PBX account from a blacklisted number, the call will fail. Setting up a blacklist Go to 'Callflows > Blacklist'. Enter a name for the blacklist. Enable Block Anonymous, if you want to block any calls coming from an anonymous number. Add the phone numbers that you want to include in the blacklist. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/reporting/customercallcosts/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/reporting/customercallcosts/ Call Costs # The call costing system and associated reports are designed to provide some analysis of where inside an organization call spend is being incurred. a cost can be added to each call modeled using the rates configured here. These costs are then available to view on call list and summarized reports Information Circle info Call costing is designed for reporting purposes only and is not designed to be used as a billing engine. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/gettingstarted/callrecording/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/gettingstarted/callrecording/ Call Recording # If it has been enabled against a customer's 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/reseller-portal/en-us/phones/devices/config/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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/reseller-portal/en-us/api/gettingstarted/onboarding/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/gettingstarted/onboarding/ Customer Onboarding Process # The onboarding process is the process of creating a new customer account on ~.Dimensions.~ along with any user accounts which will require access to the customer portal. Document note At this stage you should have completed the Authentication Process and should have the required Access/Refresh tokens. The steps below outline the recommended process for onboarding a new customer. 1. Create a Customer Account # The first step of the process is to create the customer account record. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/genericsip/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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/reseller-portal/en-us/api/reference/customers/customersgetcustomer/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersgetcustomer/ Get Customer # Gets an existing Customer GET /v1.0/customers/{CUSTOMER_TENANT_ID} Example # This request will get the specific Customer tenant. Request # GET https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID} HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{CUSTOMER_TENANT_ID_1}", "name": "Customer 1", "description": "This is Customer 1", "enabled": true, "parentTenantId": "{ACCOUNT_ID}", "reference": "customer reference 1", "dateCreated": "2019-01-01T09:00:00.000" }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoice/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoice/ Get Invoice # Gets a specific invoice. GET /v1.0/billingdata/{INVOICE_ID} Example # This request will get all the child Customer tenants for this Reseller. Request # GET /api/v1.0/billingdata/{INVOICE_ID} HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "tenantId":"{RESELLER_TENANT_ID}" ,"invoiceid":"{INVOICE_ID}" ,"invoiceNumber":"{INVOICE_NUMBER}" ,"customerName":"Reseller 1" ,"billingPeriodStart":"2020-01-01T00:00:00.000+00:00" ,"billingPeriodEnd":"2020-01-31T23:59:59.999+00:00" ,"invoiceValue":0.0 }, "status": "success", "timestamp": "2019-01-01T10:00:00.2890319Z" } Errors # Unauthorized # When the token is not provided, invalid or expired HTTP/1. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetpbx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetpbx/ Get PBX # Gets an existing PbxConnectionProfile from a Customer tenant. GET /v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} Example # This request will get the specific PbxConnectionProfiles within the Customer tenant. Request # GET https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{PBX_ID_1}", "name": "Pbx 1", "_type": "{PBX_TYPE}", "tenantId": "{CUSTOMER_TENANT_ID}" }, "status": "success", "timestamp": "2019-01-01T10:00:00.2890319Z" } Errors # Unauthorized # When the token is not provided, invalid or expired HTTP/1. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetinstance/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetinstance/ Get PBX PBX Instance # This endpoint is used to check if the target PBX is already associated with a customer tenant somewhere on the system. GET /v1.0/pbxs?instanceId={PBX_INSTANCE_ID} Depending on the Pbx type, the following values need to be passed as the {PBX_Instance_ID}: ~.pbx.kazoo.name.~ => ~.pbx.kazoo.name.~ Account Id Teams => Microsoft Tenant Id 3CX => 3CX License Key Example # This request will get the specific PbxConnectionProfiles within the Customer tenant. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportstatusget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/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} tenant-id: {TENANT_ID} 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/reseller-portal/en-us/api/reference/customers/users/usersgetuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersgetuser/ Get User # Gets an existing User from a Customer tenant. GET /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Example # This request will get the specific User within the Customer tenant. Request # GET https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "data": { "id": "{USER_ID}", "displayName": "Customer 1", "email": "user1@example.com", "primaryTenant": "{CUSTOMER_TENANT_ID}", "isParent": false, "roles": [ "customer.user", "customer.user.supervisorl3" ] }, "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/horizon/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/horizon/ Gamma Horizon # This page is not applicable in this version of ~.Dimensions.~ Requirements # Setup # Testing the Connection # https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/keywords/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/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/reseller-portal/en-us/customers/voice/callcentrepro/queues/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/queues/ Call Center Queues # From the call center app, you can set up and manage call queues to hold and route incoming calls depending on your business needs. Using queues, you can manage calls in the order they are received. Document note Only administrators can create and delete queues. Managers can edit them. Before you start Verify that your agents and members are listed with correct phone numbers Create a list of extensions to reserve for the call center Decide on your “hold” message: music, message, or queue time Decide routing strategies and how agents should be assigned Adding a call center queue Go to Apps > Call Center. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/requirements/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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. Network Port Requirements # The following network ports are used by the solution: Area Port Protocol Description Website 443 HTTPS Standard HTTPS connection for all user sessions on the customer portal or from the application for Amazon FireTV. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/scoring/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/scoring/ Scoring # The Scoring feature provides a way to automatically score calls based on a variety of available metrics. This can be useful for monitoring agent performance, ensuring compliance with company policies and identifying areas for improvement. Information Circle info Only users that have the 'Quality Assurance' role assigned can have their calls scored. Creating a Scorecard # Under the 'Conversational Intelligence / Scoring' section of the portal settings, you can add new scorecard or edit existing ones. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/phonesystems/customerservicerequests/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/phonesystems/customerservicerequests/ Service Requests # The following service request options are available on the behalf of ~.Dimensions.~ customers: Order Hardware Request Number Port Request Additional DIDs Information Circle info In order to create service requests, you must be assigned the correct permission. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/timeofday/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/timeofday/ Time of day # In Time of Day, you can set up time of day rules to define what timezone and time period the callflow should adhere to. For example, you can set up New Years Day as the 1st of January, repeating every year. You can then assign that time of day to any callflow for special call handling. Adding time of day to a call flow. Add a callflow, see Setting up an advanced callflow. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/users/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/users/ Users # From the Smart PBX > Users tab, you can view and manage all the users on your PBX. You can add new users, view a list of current users, and update their numbers, devices, and current features. Adding a user Users should be added through the ~.Dimensions.~ Reseller Portal, not the Voice Portal. For more information on adding users, refer to the customers section. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customercalltags/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customercalltags/ 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 to the ~.Dimensions.~ portal. Creating Call Tags # Call tags can be managed from the 'Settings' area of the portal. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customerdispositions/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customerdispositions/ Dispositions # Dispositions is feature designed to 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/reseller-portal/en-us/customers/phonesystems/customerrecording/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/phonesystems/customerrecording/ Call Recording # If required, call recording can be enabled on a customer by customer basis. Once enabled, all calls made on the system are automatically recorded unless specifically disabled by modify either the customer-wide or user specific recording rules. Document note There are additional costs incurred if call recording is enabled for a customer. For more information, please speak to your ~.Dimensions.~ sales contact. Storage The storage type needs to be selected when enabling call recording for a customer. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/conference/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/conference/ Conference # In Conference, you can create a virtual conference bridge or a conference service. When a conference bridge is set up, the user can join the conference from the User Portal app, see Conference. When a conference service is set up, the owner can call other participants and add them to the call. Hand Left warning The conference facility supports up to 15 callers assuming there are no broadband limitations within the office, if all callers are internal. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customerspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customerspost/ Create Customer # Creates a new Customer tenant POST /v1.0/customers Example # This request will create a new Customer with the following details: Name: "New customer" Description: "This is my new customer" Reference: "ABC00001" Enabled: false TimeZone : "America/Los_Angeles", CountryCode: "US" PbxConnectionProfile Crossbar Rest Api: "https://hostrest" Blackhole Websocket Api: "wss//:hostwebsocket" ~.pbx.kazoo.name.~ AccountId: "accountid" ~.pbx.kazoo.name.~ Api Key: "apikey" monitorSubAccounts: False sendNewUserEmail: False sendConnectWelcomeEmail: False tenantProfileType: "{TENANT_PROFILE_ID}" TrialDuration: "0" Color Wand tip https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxpost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxpost/ Create PBX # Creates a new PbxConnectionProfile assigned to a Customer tenant. POST /v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs Example # This request will create a new ~.pbx.kazoo.name.~ PbxConnectionProfile with the following details: Customer: Within the Customer tenant with id of {CUSTOMER_TENANT_ID} Name: "Customers ~.pbx.kazoo.name.~ Pbx" Host Rest: "https://rest.example.com" Host Websocket: "wss://ws.example.com" Account Id: "12345" API Key: "ABCDEF" Request # POST https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs HTTP/1.1 Content-Type: application/json accept-charges: true Authorization: Bearer {TOKEN} Connection: keep-alive { "name": "Customers ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userspost/ Create User # Creates a new User assigned to a Customer tenant. POST /v1.0/customers/{CUSTOMER_TENANT_ID}/users Remarks # Whenever a new User is created they will be given the "customer.user" role that allows them to login to the Customer portal. This will also send out an activation email to the address provided as soon as the User is created. Example # This request will create a new User with the following details: https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoicedetail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoicedetail/ Get Invoice Details # Get a detailed breakdown of all items being invoiced for a specific invoice. A ZIP file is returned from this query which contains a detailed JSON file and a simplified CSV file. Each file contains a record of every transaction in the invoice. GET /v1.0/billingdata/{INVOICE_ID}/detail Example # This request will retrieve a breakdown of items for a specific invoice id. Request # GET /api/v1. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportresultget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/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} tenant-id: {TENANT_ID} 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. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/grandstream/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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/reseller-portal/en-us/customers/voice/smartpbx/groups/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/groups/ Groups # From the Smart PBX > Groups tab, you can create a group and add multiple users to it. You can use Groups to apply settings at a group level and distribute calls among the users in the group. Adding a Group Go to Groups > Add Group. In the Creating a group dialog, enter a name for the group. Enter an extension number for the group. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/knownissues/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/knownissues/ Known Issues # ~.Dimensions.~ # The following are known issues with the ~.Dimensions.~ platform. Area Title Description Tracking No ~.UcClient.~ Web Firefox Speaker Selection on ~.UcClient.~ Known issue with Firefox which causes audio devices not to be listed as available. 25213 Platform Specific # 3CX # The following are known issues with the ~.Dimensions.~ integration to the 3CX platform. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/phonesystems/legacypbx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/phonesystems/legacypbx/ Legacy PBX # Legacy PBX settings are not applicable in this version of ~.Dimensions.~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/managers/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/managers/ Managers # Using the Call Center app, managers get an overview of how the queue performs. Managers can view each queue, with all agents listed and see how calls are being handled by agents and as a group. If an agent is assigned as a manager to a queue, they have some additional settings for that queue. Managers can perform the following tasks: Log agents out of a queue Assign agents and manager to a queue Document note https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/migration/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/migration/ Migration # The content below provides information on migrating phones from ~.pbx.kazoo.name.~ 'Advanced Provisioner' to ~.Dimensions.~ provisioning. If you have a customer that is currently using 'Advanced Provisioner' for phone provisioning, the phones can be migrated automatically to ~.Dimensions.~ provisioning, while preserving keymaps and configuration of the phones. Migration Process # If your ~.pbx.kazoo.name.~ customer has phones on 'Advanced Provisioner', the 'Migrate' will appear at the top right of the customer 'Phones' area. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/ringgrouptoggle/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/ringgrouptoggle/ Ring Group Toggle # This action enables the caller to log in or out of a ring group as needed as part of the callflow. Drag either Ring Group Login or Ring Group Logout to the callflow and select which ring group to toggle between. For information about how to login and logout of a ring group, see Ring Group Login and Logout. See Adding a ringgroup to the callflow. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/teams/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/teams/ Microsoft Teams Connection # ~.Dimensions.~ can model Teams communications on their own or in conjunction with your PBX communications in order to provide a complete overview of your business communications. Microsoft Teams modeling uses the Microsoft Graph API to retrieve call and meeting data. Information Circle info The Microsoft Graph API does not provide call information in real-time. Call events are provided post call and can take up to 150 minutes to received. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/administrator/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callcentrepro/administrator/ Administrators # Administrators have a few more permissions than agents or managers. See summary of permissions. The administrator can: Create a queue Manage members Delete a queue Adding or Removing Call Center Members Only administrators can add or remove members using this method. Go to Call Center. Click Manage Members On the Member Management pages, you can move available users into and out of the call center as required. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/releasenotes2019/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/releasenotes2019/ Archived Release Notes # 2019 Releases # 1.0.19350 # General PBX email address/name change now changes address/name on existing user (not creating a new user) Fix for duplicate email address warning when editing user permissions (Ticket #42121) Reports Calls tripping to voicemail now show as answered and ring time modeled (If not answered before tripping to voicemail) 1.0.19344 # General Reports Segmented Call View available on all Call List reports Added interactionID to reports (allow matching to ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/releasenotes2020/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/releasenotes2020/ Archived Release Notes # 2020 Releases # 1.56.0 - Dec 21st, 2020 # Tech Bulletin 20201218 released - see Tech Bulletin section Reports Call Direction now a filter on Calls by User reports. Modeling 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. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/releasenotes2021/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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/reseller-portal/en-us/about/releasenotes2022/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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/reseller-portal/en-us/about/releasenotes2023/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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 etcLocalization 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/reseller-portal/en-us/about/releasenotes2024/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/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/reseller-portal/en-us/customers/voice/callflows/device/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/device/ Device # In Device, you can add devices to the account and assign an owner. Hand Left warning The ~.Dimensions.~ Team recommends adding devices using the Smart PBX app, Adding a device. When you add a device using the Callflows app, there are advanced options that vary depending on the type of device you are adding. Each device type has different settings and it is important to understand these settings before attempting to configure a devices in the Callflows app. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoicesummary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoicesummary/ Get Invoice Summary # Get a PDF copy of a specific ~.Dimensions.~ invoice. GET /v1.0/billingdata/{INVOICE_ID}/summary Example # This request will provide a stream of a specific PDF invoice. Request # GET /api/v1.0/billingdata/{INVOICE_ID}/summary HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/octet-stream; charset=utf-8 Content-Length: xx { "status": "success", "timestamp": "2019-01-01T10:00:00.2890319Z" } Errors # Unauthorized # When the token is not provided, invalid or expired HTTP/1. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/hotdesking/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/hotdesking/ Hot-desking # This action applies hot-desking to the callflow. You can login, logout, or toggle in and out of a hot-desk. Hot-desking is set up in the Smart PBX app, see Setting up hot desking. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/mainnumber/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/mainnumber/ Main Number # From the Main Numbers tab, you can set up the main company number and the subsequent call flows associated with the main number or numbers. After you set up your office hours, and define office holidays, then you can configure call routing to handle all calls that are received when the office is closed. You can do this in the Incoming Call Handling section. Hand Left warning https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/mitel53xx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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/reseller-portal/en-us/api/reference/customers/customerspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customerspatch/ Patch Customer # Updates a specific set of properties of a Customer. This uses the JSON Patch format for any changes. PATCH /v1.0/customers/{CUSTOMER_TENANT_ID} Example # This request will update the Api Key of the PBX connection and enable it. Request # PATCH https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/ HTTP/1.1 Content-Type: application/json accept-charges: true Authorization: Bearer {TOKEN} Connection: keep-alive [{ "op": "replace", "path": "/enabled", "value": false }, { "op": "replace", "path": "/pbxConnectionProfile/apiKey", "value": "newapikey" } ] Response # HTTP/1. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxpatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxpatch/ Patch PBX # Updates a specific set of properties of a PbxConnectionProfile. This uses the JSON Patch format for any changes. PATCH /v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} Example 1 # This request will update the Name of the PbxConnectionProfile. Request # PATCH https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} HTTP/1.1 Content-Type: application/json accept-charges: true Authorization: Bearer {TOKEN} Connection: keep-alive [{ "op": "replace", "path": "/name", "value": "My New Name" } ] Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx Request-Context: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038 { "status": "success", "timestamp": "2019-11-29T15:16:54. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userspatch/ Patch User # Updates a specific set of properties of a User. This uses the JSON Patch format for any changes. PATCH /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Hand Left warning When patching the roles against a user, be careful if using the REPLACE operation. With the replace operation, the user's current roles will be replaced with the values provided in the patch request. Any role not provided in the patch request will be removed from the user (with the exception of the PBX user role which is synchronized from the PBX). https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/techbulletin/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/about/techbulletin/ Tech Bulletins # The following technical bulletins have been released: TB20201218 - ~.pbx.kazoo.name.~ update available for loss of WebSocket events https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/wildix/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/wildix/ Wildix # ~.Dimensions.~ can model your Wildix PBX communications in order to provide a complete overview of your business communications. Wildix Configuration # Below is a guide on configuring Wildix to support ~.Dimensions.~ and allow it to communicate. Required Information # The following information is required when adding a Wildix PBX connection to ~.Dimensions.~ customer account. Create the necessary Company API Key and Application within Wildix before completing the normal ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userdevices/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userdevices/ Update User Device # This endpoint allows existing devices to be assigned (or removed) as softphone devices for a user for ~.UcClient.~ Desktop, Mobile & WebRTC. Assign a Device PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/assign Unassign a Device PUT /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/devices/pbx/{DEVICE_ID}/unassign The Body of the request needs to contain a single JSON property to indicate which type of client the device is being assigned to: { "clientType": "desktop" } Valid clientType values: https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/calllogs/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/calllogs/ Call Logs # From the Call Logs tab, you can review call history on the account for any time range and filter the results as needed. You can also open a support ticket with the ~.Dimensions.~ Team from the Call Logs page. The call details are automatically included for convenience. Reporting Call Issue If a customer is having issues with a call, they can open a ticket with the ~. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/callerid/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/callerid/ Caller-ID # This action sets up caller ID for the callflow. You can enable dynamic caller ID (enter in the phone), or set up a text as a prefix to the caller ID. See Adding a prepend for caller-ID. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersdelete/ Customer Delete # Deactivates an existing Customer tenant and flags it for deletion. Request # DELETE /v1.0/customers/{CUSTOMER_TENANT_ID} Errors # Unauthorized # When the token is not provided, invalid or expired HTTP/1.1 401 Unauthorized Bad Request # When the provided tenant id is not in the correct format HTTP/1.1 400 Bad Request Date: Thu, 06 Feb 2020 12:45:27 GMT Content-Type: application/json; charset=utf-8 Content-Length: 149 { "error": 400, "message": "The value '<tenant id>' is not valid. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxdelete/ Delete PBX # Deletes an existing PbxConnectionProfile from the Customer tenant. Hand Left warning This will disconnect the Pbx connection and stop collecting any events. Request # DELETE /v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} Example # This request will delete the specific PbxConnectionProfile within the Customer tenant. Request # DELETE https://api.uk.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/pbxs/{PBX_ID} HTTP/1.1 Authorization: Bearer {TOKEN} Response # HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8 Content-Length: xx { "status": "success", "timestamp": "2019-01-01T10:00:00. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersdelete/ Delete User # Deletes an existing User from the Customer tenant. If this is a user's non primary tenant, it will remove them only from this tenant. They will still have access to any other Customer they are assigned. If this is the user's primary tenant, it will remove them from ALL other Customer tenants and delete the User account. Request # DELETE /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID} Example # This request will delete the specific User within the Customer tenant. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/directory/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/directory/ Directory # The main company directory is created automatically when you create a user and check the box to include the user in the company directory. This directory is available on the Smart PBX dashboard and you can download it to a .pdf file. In the Callflows app, you can create other directories to include in advanced callflows. Callers can connect to the appropriate person by searching the directory. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/donotdisturb/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/donotdisturb/ Do Not Disturb # This action activates do not disturb (DND) on the callflow. If DND is enabled for a user or a callflow, all calls will go directly to voicemail. You can activate, deactivate, or toggle DND during the call. See Setting up Do Not Disturb. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/mitel68xx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/mitel68xx/ Mitel 68xx/69xx Phones # Mitel 68xx/69xx phones 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/69xx 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/reseller-portal/en-us/customers/customerphones/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customerphones/ Phone Management # The customer section of the portal provides access to view and manage all the customers who have been provisioned to use the ~.Dimensions.~ Call Analytics platform. New customers can also be provisioned through the same user interface. Phone Configuration # By default, when a customer is created a copy of the 'Default Configuration' is taken from Reseller level and is used as the base configuration for all phones on the customer account. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/callrecording/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/callrecording/ Call Recording # This action starts or stops call recording for the entire callflow. If you prefer, you can set up call recording as a preflow on the entire account if you want to record all calls. See Configuring hold music and preflow. You can also set up call recording using the Call Recording application. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/devices/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/devices/ Devices # From the Devices tab, you can set up and manage the devices on the account. Adding a device Go to 'SmartPBX > Devices > Add Device'. Select the type of device you want to add. Enter the device name and number. Leave Assign to as No Owner. Click Create Device. This device now appears in the list of available or spare devices if you need to use it in the future. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/faxboxes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/faxboxes/ Fax Boxes # A faxbox is a virtual fax machine that enables you to send or receive faxes through email. Having a faxbox means that anyone using a fax machine can send a fax to your faxbox number and you can receive it as an email. Also, you can send paperwork to a fax machine from your faxbox email address. Alternatively, you can set up a faxbox at Smart PBX > Users > User Features > Faxbox, see Setting up your faxbox. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/poly/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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/reseller-portal/en-us/api/reference/customers/users/userssendactivationlink/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userssendactivationlink/ Send New User Email # Sends an activation email link to an existing User. POST /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendActivationEmail Document note This will be done automatically if the sendNewUserEmail property is enabled on the customer account. Example # This request will get send an activations link to this User within the Customer tenant. Hand Left warning Activation emails can only be sent from the User's primary tenant. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userssenducemail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userssenducemail/ Send Unified Communications Welcome Email # Sends a welcome email to a user when they are enabled to use a unified communications client. POST /v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendUConnectActivationEmail Document note This will be done automatically if the sendConnectWelcomeEmail property is enabled on the customer account. Example # This request will get send an activations link to this User within the Customer tenant. Hand Left warning https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/callforwarding/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/callflowactions/callforwarding/ Call Forwarding # This action applies diverts the callflow to a different number. Call forwarding can also be set up in Setting up call forwarding. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/groups/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/groups/ Groups # In the Groups tab you can set up groups to be used as ringing groups or pickup groups. You can also add groups in the Smart PBX, see Adding a group. Document note You can add a maximum of 15 members to any group. Adding a group Go to Callflows > Groups. From the left-hand navigation, click Add. In Create Group, assign a friendly name to the group, for example "Sales". https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/voicemailboxes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/voicemailboxes/ Voicemail Boxes # From the Voicemail Boxes tab, you can set up and manage all voicemail boxes on your VoIP account. Go to 'Smart PBX > Voicemail Boxes' to view a list of the current voicemail boxes on the account. To find out how to check your voicemail, see Check Voicemail. To set up a new voicemail from your device, see Setting up new voicemail. Document note https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/devices/hardware/yealink/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/phones/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 center of the cursor control on the keypad until the factory reset message appears. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/featurecodes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/smartpbx/featurecodes/ Setting Up Features From Your Device # From the Feature Codes tab, you can find the short codes for the various features available on your VoIP phone. Go to 'Smart PBX > Feature Codes'. Use the short codes to access and manage the features directly from your phone. Document note The following features are available by default. You cannot disable any of the features. Administrators can configure the shortcode for all features in 'Callflows > Feature Codes', see Callflows for more information. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/media/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/media/ Media # In Media, you can upload content to use as media for hold music, voice greetings, menus, or voicemails. You can also edit existing media. After you create the media, it is available to select in the Smart PBX. Adding media Go to Callflows > Play Media. From the left-hand navigation, click Add. Enter the media name and media type. If you are using text to speech (TTS), enter the text for the greeting. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/mockpbx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/pbxtemplates/mockpbx/ Mock PBX Connection # The Mock PBX connection is a dummy phone system which is used to automatically generate fake call events. This is very useful for demonstration systems where a consistent call flow volume is required. The table below outlines the settings required when configuring a Mock PBX connection: Setting Description Name A unique name to be able to easily identify the use of the connection. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/menu/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/menu/ Menu # In Menu, you can create different menus such as a main menu that callers hear when they reach a callflow. When you are adding a callflow, you can add the Menu action and configure the settings. Alternatively, you can you can create the menu first and then apply it to an existing callflow from Callflow > Callflows > Add Callflow > Actions > Basic > Menu. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/timeofday/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/timeofday/ Time of day # In Time of Day, you can set up time of day rules to define what timezone and time period the callflow should adhere to. For example, you can set up New Years Day as the 1st of January, repeating every year. You can then assign that time of day to any callflow for special call handling. Adding time of day to a call flow. Add a callflow, see Setting up an advanced callflow. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/timeofdaysets/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/timeofdaysets/ Time of Day Sets # In Time of Day Sets, you can configure reusable time of day sets, such as public holidays, or certain predefined blocks of time that you can pull into a callflow easily without having to input the details each time. Before you can assemble time of day sets, you must predefine the time-of-day instances in the Time of Day. For example, in Time of Day, you have set up New Years day as the 1st of January, repeating every year. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/user/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/user/ User # ~.Dimensions.~ recommends adding users in the Smart PBX app Adding a user. However, in the Callflow app, from User you can manage some additional user settings. Document note If you want to add a user in the Callflows app, see Adding a user. Resetting the user password Go to Callflows > User. Select the user that you want to reset. Click Advanced and then go to the Password Management tab. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customermetrics/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customermetrics/ License Metrics # This section provides information on the licenses that a customer is currently consuming. As users are provisioned or their roles are changed, the license values will be updated accordingly. Users # Metric Description Single-Device Users The number of users that have been assigned a Single-Device User license Multi-Device Users The number of users that have been assigned a Multi-Device User license Agent User Add-On1 The number of users that have been assigned an Agent User license Agent User Add-On licenses can be manually provisioned against users or automatically synced to the PBX configuration. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/voicemail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/voice/callflows/voicemail/ Voicemail # The ~.Dimensions.~ team recommends adding voicemail boxes using the Smart PBX, see Adding a voicemail box. There are no additional settings in the Callflow app to manage voicemail boxes. Document note If you want to add a voicemail box using the Callflow app, see Adding a voicemail box. Adding voicemail to a callflow Add a callflow, see Setting up an advanced callflow. From the Basic actions, drag Voicemail across and place in on top of the callflow. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/termination/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/termination/ Terminating or Disabling Customer Accounts # ~.Dimensions.~ provides the ability to restrict a customer's access to the system or terminating a customers account if they no longer wish to use the solution. Disabling Customer Accounts # The disable option is designed for use with customers who may have missed payments on the service and as a reseller you wish to restrict their access to the system temporarily. To disable a customer's access to their account, click the 'Edit' button on the customer grid then press the 'More' button and select 'Disabled'. https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customertrials/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs-voice.uk.xarios.cloud/reseller-portal/en-us/customers/customertrials/ Trial Customers # If available, customer accounts can be created as a trial during the initial provisioning process. This allows a customer to use the ~.Dimensions.~ portal for a fixed period of time without incurring a cost. Document note If you do not have this option and would like it, please contact your ~.Dimensions.~ account manager to discuss. To enable a customer as a trial, select the 'Enable Trial Period' option during the customer's initial provisioning.