Как скачать звонок через API

Скачивание звонков через API с помощью программы Postman.

Перейдите на сайт программы и скачайте версию программы для вашей операционной системы. Для Windows нажмите «Windows x64».

Postman не поддерживает Windows 32-bit. 

Откройте программу «Postman». Если уже регистрировались — нажмите _«Log In», е_сли нет —  «Create Free Account». Без аккаунта воспользоваться программой для скачивания звонков не получится.

На загрузку программы может понадобиться несколько минут. 

В вашем браузере откроется сайт, на котором необходимо зарегистрироваться. Для регистрации укажите почту, логин и пароль, затем нажмите «Create Free Account». 

После завершения регистрации на сайте — убедитесь, что вы авторизованы в программе, затем переходите к следующим этапам.

Далее необходимо импортировать коллекцию (перенос на свой компьютер коллекции Postman помогает организовать и сгруппировать связанные запросы API). Скачайте уже готовую коллекцию для программы. Вернитесь в программу Postman. Нажмите на значок импорта «Use resources or import».

В новом окне нажмите на «files».

Далее выберите скачанный ранее файл коллекции «onpbx-postman_collection». Нажмите «Открыть».

Развернётся импортированная коллекция, перейдите во вкладку «Body».  В поле «POST» вместо domain.onpbx.ru укажите название вашего домена (имеет вид pbx12345.onpbx.ru). Ниже будут параметры:

• uuid — позволит скачать определённый звонок по uuid.
• start_stamp_from, start_stamp_to — позволяет скачать звонки архивом за определённый период времени (значение периода «от» и «до»). 
• download — оставьте этот параметр активным для скачивания звонков. Если параметр включён, то вместо массива данных будет возвращен URL для скачивания файла записей звонков. Если найден один звонок, то время жизни ссылки: 200 секунд, иначе — один час.

Поставьте галку напротив требуемых.

В примере ниже будет скачиваться архив звонков за определённый период. 

Максимальный интервал, за который можно получить звонки в одном запросе (кроме запросов с uuid), — одна неделя.

Для отправки запроса требуется указать два значения времени (начало периода и конец) в формате «Unix Timestamp». Перейдите по ссылке, укажите время первой временной точки и нажмите «Преобразовать →».

Скопируйте значение из поля «Unix Timestamp».

Повторите преобразование для второй временной точки.

В программе «Postman» скопированные из поля «Unix Timestamp» значения вставьте в поля «start_stamp_from» и «start_stamp_to».

В панели управления onlinePBX перейдите в Сервисы > Интеграция, выберите «API».

Скопируйте API-ключ и возвращайтесь к работе с программой «Postman».

Перейдите во вкладку «Scripts», выберите «Pre-request Script». Замените текст _ВВЕДИТЕ API-КЛЮЧ (_кавычки "" не удаляйте) на скопированный ранее API-ключ. 

Вернитесь во вкладку «Body» и нажмите на кнопку «Send» для отправки запроса.

В нижней части экрана перейдите в Body > JSON, в открывшемся окне появится ссылка на архив записей звонков. Зажмите кнопку «Ctrl» на клавиатуре и кликните на ссылку. Начнётся скачивание архива.

Не скачивайте звонки более чем за одну неделю разом.

Во время формирования архива не закрывайте окно загрузки. На архивацию 1000 звонков требуется примерно четыре минуты. Максимальное время ожидания: 40 минут. 

Нажмите правой кнопкой мыши на скачанный архив, выберите «Извлечь всё...».

В новом окне выберите расположение места, в котором сохранится папка с записями. Нажмите «Извлечь».

Откроется папка с аудиофайлами звонков.

Готово! Теперь вы можете прослушать скачанные записи разговоров. 

Обратите внимание — у скачанных звонков время в названии файла указано в часовом поясе UTC+0.

Особенности настройки:

1. Максимальный интервал, за который можно получить звонки в одном запросе (кроме запросов с uuid) — одна неделя.
2. Разница между параметром start_stamp_to и start_stamp_from не должна превышать максимальный интервал в секундах (неделя).
3. Если интервал в секундах превышает максимальный (одна неделя), то будет отправлена информация по звонкам за максимальный интервал (одна неделя).
4. Если не указан ни один из этих параметров: start_stamp_to и start_stamp_from, то будет отправлена информация по звонкам за текущие сутки (GMT-0).
5. Возможна задержка до 1 минуты между завершением звонка и его доступностью при использовании API.

Конвертация времени в формат Unix Time Stamp. Unix-время представлено целым числом, которое увеличивается с каждой прошедшей секундой без необходимости вычислений для определения года, месяца, дня, часа или минуты для удобства восприятия человеком.