Page Comparison

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

Данный ресурс предназначен для указания почтовых адресов, на которые будут направлены сообщения о каком-либо событии на внутреннем номере (например, о пропущенном вызове).

Table of Contents

Описание структур данных

Имя

Тип

Описание

mail

string

Почтовый адрес или несколько адресов, перечисленных через запятую

event_type

string

Имя события. Возможные варианты:

"call_failed_mail" — доступно для внутренних номеров типа “IVR (голосовое меню)”. Возникает, если вызов после попадания в голосовое меню не был соединен с конечным устройством

id

long

Уникальный (для внутреннего номера) идентификационный номер оповещения

Пример

Установим оповещения о неотвеченных вызовах, пришедших в голосовое меню (IVR) с номером 099:

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":{},"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/@099/mail_notification/"}]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"{"},{"type":"hardBreak"},{"type":"text","text":"\"event_type\": \"call_failed_mail\","},{"type":"hardBreak"},{"type":"text","text":"\"mail\": \"admin@myhost\""},{"type":"hardBreak"},{"type":"text","text":"}"}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"b68d001d-8a50-4e31-b38a-4c325b9ab3c3","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 '{\n  \"event_type\": \"call_failed_mail\",\n  \"mail\": \"admin@myhost\"\n}' \\\n-X POST ${url}/extension/@099/mail_notification/"}]}]},"id":"fe630555-f699-42ce-abb3-7e8d186043d2","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/@099/mail_notification/'\nheaders = {\n    'Authorization': f'Bearer {ACCESS_TOKEN}',\n    'Content-Type': 'application/json'\n}\ndata = '''{\n    \"event_type\": \"call_failed_mail\",\n    \"mail\": \"admin@myhost\"\n}'''\nresponse = requests.post(url, headers=headers, data=data)\nprint(response.text)"}]}]},"id":"748ae253-5bf6-444c-8cd8-86d55f247dd7","label":"На языке Python3    ","type":"tab"}]

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

Code Block

language	json

{
  "mail": "admin@myhost",
  "id": 20,
  "event_type": "call_failed_mail"
}

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

Expand

title	POST /extension/{extension_id}/mail_notification/

POST /extension/{extension_id}/mail_notification/

Добавить оповещение о событии на внутреннем номере

Параметры URL

Имя	Тип
extension_id	string

Параметры JSON

Имя	Тип	Обязательный
mail	string	да
event_type	string	да

Поля ответа

Имя	Тип
mail	string
event_type	string
id	long

Expand

title	GET /extension/{extension_id}/mail_notification/

GET /extension/{extension_id}/mail_notification/

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

Параметры URL

Имя	Тип
extension_id	string

Поля ответа

Имя	Тип
mail	string
event_type	string
id	long

Expand

title	PUT /extension/{extension_id}/mail_notification/{id}

PUT /extension/{extension_id}/mail_notification/{id}

Обновить оповещение о событии на внутреннем номере

Параметры URL

Имя	Тип
extension_id	string
id	integer

Параметры JSON

Имя	Тип	Обязательный
mail	string	нет
event_type	string	нет

Поля ответа

Имя	Тип
mail	string
event_type	string
id	long

Expand

title	GET /extension/{extension_id}/mail_notification/{id}

GET /extension/{extension_id}/mail_notification/{id}

Получить оповещение о событии на внутреннем номере

Параметры URL

Имя	Тип
extension_id	string
id	integer

Поля ответа

Имя	Тип
mail	string
event_type	string
id	long

Expand

title	DELETE /extension/{extension_id}/mail_notification/{id}

DELETE /extension/{extension_id}/mail_notification/{id}

Удалить оповещение о событии на внутреннем номере

Параметры URL

Имя	Тип
extension_id	string
id	integer

Versions Compared

Old Version 1

New Version Current

Key

Описание структур данных

Пример

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