# CRM

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

# Add

# Request

# Endpoint

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

# Headers

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

# Path Parameters

# Query Parameters

There are no query parameters required for the request.

# Request Body

Request body contains required to create a new crm configuration.

{
  "Description":"test CRM",
  "CRMConfiguration":{
    "JSONData":"{\"RelatedMailFoldersNames\":[],\"ContactsFoldersNames\":[\"Contacts\"],\"RelatedCalendarFoldersNames\":[]}"
  },
  "CRMConfigurationCommon":{
    "JSONData":"{\"Cached\":true,\"RelatedDataEnabled\":true,\"CacheFrequency\":\"60\",\"CacheFrequencyUnit\":\"Minutes\"}"
  }
}

# Response

The response contains results of the operation.

# Success

With HTTP status code 204 No Content indicates that the request was successful.

{
  "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.

curl -X POST \
  https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'
  -d '{
  "Description":"test CRM",
  "CRMConfiguration":{
    "JSONData":"{\"RelatedMailFoldersNames\":[],\"ContactsFoldersNames\":[\"Contacts\"],\"RelatedCalendarFoldersNames\":[]}"
  },
  "CRMConfigurationCommon":{
    "JSONData":"{\"Cached\":true,\"RelatedDataEnabled\":true,\"CacheFrequency\":\"60\",\"CacheFrequencyUnit\":\"Minutes\"}"
  }
}'

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/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
data = JSON.stringify({
  "Description":"test CRM",
  "CRMConfiguration":{
    "JSONData":"{\"RelatedMailFoldersNames\":[],\"ContactsFoldersNames\":[\"Contacts\"],\"RelatedCalendarFoldersNames\":[]}"
  },
  "CRMConfigurationCommon":{
    "JSONData":"{\"Cached\":true,\"RelatedDataEnabled\":true,\"CacheFrequency\":\"60\",\"CacheFrequencyUnit\":\"Minutes\"}"
  }
});
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=B3A0BBA6E70EB78AA059880BCE1EE1B9;"
}
data = '{ "Description":"test CRM", "CRMConfiguration":{ "JSONData":"{\\"RelatedMailFoldersNames\\":[],\\"ContactsFoldersNames\\":[\\"Contacts\\"],\\"RelatedCalendarFoldersNames\\":[]}" }, "CRMConfigurationCommon":{ "JSONData":"{\\"Cached\\":true,\\"RelatedDataEnabled\\":true,\\"CacheFrequency\\":\\"60\\",\\"CacheFrequencyUnit\\":\\"Minutes\\"}" } }'
conn.request("POST", "CCS,API,v1,telsys,{telSysID},partition,{partitionIDInTelSys},device,{deviceNumber},integratorClient", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
    .method("POST")
    .body("{ \"Description\":\"test CRM\", \"CRMConfiguration\":{ \"JSONData\":\"{\\\"RelatedMailFoldersNames\\\":[],\\\"ContactsFoldersNames\\\":[\\\"Contacts\\\"],\\\"RelatedCalendarFoldersNames\\\":[]}\" }, \"CRMConfigurationCommon\":{ \"JSONData\":\"{\\\"Cached\\\":true,\\\"RelatedDataEnabled\\\":true,\\\"CacheFrequency\\\":\\\"60\\\",\\\"CacheFrequencyUnit\\\":\\\"Minutes\\\"}\" } }")
  .asString();

# Change

# Request

# Endpoint

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

# Headers

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

# Path Parameters

# Query Parameters

There are no query parameters.

# Request Body

The request body contains the crm configuration details to be changed.

{
  "Description":"New test CRM",
  "CRMConfiguration":{
    "JSONData":"{\"RelatedMailFoldersNames\":[],\"ContactsFoldersNames\":[\"Contacts\"],\"RelatedCalendarFoldersNames\":[]}"
  },
  "CRMConfigurationCommon":{
    "JSONData":"{\"Cached\":true,\"RelatedDataEnabled\":true,\"CacheFrequency\":\"60\",\"CacheFrequencyUnit\":\"Minutes\"}"
  }
}

# Response

# Success

With HTTP status code 204 No Content indicates that the request was successful .

{
  "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.

curl -X PUT \
  https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID} \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'
  -d '{
  "Description":"New test CRM",
  "CRMConfiguration":{   
    "JSONData":"{\"RelatedMailFoldersNames\":[],\"ContactsFoldersNames\":[\"Contacts\"],\"RelatedCalendarFoldersNames\":[]}"
  },
  "CRMConfigurationCommon":{
    "JSONData":"{\"Cached\":true,\"RelatedDataEnabled\":true,\"CacheFrequency\":\"60\",\"CacheFrequencyUnit\":\"Minutes\"}"
  }
}'

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("PUT", "https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID}");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
data = JSON.stringify({
  "Description":"New test CRM",
  "CRMConfiguration":{
    "JSONData":"{\"RelatedMailFoldersNames\":[],\"ContactsFoldersNames\":[\"Contacts\"],\"RelatedCalendarFoldersNames\":[]}"
  },
  "CRMConfigurationCommon":{
    "JSONData":"{\"Cached\":true,\"RelatedDataEnabled\":true,\"CacheFrequency\":\"60\",\"CacheFrequencyUnit\":\"Minutes\"}"
  }
});
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=B3A0BBA6E70EB78AA059880BCE1EE1B9;"
}
data = '{ "Description":"New test CRM", "CRMConfiguration":{ "JSONData":"{\\"RelatedMailFoldersNames\\":[],\\"ContactsFoldersNames\\":[\\"Contacts\\"],\\"RelatedCalendarFoldersNames\\\":[]}" }, "CRMConfigurationCommon":{ "JSONData":"{\\"Cached\\":true,\\"RelatedDataEnabled\\":true,\\"CacheFrequency\\":\\"60\\",\\"CacheFrequencyUnit\\":\\"Minutes\\"}" } }'
conn.request("PUT", "CCS,API,v1,telsys,{telSysID},partition,{partitionIDInTelSys},device,{deviceNumber},integratorClient,{CRMConfigID}", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID}")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .method("PUT")
  .body("{ \"Description\":\"New test CRM\", \"CRMConfiguration\":{ \"JSONData \":\"{\\\"RelatedMailFoldersNames\\\":[],\\\"ContactsFoldersNames\\\":[\\\"Contacts\\\"],\\\"RelatedCalendarFoldersNames\\\":[]}\" }, \"CRMConfigurationCommon\":{ \"JSONData\":\"{\\\"Cached\\\":true,\\\"RelatedDataEnabled\\\":true,\\\"CacheFrequency\\\":\\\"60\\\",\\\"CacheFrequencyUnit\\\":\\\"Minutes\\\"}\" } }")
  .asString();

# Delete

# Request

# Endpoint

https://host/CCS/API/v1/amin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID}

# Headers

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

# Path Parameters

# Query Parameters

Query parameters are not required for the request.

# Request Body

This request does not require a body.

# Response

# Success

With HTTP status code 204 No Content indicates that the request was successful .

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

curl -X DELETE \
  https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID} \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

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("DELETE", "https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID}");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=B3A0BBA6E70EB78AA059880BCE1EE1B9;"
}

conn.request("DELETE", "CCS,API,v1,telsys,{telSysID},partition,{partitionIDInTelSys},device,{deviceNumber},integratorClient,{CRMConfigID}", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID}")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();

# List

# Request

# Endpoint

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

# Headers

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

# Path Parameters

# Query Parameters

# Request Body

This request does not require a body.

# Response

# Success

With HTTP status code 200 OK indicates that the request was successful .

{
  "Result": "Success",
  "Data": {
    "Total": 3,
    "Items": [
      {
        "CRMConfigurationID": "fa52375053f0c2b3:78fd3a9e:19995546266:5fe8",
        "TelSysID": 338,
        "DeviceDescription": "[None Or All Devices]",
        "DeviceNumber": "UnknownNoneOrAll",
        "Description": "Raman-Teams",
        "TelSysDescription": "MS Teams - Thanga",
        "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
        "CRMType": "CrmAddin.GoogleContacts.GoogleContactsAddin",
        "PartIDInTelSys": 1,
        "PartitionDescription": "MS Teams - Thanga"
      },
      {
        "CRMConfigurationID": "3d5b6efefaa0a823:3af2db2a:199bb1c0014:-496",
        "TelSysID": 426,
        "DeviceDescription": "User04 A4MTTest",
        "DeviceNumber": "+442046034983",
        "Description": "test CRM",
        "TelSysDescription": "MST Dev Tenant",
        "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
        "CRMType": "CrmAddin.GraphContacts.GraphContactsAddin",
        "PartIDInTelSys": 1,
        "PartitionDescription": "MST Dev Tenant"
      },
      {
        "CRMConfigurationID": "3d5b6efefaa0a823:3af2db2a:199b9df0851:6103",
        "TelSysID": 183,
        "DeviceDescription": "Akixi O365 Sandbox",
        "DeviceNumber": "0001",
        "Description": "test CXI",
        "TelSysDescription": "Test Telsys",
        "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
        "CRMType": "CrmAddin.GoogleContacts.GoogleContactsAddin",
        "PartIDInTelSys": 1,
        "PartitionDescription": "test partition"
      }
    ],
    "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.

curl -X GET \
  https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

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/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=B3A0BBA6E70EB78AA059880BCE1EE1B9;"
}

conn.request("GET", "CCS,API,v1,telsys,{telSysID},partition,{partitionIDInTelSys},device,{deviceNumber},integratorClient", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();

# Info

# Request

# Endpoint

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

# Headers

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

# Path Parameters

# Query Parameters

# Request Body

This request does not require a body.

# Response

# Success

With HTTP status code 200 OK indicates that the request was successful .

{
  "Result": "Success",
  "Data": {
    "CRMConfigurationID": "3d5b6efefaa0a823:3af2db2a:199bb1c0014:-496",
    "TelSysID": "426",
    "DeviceNumber": "+442046034983",
    "Description": "test CRM",
    "CRMConfiguration": {
      "RelatedMailFoldersNames": [],
      "ContactsFoldersNames": [
        "Contacts"
      ],
      "RelatedCalendarFoldersNames": []
    },
    "CMEnvironmentID": "d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613",
    "CRMType": "CrmAddin.GraphContacts.GraphContactsAddin",
    "CRMConfigurationCommon": {
      "Cached": true,
      "RelatedDataEnabled": true,
      "CacheFrequency": "60",
      "CacheFrequencyUnit": "Minutes"
    },
    "PartIDInTelSys": "1"
  }
}

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

curl -X GET \
  https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID} \
  -H 'Cookie: JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;'

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/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID}");
xhr.setRequestHeader("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;");
xhr.send(data);

import http.client

conn = http.client.HTTPConnection("host")
headers = {
    'Cookie': "JSESSIONID=B3A0BBA6E70EB78AA059880BCE1EE1B9;"
}

conn.request("GET", "CCS,API,v1,telsys,{telSysID},partition,{partitionIDInTelSys},device,{deviceNumber},integratorClient,{CRMConfigID}", headers=headers)

res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

// http://unirest.io/ used in the snippet.
HttpResponse<String> response = Unirest.get("https://host/CCS/API/v1/admin/telsys/{telSysID}/partition/{partitionIDInTelSys}/device/{deviceNumber}/crm/configs/{CRMConfigID}")
  .header("Cookie", "JSESSIONID=69287CC9E1C10FAECC1D9FF522A8A927;")
  .asString();

# Error Codes

For more information on general error codes, see Error Codes

# CRM Error Codes

# Properties

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

# Field Descriptions: