Временные интервалы (/interval/)
- Asia Khalitova (Unlicensed)
- Ilya Titaev
- Evgeniy
Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Данный ресурс предназначен для управления временными интервалами, которые впоследствии могут использоваться, например, для указания периода действия правил входящего вызова.
Описание структур данных
Интервал (IntervalItem)
Имя | Тип | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|---|
conditions | Array[condition] | да |
| Список условий временных диапазонов интервала |
name | string | да |
| Имя интервала |
timezone | string | да |
| Временная зона интервала |
Условие (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" можно указать все дни недели, кроме понедельника.
При первом совпадении по условию отрабатывает интервал, при отсуствии совпадений в условиях интервала - интервал не работает.
Имя | Тип | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|---|
end_dow | long | нет | 0 | Конечный день недели 1-7 (1-воскресенье, 7-суббота) Используется для интервала типа interval. |
end_mday | long | нет | 0 | Конечный день месяца (1-31) Используется для интервала типа interval. |
end_time | string | нет |
| Время окончания в формате "hh:mm:ss" Используется для интервала типа interval. |
month | long | нет | 0 | Месяц действия в диапазоне 1-12 Используется для интервала типа interval. |
sched_active_days | long | нет | 0 | Количество рабочих дней (минимум 1), начиная с даты начала (sched_start_date) Используется для интервала типа scheduled_days |
sched_skip_days | long | нет | 0 | Количество нерабочих дней (минимум 1), которые нужно пропустить до следующих рабочих (sched_active_days). Используется для интервала типа scheduled_days |
sched_start_date | string | нет |
| Дата начала работы в формате "YYYY-MM-DD", например: "2015-02-20" Используется для интервала типа scheduled_days |
start_datetime | string | нет |
| Дата начала в формате "YYYY-MM-DD hh:mm:ss", например: "2015-02-20 15:33:01" Используется для интервала типа datetime_range. |
end_datetime | string | нет |
| Дата окончания в формате "YYYY-MM-DD hh:mm:ss", например: "2015-02-20 16:34:00" Используется для интервала типа datetime_range. |
start_dow | long | нет | 0 | Начальный день недели 1-7 (1-воскресенье, 7-суббота) Используется для интервала типа interval. |
start_mday | long | нет | 0 | Начальный день месяца (1-31) Используется для интервала типа interval. |
start_time | string | нет |
| Время начала в формате "hh:mm:ss" Используется для интервала типа interval. |
type | string | нет |
| параметр респонса. может быть один из: datetime_range - приоритетный тип интервала, будет возвращен если указаны условия start_datetime и end_datetime. В этом интервале указывается диапазон дней, когда интервал сработает. scheduled_days- будет возвращен если указаны sched_* условия. С помощью этого интервала можно сделать схему обработки звонка, например, смена 3 рабочих дня через 4. interval - будет вовзращен в случае других условий
|
usage | object | нет | null | {
'task_scheduler': {}, # {task_sched_id: null}
'context_rule': {}, # {ext_id: [{context: 1, option: ‘start’, rule: 2}], }
'incom_rule': {} # {ext_id: [{rule: 1}], }
}Содержит в себе информацию об использовании интервала в Планировщиках задач, правилах входящего вызова и правилах контекста IVR |
Пример
Для клиента с идентификатором 12 создать диапазон, отвечающий за понедельник-пятницу с 09:00 до 18:00 и субботу с 09:00 до 14:00:
Ресурсы раздела "Клиент"
Ресурсы раздела "Внутренний номер"