Временные интервалы (/interval/)
- Dmitri Savolainen
- Asia Khalitova (Unlicensed)
- Evgeniy
- Роман Сухов (Unlicensed)
Мы обновили документацию, актуальная версия страницы доступна по ссылке: Временные интервалы (/interval/)
Ресурс предназначен для управления временными интервалами, которые впоследствии могут использоваться, например, для указания периода действия привил входящего вызова.
Описание структур данных
Интервал (IntervalItem)
Имя | Тип | Обязательный | Значение По Умолчанию | Описание |
|---|---|---|---|---|
|
|
| Временная зона интервала. | |
|
|
| Список условий временных диапазонов интервала | |
|
|
| Имя интервала |
Условие (Condition)
Параметры должны быть заданы парно (если задан "start_time", то должен быть и "end_time"), кроме параметра "month", который может быть задан сам по себе.
Если заданы "start_datetime" и "end_datetime", то другие параметры будут игнорироваться. Все параметры (кроме "start_datetime" и "end_datetime") дополняют друг друга, если определены, например, "month=7, start_dow=2, end_dow=3" подразумевает все вторники и среды июля.
Параметры с префиксом "start" должны быть меньше параметров с префиксом "end", исключением является пара "start_dow/end_dow", где записью "start_dow=3, end_dow=1" можно указать все дни кроме вторника
Имя | Тип | Обязательный | Значение По Умолчанию | Описание |
|---|---|---|---|---|
|
| нет | null | Дата начала в виде "YYYY-MM-DD hh:mm:ss", например "2015-02-20 15:33:01" |
|
| нет | null | Начальный день недели 1-7 (1-воскресенье, 7-суббота) |
|
| нет | null | Время начала в виде "hh:mm:ss" |
|
| нет | null | Время окончания в виде "hh:mm:ss" |
|
| нет | null | Месяц действия в диапазоне 1-12 |
|
| нет | null | Конечный день недели 1-7 (1-воскресенье, 7-суббота) |
|
| нет | null | Дата окончания в виде "YYYY-MM-DD hh:mm:ss", например "2015-02-20 16:34:00" |
|
| нет | null | Конечный день месяца (1-31) |
|
| нет | null | Начальный день месяца (1-31) |
sched_start_date | string | нет | null | Дата начала в виде "YYYY-MM-DD hh:mm:ss", например "2015-02-20 15:33:01" |
sched_active_days | integer | нет | null | Кол-во рабочих дней, начиная с даты начала. Минимум = 1 |
sched_skip_days | integer | нет | null | Кол-во дней, которые нужно пропустить до следующих рабочих дней. Минимум = 1 |
Пример
Для клиента с идентификатором 12 создать диапазон, отвечающий за понедельник-пятницу с 09:00 до 18:00 и субботу с 09:00 до 14:00
метод | ресурс | данные | ответ |
|---|---|---|---|
| POST | /client/12/interval/ | { ], | { |
Ресурсы
Раздел "клиент"
POST /client/{client_id}/interval/
Добавить interval
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
Ресурс condition
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
Ресурс interval_condition
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/interval/
Получить interval list
Параметры URL
Имя | Тип |
|---|---|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
Ресурс interval_condition
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
PUT /client/{client_id}/interval/{interval_id}
Обновить interval
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Параметры JSON
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
Ресурс condition
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
Ресурс interval_condition
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/interval/{interval_id}
Получить interval
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
Ресурс interval_condition
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DELETE /client/{client_id}/interval/{interval_id}
Удалить interval
Параметры URL
Имя | Тип |
|---|---|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
Ресурс interval_condition
Имя | Тип | Обязательный |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Раздел "группа добавочных"
Раздел "добавочный"
GET /extension/{extension_id}/interval/
Получить interval list
Параметры URL
Имя | Тип |
|---|---|
|
|
Параметры запроса
Имя | Тип |
|---|---|
|
|
|
|
|
|
Поля ответа
Имя | Тип |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
Теги по теме