Мы обновили документацию, актуальная версия страницы доступна по ссылке: Факс (/fax/) |
Ресурс факс позволяет настраивать параметры добавочных типа "факс", а также получать и отправлять факсимильные сообщения.
Параметр | Тип | Обязательный | Значение по умолчанию | Описание |
---|---|---|---|---|
fax_mailto | string | нет | null | Адрес электронной почты, куда будет отправлен полученный добавочным факс. Возможно перечисление нескольких адресов через запятую. |
метод | ресурс | данные | ответ |
---|---|---|---|
PUT |
|
|
|
Существует возможность получать и управлять сообщениями, полученными добавочными типа "факс".
Параметр | Тип | Описание |
---|---|---|
caller_id |
| Номер отправителя сообщения |
client_id | integer | Идентификатор клиента |
datetime | string | Дата и время получения сообщения |
destination | string | Номер получателя сообщния |
extension_group_id | integer | Идентифиатор группы добавочных. Может иметь значение null, если добавочный не состоит ни в одной из групп |
extension_id | integer | Идентифиатор добавочного |
file_size | integer | Размер файла сообщения |
uuid | string | Идентификатор сообщения |
метод | ресурс | данные | ответ |
---|---|---|---|
GET |
|
|
При загрузке файлов через метод 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
Request URL: https://hostname.domain/api/ver1.0/extension/30/fax/out/ Request Method: POST Authorization:Bearer token Content-Type: multipart/form-data; boundary=----WebKitFormBoundaryuQN99hiRT3XAQXrK Host: hostname.domain ------WebKitFormBoundaryuQN99hiRT3XAQXrK Content-Disposition: form-data; name="file"; filename="faxtest.tif" Content-Type: image/tiff ------WebKitFormBoundaryuQN99hiRT3XAQXrK Content-Disposition: form-data; name="dst_num" 1234567 ------WebKitFormBoundaryuQN99hiRT3XAQXrK-- |
{ 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
метод | ресурс | данные | ответ |
---|---|---|---|
GET |
| { |
Параметр | Тип | Описание |
---|---|---|
dst_num | string | Номер, на который был отправлено факсимильное сообщение |
datetime | string | Дата и время отправки факсимильного сообщения |
id | integer | Идентификатор факсимильного сообщения |
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
метод | ресурс | данные | ответ |
---|---|---|---|
PUT |
| { |
GET /client/{client_id}/fax/in/
Получить список входящих факсимильных сообщений для клиента
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /client/{client_id}/fax/in/{fax_uuid
}Получить файл входящего факсимильного сообщения
Имя | Тип |
---|---|
|
|
|
|
DELETE /client/{client_id}/fax/in/{fax_uuid
}Удалить входящее факсимильное сообщение
Имя | Тип |
---|---|
|
|
|
|
GET /client/{client_id}/fax/out/
Получить список исходящих факсимильных сообщений
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
GET /extension_group/{ext_group_id}/fax/in/
Получить список входящих факсимильных сообщений для группы добавочных
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension_group/{ext_group_id}/fax/in/{fax_uuid
}Получить файл входящего факсимильного сообщения
Имя | Тип |
---|---|
|
|
|
|
PUT /extension/{extension_id}/fax/
Обновить конфигурацию факса
Имя | Тип |
---|---|
|
|
Имя | Тип | Обязательный |
---|---|---|
|
|
|
Имя | Тип |
---|---|
|
|
GET /extension/{extension_id}/fax/
Получить конфигурацию факса
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
GET /extension/{extension_id}/fax/in/
Получить список входящих факсимильных сообщений для добавочного
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/fax/in/{fax_uuid
}Получить файл входящего факсимильного сообщения
Имя | Тип |
---|---|
|
|
|
|
POST /extension/{extension_id}/fax/out/
Отправить факсимильное сообщение
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/fax/out/
Получить список исходящих факсимильных сообщений
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
PUT /extension/{extension_id}/fax/out/{message_id}
Переотправить или отменить отправку факсимильного сообщения
Имя | Тип |
---|---|
|
|
|
|
Имя | Тип |
---|---|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|
GET /extension/{extension_id}/fax/out/{message_id}
Получить информацию об исходящем факсимильном сообщении
Имя | Тип |
---|---|
|
|
|
|
Имя | Тип |
---|---|
|
|
|
|
|
|
|
|