Download OpenAPI specification:
Открывает новую сессию оператора колл-центра с учётом лицензионных ограничений и прав доступа. Если указан флаг принудительного входа ForceLogin, то все другие сессии от имени этого пользователя будут завершены, открытая транзакция будет привязана к только что созданной сессии. Состояние имеющейся транзакции можно поулчить с помощью метода transaction/info.
| Token required | string <GUID> Token внешней системы |
| Login required | string Логин оператора колл-центра |
| Password required | string Пароль оператора колл-центра |
| ForceLogin | boolean Флаг принудительного входа. |
{- "Login": "test",
- "Password": "testPassword",
- "ForceLogin": true
}{- "Authorization": "59cde2b6-a9f9-43e8-b6c4-31337639c999",
- "User": {
- "Id": "7225287f-7029-45ae-a65f-bc0abd73c0df",
- "Login": "testLogin",
- "Name": "Иван",
- "SurName": "Иванов",
- "IntegrationId": "ivanov_external_id"
}
}Если в текущей сессии имеется незавершёная транзакция, то данная транзакция будет автоматически отменена перед завершением сессии
| Authorization required | string <GUID> Идентификатор авторизации сессии |
API session with authorization header 'b27e2f58-d3a0-4f4d-8820-dd4dbf29584f' not foundЕсли в текущей сессии имеется незавершёная транзакция, то сервер вернёт ошибку 500
| Authorization required | string <GUID> Идентификатор авторизации сессии |
API session with authorization header 'b27e2f58-d3a0-4f4d-8820-dd4dbf29584f' not foundЕсли в текущей транзакции были выполнены какие-то изменения или операции с услугами и талона, то эти изменения будут полностью отменены
| Authorization required | string <GUID> Идентификатор авторизации сессии |
API session with authorization header 'b27e2f58-d3a0-4f4d-8820-dd4dbf29584f' not foundЕсли в текущей транзакции были выполнены какие-то изменения или операции с услугами и талона, то эти изменения будут применены полностью
| Authorization required | string <GUID> Идентификатор авторизации сессии |
API session with authorization header 'b27e2f58-d3a0-4f4d-8820-dd4dbf29584f' not foundВозвращает информацию о состоянии текущей транзакции оператора колл-центра с указанием всех операций в рамках этой транзакции. Если в массиве Reserved у какого-то элемента указан OldTicketId, но при этом Route, то это означает, что новый резерв создан путём копирования старого талона с идентификатором OldTicketId.
| Authorization required | string <GUID> Идентификатор авторизации сессии |
{- "Reserved": [
- {
- "ReservationId": "1350d9c0-430a-4b74-a707-8e68366876e1",
- "OldTicketId": "9ddda856-659a-46bf-b0c4-bcdc2f08ec70",
- "TicketId": "07381e5c-4383-4695-97e9-f9f09babc59e",
- "ServerId": "fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9",
- "TimeSlotId": "6627EC5F06DA525E",
- "StartDateTime": "2025-09-10T17:35:28",
- "Route": [
- [
- [
- {
- "LinkId": "4c158b67-acb7-cc46-579a-142abdaf9b2c",
- "Multiplier": 0
}
]
]
], - "Fields": [
- {
- "Id": "1152a115-aba3-4a07-85db-b1dc23f47ab2",
- "Name": "Номер телефона",
- "Mask": "70000000000",
- "RegularExpression": "^((7)+([0-9]){10})$",
- "Required": true
}
]
}
], - "Canceled": [
- "7fae87dc-ccea-40aa-9acc-bb5e9460b002",
- "b2c5cb8b-c03d-490f-9981-bb8f792b0a55"
]
}Возвращает список серверов, которые могут обслужить указанный пункт меню и которые доступны оператору по правам
| menuLinkId required | string <GUID> (API_колл-центра_MenuLinkId) Example: 4c158b67-acb7-cc46-579a-142abdaf9b2c Идентификатор пункта меню |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
[- {
- "Id": "fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9",
- "Name": "Тестовый филиал 1",
- "IsConnected": true,
- "WrongProtocol": false,
- "ClientId": "department1",
- "OrganizationName": "ООО Крафт АйТи",
- "OrganizationFullName": "Общество с ограниченной ответственностью Крафт АйТи",
- "OrganizationAddress": "625007, Тюменская обл., г. Тюмень, ул. 30 лет Победы, д. 25, стр. 10",
- "IntegrationId": "external_server_id",
- "TimeZone": {
- "Id": "Asia/Yekaterinburg",
- "Name": "Екатеринбург",
- "UtcOffset": "UTC+05:00"
}
}
]Возвращает пункты меню заданного типа из меню для API, указанного в настройках локального сервера. Если типа пунктов меню не указан, то будут возвращены пункты для предварительной записи
| serverId required | string <GUID> (API_колл-центра_ServerId) Example: fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9 Идентификатор локального сервера |
Живая очередь0 (any) or Предварительная запись1 (any) or Живая очередь или предварительная запись2 (any) (API_колл-центра_MenuItemType) Example: menuType=2 Тип пункта меню |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
[- {
- "SubItems": [
- {
- "QueueIsAvailable": true,
- "RecordIsAvailable": true,
- "Multiplier": {
- "Title": "Количество дел",
- "Limit": 15
}, - "IntegrationId": "external_menu_item_id",
- "Id": "0267e7a3-2746-9c7f-8f60-b7bed05d1322",
- "Name": "Доступ к порталу госуслуг (ЕСИА)"
}
], - "Id": "f49133af-2680-8aba-0fab-afc4e501c31a",
- "Name": "Общие услуги"
}
]Возвращает пункты меню заданного типа из указанного меню. Если типа пунктов меню не указан, то будут возвращены пункты для предварительной записи
| serverId required | string <GUID> (API_колл-центра_ServerId) Example: fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9 Идентификатор локального сервера |
| menuId required | string <GUID> Example: f63ba6bf-fb63-94b0-d546-f844d5fbed38 Идентификатор меню |
Живая очередь0 (any) or Предварительная запись1 (any) or Живая очередь или предварительная запись2 (any) (API_колл-центра_MenuItemType) Example: menuType=2 Тип пункта меню |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
[- {
- "SubItems": [
- {
- "QueueIsAvailable": true,
- "RecordIsAvailable": true,
- "Multiplier": {
- "Title": "Количество дел",
- "Limit": 15
}, - "IntegrationId": "external_menu_item_id",
- "Id": "0267e7a3-2746-9c7f-8f60-b7bed05d1322",
- "Name": "Доступ к порталу госуслуг (ЕСИА)"
}
], - "Id": "f49133af-2680-8aba-0fab-afc4e501c31a",
- "Name": "Общие услуги"
}
]Возвращает список этапов услуг для заданного пункта меню
| menuLinkId required | string <GUID> (API_колл-центра_MenuLinkId) Example: 4c158b67-acb7-cc46-579a-142abdaf9b2c Идентификатор пункта меню |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
[- {
- "Products": [
- {
- "Product": {
- "Id": "a64adadc-0727-8829-3d58-cdcb361108c4",
- "Name": "Тестовое наименование услуги",
- "IntegrationId": null
}, - "Priority": 0
}
]
}
]Возвращает список дат, на которые может быть выполнена запись талона для указанного пункта меню. Идентификатор талона TicketId нужно указывать, если формируем мультиталон.
| serverId required | string <GUID> (API_колл-центра_ServerId) Example: fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9 Идентификатор локального сервера |
| menuLinkId required | string <GUID> (API_колл-центра_MenuLinkId) Example: menuLinkId=4c158b67-acb7-cc46-579a-142abdaf9b2c Идентификатор пункта меню |
| multiplier | integer <byte> Example: multiplier=3 Мультипликатор (количество дел) для услуги |
| ticketId | string <GUID> (API_колл-центра_TicketId) Example: ticketId=07381e5c-4383-4695-97e9-f9f09babc59e Идентификатор существующего талона |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
[- {
- "Year": 2025,
- "Months": [
- {
- "Month": 5,
- "Days": [
- {
- "Day": 1,
- "IsFree": true
}
]
}
]
}
]Возвращает список дат, на которые может быть выполнена запись талона для маршрута. Идентификатор талона TicketId в теле запроса нужно указывать, если формируем мультиталон.
| serverId required | string <GUID> (API_колл-центра_ServerId) Example: fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9 Идентификатор локального сервера |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
required | Array of objects (API_колл-центра_RequestedRoute) [ items[ items ] ] Пользовательский маршрут услуг |
| TicketId | string <GUID> (API_колл-центра_TicketId) Идентификатор талона |
{- "Route": [
- [
- [
- {
- "LinkId": "4c158b67-acb7-cc46-579a-142abdaf9b2c",
- "Multiplier": 0
}
]
]
], - "TicketId": "07381e5c-4383-4695-97e9-f9f09babc59e"
}[- {
- "Year": 2025,
- "Months": [
- {
- "Month": 5,
- "Days": [
- {
- "Day": 1,
- "IsFree": true
}
]
}
]
}
]Возвращает список слотов с указанием доступности для записи для указанного пункта меню. Идентификатор талона TicketId нужно указывать, если формируем мультиталон.
| serverId required | string <GUID> (API_колл-центра_ServerId) Example: fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9 Идентификатор локального сервера |
| date required | string <date> (API_колл-центра_Date) Example: 23.05.2025 Дата предварительной записи |
| menuLinkId required | string <GUID> (API_колл-центра_MenuLinkId) Example: menuLinkId=4c158b67-acb7-cc46-579a-142abdaf9b2c Идентификатор пункта меню |
| multiplier | integer <byte> Example: multiplier=3 Мультипликатор (количество дел) для услуги |
| ticketId | string <GUID> (API_колл-центра_TicketId) Example: ticketId=07381e5c-4383-4695-97e9-f9f09babc59e Идентификатор существующего талона |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
[- {
- "Id": "6627EC5F06DA525E",
- "Hour": 9,
- "Minute": 30,
- "IsFree": true
}
]Возвращает список слотов предварительной записи для маршрута. Идентификатор талона TicketId в теле запроса нужно указывать, если формируем мультиталон.
| serverId required | string <GUID> (API_колл-центра_ServerId) Example: fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9 Идентификатор локального сервера |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
| Date required | string <date> (API_колл-центра_Date) Дата в формате дд.мм.гггг |
required | Array of objects (API_колл-центра_RequestedRoute) [ items[ items ] ] Пользовательский маршрут услуг |
| TicketId | string <GUID> (API_колл-центра_TicketId) Идентификатор талона |
{- "Date": "23.05.2025",
- "Route": [
- [
- [
- {
- "LinkId": "4c158b67-acb7-cc46-579a-142abdaf9b2c",
- "Multiplier": 0
}
]
]
], - "TicketId": "07381e5c-4383-4695-97e9-f9f09babc59e"
}[- {
- "Id": "6627EC5F06DA525E",
- "Hour": 9,
- "Minute": 30,
- "IsFree": true
}
]Создаёт талон предварительной записи на указанную услуг в заданный филиал на указанный слот предварительной записи. Новый талон создаётся в статусе "Зарезервирован". Слот записи резервируется на 30 минут, либо до окончания транзакции.
Идентификатор талона TicketId в теле запроса нужно указывать, если формируем мультиталон.
| Authorization required | string <GUID> Идентификатор авторизации сессии |
| ServerId required | string <GUID> (API_колл-центра_ServerId) Идентификатор сервера |
| TimeSlotId required | string Идентификатор таймслота |
| MenuLinkId required | string <GUID> (API_колл-центра_MenuLinkId) Идентификатор пункта меню |
| Multiplier | integer <Int32> Ультипликатор (количество дел) услуги |
| TicketId | string <GUID> (API_колл-центра_TicketId) Идентификатор талона |
{- "ServerId": "fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9",
- "TimeSlotId": "6627EC5F06DA525E",
- "MenuLinkId": "4c158b67-acb7-cc46-579a-142abdaf9b2c",
- "Multiplier": 1,
- "TicketId": "07381e5c-4383-4695-97e9-f9f09babc59e"
}{- "ReservationId": "1350d9c0-430a-4b74-a707-8e68366876e1",
- "TicketId": "07381e5c-4383-4695-97e9-f9f09babc59e",
- "Products": [
- {
- "Id": "string",
- "Product": {
- "Id": "a64adadc-0727-8829-3d58-cdcb361108c4",
- "Name": "Тестовое наименование услуги",
- "IntegrationId": null
}
}
], - "RequestedFields": [
- {
- "Id": "1152a115-aba3-4a07-85db-b1dc23f47ab2",
- "Name": "Номер телефона",
- "Mask": "70000000000",
- "RegularExpression": "^((7)+([0-9]){10})$",
- "Required": true
}
]
}Создаёт талон предварительной записи на маршрут в заданный филиал на указанный слот предварительной записи. Новый талон создаётся в статусе "Зарезервирован". Слот записи резервируется на 30 минут, либо до окончания транзакции.
Идентификатор талона TicketId в теле запроса нужно указывать, если формируем мультиталон.
| Authorization required | string <GUID> Идентификатор авторизации сессии |
| ServerId required | string <GUID> (API_колл-центра_ServerId) Идентификатор сервера |
| TimeSlotId required | string Идентификатор таймслота |
required | Array of objects (API_колл-центра_RequestedRoute) [ items[ items ] ] Пользовательский маршрут услуг |
| TicketId | string <GUID> (API_колл-центра_TicketId) Идентификатор талона |
{- "ServerId": "fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9",
- "TimeSlotId": "6627EC5F06DA525E",
- "Route": [
- [
- [
- {
- "LinkId": "4c158b67-acb7-cc46-579a-142abdaf9b2c",
- "Multiplier": 0
}
]
]
], - "TicketId": "07381e5c-4383-4695-97e9-f9f09babc59e"
}{- "ReservationId": "1350d9c0-430a-4b74-a707-8e68366876e1",
- "TicketId": "07381e5c-4383-4695-97e9-f9f09babc59e",
- "Products": [
- {
- "Id": "string",
- "Product": {
- "Id": "a64adadc-0727-8829-3d58-cdcb361108c4",
- "Name": "Тестовое наименование услуги",
- "IntegrationId": null
}
}
], - "RequestedFields": [
- {
- "Id": "1152a115-aba3-4a07-85db-b1dc23f47ab2",
- "Name": "Номер телефона",
- "Mask": "70000000000",
- "RegularExpression": "^((7)+([0-9]){10})$",
- "Required": true
}
]
}Заполняет во всех услугах талона заданные поля дополнительных сведений
| Authorization required | string <GUID> Идентификатор авторизации сессии |
| ReservationId | string <GUID> (API_колл-центра_ReservationId) Идентификатор резерва |
Array of objects (API_колл-центра_InputDataField) Значения полей дополнительных сведений |
{- "ReservationId": "1350d9c0-430a-4b74-a707-8e68366876e1",
- "DataFields": [
- {
- "FieldId": "1152a115-aba3-4a07-85db-b1dc23f47ab2",
- "Value": "79221234567"
}
]
}API session with authorization header 'b27e2f58-d3a0-4f4d-8820-dd4dbf29584f' not foundОтменяет указанный резерв услуг
| reservationId required | string <GUID> (API_колл-центра_ReservationId) Example: 1350d9c0-430a-4b74-a707-8e68366876e1 Идентификатор резерва |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
API session with authorization header 'b27e2f58-d3a0-4f4d-8820-dd4dbf29584f' not foundОтменяет указанный талон целиком
| ticketId required | string <GUID> (API_колл-центра_TicketId) Example: 07381e5c-4383-4695-97e9-f9f09babc59e Идентификатор существующего талона |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
{- "Id": "07381e5c-4383-4695-97e9-f9f09babc59e",
- "FullNumber": "П14",
- "Pincode": "625743",
- "State": 0,
- "Products": [
- {
- "Id": "a64adadc-0727-8829-3d58-cdcb361108c4",
- "Name": "Тестовое наименование услуги",
- "IntegrationId": null,
- "State": 13,
- "StartTime": "2025-09-15T10:30:00",
- "Fields": [
- {
- "Id": "5111cdc8-977f-410b-9a7b-e1caaea92835",
- "Value": "79123456789",
- "Field": {
- "Id": "1152a115-aba3-4a07-85db-b1dc23f47ab2",
- "Name": "Номер телефона"
}
}
]
}
], - "ServerId": "fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9",
- "ActivationAvailability": {
- "ActivationAvailabilityState": 8,
- "ErrorMessage": "Талон отменён",
- "ShowQuestionBeforeActivation": false
}
}Отменяет указанную услугу в талоне. Если услуга является частью маршрута, то отменяется весь маршрут.
| ticketProductId required | string <GUID> (API_колл-центра_TicketProductId) Example: fb99fe0d-723c-4383-a825-51b6335b5a61 Идентификатор услуги в талоне |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
{- "Id": "07381e5c-4383-4695-97e9-f9f09babc59e",
- "FullNumber": "П14",
- "Pincode": "625743",
- "State": 0,
- "Products": [
- {
- "Id": "a64adadc-0727-8829-3d58-cdcb361108c4",
- "Name": "Тестовое наименование услуги",
- "IntegrationId": null,
- "State": 13,
- "StartTime": "2025-09-15T10:30:00",
- "Fields": [
- {
- "Id": "5111cdc8-977f-410b-9a7b-e1caaea92835",
- "Value": "79123456789",
- "Field": {
- "Id": "1152a115-aba3-4a07-85db-b1dc23f47ab2",
- "Name": "Номер телефона"
}
}
]
}
], - "ServerId": "fdf88de8-5ba9-2bdf-e15c-fd0ce9b189f9",
- "ActivationAvailability": {
- "ActivationAvailabilityState": 8,
- "ErrorMessage": "Талон отменён",
- "ShowQuestionBeforeActivation": false
}
}Возвращает изображение талона для печати в формате PNG.

| ticketId required | string <GUID> (API_колл-центра_TicketId) Example: 07381e5c-4383-4695-97e9-f9f09babc59e Идентификатор существующего талона |
| scale | number [ 0.01 .. 30 ] Example: scale=1 Коэффициент масштабирования изображения от 0.01 до 30. По умолчанию 1 (96 dpi, для отображения на экране) |
| Authorization required | string <GUID> Идентификатор авторизации сессии |
�PNG
IHDR ,