Документация Api V1
● Общая информация
Адрес сервера
Как получить токен доступа?
Личный кабинет SipSim.by => Интеграции => Кнопка "Подключить" под иконкой Api
Зачем нужен токен и как его использовать?
Токен нужен для авторизации вашего запроса. Для каждого запроса по Api V1, описанному ниже, нужно добавить в параметрах токен. Пример: /phones?token=Ваш токен
●Phones
Phone (телефон) -- это базовый элемент системы. Если вам нужно узнать настройки Менеджера, Отдела или IVR в нашей системе, то вам необходим именно phones.
Доступные методы
- GET /phones
GET /phones
Request (запрос)
Дополнительных параметров нет.
Response (ответ) => Массив телефонов
Элемент массива
поле | тип поля | описание |
| type | string | "regular" "department" "ivr" |
| number | string | Номер телефона |
| outbound_number | string | Номер телефона при исходящем => подменный номер для исходящего звонка. Может быть пустым. Используется в случае, когда менеджеру необходимо звонить от имени отдела. |
| internal_number | int | Внутренний номер телефона |
| calls_record_settings | object | Настройки записи звонков |
| calls_redirect_settings | object | Настройки переадресации |
| phone_groups | array | Группы дозвона для отдела |
| ivr_rules | object | Правила IVR |
calls_record_settings
поле | тип поля | описание |
| inbound_enabled | boolean | Запись входящих |
| outbound_enabled | boolean | Запись исходящих |
calls_redirect_settings
поле | тип поля | описание |
| force_redirection | {enabled: boolean, target_number: string or null} | Безусловная переадресация => переадресация будет при любом входящем. Например, менеджер ушёл на обед и переключил свои звонки на другого сотрудника. |
| conditional_redirection | {enabled: boolean, waiting_seconds: int, target_number: string or null} | Условная переадресация => переадресация при условии неответа больше, чем установленное время ожидания |
phone_group
поле | тип поля | описание |
| name | string | Имя группы |
| cycles_amount | int | Количество циклов |
| waiting_time | int | Время ожидания в секундах |
| smart_distribution | boolean | Умное распределение |
| numbers | array | Массив номеров группы |
| working_schedule | array | Массив 7 элементов. Для каждого дня расписания. |
working_schedule
поле | тип поля | описание |
| day_of_week_index | int | Индекс дня недели (Sunday - 0) |
| day_of_week_name | string | Имя дня недели на английском |
| enabled | boolean | |
| start | string | Время начала работы ("09:00") |
| end | string | Время конца работы ("14:00") |
●Calls
Call (звонок) -- хранит все данные о звонке.
Доступные методы
- GET /calls
GET /calls
Request (запрос)
!Промежуток между датами должен быть меньше 3 месяцев!
поле | тип поля | описание |
| start_date Обязательный параметр | "%d.%m.%Y" | Поиск звонков начиная с этой даты |
| end_date Обязательный параметр | "%d.%m.%Y" | Поиск звонков заканчивая этой датой |
| page По умолчанию равен 0 | первая страница равна 0 | Для пагинации |
Response (ответ)
поле | тип поля | описание |
| page | int | Номер текущей страницы |
| total | int | Общее количество звонков |
| limit | int | Количество звонков на странице |
| calls | array | Массив звонков |
Элемент массива звонков
поле | тип поля | описание |
| call_type | string | "outbound", "inbound" |
| sip_status | string | "answer", "no_answer", "cancel", "busy", "unavailable", "other" |
| caller_number | string | Кто звонил |
| target_number | string | Куда звонил |
| answered_phone_number | string or null | Номер телефона (Если пропущенный, то будет null) |
| answered | boolean | |
| registration_time | string(time format) | Время регистрации звонка |
| start_time | string(time format) | Время начала дозвона |
| answered_time | string(time format) or null | Время ответа на звонок |
| end_time | string(time format) | Время конца дозвона |
| wait_duration_sec | int | Время ожидания ответа |
| duration_sec | int | Время разговора |
| play_record_link | string | ссылка на запись разговора |
| public_id | string | уникальный идентификатор звонка |
