Использование API

Запросы отправляются на https://digitoffice.ru/api

Параметры запроса:

  • uuid – ваш ключ.
  • from – вы можете указать номер телефона, который будет отображаться на экране абонента. Предварительно номер должен быть подтверждён на странице телефонов.
  • to – укажите номер телефона абонента. Если в запросе присутствуют несколько параметров to, то наш сервис прозвонит каждому.
  • file – загрузите аудио файл размером не более 1 Мб, который будет воспроизведен абонентам.
  • phrase – через этот параметр вы можете отправить фразы, которые будут продиктованы абоненту. В качестве фразы можно использовать просто текст (который будет преобразован в голос), либо напишите название загруженного аудио файла из страницы файлов. Одновременно загружать файл и указывать phrase нельзя.
  • query_for_files_list - если указать в запросе этот параметр, то вернется список ваших загруженных файлов. Параметр фактически является фильтром, смотрите примеры ниже.
  • delete_id - удаление файла по id.
  • rename_id, rename_name - переименование файла по id.
  • ivr_name - переадрессация на голосовое меню.
  • pre_audio, pre_text - воспроизведение фразы(аудио) после поднятия трубки.
В ответ возвращается json-строка со статусом запроса и объяснением в случае ошибки:
{"status": "ok"}
или
{"status": "error", "error": "Описание ошибки"}

Примеры:
Получение списка всех загруженных файлов:

curl --data "uuid=xxxxxyyyyyyyzzzzzzz&query_for_files_list" https://digitoffice.ru/api
Получение списка загруженных файлов, начинающихся со слова Moroder:
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&query_for_files_list=Moroder" https://digitoffice.ru/api

Загрузка файла с последующим звонком и воспроизведением на номер 74951111111
curl --form "file=@makala-200-part.wav" --form from=74950000000 --form to=74951111111 \
--form uuid=xxxxxyyyyyyyzzzzzzz https://digitoffice.ru/api
* Прим. Если не указывать параметры from и to, то получится просто загрузка файла, без последующего звонка с воспроизведением

Звонок на номер 74951111111 с воспроизведением загруженного файла
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&from=74950000000&to=74951111111\
&phrase=makala-200-part.wav" https://digitoffice.ru/api

Предварительно файл должен быть загружен на наш сервер на странице "Файлы". Копируете название файла из столбца "Название", и вставляете в url в параметр phrase. Разумеется, если у вас много файлов, то названия в таблице должны быть уникальными. Рекомендуем так же названия писать латинскими буквами, например privet-mir-eto-testovoe-soobshenie.

Звонок с воспроизведением загруженного файла и проговариванием текста (предварительно файл должен быть загружен на наш сервер, название файла берется из таблицы на странице "Файлы")
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&from=74950000000&to=74951111111\
&phrase=makala-200-part.wav&phrase=Привет! Я умею говорить&phrase=good_bye.wav" https://digitoffice.ru/api
При загрузке нескольких файлов звонки не совершаются даже если указать параметры from и to
curl --form "file=@recorded_voice.mp3" --form "file=@another_voice.mp3" \
--form uuid=xxxxxyyyyyyyzzzzzzz https://digitoffice.ru/api
Звонок с внутреннего номера 701 на 702 (фразы и файл не указываются)
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&from=701&to=702" https://digitoffice.ru/api
Удаление файла
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&delete_id=000" https://digitoffice.ru/api
Переименовывание файла
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&rename_id=000&rename_name=New-name-for-file" https://digitoffice.ru/api
Так же можно сделать переадрессацию в голосовое меню (IVR), для этого нужно в параметре ivr_name передать название меню.
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&from=74950000000&to=74951111111\
&ivr_name=menu-a" https://digitoffice.ru/api
Перед звонком (например, перед соединением с меню), можно воспроизвести заранее записанный аудиофайл, или продиктовать текст. Для этого используйте дополнительные параметры pre_audio или pre_text соответственно. Предварительное воспроизведение аудио (название файла берется из таблицы на странице "Файлы"):
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&from=74950000000&to=74951111111\
&ivr_name=menu-a&pre_audio=ricky_martin.mp3" https://digitoffice.ru/api
Предварительное проговаривание текста:
curl --data "uuid=xxxxxyyyyyyyzzzzzzz&from=74950000000&to=74951111111\
&ivr_name=menu-a&pre_text=Здравствуйте, как ваши дела?" https://digitoffice.ru/api


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