# Telephone Systems (Telephony Servers)

In this sub-section, you will learn how to programmatically create, modify, delete and view Telephony Server entries.

Akixi Telephony Server entries can represent 1 or more client-side telephony environments and are used to configure the application so that it knows how to communicate with the underlying telephony platform in order to monitor & model real-time call & ACD state information for devices.

In order to configure an Akixi Service instance to specifically communicate to either a PBX or hosted telephony platform, a Telephony Server entry component must be configured within the Akixi Service. This defines the public IP address of the target telephony platform’s external connectivity implementation, as well as some other important communication details such as TCP/UDP port numbers, authentication details, and other internal API communication settings.

Once a Telephony Server entry is created, the Akixi Service begins communicating with the corresponding telephony platform and establishes a persistent connection with it.

Depending on whether a PBX or “hosted” telephony platform is being utilised by Customer, the configuration arrangement within Akixi can be different.

# Hosted Telephony Platform Connectivity

For hosted Customers, the Akixi Service is configured to communicate with the Telephony Provider’s core hosted platform, which is running in a data centre location. Depending on the number of Customer sites being supported, and also the platform access permissions granted by the Telephone Provider to Akixi, the Akixi Service may or may not need to maintain multiple communication sessions to the Provider’s platform for each separate Customer.

Generally speaking using the currently available communication technologies, one Akixi telephony platform communication session is also rarely capable of support more than 100 Customers. Therefore for a large number of Customers, Akixi will always maintain multiple communication sessions with the corresponding hosted telephony platform.

For BroadSoft M6 telephony platforms, it is recommended to create a single Telephony Server entry, and mount each separate Customer as an Akixi Partition component (up to about an 80 Partition pessimistic safe limit before creating another new Telephony Server entry, etc.).

# Telephony Server Per BroadWorks Enterprise (Recommended)

The recommended approach is to create a separate Akixi Telephony Server entry per BroadWorks Enterprise component, and then create separate Partition elements for each individual BroadWorks Group (site) components. This approach is strongly suggested in order that the Akixi Partition level can be used as a scope permission assignment model for individual reporting supervisor Users, which might only require reporting privileges against a specific BroadWorks Enterprise Group. This option requires BroadWorks read-only administrative API credentials to be created on the telephony platform at the Enterprise level, which are then set in the AuthUserID2, AuthPassword2, AuthUserID4 & AuthPassword4 properties accordingly.

Note

This Akixi Service component integration strategy has one limitation in that cross- Enterprise hunt groups & call centre queues can’t be supported (i.e. support for call distribution groups that contains extension user members across multiple BroadWorks Groups). If support for Enterprise-wide group distribution devices is required, then use option 2 or 3 instead accordingly.

Also

Cross-BroadWorks-Group calls are modelled as external calls, which means that “internal” calls made between extensions users in different BroadWorks Groups does not require an Akixi Device entry to be created for the remote extension user on the Group where Akixi Supervisor reporting is not locally required for.

# Telephony Server Per BroadWorks Enterprise (Single Partition)

Similar to option "Telephony Server Per BroadWorks Enterprise", but where only one Akixi Service Partition component is created which is associated with the entire BroadWorks Enterprise.

# Single Telephony Server

Conversely, a single Telephony Server entry can be configured instead that has BroadWorks System/Provisioning level API access, where individual Customer Enterprises are mapped to separate Partitions. This latter approach is easier to visualise as well as configure manually, but sacrifices the ability to allow BroadWorks Group specific organisation of sites within the Akixi Service as well as the easier facility for site-specific reporting permissions. This option requires BroadWorks read-only administrative API credentials to be created on the telephony platform at the System or Provisioning level, which are then set in the AuthUserID2, AuthPassword2, AuthUserID4 & AuthPassword4 properties accordingly.

# PBXs Connectivity

For PBX Customers, the Akixi Service is configured to communicate with each individual Customer PBX telephone system, which resides in the same physical location as the Customer’s extension handsets/endpoints.

# “Site” Licensing

The Akixi application itself limits the number of Customer Site telephony environments that can be specifically monitored for Akixi Lite, 1000, 2000 & 3000 reporting. Note that you need an Akixi 1000, 2000, or 3000 assigned environment to use Akixi Presence functionality- there is no specific site license for Akixi Presence.

For PBX telephony environments, licenses are utilised & assigned at the Telephony Server component level via the LicensedForRptUserType Property in TelSysAdd & TelSysChange operations.

For hosted environments, licenses are utilised & assigned at the Partition component level via the LicensedForRptUserType Property in PartitionAdd & PartitionChange operations.

For more information on setting the LicensedForRptUserType Property in Web Services request, refer to sub-section “LicensedForRptUserType”.

# Supported Operations

The list of currently supported Telephony Server operations is provided below. Operations related to Akixi Telephone Systems/Server entries start with a “TelSys” prefix. They will be referred to as “TelSys Operations” interchangeably hereafter.

Please note that depending on your assigned telephone system privileges you may only have access to view and configure one particular Telephony Server entry. Refer back to the application administrator that created your particular User account in order to gain additional privileges.

Operation Name	Operation Description
Add	Add a new Telephony Server entry.
Change	Change an existing Telephony Server component.
Delete	Delete a Telephony Server.
List	List all Telephony Servers assigned to your Akixi account.
Info	Get information about a Telephony Server.

# Telephony Server Request Parameters

Please note that some TelSysAdd & TelSysChange parameters are platform-specific - therefore, you must be entirely sure that your request includes all parameters required to create and/or modify a Telephony Server entry of a certain telephony platform/system type.

Parameters used within both TelSysAdd and TelSysChange requests can be found in the table below. You can use this table to check whether a parameter is supported by a certain telephony platform.

To learn more about TelSysXXX parameters, please refer to the “Telephony Server Properties” section.

# Read-Only Properties After Initial Creation

Parameter Name	Cisco Broadworks	Broadsoft M6	Siemens/Unify HiPath3000	Panasonic TDA/NCP	Demo Simulator	Webex Calling	MS Teams
TelSysID	✅	✅	✅	✅	✅	✅	✅
TelSysType	✅	✅	✅	✅	✅	✅	✅

# Fully Updatable Properties

Parameter Name	Cisco Broadworks	Broadsoft M6	Siemens/Unify HiPath3000	Panasonic TDA/NCP	Demo Simulator	Webex Calling	MS Teams
Description	✅	✅	✅	✅	✅	✅	✅
BillingTag	✅	✅	✅	✅	✅	✅	✅
TimeZone	✅	✅	✅	✅	✅	✅	✅
CMEnvironmentID	✅	✅	✅	✅	✅	✅	✅
IPAddrOrHost1	✅	✅	✅	✅	✅	✅	✅
IPAddrOrHost2	✅	✅	✅	✅	✅	✅	✅
IPAddrOrHost3	✅	✅	✅	✅	✅	✅	✅
IPAddrOrHost4	✅	✅	✅	✅	✅	✅	✅
TCPPort1	✅	✅	✅	✅	❌	✅	✅
TCPPort2	✅	✅	❌	❌	❌	✅	✅
TCPPort3	✅	✅	❌	❌	❌	❌	❌
TCPPort4	✅	❌	❌	❌	❌	✅	✅
UseSSLTLS1	❌	❌	✅	✅	❌	❌	❌
UseSSLTLS2	✅	✅	❌	❌	❌	✅	✅
UseSSLTLS3	❌	❌	❌	❌	❌	❌	❌
UseSSLTLS4	✅	❌	❌	❌	❌	✅	✅
AuthUserID1	❌	❌	❌	❌	❌	✅	✅
AuthUserID2	✅	❌	❌	❌	❌	✅	✅
AuthUserID3	❌	❌	❌	❌	❌	✅	✅
AuthUserID4	✅	❌	❌	❌	❌	✅	✅
AuthPassword1	❌	❌	❌	❌	❌	✅	✅
AuthPassword2	✅	❌	❌	❌	❌	✅	✅
AuthPassword3	❌	✅	❌	❌	❌	✅	✅
AuthPassword4	✅	❌	❌	❌	❌	✅	✅
CommsParameter1	✅	❌	❌	❌	❌	✅	✅
CommsParameter2	✅	❌	❌	❌	❌	✅	✅
CommsEnabled	✅	✅	✅	✅	✅	✅	✅
InternalDigitLen	✅	✅	❌	❌	❌	✅	✅
CountryCode	✅	❌	❌	❌	❌	✅	✅
OmniChannelPermitted	❌	❌	❌	❌	✅	✅	✅
CallControlOptions	❌	❌	❌	❌	✅	✅	✅
DeleteACDAgentsOnLicenseDowngrade	❌	❌	✅	✅	❌	✅	✅
SyncNow	❌	❌	❌	✅	❌	✅	✅
TelNoPrefixes	✅	✅	✅	✅	✅	✅	✅
LicensedForRptUserType	❌	❌	✅	✅	❌	✅	✅
AutoDeleteUsers	✅	✅	✅	✅	✅	❌	❌
ManageUserMFA	✅	✅	✅	✅	✅	✅	✅
XSPServer	✅	❌	❌	❌	❌	✅	✅

# Advanced Properties (Advanced Container)

Parameter Name	Cisco Broadworks	Broadsoft M6	Siemens/Unify HiPath3000	Panasonic TDA/NCP	Demo Simulator	Webex Calling	MS Teams
CTILogEnabled	✅	✅	✅	✅	✅	✅	✅
CTICallModelLogEnabled	✅	✅	✅	✅	✅	✅	✅
InternalDiagDumpEnabled	✅	✅	✅	✅	✅	✅	✅
CTILogIncClassNames	✅	✅	✅	✅	✅	✅	✅
CallModelDiagDumpEnabledForCalls	✅	✅	✅	✅	✅	✅	✅
CallModelDiagDumpEnabledForDev	✅	✅	✅	✅	✅	✅	✅
PartitionCountMax	✅	✅	✅	✅	✅	✅	✅
PartitionsRptingScopeAllEnabled	✅	✅	✅	✅	✅	✅	✅

Recommendation

It is strongly recommended to specifically set the value of the TelSysID Property when programmatically creating new Telephony Server components via external provisioning or billing systems TelSysID values, Aggregators with a dedicated Akixi Service URL will have their own Akixi-assigned start range for which they should automatically self-track & increment internally within their own automated system(s). To find out the starting range of yourTelSysID Property, sign into your Akixi Service via the web interface and view the last existing Telephony Server entry that has already been manually pre-created, either as a demonstration simulator environment, a hosted platform lab test connectivity test, or for actual live Customer environments. Then add 1 to this value.

# Add

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys

URL Specs	Description
`protocol`	`HTTPS` is only supported protocol for API as it uses Basic authentication.
`host`	Your service instance host.
`method`	`POST`

# Headers

Key	Sample Value	Description
`Content-Type`	`application/json`	Content type of the request body.
`Cookie`	`JSESSIONID=<session_id>;`	JSessionID for the authentication request. Its optional, if x-api-key is provided.
`x-api-key`	`<api_key>`	API Key for the authentication request. Its optional, if cookie with JSessionID provided.

Note: Either Cookie or x-api-key header is required for authentication.

# Path Parameters:

Path Parameters are not required for this request.

# Query Parameters

Query Parameters are not required for this request.

# Request Body

This is the request body to create a new telsys.

Example of request body for TelSysType as MS Teams

Key	Sample Value	Description
`TelSysType`	`MS Teams`	Telephony system type
`CXIntegrationCap`	`2`	Number of CX Integrations licenses to assign.

{
  "Description": "Test Teams",
  "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
  "Tags": "",
  "BillingTag": "Billing ID or Tag",
  "Billable": true,
  "TrialEnabled": false,
  "ManageUserMFA": false,
  "TelSysType": "MS Teams",
  "OperatingMode": 1,
  "HistoricOnly": false,
  "CallControlOptions": "",
  "OmniChannelPermitted": false,
  "LicensedForRptUserType": "",
  "IntegrationMode": "RealTime",
  "DeleteACDAgentsOnLicenseDowngrade": null,
  "IPAddrOrHost1": "",
  "IPAddrOrHost2": "",
  "TCPPort1": "",
  "AuthUserID1": "",
  "AuthPassword1": null,
  "TCPPort2": "",
  "UseSSLTLS2": false,
  "AuthUserID2": "",
  "AuthPassword2": null,
  "AuthPassword2OAuthSessionID": null,
  "IPAddrOrHost3": "",
  "AuthUserID3": "",
  "AuthPassword3": null,
  "IPAddrOrHost4": "",
  "TCPPort4": "",
  "UseSSLTLS4": false,
  "AuthUserID4": "",
  "AuthPassword4": null,
  "XSPServer": "",
  "CommsParameter1": "",
  "CommsParameter2": "",
  "CommsEnabled": true,
  "MonitoringEnabled": false,
  "TimeZone": "Europe/London",
  "CountryCode": 44,
  "InternalDigitLen": 4,
  "TelNoPrefixes": "",
  "CallRecIntIDDefault": "d7ae7ea9bf56ebdc:-53beea96:1556d0e14d3:-8000",
  "E164Enabled": true,
  "SyncNow": false,
  "AddExtsAgents": false,
  "ECCRReplacement": false,
  "TelSysProfileID": "license.telsysprofile.msteams.default",
  "Advanced": {
    "PartitionCountMax": 80,
    "CTILogIncClassNames": false,
    "InternalDiagDumpEnabled": false,
    "CallModelDiagDumpEnabledForCalls": false,
    "CTILogEnabled": false,
    "PartitionsRptingScopeAllEnabled": false,
    "CallModelDiagDumpEnabledForDev": "",
    "CTICallModelLogEnabled": false,
    "UserNotificationsEnabled": false,
    "ExtensionsPerEnterpriseUser": 50
  },
  "LicenseCapManagement": {
    "EssentialsCap": 50,
    "ProfessionalCap": null,
    "EnterpriseCap": 50,
    "CallCentreAgentCap": 50,
    "CallCentreSupervisorCap": null,
    "CXIntegrationCap": 2
  }
}

Example of request body for TelSysType as BroadSoft M6

Key	Sample Value	Description
`TelSysType`	`BroadSoft M6`	Telephony system type

{
  {
    "TelSysID": "72",
    "Description": "TelSysFromRestAPI",
    "TelSysType": "BroadSoft M6",
    "TimeZone": "Asia/Calcutta",
    "BillingTag": "",
    "TelNoPrefixes": "9, 91, 0",
    "LicensedForRptUserType": "Akixi 1000",
    "IPAddrOrHost1": "192.168.1.110",
    "IPAddrOrHost2": "dnstest.akixi.com",
    "IPAddrOrHost3": "1.1.1.1",
    "IPAddrOrHost4": "TestPart",
    "TCPPort1": "",
    "TCPPort2": "5862",
    "TCPPort3": "74155",
    "TCPPort4": "54",
    "UseSSLTLS1": "true",
    "UseSSLTLS2": "yes",
    "UseSSLTLS3": "TRUE",
    "UseSSLTLS4": "YES",
    "CommsParameter1": "/xsi-checkevent",
    "CommsParameter2": "/xsi-checkevents",
    "CommsParameter3": "/xsi-3",
    "CommsParameter4": "/xsi-4",
    "AuthUserID1": "test@akixi.com",
    "AuthUserID2": "test@akixi.com",
    "AuthUserID3": "test@akixi.com",
    "AuthUserID4": "Admin",
    "AuthPassword1": "O8vAgtgrExR09OpzMxsp8Q==",
    "AuthPassword2": "O8vAgtgrExR09OpzMxsp8Q==",
    "AuthPassword3": "O8vAgtgrExR09OpzMxsp8Q==",
    "AuthPassword4": "O8vAgtgrExR09OpzMxsp8Q==",
    "InternalDigitLen": "2",
    "CountryCode": "",
    "CallControlOptions": "All",
    "CommsEnabled": "All Disabled",
    "Tags": "TestTag1, TestTag2, TagFromRestAPI"
}
}

Example of request body for TelSysType as Webex Calling

Key	Sample Value	Description
`TelSysType`	`Webex Calling`	Telephony system type

{
  "Description": "testing telephone",
  "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
  "Tags": "",
  "BillingTag": "",
  "Billable": true,
  "TrialEnabled": false,
  "ManageUserMFA": false,
  "TelSysType": "Webex Calling",
  "CallControlOptions": "",
  "OmniChannelPermitted": false,
  "LicensedForRptUserType": "",
  "DeleteACDAgentsOnLicenseDowngrade": null,
  "IPAddrOrHost1": "",
  "IPAddrOrHost2": "",
  "TCPPort1": "",
  "AuthUserID1": "C9b9409442f99c7814550ba032382fdaaa8f1ad3836d0c241c3b4d4025e4d02a5",
  "AuthPassword1": null,
  "TCPPort2": "",
  "UseSSLTLS2": false,
  "AuthUserID2": "",
  "AuthPassword2": null,
  "AuthPassword2OAuthSessionID": null,
  "IPAddrOrHost3": "",
  "AuthUserID3": "",
  "AuthPassword3": null,
  "IPAddrOrHost4": "",
  "TCPPort4": "",
  "UseSSLTLS4": false,
  "AuthUserID4": "",
  "AuthPassword4": null,
  "XSPServer": "",
  "CommsParameter1": "",
  "CommsParameter2": "",
  "CommsEnabled": true,
  "MonitoringEnabled": false,
  "TimeZone": "Europe/London",
  "CountryCode": 44,
  "InternalDigitLen": 4,
  "TelNoPrefixes": "106",
  "CallRecIntIDDefault": "d7ae7ea9bf56ebdc:-53beea96:1556d0e14d3:-8000",
  "SyncNow": false,
  "AddExtsAgents": false,
  "ECCRReplacement": false,
  "TelSysProfileID": "",
  "Advanced": {
    "PartitionCountMax": 80,
    "CTILogIncClassNames": false,
    "InternalDiagDumpEnabled": false,
    "CallModelDiagDumpEnabledForCalls": false,
    "CTILogEnabled": false,
    "PartitionsRptingScopeAllEnabled": false,
    "CallModelDiagDumpEnabledForDev": "",
    "CTICallModelLogEnabled": false,
    "UserNotificationsEnabled": false,
    "ExtensionsPerEnterpriseUser": 50
  }
}

# Response

The response contains newly created TelSysID with success message.

# Success

With 200 HTTP Status Code:

{
    "Result": "Success",
    "Data": {
        "TelSysID": 72
    }
}

# Error

For more information about the error codes see : here.

# Field Descriptions:

For more information on field descriptions, see here.

# Code Snippets

See the following code snippets to help you start with the integration: For more information check the playground here.

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === XMLHttpRequest.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://host/CCS/API/v1/admin/telsys");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
data = JSON.stringify('{
  "Description": "Test Teams",  
  "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
  "Tags": "",
  "BillingTag": "",
  "Billable": true,
  "TrialEnabled": false,
  "ManageUserMFA": false,
  "TelSysType": "Webex Calling",
  "CallControlOptions": "",
  "OmniChannelPermitted": false,
  "LicensedForRptUserType": "",
  "DeleteACDAgentsOnLicenseDowngrade": null,
  "IPAddrOrHost1": "",
  "IPAddrOrHost2": "",
  "TCPPort1": "",
  "AuthUserID1": "C9b9409442f99c7814550ba032382fdaaa8f1ad3836d0c241c3b4d4025e4d02a5",
  "AuthPassword1": null,
  "TCPPort2": "",
  "UseSSLTLS2": false,
  "AuthUserID2": "",
  "AuthPassword2": null,
  "AuthPassword2OAuthSessionID": null,
  "IPAddrOrHost3": "",
  "AuthUserID3": "",
  "AuthPassword3": null,
  "IPAddrOrHost4": "",
  "TCPPort4": "",
  "UseSSLTLS4": false,
  "AuthUserID4": "",
  "AuthPassword4": null,
  "XSPServer": "",
  "CommsParameter1": "",
  "CommsParameter2": "",
  "CommsEnabled": true,
  "MonitoringEnabled": false,
  "TimeZone": "Europe/London",
  "CountryCode": 44,
  "InternalDigitLen": 4,
  "TelNoPrefixes": "106",
  "CallRecIntIDDefault": "d7ae7ea9bf56ebdc:-53beea96:1556d0e14d3:-8000",
  "SyncNow": false,
  "AddExtsAgents": false,
  "ECCRReplacement": false,
  "TelSysProfileID": "",
  "Advanced": {
    "PartitionCountMax": 80,
    "CTILogIncClassNames": false,
    "InternalDiagDumpEnabled": false,
    "CallModelDiagDumpEnabledForCalls": false,
    "CTILogEnabled": false,
    "PartitionsRptingScopeAllEnabled": false,
    "CallModelDiagDumpEnabledForDev": "",
    "CTICallModelLogEnabled": false,
    "UserNotificationsEnabled": false,
    "ExtensionsPerEnterpriseUser": 50
  }
})';
xhr.send(data);

# Change

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{id}

URL Specs	Description
`protocol`	`HTTPS` is only supported protocol for API as it uses Basic authentication.
`host`	Your service instance host.
`method`	`PUT`

# Headers

Key	Sample Value	Description
`Content-Type`	`application/json`	Content type of the request body.
`Cookie`	`JSESSIONID=<session_id>;`	JSessionID for the authentication request. Its optional, if x-api-key is provided.
`x-api-key`	`<api_key>`	API Key for the authentication request. Its optional, if cookie with JSessionID provided.

Note: Either Cookie or x-api-key header is required for authentication.

# Path Parameters:

Key	Sample Value	Description
`id`	`389'	telsys ID

# Query Parameters:

This request does not require query parameters.

# Request Body

This request contains the changed fields of the TelSys to be updated. ( for example - Description updated in this change request)

{
  "TelSysID": 431,
  "Description": "test CXI Updated New",
  "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
  "Tags": "Rest",
  "BillingTag": "",
  "Billable": true,
  "TrialEnabled": null,
  "ManageUserMFA": false,
  "TelSysType": "Simulator",
  "ManualRTQueuesEnabled": false,
  "CallControlOptions": "Webex Calling",
  "OmniChannelPermitted": false,
  "LicensedForRptUserType": "Akixi 2000",
  "DeleteACDAgentsOnLicenseDowngrade": null,
  "IPAddrOrHost1": "",
  "IPAddrOrHost2": "",
  "AuthUserID1": "",
  "AuthPassword1": null,
  "UseSSLTLS2": false,
  "AuthUserID2": "",
  "AuthPassword2": null,
  "AuthPassword2OAuthSessionID": null,
  "IPAddrOrHost3": "",
  "AuthUserID3": "",
  "AuthPassword3": null,
  "IPAddrOrHost4": "",
  "UseSSLTLS4": false,
  "AuthUserID4": "",
  "AuthPassword4": null,
  "XSPServer": "",
  "CommsParameter1": "",
  "CommsParameter2": "",
  "CommsEnabled": true,
  "MonitoringEnabled": false,
  "TimeZone": "Europe/London",
  "CountryCode": "44",
  "InternalDigitLen": 4,
  "TelNoPrefixes": "9",
  "CallRecIntIDDefault": "d7ae7ea9bf56ebdc:-3f5d0705:1559c8e762d:-8000",
  "SyncNow": false,
  "AddExtsAgents": false,
  "ECCRReplacement": false,
  "TelSysProfileID": "",
  "Advanced": {
    "PartitionCountMax": 80,
    "CTILogIncClassNames": false,
    "InternalDiagDumpEnabled": false,
    "CallModelDiagDumpEnabledForCalls": false,
    "CTILogEnabled": false,
    "PartitionsRptingScopeAllEnabled": false,
    "CallModelDiagDumpEnabledForDev": "",
    "CTICallModelLogEnabled": false,
    "UserNotificationsEnabled": false,
    "ExtensionsPerEnterpriseUser": 50,
    "ScheduledReportsPerUser": 15,
    "EmailsPerScheduledReport": 20
  }
}

# Response

The response contains a status code.

# Success

With 204 No Content HTTP Status Code.

# Error

For more information about the error codes see : here.

# Field Descriptions:

For more information on field descriptions, see here.

# Code Snippets

See the following code snippets to help you start with the integration: For more information check the playground here.

var data = null;
var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === XMLHttpRequest.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://host/CCS/API/v1/admin/telsys/{id}");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
data = JSON.stringify('{
  "TelSysID": 431,
  "Description": "test CXI Updated New",
  "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
  "Tags": "Rest",
  "BillingTag": "",
  "Billable": true,
  "TrialEnabled": null,
  "ManageUserMFA": false,
  "TelSysType": "Simulator",
  "ManualRTQueuesEnabled": false,
  "CallControlOptions": "Webex Calling",
  "OmniChannelPermitted": false,
  "LicensedForRptUserType": "Akixi 2000",
  "DeleteACDAgentsOnLicenseDowngrade": null,
  "IPAddrOrHost1": "",
  "IPAddrOrHost2": "",
  "AuthUserID1": "",
  "AuthPassword1": null,
  "UseSSLTLS2": false,
  "AuthUserID2": "",
  "AuthPassword2": null,
  "AuthPassword2OAuthSessionID": null,
  "IPAddrOrHost3": "",
  "AuthUserID3": "",
  "AuthPassword3": null,
  "IPAddrOrHost4": "",
  "UseSSLTLS4": false,
  "AuthUserID4": "",
  "AuthPassword4": null,
  "XSPServer": "",
  "CommsParameter1": "",
  "CommsParameter2": "",
  "CommsEnabled": true,
  "MonitoringEnabled": false,
  "TimeZone": "Europe/London",
  "CountryCode": "44",
  "InternalDigitLen": 4,
  "TelNoPrefixes": "9",
  "CallRecIntIDDefault": "d7ae7ea9bf56ebdc:-3f5d0705:1559c8e762d:-8000",
  "SyncNow": false,
  "AddExtsAgents": false,
  "ECCRReplacement": false,
  "TelSysProfileID": "",
  "Advanced": {
    "PartitionCountMax": 80,
    "CTILogIncClassNames": false,
    "InternalDiagDumpEnabled": false,
    "CallModelDiagDumpEnabledForCalls": false,
    "CTILogEnabled": false,
    "PartitionsRptingScopeAllEnabled": false,
    "CallModelDiagDumpEnabledForDev": "",
    "CTICallModelLogEnabled": false,
    "UserNotificationsEnabled": false,
    "ExtensionsPerEnterpriseUser": 50,
    "ScheduledReportsPerUser": 15,
    "EmailsPerScheduledReport": 20
  }
}');
xhr.send(data);

# Delete

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{id}

URL Specs	Description
`protocol`	`HTTPS` is only supported protocol for API as it uses Basic authentication.
`host`	Your service instance host.
`method`	`DELETE`

# Headers

Key	Sample Value	Description
`Content-Type`	`application/json`	Content type of the request body.
`Cookie`	`JSESSIONID=<session_id>;`	JSessionID for the authentication request. Its optional, if x-api-key is provided.
`x-api-key`	`<api_key>`	API Key for the authentication request. Its optional, if cookie with JSessionID provided.

Note: Either Cookie or x-api-key header is required for authentication.

# Path Parameters:

Key	Sample Value	Description
`id`	`389'	telsys id to delete the telsys.

# Query Parameters:

This request does not require query parameters.

# Request Body

This request does not require a body.

# Response

The response contains a status code.

# Success

With 204 No Content HTTP Status Code.

# Error

For more information about the error codes see : here.

# Field Descriptions:

For more information on field descriptions, see here.

# Code Snippets

See the following code snippets to help you start with the integration: For more information check the playground here.

# List

TelSysList operation can be used to list all Telephony Server components that are configured against a certain Administrative account.

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys

URL Specs	Description
`protocol`	`HTTPS` is only supported protocol for API as it uses Basic authentication.
`host`	Your service instance host.
`method`	`GET`

# Headers

Key	Sample Value	Description
`Content-Type`	`application/json`	Content type of the request body.
`Cookie`	`JSESSIONID=<session_id>;`	JSessionID for the authentication request. Its optional, if x-api-key is provided.
`x-api-key`	`<api_key>`	API Key for the authentication request. Its optional, if cookie with JSessionID provided.

Note: Either Cookie or x-api-key header is required for authentication.

# Path Parameters:

This request does not require query parameters.

# Query Parameters:

Key	Sample Value	Description
`telSysFields`	[TelSysID, Description, TelSysTypeID, CommsStatus, Tags]	`Comma separated list of fields needs to be included in the response.`
`SearchQuery`	`Demo`	`Optional query parameter to query against Telephony Server's TelSysID value or Description and filter the response.`
`offset`	`0`	`The number of telephone systems to skip (i.e. which telephone system in the list to start from, zero index). Only used if "limit" parameter is also specified.`
`limit`	`25`	`The number of telephone systems to return. Only used if "offset" parameter is also specified.`
`filterByIntegrationMode`	`CXA Real-time + CXI`	`Optional comma separated list of Telephony Server's integration modes to filter on.`

# Request Body

This request does not require a body. `

# Response

The response contains a list of telsys configured under CME.

# Success

With 200 HTTP Status Code.

{
    "Data": {
        "Items": [
            {
                "TelSysID": 1,
                "TelSysTypeID": 7,
                "Description": "Demo"
            },
            {
                "TelSysID": 2,
                "TelSysTypeID": 30,
                "Description": "Demo MS Teams ."
            },
            {
                "TelSysID": 4,
                "TelSysTypeID": 1,
                "Description": "Demo New"
            },
            {
                "TelSysID": 5,
                "TelSysTypeID": 5,
                "Description": "Demo New 1"
            },
            {
                "TelSysID": 72,
                "TelSysTypeID": 5,
                "Description": "MS Team Test 2 %%% +123456"
            },
            {
                "TelSysID": 3,
                "TelSysTypeID": 7,
                "Description": "telsys - testing-9319"
            },
            {
                "TelSysID": 6,
                "TelSysTypeID": 15,
                "Description": "Test 9551"
            },
            {
                "TelSysID": 7,
                "TelSysTypeID": 1,
                "Description": "Test Again 9551"
            }
        ]
    },
    "Result": "Success"
}

For more information on error codes, see Error Codes.

# Field Descriptions:

For more information on field descriptions, see Field Descriptions.

# Code Snippets

See the following code snippets to help you start with the integration: For more information check the playground here.

# Info

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{id}

URL Specs	Description
`protocol`	`HTTPS` is only supported protocol for API as it uses Basic authentication.
`host`	Your service instance host.
`method`	`GET`

# Headers

Key	Sample Value	Description
`Content-Type`	`application/json`	Content type of the request body.
`Cookie`	`JSESSIONID=<session_id>;`	JSessionID for the authentication request. Its optional, if x-api-key is provided.
`x-api-key`	`<api_key>`	API Key for the authentication request. Its optional, if cookie with JSessionID provided.

Note: Either Cookie or x-api-key header is required for authentication.

# Path Parameters:

Key	Sample Value	Description
`id`	`389'	telsys ID

# Query Parameters:

This request does not require query parameters.

# Request Body

There is no request body required for this request.

# Response

The response contains the details of the given telsys id.

# Success

With 200 HTTP Status Code.


{
    "Result": "Success",
    "Data": {
        "MonitoringEnabled": false,
        "Advanced": {
            "CTILogIncClassNames": false,
            "ExtensionsPerEnterpriseUser": 50,
            "UserNotificationsEnabled": false,
            "CallModelDiagDumpEnabledForCalls": false,
            "MaximumAllowedUsersMonitored": 600,
            "InternalDiagDumpEnabled": false,
            "MaximumAllowedUsersSync": 3000,
            "CTILogEnabled": false,
            "PartitionsRptingScopeAllEnabled": false,
            "CallModelDiagDumpEnabledForDev": null,
            "PartitionCountMax": 80,
            "CTICallModelLogEnabled": false
        },
        "Description": "Test Telsys Simal 2",
        "CommsEnabled": false,
        "InternalDigitLen": 4,
        "CommsStatus": "Communication Disabled",
        "CXIAccessCode": "",
        "AppDownloadURL": "https://native.prd.mst.akixi.com/static/downloads/akixi-native-app.zip",
        "TelNoPrefixes": null,
        "LicenseCapManagement": {
            "EssentialsCap": null,
            "CallCentreSupervisorCap": null,
            "EnterpriseCap": null,
            "CXIntegrationCap": null,
            "CallCentreAgentCap": null
        },
        "TelSysType": "MS Teams",
        "CountryCode": "44",
        "CommsLogs": [
            "Communication Disabled. "
        ],
        "Tags": "Rest",
        "TelSysID": 389,
        "CommsParameter1": "e3a46007-31cb-4529-b8cc-1e59b97ebdbjJhf",
        "Billable": true,
        "SyncStatus": null,
        "RemainingTrialPeriod": null,
        "CallRecIntIDDefault": "d7ae7ea9bf56ebdc:-53beea96:1556d0e14d3:-8000",
        "E164Enabled": true,
        "AuthPassword1Provided": false,
        "TimeZone": "Europe/London",
        "AuthUserID1": "test@test.com",
        "BillingTag": null,
        "AuthUserID2": null,
        "AuthPassword2Provided": false,
        "LastErrorCode": 4,
        "HistoricOnly": false,
        "CMEnvironmentID": "1c494ce9c284bf17:7db3ab97:1981d6def1e:-791a",
        "CommsParameter2": null,
        "ManageUserMFA": false,
        "IntegrationMode": "CXA Real-time + CXI",
        "PartitionLicences": [
            "Enterprise"
        ]
    }
}

# Error

For more information on error codes, see Error Codes.

# Field Descriptions

For more information on field descriptions, see Field Descriptions.

# Code Snippets

See the following code snippets to help you start with the integration: For more information check the playground here.

# Error Codes

For more information on general error codes, see Error Codes

Error Code	Error Message	Description
11010	Invalid or no telephony server type specified.	Specify a correct telephony platform type value. Refer to the TelSysType Property for more information on the supported values.
11011	The telephone system identifier value was invalid or out of the allowable range.	Specify a correct Telephony Server identifier value. The value is always a positive integer number. Refer to the TelSysID Property for further information.
11012	The telephone system identifier value was not specified or invalid.	Specify a correct Telephony Server identifier value. The value is always a positive integer number. Refer to the TelSysID Property for further information.
11013	The telephone system with identifier 'Identifier' not found.	An existing Akixi Telephony Server configuration component could not be found matching the TelSysID Property value given with the corresponding API request. Specify a component identifier value that represents an existing Akixi Telephony Server configuration entry.
11014	The telephone system with identifier 'Identifier' already exists.	Specify a unique identifier value for the new Telephony Server component. The value is always a positive integer number and is automatically assigned for newly added Telephony Server entries if the TelSysID Property is left empty.
11020	Unable to delete telephone system entry 'Identifier' because it is still configured to be "in service".	Only inactive Telephony Server components can be deleted. Therefore, you must ensure that the CommsEnabled Property of the designated Telephony Server entry is set to False by invoking a TelSysChange operation first.
11021	The telephony server type is not allowed by the CME.	The enclosing CME does not allow this type of Telephony Server to be created. Select a different type, or change the restriction in the CME.
11022	The telephony server can't be created as it would exceed the maximum count set in the CME.	The enclosing CME imposes a limit on the number of Telephony Servers that can be created within it. Remove obsolete Telephony Servers, if there are any, or change the restriction in the CME.
11023	Teams Auth Email already in use	The Teams Auth Email must be unique across all Telephony Servers. Specify a different Teams Auth Email that is not already in use.
11024	The default MS Teams partition could not be created.	If this error occurs, report it to your Akixi Service Administrator or Application Provider.
11025	The Default user creation failed	If this error occurs, report it to your Akixi Service Administrator or Application Provider.
11026	Telephone system type is not allowed by the parent CME.	The enclosing CME does not allow this type of Telephony Server to be created. Select a different type, or change the restriction in the CME.
11027	Too many telephone systems in CME	The enclosing CME imposes a limit on the number of Telephony Servers that can be created within it. Remove obsolete Telephony Servers, if there are any, or change the restriction in the CME.
11029	Real-time mode is not allowed at this time	The telephony server type does not support real-time mode, or the CME does not allow real-time mode to be enabled. Either select a different telephony server type, or change the restriction in the CME, or disable real-time mode.
11030	Integration mode cannot be changed when telsys is enabled.	The IntegrationMode Property of a Telephony Server component cannot be changed when the CommsEnabled Property is set to True. You must first disable the Telephony Server by setting its CommsEnabled Property to False, before changing its IntegrationMode Property value.
11031	The value of scheduled reports on telsys being changed to is less than the current max value set by a user	The ScheduledReportsMax Property of a Telephony Server component cannot be changed to a value that is less than the current maximum number of scheduled reports configured by any User account that has privileges on the designated Telephony Server. You must first reduce the maximum number of scheduled reports configured by all Users that have privileges on the designated Telephony Server, before changing its ScheduledReportsMax Property value.

# Properties

This section provides a description of the fields used in the Telsys-related endpoints.

# Field Descriptions:

Key	Types	Description
TelSysID	integer	tel sys ID
CMEnvironmentID	character varying	CM Environment ID
TelSysType	character varying	tel sys type
TimeZone	character varying	Time zone
IPAddrOrHost1	character varying	IP address or host 1
IPAddrOrHost2	character varying	IP address or host 2
IPAddrOrHost3	character varying	IP address or host 3
IPAddrOrHost4	character varying	IP address or host 4
TCPPort2	integer	TCP port 2
TCPPort4	integer	TCP port 4
UseSSLTLS2	boolean	Use SSL/TLS 2
UseSSLTLS4	boolean	Use SSL/TLS 4
AuthUserID2	character varying	Auth user ID 2
AuthPassword2	text	Auth password 2
AuthUserID4	character varying	Auth user ID 4
AuthPassword4	text	Auth password 4
CommsParameter1	character varying	Comms parameter 1
CommsParameter2	character varying	Comms parameter 2
CommsEnabled	boolean	Comms enabled
LicensedForRptUserType	integer	Licensed for rpt user type
BillingTag	character varying	Billing tag
TelNoPrefixes	character varying	Tel no prefixes
PartitionCountMax	integer	Partition count max
PartitionsRptScopeAll	boolean	Partitions rpt scope all
InternalDigitLen	integer	Internal digit length
CountryCode	character varying	Country code
ManageUserMFA	boolean	Manage user MFA
XSPServer	character varying	XSP server
Tags	character varying	Tags
CTILogEnabled	boolean	CTI log enabled
CTICallModelLogEnabled	boolean	CTI call model log enabled
InternalDiagDumpEnabled	boolean	Internal diag dump enabled
CTILogIncClassNames	boolean	CTI log inc class names
CallModelDiagDumpEnabledForCalls	boolean	Call model diag dump enabled for calls
CallModelDiagDumpEnabledForDev	boolean	Call model diag dump enabled for dev
PartitionCountMax	integer	Partition count max
PartitionsRptingScopeAllEnabled	boolean	Partitions rpting scope all enabled
UserNotificationsEnabled	boolean	User notifications enabled
Description	character varying	Description
CommsStatus	character varying	Comms status

← Central Management Environments Partition →

# Telephone Systems (Telephony Servers)

# Hosted Telephony Platform Connectivity

# Telephony Server Per BroadWorks Enterprise (Recommended)

# Telephony Server Per BroadWorks Enterprise (Single Partition)

# Single Telephony Server

# PBXs Connectivity

# “Site” Licensing

# Supported Operations

# Telephony Server Request Parameters

# Read-Only Properties After Initial Creation

# Fully Updatable Properties

# Advanced Properties (Advanced Container)

# Add

# Request

# Endpoint

# Headers

# Path Parameters:

# Query Parameters

# Request Body

# Response

# Success

# Error

# Field Descriptions:

# Code Snippets

# Change

# Request

# Endpoint

# Headers

# Path Parameters:

# Query Parameters:

# Request Body

# Response

# Success

# Error

# Field Descriptions:

# Code Snippets

# Delete

# Request

# Endpoint

# Headers

# Path Parameters:

# Query Parameters:

# Request Body

# Response

# Success

# Error

# Field Descriptions:

# Code Snippets

# List

# Request

# Endpoint

# Headers

# Path Parameters:

# Query Parameters:

# Request Body

# Response

# Success

# Field Descriptions:

# Code Snippets

# Info

# Request

# Endpoint

# Headers

# Path Parameters:

# Query Parameters:

# Request Body

# Response

# Success

# Error

# Field Descriptions

# Code Snippets

# Error Codes

# Telephony Server Component Related Error Codes

# Properties

# Field Descriptions: