https://docs.na.xarios.cloud/reseller-portal/en-us/ Recent content in ~.Dimensions.~ Reseller Portal on Reseller Portal Hugo -- gohugo.io https://docs.na.xarios.cloud/reseller-portal/en-us/api/gettingstarted/authentication/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/billing/billinghistory/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/contactdirectories/contacts/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/customdictionary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportsgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/workspacesgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.myreports.cloud/api/v1.0/workspaces HTTP/1.1 Authorization: Bearer {TOKEN} tenant-id: {TENANT_ID} Response # HTTP/1. https://docs.na.xarios.cloud/reseller-portal/en-us/customers/users/customerusergroups/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/billing/billingdatajson/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/businessareas/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/charges/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/users/customerclientprofiles/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/gettingstarted/clients/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/profiles/profilesgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersgetall/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/customers/contactdirectories/import/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportrequest/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/gettingstarted/postman/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/provisioning/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/about/releasenotes/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.109.2 Releases # 1.109.0 - June 1st, 2026 # Features Area Description Conversational Intelligence 'Call Scoring' support added Customer Portal Supervisor access type requirement no longer required on the 'Recording Playback' role Dashboard Persistent Agent State filter now available on the Agent grid Platform 3CX - Calls now suppressed if connections exceed 500Wildix - Initial beta support for Wildix integration Provisioning Support added for Cloudflare R2 storage for call recordingsContact directory items now shown in the configuration section Reporting New 'Queue Performance By Name' report template addedFiltering support added for 'Force Away' agent status reasonNew 'Calls by Business Area' report template addedPercentage stat rendering improvementsReport groups view added for 'Long Calls' and 'Repeat Calls'Reports can now be set to auto-run if they have not already been runScheduled reporting based on day of the monthWorkspace configuration support added for setting top/bottom longest %Workspace configuration support added for setting repeat call duration'User Group Name' field added to segmented list reports ~. https://docs.na.xarios.cloud/reseller-portal/en-us/customers/customersettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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 Sync Agent User Add-On role with the PBX Configuration When enabled, the 'Agent User Add-On' role will be automatically assigned to Essential Users when they are configured as an agent on the PBX[^1] and unassigned when this configuration is removed Disabled https://docs.na.xarios.cloud/reseller-portal/en-us/users/usersettings/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/zswitch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/zswitch/ ~.pbx.kazoo.name.~ Connection # The ~.pbx.kazoo.name.~ connection provides a data collection service for the ~.pbx.kazoo.name.~ UCaaS/CPaaS platform. The table below outlines the settings required when configuring a ~.pbx.kazoo.name.~ PBX connection: Setting Description Name A unique name to be able to easily identify the use of the connection. API Key The API key to allow ~.Dimensions.~ to connect to ~.pbx.kazoo.name.~ and monitor the customer's communications. https://docs.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/3cx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/3cx/ 3CX Connection # This connection provides a data collection service for the 3CX communications platform. It provides call data modeling to enable usage of call analytics (Dashboards/Wallboards) on Self-Hosted 3CX installations. This page outlines how to install the 3CX Remote Collector service on a 3CX PBX Information Circle info For information on how to set up ~.Dimensions.~ on a Passive Failover 3CX system, please see here. https://docs.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/3cxfailover/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/billing/billingdatacsv/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/reporting/customercallcosts/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/gettingstarted/onboarding/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersgetcustomer/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoice/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetpbx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxgetinstance/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportstatusget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersgetuser/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/horizon/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/horizon/ Gamma Horizon # ~.Dimensions.~ supports and integration with Gamma Horizon based on call recording downloads. This allows for call recording data to be added to ~.Dimensions.~ and call data modeled for transcription and Conversational Intelligence. This page outlines the requirements and setup process for configure ~.Dimensions.~ to connect to a Gamma Horizon system. Requirements # The following requirements must be met in order to connect ~.Dimensions.~ to a Gamma Horizon installation. https://docs.na.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/keywords/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/about/requirements/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/scoring/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/customers/conversationalintelligence/scoring/ Scoring # 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.na.xarios.cloud/reseller-portal/en-us/customers/customercalltags/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/customerdispositions/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/customers/customerdispositions/ Dispositions # Dispositions is feature designed require certain types of calls to be given call results. These 'Dispositions' (or lack of) can then be reported on through the reporting and dashboard/wallboard features. This section provides information on how dispositions work and how they are configured. How Dispositions Work # Dispositions work in a similar way to call tag lists, but instead of being optional, they are required. Each disposition instance created requires a filter to be provided. https://docs.na.xarios.cloud/reseller-portal/en-us/customers/phonesystems/customerrecording/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/customers/phonesystems/customerrecording/ Call Recording # ~.Dimensions.~ provides access to playback recordings through the analytics Call Session View. Depending on the PBX platform being connected to, the Call Recording configuration section may or may not be relevant. ~.pbx.kazoo.name.~ No call recording configuration is required. Call recordings are automatically accessed through the ~.pbx.kazoo.name.~ API and made available to users with the necessary permissions. 3CX ~.Dimensions.~ supports playback of 3CX call recordings providing the 3CX system is archived to Google Cloud Storage (GCS) for call recording backups. https://docs.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/customerspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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 TrialDuration: "0" Request # POST https://api. https://docs.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxpost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userspost/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoicedetail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/workspaces/reports/reportresultget/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/about/knownissues/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/about/knownissues/ Known Issues # The table below lists the known problems and the expected fix date: Issue Ref Description Expected Fix Date Platform Restrictions # Please refer the communications platform specific section for information on requirements and restrictions. ~.pbx.kazoo.name.~ https://docs.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/teams/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/teams/ Microsoft Teams Connection # ~.Dimensions.~ can model Teams communications in conjunction with your PBX communications in order to provide a complete overview of your business communications. Support for Microsoft Teams is currently available in Preview. If you are interested in trialling this feature, please contact you ~.Dimensions.~ sales representative. Manual Teams Configuration # Below is a guide on configuring Azure to support the ~.Dimensions.~ Microsoft Teams integration. Please follow the steps below to generate a client Id/Secret that can be used by ~. https://docs.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2019/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2020/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2021/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2021/ Archived Release Notes # 2021 Releases # 1.72.0 - Dec 7th, 2021 # ~.UcClient.~ Desktop Presence Profiles -> Profiles can now be overridden by users giving control of DND, Forwarding and Personal Call Routing ~.UcClient.~ Mobile Android -> Initial Android version released Voicemail Access -> Users can see voicemail quantity and dial in to play them Presence Profile Selection -> Users can now control their presence through the mobile application 1. https://docs.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2022/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2022/ Archived Release Notes # 2022 Releases # 1.81.0 - Nov 8th, 2022 # 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) ~.UcClient.~ Clients (Desktop/Mobile/CRM) Features Group calls will no longer show as missed if answered at another location Fixes Fixed issue with clients being intermittently logged out (Ticket #49724) ~. https://docs.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2023/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/about/releasenotes2024/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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 API Expanded reseller metricsCustomer trial status now included ~.UcClient.~ Clients New welcome emails per client type ~. https://docs.na.xarios.cloud/reseller-portal/en-us/api/reference/billing/billinggetinvoicesummary/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/customerspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxpatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userspatch/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/about/techbulletin/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userdevices/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/customersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/pbxprofiles/pbxdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/usersdelete/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userssendactivationlink/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/api/reference/customers/users/userssenducemail/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/pbxtemplates/mockpbx/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/customercrmintegration/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.xarios.cloud/reseller-portal/en-us/customers/customercrmintegration/ CRM Integration # If a customer is using one of the ~.UcClient.~ CRM User Add-Ons, there may be some additional configuration needed to ensure they can login into the plugin successfully. In order to maintain a high level of security, ~.Dimensions.~ only supports login through an iFrame if it is from a known source. If a customer using one of the CRM providers standard domains (e.g. https://Salesforce.com or https://freshdesk.com), no additional configuration is necessary. https://docs.na.xarios.cloud/reseller-portal/en-us/customers/customermetrics/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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 Essential Users The number of users that have been assigned an Essential User license Professional Users The number of users that have been assigned a Professional 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.na.xarios.cloud/reseller-portal/en-us/customers/termination/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.na.xarios.cloud/reseller-portal/en-us/customers/customertrials/ Mon, 01 Jan 0001 00:00:00 +0000 https://docs.na.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.