# Partitions (Tenants)
Partitions allow you to segregate a Telephony Server into multiple areas in order to only allow users specific visibility on certain Devices & ACD Agents when running reports or administering the Akixi Application. Within the Akixi Application, Devices and ACD Agents always belong to a specific Partition (tenant).
Partition entries are the nearest concept within Akixi that defines a “Customer Site”. Due to the fact that each telephony platform environment is configured differently, a Partition can in some deployments be specifically associated with a single sub-site within an enterprise, or conversely associated to an entire large multi-site enterprise.
In the following sub-sections, you will learn how to programmatically create, modify, delete and view Partitions.
# Supported Operations
The list of currently supported Partition operations is provided below. Operations related to Akixi Partition components start with a “Partition” prefix. They will be referred to as “Partition Operations” interchangeably hereafter.
Please note that depending on your assigned Akixi Telephony Server privileges, you may only have access to view & 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 Partition. |
Change | Change an existing Partition. |
Delete | Delete a Partition. |
Info | Get information about a Partition. |
List | List all Partitions configured against a specific Telephony Server. |
# The Common Devices Partition
Whenever a new Telephony Server configuration entry is created, a default common devices Partition (tenant) is always created for it. The common devices Partition is where shared Devices should be created that all Partitions require access to, such as trunk gateway Devices, voice mail etc. The use & your API interaction for the common devices Partition differs slightly depending on whether the type configured against the corresponding owning Telephony Server is set to be for PBX or hosted telephony platforms as follows:
- PBX Environments: For PBX telephony environments, all Devices & ACD Agents are usually created & maintained within the single common devices Partition – no further Partition entries ordinarily need to be created.
- Hosted Environments However for hosted telephony environments, the common devices Partition should only contain the special “pseudo” Devices such as the
[Trunk]
,[Conference]
, etc. Devices, which are required to model certain complex call scenarios where these Devices should never ever be removed. These pseudo Devices are created by default. The common devices Partition should also not require any further provisioning interaction on hosted environments, either manually invoked or programmatically via the Web Services API.
Note
Note: The common devices Partition always has a definitive configuration: It’s IsGlobal
Property value is always set to True and the PartIDInTelSys
Property’s value is also 0. Note that ordinarily there is absolutely no need to change the zIsGlobal
Property to True
for any other Partition component and doing so is not a supported configuration.
# Partition Usage Strategy
The way that Telephony Server component and Partition are configured to be associated with Customer telephony environments, depends on the particular telephony platform being employed as follows:
# PBX Platforms
Telephony Platform | Component Mapping Strategy Telephony server | Component Mapping Strategy Partition | Description |
---|---|---|---|
Siemens/Unify HiPath | Customer | Common | A dedicated Telephony Server component should be created, where all Devices & ACD Agents are created & maintained within the single common devices Partition. |
Panasonic TDA/NCP | Customer | Common | A dedicated Telephony Server component should be created, where all Devices & ACD Agents are created & maintained within the single common devices Partition. Devices & ACD agent configuration entries excluded from reporting should be added to the device exclusions Partition, which is named "[Excluded Devices Partition] " and also has an associated IDInTelSys value of 1. The device exclusions Partition is always added automatically for newly created Panasonic TDA/NCP Telephony Server components. |
# Hosted Platfroms
Telephony Platform | Component Mapping Strategy Telephony server | Component Mapping Strategy Partition | Description |
---|---|---|---|
Cisco BroadWorks (Recommended Approach) | Enterprise | BroadWorks Group | The recommended method is to create individual Telephony Server entries for each separate BroadWorks Enterprise component, where a distinct Akixi Partition is also created for every BroadWorks Group (i.e. site). |
Cisco BroadWorks (Alternative Option) | System / Provisioning | Enterprise | An alternative option exists for BroadWorks platforms, although it is not recommended when programmatically provisioning the Akixi Service, due to the effective loss of a reporting scope permissions level for individual BroadWorks Group components (this is a requirement that’s often particularly important for large multi-site Customers). In this particular scheme, separate Partition components are created for each discrete BroadWorks Enterprise against one Telephony Server entry that effectively addresses the entire telephony platform, up to maximum of 80 Partitions, after which an additional Telephony Server component should be created accordingly. |
BroadSoft M6 | System | Partition | Mount separate Partition components for each separate Customer on a Telephony Server entry that effectively accesses the entire telephony platform, up to maximum of 80 Partitions, after which an additional Telephony Server component should be created accordingly. |
Demo Simulator | [N/A] | [N/A] | The Akixi Service Partition configuration as well as the Device & ACD Agent entries are automatically created for Telephony Server components configured with the “Simulator” type. |
MS Teams | [TBC] | [TBC] | [TBC] |
# Partition Configuration Synchronisation
A concept called configuration synchronisation can be performed for Partition components on hosted telephony platforms, where the Akixi Service’s Device & ACD Agent configuration is automatically updated by extracting it from the underlying telephony platform. This may be performed on-demand from within the Akixi Service user interface, or programmatically via PartitionAdd
& PartitionChange
requests by also specifically setting the SyncNow
Property to True
.
Note that the configuration synchronisation logic is performed asynchronously as a background task within the Akixi Service server-side, which can take 20s to several minutes to complete, depending on the size of the corresponding Customer telephony environment. The operation also does not “block” the original invoking operation (whether submitted via the user interface or programmatically via the Web Services API), which effectively would have originally updated the corresponding Partition’s SyncNow
Property to True
.
Additionally two types of configuration synchronisation can be performed which depends on the SyncType
Property:
# Soft
Synchronisation
This performs the synchronisation process but without increasing monthly billing charges in any way. The Akixi Service configuration for non-billable Devices such as hunt groups, call centre queues, voice mail applications, automated attendants, etc. are added or updated. The descriptions and/or device numbers are also changed accordingly for existing billable Device & ACD Agent entries, should they be detected as having being modified since the last synchronisation invocation, but no new billable Akixi configuration elements are ever created. The “Soft” synchronisation is performed automatically as well for each Partition once per day out-of-hours, at a randomly chosen time between 10PM and 5AM.
# Full
and One-Time Full
Synchronisation
An incremental billing-affecting synchronisation operation is performed where all Devices & ACD Agents existing within the underlying telephony platform are all added and/or updated into the Akixi Service configuration.
For BroadSoft BroadWorks platforms, SyncOptions can be used to restrict the billable items that may be created by a Full Synchronisation. The flag values are normally all ON, but setting any of them OFF will prevent that type of device from being created. The types are: Extensions(Endpoints)
, Extensions(Trunking)
and Agents
. These should be combined using commas to separate them. At least one flag must be enabled; to disable all types, request a Soft
synchronisation type instead.
Note that the ACD Agents option, if enabled, will mean that Extensions and SIP Trunk Users will be created if they are needed by the agents, even if the 'Extensions(Endpoints)' and/or 'Extensions(Trunking)' options are OFF.
It is not recommended to programmatically invoke the full synchronisation using PartitionAdd
or PartitionChange
operations, since all Device/Agent items would get added regardless, where the associated Customer may not want to pay for reporting data collection across all those elements anyway. Instead, you should programmatically add the Akixi Service billing affecting extension Device & ACD Agent configuration using other WS API operations as required.
# Is the above descrption same for MS teams as well?
# Force Monitored
The ForceMonitored
setting can be used to enforce all the devices and agent that are in unmonitored status to monitored status. When the device or agent is in unmonitored status, they are not monitored by Akixi reporting.
The ForceMonitored
setting is only applicable for Cisco BroadWorks
, WebEx Calling
and MS Teams
. It can have effect only if it is used with Full
or One-Time Full
sync types.
Note
There are also a number of very rare configuration change use cases that can occur in the BroadWorks hosted telephony platform environments which can occasionally cause billable Devices to be automatically deleted in Partition synchronisation operations, whether “Soft” or “Full”: This is when the BroadWorks UserID or main public telephone number of a BroadWorks-side extension user configuration is “recycled” and then subsequently utilised/assigned against a different virtual device/subscriber like a hunt group, call centre queue, automated attendant, etc. Additionally, whenever the Identity/Device profile (i.e. Line/Port settings area under Profile Addresses) is removed against a BroadWorks extension user in order to make it a simple public number mount point within the underlying platform, this also causes the extension device within the Akixi Service to be deleted and a DNIS device entry to be created instead, which is not billable.
Accordingly, Partition synchronisation operations can therefore potentially cause monthly billing charges to be reduced for the corresponding Customer. Billing charges are never increased though for the soft synchronisation variant specifically.
Also
For Panasonic NCP telephone system environments, configuration synchronisation is actually supported but at the Telephony Server component level, through the use of its SyncNow
Property. However, there is no corresponding equivalent of the SyncType
Property against Telephony Server entries. Instead, extension Devices & ACD Agents that the corresponding Customer does not wish to pay reporting data capture billing charges for, should be instead added to the “[Excluded Devices Partition]
” Partition.
# Partition Request Parameters
As previously mentioned, some PartitionAdd
& PartitionChange
parameters are telephony platform-specific - therefore, you must be entirely sure that your request includes all parameters required to create and/or modify a Partition for the telephony platform type set against the corresponding Partition’s owning Telephony Server component.
Please note that you cannot add further Partition entries when the maximum number of allowed Partitions has already been reached for the owning Telephony Server, as defined by its PartitionCountMax
setting within the TelSysAdd
/TelSysChange
requests. When this occurs, you should create a brand-new Telephony Server entry in order to add newly created Partitions under.
Parameters used within PartitionAdd
and PartitionChange
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 Partition
parameters, please refer to the “Partition Properties” sub-section.
# Read-Only Properties After Initial Creation
Parameter Name | Cisco Broadworks | Broadsoft M6 | Siemens/Unify HiPath3000 | Panasonic TDA/NCP | Demo Simulator | MS Teams | WebEx Calling |
---|---|---|---|---|---|---|---|
PartIDInTelSys | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
TelSysID | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
PartitionGUID | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Parameter PartIDInTelSys
This is the identifier of the tenant or sub-telephony environment, which uniquely distinguishes it within the owning Akixi Telephony Server component. If the Property is not given when creating new Partition components, an appropriate number is automatically assigned by the Akixi Service. The Property cannot be changed for Partition components after creation. When creating Partition configuration programmatically via the WS API, it is recommended that external systems maintain & track their own value for the next available PartIDInTelSys Property starting from a value of 1, incrementing it whenever a new Partition is created and specifically assigned the last (pre-incremented) value.
Parameter PartitionGUID
The PartitionGUID value is automatically generated by Akixi server-side logic. Therefore, in most cases you must not include this parameter when you generate & send a PartitionAdd request. You should only use this parameter if you have been specifically asked to do so by the Akixi Service Application Provider.
# Fully Updatable Properties
Parameter Name | Cisco Broadworks | WebEx Calling | Broadsoft M6 | Siemens/Unify HiPath3000 | Panasonic TDA/NCP | Demo Simulator | MS Teams |
---|---|---|---|---|---|---|---|
Description | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
BillingTag | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
TimeZone | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
StartOfDay | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
CommsEnabled | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
IsGlobal | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
CTILogEnabled | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ | ✅ |
CountryCode | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ | ✅ |
TelSysComponentType | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
IDOnTelSys | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ |
IDOnTelSysOwner | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
NameOnTelSys | ❌ | ❌ | ✅ | ❌ | ❌ | ❌ | ❌ |
LicensedForRptUserType | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |
InternalDigitLen | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |
CountryCode | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |
TrunkCapacity | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
TrunkCapacityBurst | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
SyncNow | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |
SyncType | ✅ | ✅ | ✅ | ❌ | ❌ | ❌ | ✅ |
SyncOptions | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ |
SynchroniseSupervisorPermissions | ✅ | ❌ | ❌ | ❌ | ❌ | ❌ | ❌ |
MaintainParity | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |
ForceMonitored | ✅ | ✅ | ❌ | ❌ | ❌ | ❌ | ✅ |
DeleteACDAgentsOnLicenseDowngrade | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
AutoDeleteUsers | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
Parameter IsGlobal
The IsGlobal Property may only be set to a value of True for the common devices Partition, which must also always have a PartIDInTelSys Property value of 0. Note that ordinarily there is absolutely no need to change the IsGlobal Property.
# Add
Partition components are added via the PartitionAdd
request. The main purpose of this request is to effectively create a new reporting scope container.
Additionally on hosted telephony platforms, configurational parameters must also be specified that explicitly depict the Customer environment on the underlying telephony platform itself that real-time reporting call & ACD state data will be collected for.
For example on BroadSoft M6 environments, the NameOnTelSys
Property should be exactly specified (with matching character case and whitespace usage) as the name of the corresponding partition/tenant within the underlying telephone platform configuration. Alternatively the IDOnTelSys parameter can be set instead to the M6 partition’s OID value, which is 6 multiples of 16 bit (word) values encoded as hex text separated by a full-stop character (e.g. “0000.feda.eda9.da98.a987.9876
”). The InternalDigitLe
n Property should also be set to a number that represents the internal digit length used when dialling devices internally – this is usually a value of 3
or 4
.
For Cisco BroadWorks® platforms, the IDOnTelSysOwner
value should be set as the BroadWorks EnterpriseID for the corresponding Customer. Additionally when the TelSysComponentType
parameter depicts the Enterprise Group mapping (the “BroadWorks Enterprise Group” value), then the IDOnTelSys
parameter should also contain the BroadWorks Enterprise GroupID value for the corresponding site. The InternalDigitLen
Property should also be set to a number that represents the internal digit length used when dialling devices internally – this is usually a value of 3
or 4
.
# Request
# Endpoint
https://host/CCS/API/v1/admin/telsys/{telSysID}/partition
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
Key | Sample Value | Description |
---|---|---|
telSysID | 6 | telSys ID |
# Query Parameters
This request does not require any query parameters.
# Request Body
This request requires a body contains to create a new Partition.
{
"EmailAddr": "insights.test9@akixi.com",
"Advanced": {
"PromptForTerms": false
},
"PasswordChgRequired": false,
"SendWelcomeEmail": false,
"Scope": {
"TelSysID": [-1],
"ReportingAccess": "Akixi 2000",
"AgentNumber": "All",
"ReportReadOnly": false,
"DeviceNumber": "All",
"CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
"Admin": false,
"PartIDInTelSys": [-1]
},
"Username": "Akixi Insights Customer Reports Test9",
"DefaultLang": "en_GB",
"FullName": "Akixi Insights Customer Reports Test9",
"Permissions": {
"NonAdmin": [
"Report|Create",
"Report|Read",
"Report|Update",
"Report|Delete"
]
},
"LockOut": false
}
# Response
The response contains the status code and message body.
# Success
With HTTP status code 201 Created
indicates that the request was successful and the partition was created.
{
"Result": "Success",
"Data": {
"PartitionGUID": "69a93ba59d7c0861:-6ae3f43b:198f08a6484:-5a50",
"PartIDInTelSys": 2
}
}
# 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.
# Change
Partitions are changed via PartitionChange
request.
# Request
To change an existing Partition component, one needs to specify its corresponding identifier value(s), which can be done in two different ways:
- By providing the
TelSysID
andPartIDInTelSys
parameters. - By providing a
PartitionGUID
parameter.
# Endpoint
Update the partition by Partition ID in Telephone system and Telephone system ID.
https://host/CCS/API/v1/admin/telsys/{id}/partition/{partIdInTelSys}
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 |
---|---|---|
telSysID | 1 | telSys ID |
partIdInTelSys | 1 | Partition ID in Telephone system |
# Query Parameters
This request does not require any query parameters.
# Endpoint
Update the partition by Partition GUID.
https://host/CCS/API/v1/admin/partition/{partitionGUID}
# Path Parameters
Key | Sample Value | Description |
---|---|---|
partitionGUID | dd0e6767f361ab4d:3983977b:1965ccdabcb:-7ff6 | Partition GUID |
# Query Parameters
This request doesn't require any query parameters.
# Request Body
This request requires a body contains to change an existing Partition.
{
"TelSysID": 1,
"SyncNow": false,
"Description": "Organisation",
"CommsEnabled": true,
"StartOfDay": "00:00:00",
"InternalDigitLen": 4,
"PartIDInTelSys": 1,
"TrunkCapacityBurst": 0,
"TimeZone": "Europe/Prague",
"MaintainParity": true,
"CTILogEnabled": false,
"SyncType": 1,
"LicensedForRptUserType": "Akixi 3000",
"TrunkCapacity": 0,
"CountryCode": "44",
"IsGlobal": false
}
# Response
# Success
With HTTP status code 204 No Content
indicates that the request was successful and the partition is updated.
# 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.
# Delete
Akixi Service Partition components can be removed via PartitionDelete
requests. Please note that you cannot delete Partition entries unless they are configured to be "out-of-service" by ensuring that their CommsEnabled
parameter is specifically set to False
(e.g. by submitting appropriate PartitionChange
request(s) first).
Warning
Deleting a Partition entry automatically deletes all of its owned devices and agents configuration items. Additionally, any previously recorded historic call & ACD activity for the deleted Partition(s) can no longer be reported on either.
Unless specifically directed to by your System or Application Provider, you should be particularly careful not to delete the default common devices Partition containing the special Devices such as the [Trunk]
, [Conference]
, etc. entries, which are required to model certain call scenarios on most telephony platforms and should never ever be removed.
# Request
PartitionDelete
requests are quite minimalistic. In order to delete a Partition, you must simply specify its identifier value(s), similar to PartitionChange
requests. This can be done in two ways:
- By providing the
TelSysID
andPartIDInTelSys
parameters. - By providing a
PartitionGUID
parameter.
# Endpoint
Delete the partition by Partition ID in Telephone system and Telephone system ID.
https://host/CCS/API/v1/admin/telsys/{id}/partition/{partIdInTelSys}
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 |
---|---|---|
telSysID | 1 | telSys ID |
partIdInTelSys | 1 | Partition ID in Telephone system |
# Query Parameters
This request does not require any query parameters.
# Endpoint
Delete the partition by Partition GUID
https://host/CCS/API/v1/admin/partition/{partitionGUID}
# Path Parameters
Key | Sample Value | Description |
---|---|---|
partitionGUID | dd0e6767f361ab4d:3983977b:1965ccdabcb:-7ff6 | Partition GUID |
# Query Parameters
This request does not require any query parameters.
# Request Body
This request does not require a body.
# Response
# Success
With HTTP status code 204 No Content
indicates that the request was successful and the partition is deleted.
# 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
The PartitionList
operation can be used to list all Partitions that are configured against a certain Telephony Server component within the Akixi Service.
# Request
By default, the body of PartitionList
requests is quite minimalistic: you can simply specify the Telephony Server Identifier in order to obtain the list of all underlying Partitions (as well as some commonly used Partition-related parameter values).
If you want to list parameters that are not returned when you invoke a default “minimalistic” request, you can request additional values via PartitionFields
Property. If you want to only list Partitions containing a specific PartIDInTelSys
or Description
, you can request for it via SearchQuery
Payload Property.
The Offset
and Limit
parameters can also be specified to request a specific subsection of the listed entries (if not specified these values are assumed to be 0 and 1000 respectively).
Offset
defines how many entries to skip over (i.e. which entry to start on if the first entry is entry 0) and Limit
defines how many entries to retrieve:
# Endpoint
List the partition by Telephone system ID.
https://host/CCS/API/v1/admin/telsys/{id}/partition
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 |
---|---|---|
telSysID | 1 | telSys ID |
# Query Parameters
This request does not require any query parameters.
# Request Body
This request does not require a body.
# Response
The response contains the status code and message body.
# Success
With HTTP status code 200 OK
indicates that the request was successful and the partition list is fetched.
{
"Result": "Success",
"Data": {
"Items": [
{
"PartIDInTelSys": 0,
"Description": "[Common Devices Partition]"
},
{
"PartIDInTelSys": 1,
"Description": "Organisation"
},
{
"PartIDInTelSys": 2,
"Description": "two"
}
]
}
}
# 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.
# Info
The PartitionInfo
request can be used in order to obtain information related to a certain specific Partition component.
# Request
# Endpoint
API endpoint to get partition by PartIdInTelSys in given Telephone system.
https://host/CCS/API//v1/admin/telsys/{telSysID}/partition/{partIdInTelSys}
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 |
---|---|---|
telSysID | 1 | telSys ID |
partIdInTelSys | 1 | Partition ID in Telephone system |
API endpoint to fetch a partition by Partition GUID.
https://host/CCS/API//v1/admin/telsys/{telSysID}/partition/{partitionGUID}
# Path Parameters
Key | Sample Value | Description |
---|---|---|
telSysID | 1 | telSys ID |
partitionGUID | dd0e6767f361ab4d:3983977b:1965ccdabcb:-7ff6 | Partition GUID |
# Query Parameters
This request does not require any query parameters.
# Request Body
This request does not require a body.
# Response
This response contains the partition information for the given identifier and telSys ID.
# Success
With HTTP status code 200 OK
indicates that the request was successful and the partition info fetched.
{
"Result": "Success",
"Data": {
"SyncNow": false,
"Description": "Demo Partition",
"CommsEnabled": true,
"StartOfDay": "00:00:00",
"InternalDigitLen": 4,
"ForceMonitored": false,
"CommsStatus": "Communication Inactive",
"IDOnTelSys": null,
"PhotoSyncNow": false,
"PartIDInTelSys": 1,
"TrunkCapacityBurst": 0,
"PartitionGUID": "dd0e6767f361ab4d:3983977b:1965ccdabcb:-7ff6",
"CTILogEnabled": true,
"BilledMonthly": false,
"LicensedForRptUserType": "Akixi 2000",
"CountryCode": "44",
"TelSysID": 1,
"IDOnTelSysOwner": "Demo",
"SynchroniseSupervisorPermissions": false,
"TimeZone": "Europe/London",
"TelSysComponentType": "BroadWorks ServiceProvider",
"MaintainParity": false,
"BillingTag": null,
"SyncOptions": 7,
"SyncType": 1,
"TrunkCapacity": 0,
"IsGlobal": false
}
}
# 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.
# Error Codes
For more information on general error codes, see Error Codes
# Partition Related Error Codes
Error Code | Error Message | Description |
---|---|---|
11110 | The partition with identifier 'Identifier' not found. | Specify a correct Partition identifier value (see the PartitionGUID Property). The value is usually a long text value containing around 40 characters of content length. |
11111 | The partition with identifier 'Identifier' already exists. | This error occurs if the specified PartitionGUID Property value is deliberately specified and a Partition with the same GUID identifier already exists attached to any other Telephony Server component within the Akixi Service. Note that Partition identifier values are automatically generated by the Akixi server-side logic if not specified within PartitionAdd requests. The recommended practice is to only specify this parameter if you have been specifically asked to do so by your Application Provider, when reconstructing an Akixi Service configuration for previously erroneously deleted elements. |
11112 | The partition with identifier 'Identifier' already exists against the same telephone system. | The PartIDInTelSys Property value that is specified in the request is already assigned to a different Partition within the owning Telephony Server component. Specify a new value that is not assigned to any other existing Partition. Note that Partition identifier values are automatically generated by the Akixi server-side logic if not specified within PartitionAdd requests. |
11113 | The partition identifier value within telephone system was invalid or out of the allowable range. | Specify a correct PartIDInTelSys Property value. The value is always a positive integer number. |
11114 | The maximum number of ‘n’ allowed partitions entries has already been reached for the specified Telephony Server. | You cannot add further Partition entries when the maximum number of allowed Partitions has already been reached for the designated Telephony Server component, as defined by its PartitionCountMax setting within the TelSysAdd & TelSysChange requests. When this occurs, you should create a brand-new Telephony Server component entry to add Partitions to. |
11115 | The telephone system component type has not been specified or is invalid. | Specify a correct telephony platform component type mapping within the TelSysComponentType Property. |
11120 | IDOnTelSysOwner value not specified which is mandatory for BroadWorks telephone platform and the field corresponds to an Enterprise ID or a Service Provider ID. | Provide an appropriate IDOnTelSysOwner value, which is required for Cisco BroadWorks telephony platform environments. The value should be set to the identifier of the BroadWorks Enterprise or Service Provider component that the associated Customer telephony environment is configured within the telephony platform itself. Note that the Enterprise or Service Provider identifier should be entered in without the domain name (i.e. unqualified). |
11121 | IDOnTelSys value not specified which is mandatory for BroadWorks telephone platform for "Enterprise Group"/"Service Provider Group" component types. The field corresponds to "Group ID" within BroadWorks telephone platform. | Provide an appropriate IDOnTelSys Property value, which is required for Cisco BroadWorks telephony platform environments when the TelSysComponentType Property is set with the values “BroadWorks Enterprise Group” or “BroadWorks ServiceProvider Group”. The value corresponds to the identifier of BroadWorks Enterprise Group component or Service Provider Group component (respectively) within the underlying telephony platform configuration. |
11122 | There is already an existing partition with an 'IDOnTelSysOwner' field value of 'Value'. This field should match the identifier of the telephone system configuration entity that owns the corresponding partition within the physical telephony platform's configuration. | The same IDOnTelSysOwner Property value is already specified for another Partition within the owning Akixi Telephony Server component. Provide a value that is not specified against any other Partition. |
11123 | There is already an existing partition with an 'IDOnTelSys' field value of 'Value'. This field should match the identifier of the partition within the actual configuration of the physical Telephony Server component but can be empty for some telephony server types. | The same IDOnTelSys Property value is already specified for another Partition within the owning Akixi Telephony Server component. Provide a value that is not specified against any other Partition. |
11124 | There is already an existing partition with an existing 'NameOnTelSys' field value of 'Value'. This field should match the name of the partition within the actual configuration of the physical Telephony Server component but can be empty for some telephony server types. | The same NameOnTelSys Property value is already specified for another Partition within the owning Akixi Telephony Server component. Provide a value that is not specified against any other Partition. |
11130 | Either a valid PartitionGUID value or a valid combination of TelSysID and PartIDInTelSys values must be specified in order to identify a partition. | To identify a Partition, either specify its PartitionGUID value alone, or both Partition’s TelSysID & PartIDInTelSys Properties together. |
11131 | The partition with identifier 'Identifier' not found within the specified telephone system. | Specify a Partition number in the PartIDInTelSys Property that represents an existing entry within the Telephony Server component specifically identified by the TelSysID Property. |
11140 | Unable to delete the specified partition because it is still configured to be "in service". | Only inactive Partitions can be deleted. Therefore, you must ensure that the CommsEnabled parameter of the designated Partition component is set to False by invoking a PartitionChange operation first. |
11141 | Supervisor Permission Synchronisation is not supported by this partition or provided partition config. | The telephony server type or the partition type does not support this property to be set. If you are not providing it in request, try providing a "false" value. |
11142 | Partition license does not support Supervisor Permission Synchronisation. | The partition license level does not allow Supervisor Permissions Synchronisation to be enabled. If you are not providing sypervisor permission sync flag in request, try providing a "false" value. |
11143 | The CME does not allow the partition to be given this license type. | The enclosing CME restricts the types of partition that can be created. Select a different license type, or change the restriction in the CME. |
11144 | Partition license not supported for WebEx TelSys. | The partition license level supported by WebEx TelSys is "Akixi Enterprise" only. |
11150 | A valid TelSysID and PartIDInTelSys must be specified. | Specify both a valid Partition number via the PartIDInTelSys Property as well as its owning Telephony Server component within the TelSysID Property. |
# Properties
This section provides a description of the fields used in the Partition-related endpoints.
# Field Descriptions:
Key | Types | Description |
---|---|---|
TelSysID | integer | tel sys ID |
PartIDInTelSys | integer | part ID in tel sys |
Description | character varying | Description |
TelSysType | character varying | tel sys type |
StartOfDay | character varying | Start of day |
TimeZone | character varying | Time zone |
TelSysComponentType | character varying | Tel sys component type |
IDOnTelSysOwner | character varying | ID on tel sys owner |
IDOnTelSys | character varying | ID on tel sys |
LicensedForRptUserType | character varying | Licensed for rpt user type |
CommsEnabled | boolean | Comms enabled |
BillingTag | character varying | Billing tag |
SyncNow | boolean | Sync now |
SynchroniseSupervisorPermissions | boolean | Synchronise supervisor permissions |
SyncType | integer | Sync type |
MaintainParity | boolean | Maintain parity |
ForceMonitored | boolean | Force monitored |
CTILogEnabled | boolean | CTI log enabled |
CountryCode | integer | Country code |
InternalDigitLen | integer | Internal digit length |
Tags | character varying | Tags |
IsGlobal | boolean | Is global |
AutoDeleteUsers | boolean | Auto delete users |
PartitionGUID | character varying | Partition GUID |
← Telephone Systems CRM →