Факс (/fax/)
Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Данный ресурс позволяет настраивать параметры внутренних номеров типа "факс", а также получать и отправлять факсимильные сообщения.
Конфигурация факса
Параметр | Тип | Обяза-тельный | Значение по умолчанию | Описание |
|---|---|---|---|---|
fax_mailto | string | нет | null | Адрес электронной почты, на который будут отправлены полученные внутренним номером факсимильные сообщения. Возможно перечисление нескольких адресов через запятую |
- 1 Конфигурация факса
- 1.1 Пример
- 2 Получение факсимильных сообщений
- 2.1 Пример
- 3 Отправка факсимильных сообщений
- 3.1 Пример
- 4 Получение информации о состоянии отправки
- 5 Повтор и отмена отправки
- 5.1 Пример
- 6 Ресурсы раздела "Клиент"
- 7 Ресурсы раздела "Группа внутренних номеров”
- 8 Ресурсы раздела "Внутренний номер”
Пример
У внутреннего номера типа “факс” добавим адреса электронной почты, на которые будут отправляться полученные данным внутренним номером факсимильные сообщения:
Ответ системы:
{
"fax_mailto": "admin@host.com,user@host.com"
}Получение факсимильных сообщений
Существует возможность получать и управлять сообщениями, полученными внутренними номерами типа "факс".
Описание полей
Параметр | Тип | Описание |
|---|---|---|
caller_id | string | Номер отправителя сообщения |
client_id | long | Идентификатор клиента |
datetime | string | Дата и время получения сообщения |
destination | string | Номер получателя сообщения |
extension_group_id | long | Идентификатор группы внутренних номеров. Может иметь значение ‘null’, если внутренний номер не состоит ни в одной из групп |
extension_id | long | Идентификатор внутреннего номера |
file_size | long | Размер файла сообщения |
uuid | string | Идентификатор сообщения |
Пример
Отправка факсимильных сообщений
Content-Type при загрузке файлов
При загрузке файлов через метод POST следует установить заголовок Content-Type в значение multipart/form-data с указанием параметра boundary, который содержит последовательность символов, разделяющую части тела запроса. Параметры звукового файла и сам файл передаются как поля формы. Во всех остальных методах, в том числе и обновлении информации о звуковом файле, следует использовать обычный Content-Type: application/json и передавать информацию в JSON-формате. Стоит отметить, что в большинстве случаев различные библиотеки для работы с веб-ресурсами генерируют тело запроса и заголовок Content-Type с параметром boundary автоматически.
Описание полей запроса
Параметр | Тип | Обяза-тельный | Значение по умолчанию | Описание |
|---|---|---|---|---|
dst_num | string | да |
| Номер, на который требуется отправить факс |
file | file | да |
| Файл в формате tiff или pdf. Максимальный размер файла – 10 мегабайт |
Пример
Отправка файла faxtest.tif на номер 1234567
Ответ системы:
{
datetime: "2016-04-07 20:08:54",
dst_num: "1234567",
id: 174,
status: "ready_to_send"
}С точки зрения загрузки файлов, отправка факса производится так же, как и добавление звука, поэтому примеры запросов, содержащих файлы, можно посмотреть на странице “Звуковые файлы”.
Получение информации о состоянии отправки
Для получения информации о статусе отправки факсимильного сообщения необходимо воспользоваться соответствующим ресурсом:
для получения списка всех отправленных с внутреннего номера факсимильных сообщений: GET /extension/{extension_id}/fax/out/
для получения информации о конкретном отправленном факсимильном сообщении: GET /extension/{extension_id}/fax/out/{message_id}
Пример
Запросим информацию о сообщении с id 175, отправленном с внутреннего номера с id 122:
Ответ системы:
Описание полей
Параметр | Тип | Описание |
|---|---|---|
datetime | string | Дата и время отправки факсимильного сообщения |
dst_num | string | Номер, на который был отправлено факсимильное сообщение |
id | long | Идентификатор факсимильного сообщения |
status | string | Статус отправки факсимильного сообщения. Описание см. ниже |
Статус отправки
Статус | Описание |
|---|---|
ready_to_send | Сообщение поставлено в очередь на отправку. Отправку сообщения, имеющего данный статус, можно отменить |
sending | Сообщение в процессе отправки |
failed | Сбой отправки сообщения. Сообщение, имеющее этот статус, можно отправить заново или отменить отправку |
canceled | Отправка отменена |
error | Возникла ошибка отправки |
Повтор и отмена отправки
Сообщение, отправка которого завершилась неудачно (статус failed), можно отправить заново или отменить его отправку. Также возможна отмена отправки сообщения со статусом ready_to_send.
Для повтора отправки сообщения или отмены отправки необходимо осуществить PUT-запрос на ресурс /extension/{extension_id}/fax/out/{message_id}?action={action},
где параметр URL “action” может принимать значения retry и cancel для повтора отправки и отмены отправки сообщения соответственно.
Пример
Повторим отправку сообщения c id 175 с внутреннего номера с id 122:
Ответ системы: