Загальна інформація
Отримуємо об’єктAccessToken, доступ до токена здійснюється через accessToken.token, який використовується у всіх наступних запитах.Отримання токена
Дата створення 2026-03-20
Дата останньої зміни 2026-03-31
Тіло запиту
{
"username": "user1",
"password": "password123"
}Приклад запиту
curl -X POST \
"${API_ENDPOINT}:8443/ics3/rest/login" \
-H "Content-Type: application/json" \
-d '{
"username": "user1",
"password": "password123"
}'Приклад відповіді
{
"id": 11,
"token": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZ2VudDIiLCJleHAiOjE3NzQzMjI3NDcsImasdaTc3NDI3OTU0N30.0m4gd19ByQfIh7cfZUOlptev97boOHH39HaS8UMsPoU",
"longExpiringToken": "long-exp:eyJasdaSDasdSasqJIUzI1NiJ9.eyJzdWIiOiJhZ2VudDIiLCJleHAiOjQ5MDQ1MjkwMTUsImlhdCI6MTc1MDkyOTAxNX0.jJwsaC18HBnKLPsWv0Iw2gOqIvJqmi_euNCui9NLLAk",
"refreshToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZ2VudDIiLCJleHAiOjE3NzY5MTQ3NDcsImlhdCI6MTc3NDI3OTU0N30.Qec9QZ_OI_fVbI4_vdSKa-ISYpx2ftKwqFd8NyodZ8M",
"user": {
"id": 10,
"name": "Agent-2",
"username": "agent2",
"password": "",
"description": "",
"creationDate": [
2025,
6,
12,
11,
56,
50
],
"email": "",
"mobilePhone": "",
"workPhone": "3003",
"position": "Agent",
"pbxDnsName": "webrtc-ics-dev2.iptel.ua",
"fmcNumber": null,
"authorities": null,
"userGroups": [
{
"id": 7,
"name": "users",
"userRoles": [
{
"id": 2,
"role": "GET_USER",
"description": ""
},
{
"id": 517,
"role": "USER_QUEUE_DASHBOARD_ADMIN",
"description": ""
}
],
"settings": {
"id": 4,
"isActive": null,
"name": "ICS-3",
"tariffName": "ICS-3",
"tariffCost": 100.0,
"tariffMaxUsers": 10,
"crmModuleEnabled": true,
"emailModuleEnabled": true,
"callCenterModuleEnabled": true,
"fmcModuleEnabled": true,
"missedCallsModuleEnabled": true,
"bitrix24ModuleEnabled": true,
"pipedriveModuleEnabled": null,
"uspacyModuleEnabled": null,
"amoCrmModuleEnabled": true,
"webRtcModuleEnabled": true,
"roboDialerEnabled": null,
"autoDialerEnabled": null,
"ttsEnabled": null,
"speechToTextEnabled": null,
"speechAnalyticsEnabled": null,
"vchasnoModuleEnabled": null,
"billingModuleEnabled": null,
"chatModuleEnabled": null,
"viberBotsEnabled": null,
"automatizationEnabled": null,
"contactCenterModuleEnabled": null,
"virtualAgentsModuleEnabled": null,
"whatsappModuleEnabled": null,
"tariffMaxRobots": null,
"tariffMaxAutoDialerAgents": null,
"checkLeadTimezoneModule": null,
"webRtcDefaultHost": null,
"sipDefaultHost": null,
"language": {
"id": 2,
"code": "ua",
"name": "Ukrainian",
"isDefault": null
},
"defaultAccount": null,
"defaultChatVirtualAgent": null,
"tariffMaxExternalNumbers": null,
"tariffUsedAdditionalDisks": null,
"maxTestCalls": null,
"maxCallDurationInSecondsToAnalyze": null,
"speechToTextDiarizationModel": null,
"tariffMaxFmcNumbers": null,
"tariffMaxAutodialerDialLevel": null,
"smsModuleEnabled": null,
"defaultSttProvider": null,
"calltrackingEnabled": null
}
}
],
"userViews": [
{
"availableUserView": {
"id": 1,
"name": "NAVBAR_VIEW",
"defaultValue": "VISIBLE"
},
"value": "VISIBLE"
},
{
"availableUserView": {
"id": 2,
"name": "DEFAULT_LEFT_PANEL_SIZE",
"defaultValue": "FULL"
},
"value": "FULL"
},
{
"availableUserView": {
"id": 3,
"name": "HORIZONTAL_SETTINGS_VIEW",
"defaultValue": "VISIBLE"
},
"value": "VISIBLE"
},
{
"availableUserView": {
"id": 4,
"name": "PREFERRED_CRM_VIEW",
"defaultValue": "KANBAN"
},
"value": "KANBAN"
},
{
"availableUserView": {
"id": 5,
"name": "SHOW_PUSH_NOTIFICATION",
"defaultValue": "ALWAYS"
},
"value": "ALWAYS"
},
{
"availableUserView": {
"id": 6,
"name": "PLAY_NEW_MESSAGE_AUDIO",
"defaultValue": "ALWAYS"
},
"value": "ALWAYS"
},
{
"availableUserView": {
"id": 7,
"name": "SHOW_SIDE_CHAT",
"defaultValue": "YES"
},
"value": "YES"
},
{
"availableUserView": {
"id": 8,
"name": "DEFAULT_KANBAN_SIZE",
"defaultValue": "10"
},
"value": "10"
},
{
"availableUserView": {
"id": 9,
"name": "PREFERRED_TASK_VIEW",
"defaultValue": "KANBAN"
},
"value": "KANBAN"
},
{
"availableUserView": {
"id": 51,
"name": "ENABLE_DEBUG_MODE",
"defaultValue": "NO"
},
"value": "NO"
},
{
"availableUserView": {
"id": 60,
"name": "ENABLE_SIP_JS_LOG",
"defaultValue": "NO"
},
"value": "NO"
}
],
"userSkills": null,
"userTeams": [
{
"id": 3,
"name": "Default",
"parentId": 0,
"isDefault": true,
"showNavbar": false,
"crmLeadResponsibleIsRequired": false,
"crmDealResponsibleIsRequired": false,
"crmTaskResponsibleIsRequired": false,
"appendCrmLeadsWithEmptyResponsibleToOwn": false,
"appendTicketsWithEmptyResponsibleToAvailable": false,
"showIcsEntityCardAfterCall": false,
"allowSelfEnrollAutodialerQueues": true,
"setAgentOnPauseAfterRegularQueueCall": false,
"childrens": null,
"users": null,
"pipelines": null,
"restrictedFields": null
},
],
"enabled": true,
"accountNonExpired": true,
"accountNonLocked": true,
"credentialsNonExpired": true
},
"expire": [
2026,
3,
24,
5,
25,
47,
502453029
],
"pjsipUser": {
"id": 3,
"userName": "3003",
"password": "a96zw000elgkmllh",
"isNat": false,
"isWebRtc": true,
"recordCalls": true,
"isBusy": true,
"customWebRtcSettings": true,
"enableEchoCancellation": false,
"enableNoiseSuppression": true,
"enableAutoGainControl": true,
"suppressLocalAudioPlayback": true,
"webRtcResponseTimeout": 0,
"iceServers": [],
"user": {
"id": 10,
"username": "agent2",
"name": "Agent-2"
}
},
"activeTariff": {
"id": 4,
"isActive": true,
"name": "ICS-3",
"tariffName": "ICS-3",
"tariffCost": 100.0,
"tariffMaxUsers": 10,
"crmModuleEnabled": true,
"emailModuleEnabled": true,
"callCenterModuleEnabled": true,
"fmcModuleEnabled": true,
"missedCallsModuleEnabled": true,
"bitrix24ModuleEnabled": true,
"pipedriveModuleEnabled": false,
"uspacyModuleEnabled": false,
"amoCrmModuleEnabled": true,
"webRtcModuleEnabled": true,
"roboDialerEnabled": true,
"autoDialerEnabled": true,
"ttsEnabled": false,
"speechToTextEnabled": true,
"speechAnalyticsEnabled": true,
"vchasnoModuleEnabled": false,
"billingModuleEnabled": true,
"chatModuleEnabled": true,
"viberBotsEnabled": false,
"automatizationEnabled": true,
"contactCenterModuleEnabled": true,
"virtualAgentsModuleEnabled": true,
"whatsappModuleEnabled": true,
"tariffMaxRobots": 10,
"tariffMaxAutoDialerAgents": 5,
"checkLeadTimezoneModule": false,
"webRtcDefaultHost": "webrtc-ics-dev2.iptel.ua",
"sipDefaultHost": "ics-dev2.iptel.ua",
"language": {
"id": 2,
"code": "ua",
"name": "Ukrainian",
"isDefault": null
},
"defaultAccount": {
"id": 1,
"name": "Default",
"isActive": null,
"isDefault": null,
"balance": null
},
"defaultChatVirtualAgent": null,
"tariffMaxExternalNumbers": 5,
"tariffUsedAdditionalDisks": 0,
"maxTestCalls": 0,
"maxCallDurationInSecondsToAnalyze": 1200,
"speechToTextDiarizationModel": "gpt-4o-mini",
"tariffMaxFmcNumbers": 0,
"tariffMaxAutodialerDialLevel": 3.0,
"smsModuleEnabled": true,
"defaultSttProvider": "OPEN_AI",
"calltrackingEnabled": true
},
"appConfigurationParams": [
{
"id": 33,
"name": "callDurationAverageLoss",
"value": "0.0"
},
{
"id": 27,
"name": "showTotalWorkTimeInReports",
"value": "yes"
},
{
"id": 51,
"name": "playOneBeepAudioAfterCallFinish",
"value": "no"
},
{
"id": 28,
"name": "enableAutodialerQueueAutoAnswer",
"value": "yes"
},
{
"id": 18,
"name": "showInboundAnsweredCallsInReports",
"value": "yes"
},
{
"id": 39,
"name": "crmLeadEntityAlias",
"value": ""
},
{
"id": 45,
"name": "crmSubscribedGoodEntityAlias",
"value": ""
},
{
"id": 26,
"name": "showIdleTimeInReports",
"value": "yes"
},
{
"id": 47,
"name": "groupUsersInCdr",
"value": "yes"
},
{
"id": 125,
"name": "customWebRtcSettings",
"value": "yes"
},
{
"id": 9,
"name": "setCustomOriginateVarAsCalledName",
"value": "no"
},
{
"id": 11,
"name": "showOutboundWaitingTimeInReports",
"value": "yes"
},
{
"id": 36,
"name": "linkIcsEntityToCallDetail",
"value": "yes"
},
{
"id": 52,
"name": "playOneBeepAudioBeforeAutoAnswer",
"value": "yes"
},
{
"id": 60,
"name": "showTechSupportModule",
"value": "yes"
},
{
"id": 55,
"name": "returnToAgentWorkspaceAfterCall",
"value": "yes"
},
{
"id": 16,
"name": "showInboundCallsInReports",
"value": "yes"
},
{
"id": 35,
"name": "showOldAgentWorkspace",
"value": "no"
},
{
"id": 68,
"name": "logAgentPause",
"value": "no"
},
{
"id": 66,
"name": "linkCrmEntityExternalKeyToCallDetail",
"value": "yes"
},
{
"id": 25,
"name": "showPauseTimeInReports",
"value": "yes"
},
{
"id": 100,
"name": "codecsForWebRtcInternalEndpoints",
"value": "default"
},
{
"id": 17,
"name": "showOutboundCallsInReports",
"value": "yes"
},
{
"id": 29,
"name": "enableRegularQueueAutoAnswer",
"value": "no"
},
{
"id": 19,
"name": "showInboundAsrInReports",
"value": "yes"
},
{
"id": 62,
"name": "allowAnonymousCalls",
"value": "yes"
},
{
"id": 30,
"name": "showPhoneNumberInAgentWorkspace",
"value": "yes"
},
{
"id": 166,
"name": "setAgentOnPauseAfterRegularQueueCall",
"value": "no"
},
{
"id": 58,
"name": "synchronizeExternalChatMessageModificationInIcs",
"value": "yes"
},
{
"id": 4,
"name": "logUserLogin",
"value": "yes"
},
{
"id": 2,
"name": "callDetailsShowExternalKey",
"value": "no"
},
{
"id": 14,
"name": "cleanChannelsAfterHangup",
"value": "no"
},
{
"id": 6,
"name": "logUserPressedPlayCallRecord",
"value": "no"
},
{
"id": 105,
"name": "showFailedPhasesInLeadKanban",
"value": "yes"
},
{
"id": 65,
"name": "enableCallSummarization",
"value": "no"
},
{
"id": 7,
"name": "logUserPressedDownloadCallRecord",
"value": "no"
},
{
"id": 63,
"name": "enableDebugMode",
"value": "yes"
},
{
"id": 24,
"name": "showInQueueTimeInReports",
"value": "yes"
},
{
"id": 13,
"name": "showSipAndAsteriskCauses",
"value": "no"
},
{
"id": 32,
"name": "callRecordsInStereoMode",
"value": "no"
},
{
"id": 23,
"name": "showInTalkingTimeInReports",
"value": "yes"
},
{
"id": 64,
"name": "allowToMakeDirectCalls",
"value": "no"
},
{
"id": 41,
"name": "crmCompanyEntityAlias",
"value": ""
},
{
"id": 42,
"name": "crmDealEntityAlias",
"value": ""
},
{
"id": 21,
"name": "showOutboundAsrInReports",
"value": "yes"
},
{
"id": 31,
"name": "showSideChat",
"value": "yes"
},
{
"id": 57,
"name": "displayLeadWithPhaseColor",
"value": "yes"
},
{
"id": 37,
"name": "icsEntityLinkingToCallDetailPriority",
"value": "COMPANY,LEAD,PHONEBOOK,INTERNAL,CONTACT"
},
{
"id": 5,
"name": "logUserLogout",
"value": "yes"
},
{
"id": 15,
"name": "showTotalCallsInReports",
"value": "yes"
},
{
"id": 38,
"name": "allowToGetVoicemailsViaFeatureCodes",
"value": "no"
},
{
"id": 56,
"name": "enableCrmEntityTableEditingMode",
"value": "no"
},
{
"id": 59,
"name": "showExternalNumberDescriptionInIncomingCalls",
"value": "no"
},
{
"id": 54,
"name": "showLastCommunicationChannelInTicket",
"value": "yes"
},
{
"id": 43,
"name": "crmTaskEntityAlias",
"value": ""
},
{
"id": 12,
"name": "showAsdInReports",
"value": "yes"
},
{
"id": 40,
"name": "crmContactEntityAlias",
"value": ""
},
{
"id": 50,
"name": "disableTelephoneSystemMessages",
"value": "no"
},
{
"id": 48,
"name": "hideDefaultPauseCodes",
"value": "no"
},
{
"id": 61,
"name": "enableTtsModuleBilling",
"value": "yes"
},
{
"id": 8,
"name": "logHangupAction",
"value": "no"
},
{
"id": 167,
"name": "enableExtendedQueueCallsStats",
"value": "no"
},
{
"id": 1,
"name": "callDetailsShowCalledNumber",
"value": "yes"
},
{
"id": 22,
"name": "showMissedCallsInReports",
"value": "yes"
},
{
"id": 46,
"name": "showCalledNumberInC2c",
"value": "yes"
},
{
"id": 53,
"name": "callRecordCustomFilenameFormat",
"value": ""
},
{
"id": 99,
"name": "codecsForNatInternalEndpoints",
"value": "default"
},
{
"id": 34,
"name": "showNewAgentWorkspace",
"value": "yes"
},
{
"id": 10,
"name": "showInternalCallsInReports",
"value": "yes"
},
{
"id": 44,
"name": "crmGoodEntityAlias",
"value": ""
},
{
"id": 3,
"name": "dashboardShowInCallWith",
"value": "yes"
},
{
"id": 67,
"name": "logPhoneChange",
"value": "no"
},
{
"id": 20,
"name": "showOutboundAnsweredCallsInReports",
"value": "yes"
},
{
"id": 49,
"name": "automaticallyAddUserIntoTicketChatOnOpen",
"value": "yes"
}
]
}