# Central Management Environments

In this sub-section, you will learn how to programmatically create, modify, delete and view Central Management Environment entries.

The CME provides a single point of access for Akixi Administrators to view, manage and administrate all their Akixi customers from within a single environment.

The CME also has the added benefit of allowing Akixi Administrators to access billing for all customer sites from a single location.

A CME is a container environment, that can hold any number of Telephony Servers, Application Users and even other CMEs, with each CME having the ability to be associated to a single company. The top-level CME is known as the Primary CME, this is where Administrators can sign in to manage their entire Akixi estate.

# Supported Operations

The list of currently supported Central Management Environment Server operations is provided below. Operations related to Akixi Central Management Environment entries start with a “CMEnvironment” prefix. They will be referred to as “CM Environment Operations” interchangeably hereafter.

Please note that depending on your assigned CM Environment system privileges you may only have access to view and configure one particular CM Environment 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 Central Management Environment entry.
Change	Change an existing Central Management Environment.
Delete	Delete a Central Management Environment.
List	List all Central Management Environment accessibly with your Akixi account.
Info	Get a Central Management Environment details accessibly with your Akixi account.

# Central Management Environment Request Parameters

Parameters used within both CMEnvironmentAdd and CMEnvironmentChange requests can be found in the table below.

# Read-Only Properties After Initial Creation

Parameter Name	Description
CMEnvironmentID	Unique ID for each Central Management Environment, generated by application when the entity is first created.
ParentCMEnvironmentID	Unique ID of parent Central Management Environment. Every CM Environment has to have a parent CM Environment except for the first (default) one.

# Add

CM Environments are added via CMEnvironmentAdd request. The main purpose of this request is to create a new central management environment that is later used to group other CM Environments and telephony servers.

# Request

# Endpoint

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

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 CME.

{
    "FromAddressName": "Akixi Application Mailer (Do Not Reply)",
    "CompanyName": "Akixi",
    "Description": "Akixi",
    "UseAuthentication": false,
    "FromAddressEmail": "do_not_reply@akixi.com",
    "ServerIPAddress": "127.0.0.1",
    "CommunicationActivated": true,
    "ServerTCPPort": 25,
    "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:56212",
    "Domain": "test.akixi.com",
    "LicenseManagement": {
        "essentials": 9,
        "professional": 15,
        "enterprise": 56
    }
}

# Response

The response contains a JSON object with the following fields:

# Success

With 201 Created HTTP Status Code:

{
    "Result": "Success"
}

# 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

Central Management Environment components can be modified via CMEnvironmentChange request. To modify parameters of an existing Central Management Environment, you must build a request that will include corresponding component’s unique identifier CMEnvironmentID, as well as the Properties to actually update.

# Request

# Endpoint

https://host/CCS/API/v1/admin/cme/{CMEnvironmentID}

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

Parameter Name	Sample Value	Description
`CMEnvironmentID`	142b4a397e61ee48:-5ff17860:196cf4c9213:-7fdf	ID/GUID of the CM Environment to be modified.

# Query Parameters:

This request does not require query parameters.

# Request Body

The request body contains the modified values for the update CME request ( Domain value changed in sample example).

{
        "FromAddressName": "Akixi Application Mailer (Do Not Reply)",
        "CompanyName": "Akixi",
        "Description": "Akixi",
        "UseAuthentication": false,
        "FromAddressEmail": "do_not_reply@akixi.com",
        "ServerIPAddress": "127.0.0.1",
        "CommunicationActivated": true,
        "ServerTCPPort": 25,
        "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5614",
        "Domain": "unknown.akixi.com",
        "LicenseManagement": {
            "essentials": 545453,
            "professional": 70,
            "enterprise": 504
        }
    }

# Response

The response contains the BrandingGUID of the updated CME with 200 OK HTTP status code.

# Success

With 200 OK HTTP Status Code:

{
    "Data": {
        "BrandingGUID": "142b4a397e61ee48:-5ff17860:196cf4c9213:-7fde"
    },
    "Result": "Success"
}

# 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 Central Management Environment component can be removed via CMEnvironmentDelete request. To delete a specific Central Management Environment entry, you must build a request that will include the corresponding entry’s unique identifier value (CMEnvironmentID), as well as any required optional deletion parameters.

Warning

You will not be able to restore the deleted Central Management Environment component once it is deleted.

Only empty (i.e. no child CM Environments, no telephony servers) Central Management Environment components can be deleted.

# Request

The example request below is an example of a CM Environment deletion operation. This request includes all parameters supported by CMEnvironment operation invoked in order to delete an existing entry (where CMEnvironmentID=67111f4833d46afc:13698559:178111e794b:-7f4c).

# Endpoint

https://host/CCS/API/v1/admin/cme/{CMEnvironmentID}

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

Parameter Name	Sample Value	Description
`CMEnvironmentID`	142b4a397e61ee48:-5ff17860:196cf4c9213:-7fdf	GUID/ID of the CM Environment to be deleted.

# Query Parameters:

This request does not require query parameters.

# Body

This request does not require a body.

# Response

The response contains a status of the delete operation with success or error message.

# Success

With 200 OK HTTP Status Code:

{
    "Result": "Success"
}

# 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

CMEnvironmentList operation can be used to list all CM Environment components that are configured against a certain Administrative account.

# Request

By default, the CMEnvironmentList request body is quite minimalistic: you can simply provide correct SessionID and InvokeID values in order to obtain CMEnvironmentID and Description parameters of CM Environment components configured against your Administrative account:

# Endpoint

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

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 path parameters.

# Query Parameters:

Parameter Name	Sample Value	Description
`CMEnvironmentFields`	[Domain,CompanyName,ParentCMEnvironmentID]	CM Environment fields .
`SearchQuery`	'Akixi'	Search string to filter results.
`Offset`	1	starting point of the record set
`Limit`	10	size of the record set

# Request Body

This request does not require a body.

# Response

The response contains list of Items containing CM Environment details.

# Success

With 200 OK HTTP Status Code:

{
    "Data": {
        "Items": [
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5622",
                "Description": "Akixi",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "test.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:56212",
                "Description": "Akixi",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "test.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Description": "Akixi",
                "ParentCMEnvironmentID": null,
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "142b4a397e61ee48:-5ff17860:196cf4c9213:-7fdf",
                "Description": "Akixi",
                "ParentCMEnvironmentID": "142b4a397e61ee48:-5ff17860:196cf4c9213:-7ff9",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5621",
                "Description": "Akixi",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "375a735413e54810:25de4fea:19735d4f15c:-7989",
                "Description": "Akixi_1",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "2bf4e6215ac6561c:d01b50a:1973c74631b:-75a4",
                "Description": "Akixi_1_child",
                "ParentCMEnvironmentID": "375a735413e54810:25de4fea:19735d4f15c:-7989",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "a8164d8a7633fb04:129d2c18:1973f878630:-7e9a",
                "Description": "Akixi_1_with_blank_url",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "a8164d8a7633fb04:129d2c18:1973f878630:-7e3f",
                "Description": "Akixi_1_with_blank_url_1",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "a8164d8a7633fb04:129d2c18:1973f878630:-7d5e",
                "Description": "Akixi_2_without_url",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "a8164d8a7633fb04:129d2c18:1973f878630:-775a",
                "Description": "akixi_child_3",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "a8164d8a7633fb04:129d2c18:1973f878630:-6a3e",
                "Description": "Akixi_New",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "6076ccc70a1d1c1e:439a10ab:197409c9bed:-7cce",
                "Description": "akixi_parent_9833",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "682e56a873c25a01:2c19ab1f:19905c37ab2:-7ff7",
                "Description": "CME Test",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "682e56a873c25a01:2c19ab1f:19905c37ab2:-7ff6",
                "Description": "CMEUser",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "3e4f6c3af9b8306c:-6e3ad9c:1966cf75fd3:-7ff9",
                "Description": "Demo",
                "ParentCMEnvironmentID": "3e4f6c3af9b8306c:-6e3ad9c:1966cf75fd3:-7ffb",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "4fd9f983c3e4d0b5:-56652b6e:1967d372145:-7ffd",
                "Description": "Demo -child - test",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "e0b4b8dd8b762605:5bf2417f:196f7a9c2bd:-7ffe",
                "Description": "Demo -child - test - new download links",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "4fd9f983c3e4d0b5:-56652b6e:1967d372145:-7ffa",
                "Description": "Demo -child - test - new download links",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "3e4f6c3af9b8306c:-6e3ad9c:1966cf75fd3:-7ffb",
                "Description": "demo-child-mac",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "142b4a397e61ee48:-5ff17860:196cf4c9213:-7ff9",
                "Description": "new-9319",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "23bcc1cdb9f1a965:21b90a48:196ce4745a9:-7fe2",
                "Description": "testing-9319",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "142b4a397e61ee48:-5ff17860:196cf4c9213:-7ffb",
                "Description": "testing-9319-3",
                "ParentCMEnvironmentID": "23bcc1cdb9f1a965:21b90a48:196ce4745a9:-7fe2",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "ef181e7ccf56ae43:-5b7c0674:196cf43f8f3:-7fff",
                "Description": "testing-9319-child",
                "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "142b4a397e61ee48:-5ff17860:196cf4c9213:-7fff",
                "Description": "testing-9319-child-1",
                "ParentCMEnvironmentID": "23bcc1cdb9f1a965:21b90a48:196ce4745a9:-7fe2",
                "Domain": "unknown.akixi.com"
            },
            {
                "CompanyName": "Akixi",
                "CMEnvironmentID": "142b4a397e61ee48:-5ff17860:196cf4c9213:-7ffd",
                "Description": "testing-9319-child-2",
                "ParentCMEnvironmentID": "23bcc1cdb9f1a965:21b90a48:196ce4745a9:-7fe2",
                "Domain": "unknown.akixi.com"
            }
        ]
    },
    "Result": "Success"
}

# 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

CMEnvironmentInfo operation can be used to get CM Environment info components that are configured against a certain Administrative account.

# Request

By default, the CMEnvironmentInfo request body is quite minimalistic: you can simply provide correct SessionID and InvokeID values in order to obtain CMEnvironmentID and Description parameters of CM Environment components configured against your Administrative account:

# Endpoint

https://host/CCS/API/v1/admin/cme/{CMEnvironmentID}

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:

Parameter Name	Sample Value	Description
`CMEnvironmentID`	'3e4f6c3af9b8306c:-6e3ad9c:1966cf75fd3:-7ffb'	GUID/ID of the CM Environment to be fetched.

# Query Parameters

This request does not require query parameters.

# Request Body

This request does not require a body.

# Response

The response contains CM Environment details for a given GUID/ID.

# Success

With 200 OK HTTP Status Code:

{
    "Data": {
        "Description": "demo-child-mac",
        "CommunicationActivated": true,
        "BotsEnabledTelsys": 0,
        "MaxTelsysCount": -1,
        "CXIClientDownloadURLMac": "https://native.prd.mst.akixi.com/static/downloads/akixi-mac-app.zip",
        "ServerTCPPort": 25,
        "ProvisioningConfig": {
            "BroadworksProvisioning": {}
        },
        "FromAddressName": "Akixi Application Mailer (Do Not Reply)",
        "CompanyName": "Akixi",
        "AppDownloadURL": "https://native.prd.mst.akixi.com/static/downloads/akixi-native-app.zip",
        "UseAuthentication": false,
        "BotsDisabled": false,
        "FromAddressEmail": "do_not_reply@akixi.com",
        "ServerIPAddress": "127.0.0.1",
        "Capabilities": 3843,
        "LicenseCapManagement": {
            "EssentialsCap": null,
            "EnterpriseCap": null,
            "CXIntegrationCap": null,
            "ProfessionalCap": null,
            "CallCentreSupervisorCap": null,
            "CallCentreAgentCap": null
        },
        "DisableAkixiLogin": false,
        "CMEnvironmentID": "3e4f6c3af9b8306c:-6e3ad9c:1966cf75fd3:-7ffb",
        "ParentCMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
        "CXIClientDownloadURLWin": "https://native.prd.mst.akixi.com/static/downloads/akixi-win-app.zip",
        "Domain": "unknown.akixi.com",
        "SearchAndCallAppDownloadURL": "https://native.prd.mst.akixi.com/static/downloads/akixi-app.zip",
        "BotsDisabledTelsys": 0
    },
    "Result": "Success"
}

# 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

Error Code	Error Message	Description
12100	CM Environment ID already exists.	Specify different ID.
12101	Parent CM Environment specified in the request does not exist.	Specify ID of a valid parent CM Environment.
12102	Duplicate domain value.	CM Environment with specified domain already exists.
12103	CM Environment ID was not specified.	Specify a valid CM Environment ID.
12104	CM Environment with the provided ID was not found.	CM Environment probably does not exist.
12105	CM Environment communication setting is still turned on which prevents the action.	Set communication active flag to Off.
12106	The specified CM Environment contains child CM environments that prevents the requested action.	Remove all child CM environments before attempting the action.
12107	There are telephone servers that belong to the specified CM Environment.	Delete the telephony servers or move them under different CM Environment.
12108	Parent CM Environment ID is missing in the request.	Add a valid parent CM Environment ID.
12109	The root CM Environment cannot be deleted.	It is never possible to delete the root CM Environment.
12110	There are users that belong to the specified CM Environment.	Update related users and move them to different CM Environment.
12111	Root CM Environment cannot be created using Web Services API.	If you would like to create a Root CM Environment, please contact your system administrator.
12112	The parent CM Environment ID cannot be the same as the ID of the CM environment.	Change parent CM Environment ID to a valid value that does not equal the ID of the CM environment.
12113	The root CM Environment cannot have a parent.	It is not possible to specify parent CM Environment for root CM Environment.
12114	The provisioning config for this CM Environment cannot be updated by current user.	Either use different user account or extend the permissions of the current user.
12120	The requested telephone server count cannot be saved, as there are already more telephone servers in this CME.	The count entered is less than the number of existing Telephony Servers in this CME. Enter a larger number, or remove obsolete Telephony Servers.
12124	The requested capabilities cannot be saved, as the CME already contains telephone server(s) that violate the new restrictions.	You cannot disable a Telephony Server type in a CME if there are already Telephony Servers of this type within it, or within one of its child CMEs. Remove the Telephony Server(s), or leave the type enabled in the CME Capabilities.
12125	The requested capabilities cannot be saved, as the CME already contains partition(s) that violate the new restrictions.	You cannot disable a License Level in a CME if there are already Partitions of this type within it, or within one of its child CMEs. Remove the partition(s), change their license level(s), or leave the license type enabled in the CME Capabilities.
12126	The requested capabilities cannot be saved, as the CME already contains user(s) that violate the new restrictions.	You cannot disable a License Level in a CME if there are already Users with this reporting level within it, or within one of its child CMEs. Remove the user(s), change their reporting access level(s), or leave the license type enabled in the CME Capabilities.
12130	CME contains customized roles	The CME contains customized roles. Remove all customized roles before attempting the action.
12131	license capacity range is invalid	The specified license capacity range is invalid. The minimum value must be less than or equal to the maximum value.
12132	The specified license capacity range is invalid. The minimum value must be greater than or equal to the total license capacity of all existing telephony servers within the CME and its child CMEs.	Specify a valid license capacity range where the minimum value is greater than or equal to the total license capacity of all existing telephony servers within the CME and its child CMEs.

# Properties

For more information about the properties / fields used in the CME-related endpoints, see the table below.

# Field Descriptions:

Fields	Types	Description
Domain	character varying	Domain name
Description	character varying	CME decsription
CommsActivated	boolean	Checks if communications are activated
ServerIPAddress	character varying	Server IP address
ServerTCPPort	integer	Server TCP port
FromAddressEmail	character varying	From address email
FromAddressName	character varying	From address name
CompanyName	character varying	Company name
AuthUse	boolean	Checks if authentication is used
AuthUserName	character varying	Auth username
AuthPassword	text	Auth password
ParentCMEnvironmentID	character varying	Parent CM Environment ID
BillingTag	character varying	Billing tag
DateTimeCreated	timestamp without time zone	Creation date and time
DateTimeModifiedLast	timestamp without time zone	Last modified date and time
UserIDCreatedBy	character varying	creator User ID
UserIDModifiedByLast	character varying	last modifier User ID
ProvisioningConfig	json	Provisioning configuration
IdentityProviderIDs	ARRAY	List of identity provider IDs
Capabilities	integer	Capabilities
EssentialsLicenseCap	integer	Essentials license cap
ProfessionalLicenseCap	integer	Professional license cap
EnterpriseLicenseCap	integer	Enterprise license cap
MaxTelsysCount	integer	Maximum telephone system count
DisableAkixiLogin	boolean	Checks if Akixi login is disabled
CallCentreAgentLicenseCap	integer	Call Centre Agent license cap
CallCentreSupervisorLicenseCap	integer	Call Centre Supervisor license cap
OperatingMode	integer	Operating mode
PreviewBrandingConfig	json	Preview branding configuration
PreviousBrandingConfig	json	Previous branding configuration
BrandingConfig	json	Branding configuration
BrandingGUID	character varying	Branding GUID
PreviewBrandingGUID	character varying	Preview branding GUID
AppDownloadURL	text	App download URL
CXIClientDownloadURLWin	text	CXI Client download URL for Windows
CXIClientDownloadURLMac	text	CXI Client download URL for Mac
SearchAndCallAppDownloadURL	text	Search and Call app download URL
CXIntegrationLicenseCap	integer	CX Integration license cap
CXIAccessCode	character varying	CXI access code

← Users Telephone Systems →

# Central Management Environments

# Supported Operations

# Central Management Environment Request Parameters

# Read-Only Properties After Initial Creation

# 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:

# Body

# Response

# Success

# Error

# Field Descriptions:

# Code Snippets

# List

# Request

# Endpoint

# Headers

# Path Parameters

# Query Parameters:

# Request Body

# Response

# Success

# Error

# Field Descriptions:

# Code Snippets

# Info

# Request

# Endpoint

# Headers

# Path Parameters:

# Query Parameters

# Request Body

# Response

# Success

# Error

# Field Descriptions:

# Code Snippets

# Error Codes

# Central Management Environment Related Error Codes

# Properties

# Field Descriptions: