Queues
GET /api/organizations/{tenant_id}/queues/
Get Queues
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id |
Query параметры:
| Параметр | Тип | По умолчанию | Описание |
|---|---|---|---|
| skip | Skip | 0 | |
| limit | Limit | 100 |
Response 200: Successful Response
array[QueueResponse]
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | нет | |
| display_name | Display Name | нет | |
| queue_number | Queue Number | нет | |
| strategy | Strategy | нет | |
| context | Context | нет | |
| timeout | Timeout | нет | |
| musicclass | Musicclass | нет | |
| joinempty | Joinempty | нет | |
| leavewhenempty | Leavewhenempty | нет | |
| autopause | Autopause | нет | |
| autopausedelay | Autopausedelay | нет | |
| setinterfacevar | Setinterfacevar | нет | |
| tenant_id | Tenant Id | нет | |
| org_id | Org Id | нет | |
| auto_remove_unavailable | Auto Remove Unavailable | нет | |
| retry | Retry | нет | |
| wrapuptime | Wrapuptime | нет | |
| maxlen | Maxlen | нет | |
| servicelevel | Servicelevel | нет | |
| weight | Weight | нет | |
| announce_position | Announce Position | нет | |
| announce_holdtime | Announce Holdtime | нет | |
| periodic_announce_frequency | Periodic Announce Frequency | нет | |
| persistent | Persistent | нет | |
| membermacro | Membermacro | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
POST /api/organizations/{tenant_id}/queues/
Create Queue
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| queue_number | Queue Number | да | Номер очереди для feature-кодов (0-99) |
| display_name | Display Name | да | Наименование очереди |
| strategy | Strategy | нет | Стратегия распределения |
| timeout | Timeout | нет | Таймаут звонка оператору (сек) |
| musicclass | Musicclass | нет | Класс музыки на удержании |
| joinempty | Joinempty | нет | Входить в пустую очередь |
| leavewhenempty | Leavewhenempty | нет | Покидать пустую очередь |
| autopause | Autopause | нет | Автопауза при пропуске |
| autopausedelay | Autopausedelay | нет | Задержка автопаузы (сек) |
| setinterfacevar | Setinterfacevar | нет | Устанавливать переменные интерфейса |
| auto_remove_unavailable | Auto Remove Unavailable | нет | Автоудаление операторов при недоступности терминала |
| retry | Retry | нет | Интервал между попытками (сек) |
| wrapuptime | Wrapuptime | нет | Пауза после разговора (сек) |
| maxlen | Maxlen | нет | Макс. звонков в очереди (0=без лимита) |
| servicelevel | Servicelevel | нет | SLA порог (сек) |
| weight | Weight | нет | Приоритет очереди |
| announce_position | Announce Position | нет | Объявлять позицию в очереди |
| announce_holdtime | Announce Holdtime | нет | Объявлять время ожидания |
| periodic_announce_frequency | Periodic Announce Frequency | нет | Частота объявлений (сек) |
Response 201: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | нет | |
| display_name | Display Name | нет | |
| queue_number | Queue Number | нет | |
| strategy | Strategy | нет | |
| context | Context | нет | |
| timeout | Timeout | нет | |
| musicclass | Musicclass | нет | |
| joinempty | Joinempty | нет | |
| leavewhenempty | Leavewhenempty | нет | |
| autopause | Autopause | нет | |
| autopausedelay | Autopausedelay | нет | |
| setinterfacevar | Setinterfacevar | нет | |
| tenant_id | Tenant Id | нет | |
| org_id | Org Id | нет | |
| auto_remove_unavailable | Auto Remove Unavailable | нет | |
| retry | Retry | нет | |
| wrapuptime | Wrapuptime | нет | |
| maxlen | Maxlen | нет | |
| servicelevel | Servicelevel | нет | |
| weight | Weight | нет | |
| announce_position | Announce Position | нет | |
| announce_holdtime | Announce Holdtime | нет | |
| periodic_announce_frequency | Periodic Announce Frequency | нет | |
| persistent | Persistent | нет | |
| membermacro | Membermacro | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
GET /api/organizations/{tenant_id}/queues/{queue_name}
Get Queue
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id | |
| queue_name | Queue Name |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | нет | |
| display_name | Display Name | нет | |
| queue_number | Queue Number | нет | |
| strategy | Strategy | нет | |
| context | Context | нет | |
| timeout | Timeout | нет | |
| musicclass | Musicclass | нет | |
| joinempty | Joinempty | нет | |
| leavewhenempty | Leavewhenempty | нет | |
| autopause | Autopause | нет | |
| autopausedelay | Autopausedelay | нет | |
| setinterfacevar | Setinterfacevar | нет | |
| tenant_id | Tenant Id | нет | |
| org_id | Org Id | нет | |
| auto_remove_unavailable | Auto Remove Unavailable | нет | |
| retry | Retry | нет | |
| wrapuptime | Wrapuptime | нет | |
| maxlen | Maxlen | нет | |
| servicelevel | Servicelevel | нет | |
| weight | Weight | нет | |
| announce_position | Announce Position | нет | |
| announce_holdtime | Announce Holdtime | нет | |
| periodic_announce_frequency | Periodic Announce Frequency | нет | |
| persistent | Persistent | нет | |
| membermacro | Membermacro | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
PUT /api/organizations/{tenant_id}/queues/{queue_name}
Update Queue
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id | |
| queue_name | Queue Name |
Request Body:
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| display_name | Display Name | нет | |
| strategy | Strategy | нет | |
| timeout | Timeout | нет | |
| musicclass | Musicclass | нет | |
| joinempty | Joinempty | нет | |
| leavewhenempty | Leavewhenempty | нет | |
| autopause | Autopause | нет | |
| autopausedelay | Autopausedelay | нет | |
| setinterfacevar | Setinterfacevar | нет | |
| auto_remove_unavailable | Auto Remove Unavailable | нет | |
| retry | Retry | нет | |
| wrapuptime | Wrapuptime | нет | |
| maxlen | Maxlen | нет | |
| servicelevel | Servicelevel | нет | |
| weight | Weight | нет | |
| announce_position | Announce Position | нет | |
| announce_holdtime | Announce Holdtime | нет | |
| periodic_announce_frequency | Periodic Announce Frequency | нет |
Response 200: Successful Response
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
| name | Name | нет | |
| display_name | Display Name | нет | |
| queue_number | Queue Number | нет | |
| strategy | Strategy | нет | |
| context | Context | нет | |
| timeout | Timeout | нет | |
| musicclass | Musicclass | нет | |
| joinempty | Joinempty | нет | |
| leavewhenempty | Leavewhenempty | нет | |
| autopause | Autopause | нет | |
| autopausedelay | Autopausedelay | нет | |
| setinterfacevar | Setinterfacevar | нет | |
| tenant_id | Tenant Id | нет | |
| org_id | Org Id | нет | |
| auto_remove_unavailable | Auto Remove Unavailable | нет | |
| retry | Retry | нет | |
| wrapuptime | Wrapuptime | нет | |
| maxlen | Maxlen | нет | |
| servicelevel | Servicelevel | нет | |
| weight | Weight | нет | |
| announce_position | Announce Position | нет | |
| announce_holdtime | Announce Holdtime | нет | |
| periodic_announce_frequency | Periodic Announce Frequency | нет | |
| persistent | Persistent | нет | |
| membermacro | Membermacro | нет |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |
DELETE /api/organizations/{tenant_id}/queues/{queue_name}
Delete Queue
Авторизация: Bearer Token
Path параметры:
| Параметр | Тип | Описание |
|---|---|---|
| tenant_id | Tenant Id | |
| queue_name | Queue Name |
Ошибки:
| Код | Описание |
|---|---|
| 422 | Validation Error |