API Specifications

To get started with API in the CC system, you need to get a login and password for authorization during requests.
HTTP Basic Access Authentication is applied.
Requests should be submitted with the required HEADER: Content-Type: application/json




Preparation of client card for work with API

When setting up a client card, the field names that will be used in the API queries when working with the client should be provided. In the column "Synchronization" for each individual field of the client card, it is necessary to enter the names, which will appear in the requests concerning actions on the client in the CC.

These names should be given in English, without the use of special characters. Numbers can also be used in names. The field name should be informative to understand and simplify the integration process.




Customization of client IDs

An important step is also to select a client card field that will define a common synchronization ID for both systems. The check mark in the “Sync ID” column indicates that this field is being used to identify a unique client for a third-party system. Client IDs can be either a single field or a set of two or more fields.

By default, the external unique client ID is the internal client id field generated by the CC system itself.

If a new client is created by a remote system, it is always possible to retrieve the value of that ID when prompted. If the integration and management of the client ID is determined by the principle of transferring value from a third-party system, then the client management occurs by the value that is transmitted in requests from a third-party system.

Under these conditions, two principles of client IDs are possible:

  • use of CC's internal client id as an identifier
  • use of a set of values ​​transmitted by a third-party system



How to find out the value of {clientRoleId}

The value of this parameter is static and is issued once by the system administrator after running the CC environment, along with the login and password for the user API.




Learn in detail how to create a list of fields in the array "fields"

The name of the fields in the array is determined by the name configured in the client card in the Sync column.

As an example, to configure the client card below, the array will look like


  "fields": {
    "offerDomain": "TEST",
    "offerId": 10,
    "fullUrl": "Full URL Data",
    "fullName": "Some data",
    "city": "Some city data"
}




How client ID array parameters are formed {syncIdentifiers}

The syncIdentifiers array is formed from the field names in the "Sync" field of the client card, which are defined as synchronization identifiers.

As an example, to configure the client card below, the array will look like


  "syncIdentifiers": {
                 "offerDomain": "TEST",
                 "offerId": 10
         }




How client card array fields are formed {fieldsToUpdate}

The array may have field names marked in the Sync column.

As an example, to configure the client card below, the array will look like


  "fieldsToUpdate": {
                "fullUrl": "http://test.com",
                "fullName": "FullName data",
                "city": “City Info”,
        }




How the parameters of the {clientSyncIdentifiers} client ID array are formed

The syncIdentifiers array is formed from the field names in the "Sync" field of the client card, which are defined as synchronization identifiers.

As an example, to configure the client card below, the array will look like


  "clientSyncIdentifiers": {
                "offerDomain": "TEST",
                "offerId": 10
        }




Internal client ID. Find out where to get {clientId}

а) The internal client ID always appears in response to the creation of a new client. If system integration involves storing such an identifier on the side of a third-party system as externalId, then the value of this parameter should already be known after the client is created.

  {
   "createResult": [
      {
         "uuid": "000000000",
         "result": "Success",
         "createdClientId": 1529670
      }
   ]
}

b) Use API request "ClientDTO Client Card Data Retrieval", which will return a scan of all client fields including its internal id "id"

c) through the Web interface, using the appropriate filters.




How to find out the {roleId} value

The roleId value determines what role the user will be assigned to the system. These roles are configured at the admin level at project startup and are mostly static. The value can be found in the administrative console when its are configured.




How to find out the value of {internalPhoneId}

The ID of the internal phone number to which the user on the system must be attached. InternalPhoneId is issued by the administrator after entering the internal telephone numbers for the operators. This ID is part of the SIP name of the user to authorize the phone. (IDinternal).




How to find out the value of {userId}

User Id on the system. List of users in the system, you can get:
- via the web management console in the group setup


- using api request "Getting a list of users in the system"




Where to get the value {groupId}

- The group id can be obtained through the Web Manager interface in the group settings section:


- using api request "Get a list of all available groups"




Where to get {taskId}

The ID of the task that is added to the group and for which priority is given to the user
- can be accessed through the management web interface in the group setup, in the Priority Management section:


- using API request "Return taskId value by telemarketing id"




How to find out the values ​​of {smsProviderId}

The unique identifier of the SMS provider configured on the system provided by the system administrator.




How to find out {ivrScenarioId} values

Unique script IVR. The script ID can be seen in the manager panel in the script settings section of the script.




How to find out {callingSearchSpaceId} value

Unique call routing direction identifier.
A list of available values ​​is provided by the system administrator.




How to find out {callStatusRuleProcessorId} value

The processing processor id on unsuccessful attempts
A list of available values ​​is provided by the system administrator.




How to find out {QueueScenarioId} value

is a unique script identifier
A list of available values ​​is provided by the system administrator.




How to find out the value of {recallId}

Web recall account id can be seen in the manager panel in Web Callback Tasks settings.




Timezone list

The list of available time zones defined by the getAvailableIDs() method of the TimeZone class in Java

  Africa/Abidjan
  Africa/Accra
  Africa/Addis_Ababa
  Africa/Algiers
  Africa/Asmara
  Africa/Asmera
  Africa/Bamako
  Africa/Bangui
  Africa/Banjul
  Africa/Bissau
  Africa/Blantyre
  Africa/Brazzaville
  Africa/Bujumbura
  Africa/Cairo
  Africa/Casablanca
  Africa/Ceuta
  Africa/Conakry
  Africa/Dakar
  Africa/Dar_es_Salaam
  Africa/Djibouti
  Africa/Douala
  Africa/El_Aaiun
  Africa/Freetown
  Africa/Gaborone
  Africa/Harare
  Africa/Johannesburg
  Africa/Juba
  Africa/Kampala
  Africa/Khartoum
  Africa/Kigali
  Africa/Kinshasa
  Africa/Lagos
  Africa/Libreville
  Africa/Lome
  Africa/Luanda
  Africa/Lubumbashi
  Africa/Lusaka
  Africa/Malabo
  Africa/Maputo
  Africa/Maseru
  Africa/Mbabane
  Africa/Mogadishu
  Africa/Monrovia
  Africa/Nairobi
  Africa/Ndjamena
  Africa/Niamey
  Africa/Nouakchott
  Africa/Ouagadougou
  Africa/Porto-Novo
  Africa/Sao_Tome
  Africa/Timbuktu
  Africa/Tripoli
  Africa/Tunis
  Africa/Windhoek
  America/Adak
  America/Anchorage
  America/Anguilla
  America/Antigua
  America/Araguaina
  America/Argentina/Buenos_Aires
  America/Argentina/Catamarca
  America/Argentina/ComodRivadavia
  America/Argentina/Cordoba
  America/Argentina/Jujuy
  America/Argentina/La_Rioja
  America/Argentina/Mendoza
  America/Argentina/Rio_Gallegos
  America/Argentina/Salta
  America/Argentina/San_Juan
  America/Argentina/San_Luis
  America/Argentina/Tucuman
  America/Argentina/Ushuaia
  America/Aruba
  America/Asuncion
  America/Atikokan
  America/Atka
  America/Bahia
  America/Bahia_Banderas
  America/Barbados
  America/Belem
  America/Belize
  America/Blanc-Sablon
  America/Boa_Vista
  America/Bogota
  America/Boise
  America/Buenos_Aires
  America/Cambridge_Bay
  America/Campo_Grande
  America/Cancun
  America/Caracas
  America/Catamarca
  America/Cayenne
  America/Cayman
  America/Chicago
  America/Chihuahua
  America/Coral_Harbour
  America/Cordoba
  America/Costa_Rica
  America/Creston
  America/Cuiaba
  America/Curacao
  America/Danmarkshavn
  America/Dawson
  America/Dawson_Creek
  America/Denver
  America/Detroit
  America/Dominica
  America/Edmonton
  America/Eirunepe
  America/El_Salvador
  America/Ensenada
  America/Fort_Nelson
  America/Fort_Wayne
  America/Fortaleza
  America/Glace_Bay
  America/Godthab
  America/Goose_Bay
  America/Grand_Turk
  America/Grenada
  America/Guadeloupe
  America/Guatemala
  America/Guayaquil
  America/Guyana
  America/Halifax
  America/Havana
  America/Hermosillo
  America/Indiana/Indianapolis
  America/Indiana/Knox
  America/Indiana/Marengo
  America/Indiana/Petersburg
  America/Indiana/Tell_City
  America/Indiana/Vevay
  America/Indiana/Vincennes
  America/Indiana/Winamac
  America/Indianapolis
  America/Inuvik
  America/Iqaluit
  America/Jamaica
  America/Jujuy
  America/Juneau
  America/Kentucky/Louisville
  America/Kentucky/Monticello
  America/Knox_IN
  America/Kralendijk
  America/La_Paz
  America/Lima
  America/Los_Angeles
  America/Louisville
  America/Lower_Princes
  America/Maceio
  America/Managua
  America/Manaus
  America/Marigot
  America/Martinique
  America/Matamoros
  America/Mazatlan
  America/Mendoza
  America/Menominee
  America/Merida
  America/Metlakatla
  America/Mexico_City
  America/Miquelon
  America/Moncton
  America/Monterrey
  America/Montevideo
  America/Montreal
  America/Montserrat
  America/Nassau
  America/New_York
  America/Nipigon
  America/Nome
  America/Noronha
  America/North_Dakota/Beulah
  America/North_Dakota/Center
  America/North_Dakota/New_Salem
  America/Ojinaga
  America/Panama
  America/Pangnirtung
  America/Paramaribo
  America/Phoenix
  America/Port-au-Prince
  America/Port_of_Spain
  America/Porto_Acre
  America/Porto_Velho
  America/Puerto_Rico
  America/Punta_Arenas
  America/Rainy_River
  America/Rankin_Inlet
  America/Recife
  America/Regina
  America/Resolute
  America/Rio_Branco
  America/Rosario
  America/Santa_Isabel
  America/Santarem
  America/Santiago
  America/Santo_Domingo
  America/Sao_Paulo
  America/Scoresbysund
  America/Shiprock
  America/Sitka
  America/St_Barthelemy
  America/St_Johns
  America/St_Kitts
  America/St_Lucia
  America/St_Thomas
  America/St_Vincent
  America/Swift_Current
  America/Tegucigalpa
  America/Thule
  America/Thunder_Bay
  America/Tijuana
  America/Toronto
  America/Tortola
  America/Vancouver
  America/Virgin
  America/Whitehorse
  America/Winnipeg
  America/Yakutat
  America/Yellowknife
  Antarctica/Casey
  Antarctica/Davis
  Antarctica/DumontDUrville
  Antarctica/Macquarie
  Antarctica/Mawson
  Antarctica/McMurdo
  Antarctica/Palmer
  Antarctica/Rothera
  Antarctica/South_Pole
  Antarctica/Syowa
  Antarctica/Troll
  Antarctica/Vostok
  Arctic/Longyearbyen
  Asia/Aden
  Asia/Almaty
  Asia/Amman
  Asia/Anadyr
  Asia/Aqtau
  Asia/Aqtobe
  Asia/Ashgabat
  Asia/Ashkhabad
  Asia/Atyrau
  Asia/Baghdad
  Asia/Bahrain
  Asia/Baku
  Asia/Bangkok
  Asia/Barnaul
  Asia/Beirut
  Asia/Bishkek
  Asia/Brunei
  Asia/Calcutta
  Asia/Chita
  Asia/Choibalsan
  Asia/Chongqing
  Asia/Chungking
  Asia/Colombo
  Asia/Dacca
  Asia/Damascus
  Asia/Dhaka
  Asia/Dili
  Asia/Dubai
  Asia/Dushanbe
  Asia/Famagusta
  Asia/Gaza
  Asia/Harbin
  Asia/Hebron
  Asia/Ho_Chi_Minh
  Asia/Hong_Kong
  Asia/Hovd
  Asia/Irkutsk
  Asia/Istanbul
  Asia/Jakarta
  Asia/Jayapura
  Asia/Jerusalem
  Asia/Kabul
  Asia/Kamchatka
  Asia/Karachi
  Asia/Kashgar
  Asia/Kathmandu
  Asia/Katmandu
  Asia/Khandyga
  Asia/Kolkata
  Asia/Krasnoyarsk
  Asia/Kuala_Lumpur
  Asia/Kuching
  Asia/Kuwait
  Asia/Macao
  Asia/Macau
  Asia/Magadan
  Asia/Makassar
  Asia/Manila
  Asia/Muscat
  Asia/Nicosia
  Asia/Novokuznetsk
  Asia/Novosibirsk
  Asia/Omsk
  Asia/Oral
  Asia/Phnom_Penh
  Asia/Pontianak
  Asia/Pyongyang
  Asia/Qatar
  Asia/Qyzylorda
  Asia/Rangoon
  Asia/Riyadh
  Asia/Saigon
  Asia/Sakhalin
  Asia/Samarkand
  Asia/Seoul
  Asia/Shanghai
  Asia/Singapore
  Asia/Srednekolymsk
  Asia/Taipei
  Asia/Tashkent
  Asia/Tbilisi
  Asia/Tehran
  Asia/Tel_Aviv
  Asia/Thimbu
  Asia/Thimphu
  Asia/Tokyo
  Asia/Tomsk
  Asia/Ujung_Pandang
  Asia/Ulaanbaatar
  Asia/Ulan_Bator
  Asia/Urumqi
  Asia/Ust-Nera
  Asia/Vientiane
  Asia/Vladivostok
  Asia/Yakutsk
  Asia/Yangon
  Asia/Yekaterinburg
  Asia/Yerevan
  Atlantic/Azores
  Atlantic/Bermuda
  Atlantic/Canary
  Atlantic/Cape_Verde
  Atlantic/Faeroe
  Atlantic/Faroe
  Atlantic/Jan_Mayen
  Atlantic/Madeira
  Atlantic/Reykjavik
  Atlantic/South_Georgia
  Atlantic/St_Helena
  Atlantic/Stanley
  Australia/ACT
  Australia/Adelaide
  Australia/Brisbane
  Australia/Broken_Hill
  Australia/Canberra
  Australia/Currie
  Australia/Darwin
  Australia/Eucla
  Australia/Hobart
  Australia/LHI
  Australia/Lindeman
  Australia/Lord_Howe
  Australia/Melbourne
  Australia/NSW
  Australia/North
  Australia/Perth
  Australia/Queensland
  Australia/South
  Australia/Sydney
  Australia/Tasmania
  Australia/Victoria
  Australia/West
  Australia/Yancowinna
  Brazil/Acre
  Brazil/DeNoronha
  Brazil/East
  Brazil/West
  CET
  CST6CDT
  Canada/Atlantic
  Canada/Central
  Canada/Eastern
  Canada/Mountain
  Canada/Newfoundland
  Canada/Pacific
  Canada/Saskatchewan
  Canada/Yukon
  Chile/Continental
  Chile/EasterIsland
  Cuba
  EET
  EST5EDT
  Egypt
  Eire
  Etc/GMT
  Etc/GMT+0
  Etc/GMT+1
  Etc/GMT+10
  Etc/GMT+11
  Etc/GMT+12
  Etc/GMT+2
  Etc/GMT+3
  Etc/GMT+4
  Etc/GMT+5
  Etc/GMT+6
  Etc/GMT+7
  Etc/GMT+8
  Etc/GMT+9
  Etc/GMT-0
  Etc/GMT-1
  Etc/GMT-10
  Etc/GMT-11
  Etc/GMT-12
  Etc/GMT-13
  Etc/GMT-14
  Etc/GMT-2
  Etc/GMT-3
  Etc/GMT-4
  Etc/GMT-5
  Etc/GMT-6
  Etc/GMT-7
  Etc/GMT-8
  Etc/GMT-9
  Etc/GMT0
  Etc/Greenwich
  Etc/UCT
  Etc/UTC
  Etc/Universal
  Etc/Zulu
  Europe/Amsterdam
  Europe/Andorra
  Europe/Astrakhan
  Europe/Athens
  Europe/Belfast
  Europe/Belgrade
  Europe/Berlin
  Europe/Bratislava
  Europe/Brussels
  Europe/Bucharest
  Europe/Budapest
  Europe/Busingen
  Europe/Chisinau
  Europe/Copenhagen
  Europe/Dublin
  Europe/Gibraltar
  Europe/Guernsey
  Europe/Helsinki
  Europe/Isle_of_Man
  Europe/Istanbul
  Europe/Jersey
  Europe/Kaliningrad
  Europe/Kiev
  Europe/Kirov
  Europe/Lisbon
  Europe/Ljubljana
  Europe/London
  Europe/Luxembourg
  Europe/Madrid
  Europe/Malta
  Europe/Mariehamn
  Europe/Minsk
  Europe/Monaco
  Europe/Moscow
  Europe/Nicosia
  Europe/Oslo
  Europe/Paris
  Europe/Podgorica
  Europe/Prague
  Europe/Riga
  Europe/Rome
  Europe/Samara
  Europe/San_Marino
  Europe/Sarajevo
  Europe/Saratov
  Europe/Simferopol
  Europe/Skopje
  Europe/Sofia
  Europe/Stockholm
  Europe/Tallinn
  Europe/Tirane
  Europe/Tiraspol
  Europe/Ulyanovsk
  Europe/Uzhgorod
  Europe/Vaduz
  Europe/Vatican
  Europe/Vienna
  Europe/Vilnius
  Europe/Volgograd
  Europe/Warsaw
  Europe/Zagreb
  Europe/Zaporozhye
  Europe/Zurich
  GB
  GB-Eire
  GMT
  GMT0
  Greenwich
  Hongkong
  Iceland
  Indian/Antananarivo
  Indian/Chagos
  Indian/Christmas
  Indian/Cocos
  Indian/Comoro
  Indian/Kerguelen
  Indian/Mahe
  Indian/Maldives
  Indian/Mauritius
  Indian/Mayotte
  Indian/Reunion
  Iran
  Israel
  Jamaica
  Japan
  Kwajalein
  Libya
  MET
  MST7MDT
  Mexico/BajaNorte
  Mexico/BajaSur
  Mexico/General
  NZ
  NZ-CHAT
  Navajo
  PRC
  PST8PDT
  Pacific/Apia
  Pacific/Auckland
  Pacific/Bougainville
  Pacific/Chatham
  Pacific/Chuuk
  Pacific/Easter
  Pacific/Efate
  Pacific/Enderbury
  Pacific/Fakaofo
  Pacific/Fiji
  Pacific/Funafuti
  Pacific/Galapagos
  Pacific/Gambier
  Pacific/Guadalcanal
  Pacific/Guam
  Pacific/Honolulu
  Pacific/Johnston
  Pacific/Kiritimati
  Pacific/Kosrae
  Pacific/Kwajalein
  Pacific/Majuro
  Pacific/Marquesas
  Pacific/Midway
  Pacific/Nauru
  Pacific/Niue
  Pacific/Norfolk
  Pacific/Noumea
  Pacific/Pago_Pago
  Pacific/Palau
  Pacific/Pitcairn
  Pacific/Pohnpei
  Pacific/Ponape
  Pacific/Port_Moresby
  Pacific/Rarotonga
  Pacific/Saipan
  Pacific/Samoa
  Pacific/Tahiti
  Pacific/Tarawa
  Pacific/Tongatapu
  Pacific/Truk
  Pacific/Wake
  Pacific/Wallis
  Pacific/Yap
  Poland
  Portugal
  ROK
  Singapore
  SystemV/AST4
  SystemV/AST4ADT
  SystemV/CST6
  SystemV/CST6CDT
  SystemV/EST5
  SystemV/EST5EDT
  SystemV/HST10
  SystemV/MST7
  SystemV/MST7MDT
  SystemV/PST8
  SystemV/PST8PDT
  SystemV/YST9
  SystemV/YST9YDT
  Turkey
  UCT
  US/Alaska
  US/Aleutian
  US/Arizona
  US/Central
  US/East-Indiana
  US/Eastern
  US/Hawaii
  US/Indiana-Starke
  US/Michigan
  US/Mountain
  US/Pacific
  US/Pacific-New
  US/Samoa
  UTC
  Universal
  W-SU
  WET
  Zulu
  EST
  HST
  MST
  ACT
  AET
  AGT
  ART
  AST
  BET
  BST
  CAT
  CNT
  CST
  CTT
  EAT
  ECT
  IET
  IST
  JST
  MIT
  NET
  NST
  PLT
  PNT
  PRT
  PST
  SST
  VST