Page Comparison

_{Протестировать методы API можно на странице}_{интерактивного обозревателя API}_{и без написания кода}
_{Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см.}_{Создание и авторизация приложений}₎

Данный ресурс позволяет настраивать параметры внутренних номеров типа "факс", а также получать и отправлять факсимильные сообщения.

Конфигурация факса

Параметр	Тип	Обяза-тельный	Значение по умолчанию	Описание
fax_mailto	string	нет	null	Адрес электронной почты, на который будут отправлены полученные внутренним номером факсимильные сообщения. Возможно перечисление нескольких адресов через запятую

Table of Contents

Пример

У внутреннего номера типа “факс” добавим адреса электронной почты, на которые будут отправляться полученные данным внутренним номером факсимильные сообщения:

Tabs

[{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"В разделе "},{"type":"text","text":"authentication","marks":[{"type":"strong"}]},{"type":"text","text":" в поля "},{"type":"text","text":"client_id","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"client_secret","marks":[{"type":"strong"}]},{"type":"text","text":"  требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Application_ID","marks":[{"type":"strong"}]},{"type":"text","text":" и "},{"type":"text","text":"Application_Secret","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку \""},{"type":"text","text":"Try it out!","marks":[{"type":"strong"}]},{"type":"text","text":"\". Если данные приложения верны, в ответ вернётся токен доступа ("},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \""},{"type":"text","text":"Access Token Field","marks":[{"type":"strong"}]},{"type":"text","text":"\" вверху страницы и сохранить его нажатием кнопки \""},{"type":"text","text":"Set Token","marks":[{"type":"strong"}]},{"type":"text","text":"\"."}]},{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"background":"#f0f0f0"},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод"}]}]},{"type":"tableHeader","attrs":{"background":"#f0f0f0"},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс"}]}]},{"type":"tableHeader","attrs":{"background":"#f0f0f0"},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"PUT"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/122/fax/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"{"},{"type":"hardBreak"},{"type":"text","text":"\"fax_mailto\": \"admin@host.com,user@host.com\""},{"type":"hardBreak"},{"type":"text","text":"}"}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"a5994658-c5f7-4a83-baee-d9e7a2805cfa","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"url ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"access_token","marks":[{"type":"strong"}]},{"type":"text","text":":"}]},{"type":"paragraph","content":[{"type":"text","text":"$ export url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"$ export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"text","text":" "},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraph","content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"fax_mailto\": \"admin@host.com,user@host.com\"}' \\\n-X PUT ${url}/extension/122/fax/"}]}]},"id":"ab6e9596-8937-4929-a34d-e09338948cb8","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"paragraph","content":[{"type":"text","text":"URL = \"https://<hostname>/api/ver1.0\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\n\nimport requests\n\nurl = f'{URL}/extension/122/fax/'\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}',\r\n    'Content-Type': 'application/json'\r\n}\r\ndata = '''{\n    \"fax_mailto\": \"admin@host.com,user@host.com\"\n}'''\nresponse = requests.put(url, headers=headers, data=data)\nprint(response.text)"}]}]},"id":"7687566e-2a6b-4241-9f39-f0078d01f2ec","label":"На языке Python3    ","type":"tab"}]

Ответ системы:

Code Block

language	json

{
  "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	Идентификатор сообщения

Пример

Tabs

[{"content":{"version":1,"type":"doc","content":[{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/122/fax/in/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[]}]}]}]},{"type":"paragraph","content":[]}]},"id":"03a35251-8ec9-4687-9637-e0b9610197dd","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-X GET ${url}/extension/122/fax/in/"}]}]},"id":"d5168e59-32e7-45ba-b47a-ede8416d2dee","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\r\n\r\nimport requests\r\n\r\nurl = f'{URL}/extension/122/fax/in/'\r\nheaders = {\r\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\r\n}\r\nresponse = requests.get(url, headers=headers)\r\nprint(response.text)"}]}]},"id":"28bfc4b6-0459-40f7-a6a4-b338ae87d287","label":"На языке Python3    ","type":"tab"}]

Expand

title	Ответ системы:

Code Block

language	json

[
  {
    "caller_id": "1844*001",
    "client_id": 12,
    "datetime": "2015-11-25 15:08:06",
    "destination": "78123092631",
    "extension_group_id": null,
    "extension_id": 122,
    "file_size": 23142,
    "uuid": "1a66f8c6-936d-11e5-8563-d3163e2a7e2d"
  },
  {
    "caller_id": "1844*002",
    "client_id": 12,
    "datetime": "2015-11-25 15:16:10",
    "destination": "78123092631",
    "extension_group_id": null,
    "extension_id": 122,
    "file_size": 23138,
    "uuid": "3ae42208-936e-11e5-85a2-d3163e2a7e2d"
  }
]

Отправка факсимильных сообщений

Note

^{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

Tabs

[{"content":{"version":1,"type":"doc","content":[{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"POST"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/30/fax/out/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"{"},{"type":"hardBreak"},{"type":"text","text":"\"dst_num\": \"1234567\","},{"type":"hardBreak"},{"type":"text","text":"\"file\": \"faxtest.tif\""},{"type":"hardBreak"},{"type":"text","text":"}"}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"1f9ee4e4-9395-4e81-9e3f-e7bee991f220","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-H \"Content-Type: application/json\" \\\n-F file=@faxtest.tif \\\n-d '{\"dst_num\": \"1234567\"}' \\\n-X POST ${url}/extension/30/fax/out/"}]}]},"id":"7129cd15-5344-45a2-b060-25b94e257176","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\r\n\r\nimport requests\r\n\r\nurl = f'{URL}/extension/30/fax/out/'\r\nheaders = {\r\n    'Authorization': f'Bearer {ACCESS_TOKEN}',\r\n    'Content-Type': 'application/json'\r\n}\r\nfiles = {'file': open('faxtest.tif', 'rb')}\ndata = '''{'dst_num': '1234567'}'''\nresponse = requests.post(url, files=files, data=data, headers=headers)\r\nprint(response.text)"}]}]},"id":"3d2c3a68-16f4-4a29-a710-1efc183d1b51","label":"На языке Python3","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"html"},"content":[{"type":"text","text":"Request URL: https://hostname.domain/api/ver1.0/extension/30/fax/out/\nRequest Method: POST\nAuthorization:Bearer token\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundaryuQN99hiRT3XAQXrK\nHost: hostname.domain\n------WebKitFormBoundaryuQN99hiRT3XAQXrK\nContent-Disposition: form-data; name=\"file\"; filename=\"faxtest.tif\"\nContent-Type: image/tiff\n \n \n------WebKitFormBoundaryuQN99hiRT3XAQXrK\nContent-Disposition: form-data; name=\"dst_num\"\n \n1234567\n------WebKitFormBoundaryuQN99hiRT3XAQXrK--"}]}]},"id":"59f629ac-a055-4281-8cfa-002428ebeaa5","label":"HTTP-запрос    ","type":"tab"}]

Ответ системы:

Code Block

language	json

{
  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:

Tabs

[{"content":{"version":1,"type":"doc","content":[{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"GET"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/122/fax/out/175"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[]}]}]}]},{"type":"paragraph","content":[]}]},"id":"03a35251-8ec9-4687-9637-e0b9610197dd","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-X GET ${url}/extension/122/fax/out/175"}]}]},"id":"d5168e59-32e7-45ba-b47a-ede8416d2dee","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\r\n\r\nimport requests\r\n\r\nurl = f\"{URL}/extension/122/fax/out/175\"\r\nheaders = {\r\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\r\n}\r\nresponse = requests.get(url, headers=headers)\r\nprint(response.text)"}]}]},"id":"28bfc4b6-0459-40f7-a6a4-b338ae87d287","label":"На языке Python3    ","type":"tab"}]

Ответ системы:

Code Block

language	json

{
  "status": "sent",
  "dst_num": "1234567",
  "id": 175,
  "datetime": "2016-04-11 18:07:53"
}

Описание полей

Параметр	Тип	Описание
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:

Tabs

[{"content":{"version":1,"type":"doc","content":[{"type":"table","attrs":{"isNumberColumnEnabled":false,"layout":"default"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"метод","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"ресурс","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данные","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"PUT"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/122/fax/out/175?action=retry"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"03a35251-8ec9-4687-9637-e0b9610197dd","label":"Интерактивный обозреватель API    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"type":"text","text":"curl \\\n-H \"Authorization: Bearer ${access_token}\" \\\n-X PUT ${url}/extension/122/fax/out/175?action=retry"}]}]},"id":"d5168e59-32e7-45ba-b47a-ede8416d2dee","label":"Программа cURL    ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"codeBlock","attrs":{"language":"python"},"content":[{"type":"text","text":"#!/usr/bin/python\r\n\r\nimport requests\r\n\r\nurl = f\"{URL}/extension/122/fax/out/175?action=retry\"\r\nheaders = {\r\n    'Authorization': f'Bearer {ACCESS_TOKEN}'\r\n}\r\nresponse = requests.put(url, headers=headers)\r\nprint(response.text)"}]}]},"id":"28bfc4b6-0459-40f7-a6a4-b338ae87d287","label":"На языке Python3    ","type":"tab"}]

Ответ системы:

Code Block

language	json

{
  "status": "ready_to_send",
  "dst_num": "123",
  "id": 175,
  "datetime": "2016-04-11 18:07:53"
}

Ресурсы раздела "Клиент"

Expand

title	GET /client/{client_id}/fax/in/

GET /client/{client_id}/fax/in/

Получить список входящих факсимильных сообщений для клиента

Параметры URL

Имя	Тип
client_id	string

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

Имя	Тип
start_datetime	string
uuid	array [string]
destination	array [string]
caller_id	array [string]
end_datetime	string
extension_group_id	integer
order	string
extension_id	integer

Поля ответа

Имя	Тип
caller_id	string
client_id	long
datetime	string
destination	string
extension_group_id	long
extension_id	long
file_size	long
uuid	string

Expand

title	GET /client/{client_id}/fax/in/{fax_uuid}

GET /client/{client_id}/fax/in/{fax_uuid}

Получить файл входящего факсимильного сообщения

Параметры URL

Имя	Тип
fax_uuid	string
client_id	string

Expand

title	DELETE /client/{client_id}/fax/in/{fax_uuid}

DELETE /client/{client_id}/fax/in/{fax_uuid}

Удалить входящее факсимильное сообщение

Параметры URL

Имя	Тип
fax_uuid	string
client_id	string

Expand

title	GET /client/{client_id}/fax/out/

GET /client/{client_id}/fax/out/

Получить список исходящих факсимильных сообщений

Параметры URL

Имя	Тип
client_id	string

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

Имя	Тип
start_datetime	string
extension_id	integer
end_datetime	string
order	string

Поля ответа

Имя	Тип
id	long
status	string
dst_num	string
extension_id	long
datetime	string

Ресурсы раздела "Группа внутренних номеров”

Expand

title	GET /extension_group/{ext_group_id}/fax/in/

GET /extension_group/{ext_group_id}/fax/in/

Получить список входящих факсимильных сообщений для группы внутренних номеров

Параметры URL

Имя	Тип
ext_group_id	string

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

Имя	Тип
start_datetime	string
uuid	array [string]
destination	array [string]
caller_id	array [string]
end_datetime	string
order	string
extension_id	integer

Поля ответа

Имя	Тип
caller_id	string
client_id	long
datetime	string
destination	string
extension_group_id	long
extension_id	long
file_size	long
uuid	string

Expand

title	GET /extension_group/{ext_group_id}/fax/in/{fax_uuid}

GET /extension_group/{ext_group_id}/fax/in/{fax_uuid}

Получить файл входящего факсимильного сообщения

Параметры URL

Имя	Тип
ext_group_id	string
fax_uuid	string

Ресурсы раздела "Внутренний номер”

Expand

title	PUT /extension/{extension_id}/fax/

PUT /extension/{extension_id}/fax/

Обновить конфигурацию факса

Параметры URL

Имя	Тип
extension_id	string

Параметры JSON

Имя	Тип	Обязательный
email_to_fax_accept	string	нет
fax_in_format	string	нет
fax_mailto	string	нет
fax_out_greeting	long	нет

Поля ответа

Имя	Тип
email_to_fax_accept	string
fax_in_format	string
fax_mailto	string
fax_out_greeting	long

Expand

title	GET /extension/{extension_id}/fax/

GET /extension/{extension_id}/fax/

Получить конфигурацию факса

Параметры URL

Имя	Тип
extension_id	string

Поля ответа

Имя	Тип
email_to_fax_accept	string
fax_in_format	string
fax_mailto	string
fax_out_greeting	long

Expand

title	GET /extension/{extension_id}/fax/in/

GET /extension/{extension_id}/fax/in/

Получить список входящих факсимильных сообщений для внутреннего номера

Параметры URL

Имя	Тип
extension_id	string

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

Имя	Тип
start_datetime	string
uuid	array [string]
destination	array [string]
caller_id	array [string]
end_datetime	string
order	string

Поля ответа

Имя	Тип
caller_id	string
client_id	long
datetime	string
destination	string
extension_group_id	long
extension_id	long
file_size	long
uuid	string

Expand

title	GET /extension/{extension_id}/fax/in/{fax_uuid}

GET /extension/{extension_id}/fax/in/{fax_uuid}

Получить файл входящего факсимильного сообщения

Параметры URL

Имя	Тип
extension_id	string
fax_uuid	string

Expand

title	POST /extension/{extension_id}/fax/out/

POST /extension/{extension_id}/fax/out/

Отправить факсимильное сообщение

Параметры URL

Имя	Тип
extension_id	string

Поля ответа

Имя	Тип
datetime	string
dst_num	string
id	long
status	string

Expand

title	GET /extension/{extension_id}/fax/out/

GET /extension/{extension_id}/fax/out/

Получить список исходящих факсимильных сообщений

Параметры URL

Имя	Тип
extension_id	string

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

Имя	Тип
start_datetime	string
order	string
end_datetime	string

Поля ответа

Имя	Тип
datetime	string
dst_num	string
id	long
status	string

Expand

title	PUT /extension/{extension_id}/fax/out/{message_id}

PUT /extension/{extension_id}/fax/out/{message_id}

Повторить или отменить отправку факсимильного сообщения

Параметры URL

Имя	Тип
extension_id	string
message_id	integer

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

Имя	Тип
action	string

Поля ответа

Имя	Тип
datetime	string
dst_num	string
id	long
status	string

Expand

title	GET /extension/{extension_id}/fax/out/{message_id}

GET /extension/{extension_id}/fax/out/{message_id}

Получить информацию об исходящем факсимильном сообщении

Параметры URL

Имя	Тип
extension_id	string
message_id	integer

Поля ответа

Имя	Тип
datetime	string
dst_num	string
id	long
status	string

Versions Compared

Old Version 1

New Version Current

Key

Конфигурация факса

Пример

Получение факсимильных сообщений

Пример

Отправка факсимильных сообщений

Пример

Получение информации о состоянии отправки

Повтор и отмена отправки

Пример

Ресурсы раздела "Клиент"

Ресурсы раздела "Группа внутренних номеров”

Ресурсы раздела "Внутренний номер”