# IntegratorClient

# Supported Operations

The list of currently supported Integrator Client operations is provided below.

Please note that depending on your assigned Integrator Client privileges you may only have access to view and configure one particular Integrator Client 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 Integrator Client.
Change	Change an existing Integrator Client Change.
Delete	Delete a Integrator Client.
List	List all Integrator Client assigned to your Akixi account.
Info	Get information about a IntegratorClient.

# Add

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/integratorClient/

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`	426	telSysID of the linked device
`partitionIDInTelSys`	1	partitionID of the linked device
`deviceNumber`	+442046034980	deviceNumber of the device

# Query Parameters

Key	Sample Value	Description
`IntegratorClientFields`	[Policies,Settings]	Policies and Settings values will be set in the query paramters

# Request Body

Request body contains required to create a new CXI Integrator client configuration.

{
  "Description":"testCXI Config",
  "CMEnvironmentID":"d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
  "Policies":{
    "core::showUseConfigurationWindow":true
  },
  "Settings":{
    "interface::showCallNotificationPreview":true
  }
}

# Response

The response contains results of the operation.

# Success

With 200 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

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/integratorClient/{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
`telSysID`	426	telSysID of the linked device
`partitionIDInTelSys`	1	partitionID of the linked device
`deviceNumber`	+442046034980	deviceNumber of the device
`id`	`d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613`	GUID of the integrator client

# Query Parameters

Key	Value	description
`IntegratorClientFields`	[Policies,Settings]	Policies and Settings values will be set in the query paramters

# Request Body

Request body contains required to update an existing CXI Integrator client configuration.

{
  "Description":"testCXI Config",
  "CMEnvironmentID":"d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
  "Policies":{
    "core::showUseConfigurationWindow":true
  },
  "Settings":{
    "interface::showCallNotificationPreview":true,
    "interface::showMissedCallPreview":true
  }
}

# Response

The response contains results of the operation.

# Success

Response with HTTP status code 204 No Content

# 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

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/integratorClient/{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
`telSysID`	426	telSys ID
`partitionIDInTelSys`	1	partition ID
`deviceNumber`	+442046034980	deviceNumber
`id`	`d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613`	GUID of the integrator client

# Query Parameters

Query parameters are not required to delete an Integrator Client.

# Request Body

This request does not require a body.

# Response

# Success

With HTTP status code 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

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/integratorClient

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	Fetch for all telSysID's
`partitionIDInTelSys`	-1	Fetch for all partitionIDInTelSys's
`deviceNumber`	UnknownNoneOrAll	Fetch for all deviceNumbers

# Query Parameters

Key	Sample Value	Description
`limit`	25	Number of records per record set.
`offset`	0	Starting position of the record set.
`sort`	['DESC','ASC']	Sort order of the record set.
`IntegratorClientFields`	'[TelSysDescription,PartitionDescription,DeviceDescription]'	Integration fields to be returned in the response.

# Request Body

This request does not require a body.

# Response

The response contains a list of all integrator Client configurations with additional fields mentioned in the query parameters ( telSysDescription, PartitionDescription, DeviceDescription).

# Success

With 200 HTTP Status Code:

{
  "Result": "Success",
  "Data": {
    "Total": 15,
    "Items": [
      {
        "TelSysID": 389,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "Child Test",
        "TelSysDescription": null,
        "ID": "174546f958aa15f1:2744ca9:19889c3e648:-2229",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 403,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "3",
        "TelSysDescription": null,
        "ID": "a05241ee7b21d0ac:-69f03ef2:1989d3eaf18:3533",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 398,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "test-123",
        "TelSysDescription": null,
        "ID": "a05241ee7b21d0ac:-69f03ef2:1989d3eaf18:7877",
        "PartitionID": -1,
        "PartitionDescription": "[None Or All Partitions]"
      },
      {
        "TelSysID": 366,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "123",
        "TelSysDescription": null,
        "ID": "a05241ee7b21d0ac:-69f03ef2:1989d3eaf18:79d4",
        "PartitionID": -1,
        "PartitionDescription": "[None Or All Partitions]"
      },
      {
        "TelSysID": 403,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "Colin Scope",
        "TelSysDescription": null,
        "ID": "a21abf960a398ee2:7b73f31a:198cb98618e:6e40",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 401,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "Regression-Test-1",
        "TelSysDescription": null,
        "ID": "a21abf960a398ee2:7b73f31a:198eb3531fc:-7aed",
        "PartitionID": -1,
        "PartitionDescription": "[None Or All Partitions]"
      },
      {
        "TelSysID": 401,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "Regression-Test-2-telsysy-part",
        "TelSysDescription": null,
        "ID": "a21abf960a398ee2:7b73f31a:198eb3531fc:c07",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 401,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "Regression-Test-2-telsysy-part-device",
        "TelSysDescription": null,
        "ID": "a21abf960a398ee2:7b73f31a:198eb3531fc:ca1",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 403,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "All Mondago.net",
        "TelSysDescription": null,
        "ID": "fd3548fed99dcd47:463d17a5:198608d9cb3:-79b7",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 403,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "Chris' Device",
        "TelSysDescription": null,
        "ID": "fd3548fed99dcd47:463d17a5:198648022c9:-7e7b",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 403,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "3",
        "TelSysDescription": null,
        "ID": "fd3548fed99dcd47:463d17a5:19864e67f42:79b8",
        "PartitionID": -3,
        "PartitionDescription": null
      },
      {
        "TelSysID": 426,
        "DeviceDescription": "User02 A4MTTest",
        "DeviceNumber": "+442046034981",
        "Description": "test CXI",
        "TelSysDescription": "MST Dev Tenant",
        "ID": "3d5b6efefaa0a823:3af2db2a:199bb1c0014:-36cd",
        "PartitionID": 1,
        "PartitionDescription": "MST Dev Tenant"
      },
      {
        "TelSysID": 417,
        "DeviceDescription": "Doc Morrissey",
        "DeviceNumber": "01234567102",
        "Description": "test CXI",
        "TelSysDescription": "Sunshine Insurance",
        "ID": "3d5b6efefaa0a823:3af2db2a:199b9df0851:7aec",
        "PartitionID": 1,
        "PartitionDescription": "Sunshine Insurance"
      },
      {
        "TelSysID": 417,
        "DeviceDescription": "None",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "No Config Access",
        "TelSysDescription": "Sunshine Insurance",
        "ID": "a21abf960a398ee2:7b73f31a:198d18707a9:6b7b",
        "PartitionID": 1,
        "PartitionDescription": "Sunshine Insurance"
      },
      {
        "TelSysID": 417,
        "DeviceDescription": "Anne Hunter",
        "DeviceNumber": "01234567120",
        "Description": "Config Access Allowed",
        "TelSysDescription": "Sunshine Insurance",
        "ID": "a21abf960a398ee2:7b73f31a:198d18707a9:6e88",
        "PartitionID": 1,
        "PartitionDescription": "Sunshine Insurance"
      }
    ],
    "Offset": 0
  }
}

# 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

# Request

# Endpoint

https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/integratorClient/{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
`telSysID`	426	telSysID of the linked device
`partitionIDInTelSys`	1	partitionID of the linked device
`deviceNumber`	+442046034980	deviceNumber of the device
`id`	`d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613`	GUID of the integrator client

# Query Parameters

Key	Sample Value	Description
`IntegratorClientFields`	`[TelSysDescription,PartitionDescription,DeviceDescription]`	Additional fields to be returned in the response.

# Request Body

This request does not require a body.

# Response

The response contains a client configuration details for a given Integrator Client ID.

# Success

With 200 HTTP Status Code:

{
  "Result": "Success",
  "Data": {
    "TelSysID": "426",
    "DeviceDescription": "User04 A4MTTest",
    "DeviceNumber": "+442046034983",
    "Description": "new test CXI",
    "TelSysDescription": "MST Dev Tenant",
    "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
    "ID": "3d5b6efefaa0a823:3af2db2a:199bb1c0014:-fd3",
    "PartitionID": "1",
    "PartitionDescription": "MST Dev Tenant"
  }
}

# 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
30000	INTEGRATOR_CLIENT_NOT_ENOUGH_PERMISSIONS_FOR_ACTION	The current user does not have enough permissions to perform the action.
30001	INTEGRATOR_CLIENT_NO_CONFIG_PROVIDED	No configuration provided in the request.
30002	INTEGRATOR_CLIENT_NO_ID_PROVIDED_IN_REQUEST	No Integrator Client ID provided in the request.
30003	INTEGRATOR_CLIENT_NOT_FOUND	Integrator Client with the specified ID was not found.
30004	INTEGRATOR_CLIENT_DEVICE_NOT_FOUND_IN_TELSYS	The specified device was not found in the telephony server.
30005	INTEGRATOR_CLIENT_EXISTS_FOR_SCOPE	An Integrator Client with the same scope already exists.
30006	INTEGRATOR_CLIENT_EXISTS_FOR_ID	An Integrator Client with the same ID already exists.
30007	INTEGRATOR_CLIENT_NOT_RESOLVED_FROM_GENERIC_CONFIG	The Integrator Client could not be resolved from the generic configuration.
30008	INTEGRATOR_CLIENT_MULTI_TELSYS_NOT_ALLOWED_FOR_USER	The Integrator Client cannot be assigned to multiple telephony servers for the user.
30009	INTEGRATOR_CLIENT_MULTI_PARTITION_NOT_ALLOWED_FOR_USER	The Integrator Client cannot be assigned to multiple partitions for the user.

# Properties

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

# Field Descriptions:

Field	Type	Description
`ID`	`character varying`	Client integrator ID
`Description`	`character varying`	Client integrator description
`TelSysID`	`integer`	Telephone system ID
`PartitionID`	`character varying`	Partition ID
`DeviceUniqueID`	`character varying`	Device Unique ID
`Settings`	`json`	Client integrator settings
`Policies`	`json`	Client integrator policies
`UserIDCreatedBy`	`character varying`	creator User ID
`UserIDUpdatedBy`	`character varying`	last modifier User ID
`DateTimeCreated`	`timestamp without time zone`	Creation date and time
`DateTimeUpdated`	`timestamp without time zone`	Last modified date and time

← CRM Misc Info →

# IntegratorClient

# Supported Operations

# 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

# Error

# Field Descriptions:

# Code Snippets

# Info

# Request

# Endpoint

# Headers

# Path Parameters

# Query Parameters

# Request Body

# Response

# Success

# Error

# Field Descriptions:

# Code Snippets

# Error Codes

# Integrator Client Related Error Codes

# Properties

# Field Descriptions: