Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Описание структур данных
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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
| Максимальное время ожидания снятия трубки в секундах. Сначала ожидается снятие трубки номерами-источниками вызова, затем ожидается снятие трубки на номере назначения dst-num. Если наdst-num проиграется early-media, то с момента проигрывания early-media возобновится таймер времени ожидания wait_for_pickup. Если за время wait_for_pickup трубка не будет снята, вызов не будет совершен (в случае передачи параметров transfer_after_* рекомендуется дожидаться истечения таймеров wait_for_pickup)Системное значение call_api_id string да Возвращается в ответ на запрос callback. Используется для возможности последующего управления вызовом call_id string да Возвращается в ответ на запрос callback и является его идентификатором. По нему можно фильтровать события, относящиеся к данному callback, получать отчеты по его результатам. Является синонимом call_uuid для ресурса истории вызовов |
Info |
---|
Результат callback |
Пример использования переменных в запросе
Использовать уже заданные в ресурсе Переменные (/variables/) переменные :
ext_id = 34535
caller_id_name = Ivan
|
Info |
---|
Результат callback |
Пример использования переменных в запросе
Использовать уже заданные в ресурсе Переменные переменные :
ext_id = 34535
caller_id_name = Ivan
Tabs |
---|
[{"content":{"version":1,"type":"doc","content":[{"type":"strongparagraph"}]},,"content":[{"type":"text","text":"иВ разделе "},{"type":"text","text":"client_secret authentication ","marks":[{"type":"strong"}]},{"type":"text","text":"требуется ввести полученные при регистрации приложения значения"text":"в поля "},{"type":"text","text":"Applicationclient_IDid ","marks":[{"type":"strong"}]},{"type":"text","text":"и "},{"type":"text","text":"Applicationclient_Secretsecret ","marks":[{"type":"strong"}]},{"type":"text","text":", затем нажать на кнопку \"требуется ввести полученные при регистрации приложения значения "},{"type":"text","text":"Try it out!Application_ID ","marks":[{"type":"strong"}]},{"type":"text","text":"\". Если данные приложения верны, в ответ вернётся токен доступа (","text":"и "},{"type":"text","text":"accessApplication_tokenSecret","marks":[{"type":"strong"}]},{"type":"text","text":")., Полученныйзатем токеннажать доступа следует ввести в полена кнопку \""},{"type":"text","text":"AccessTry Tokenit Fieldout!","marks":[{"type":"strong"}]},{"type":"text","text":"\". Если данные вверхуприложения страницыверны, ив сохранитьответ еговернётся нажатиемтокен кнопкидоступа \"("},{"type":"text","text":"Set Tokenaccess_token","marks":[{"type":"strong"}]},{"type":"text","text":"). Полученный токен доступа следует ввести в поле \"."}]},{"type":"text","text":"tableAccess Token Field","attrsmarks":[{"isNumberColumnEnabledtype":false,"layout"strong"}]},{"type":"defaulttext"},"contenttext":[{"type":"tableRow","content":[\" вверху страницы и сохранить его нажатием кнопки \""},{"type":"tableHeadertext","attrstext":{}"Set Token","contentmarks":[{"type":"paragraphstrong","content":[}]},{"type":"text","text":"метод\"."}]}]},{"type":"tableHeadertable","attrs":{},"contentisNumberColumnEnabled":[{false,"typelayout":"paragraphdefault"},"content":[{"type":"texttableRow","textcontent":"ресурс"}]}]},[{"type":"tableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"данныеметод"}]}]}]},{"type":"tableRowtableHeader","content":[{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"POSTресурс"}]}]},{"type":"tableCelltableHeader","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"/extension/@ext_id/callback/""данные"}]}]}]},{"type":"paragraphtableRow","content":[]}]},{"type":"tableCell","attrs":{},"content":[{"type":"paragraph","content":[{"type":"text","text":"POST"}]}]},{"type":"tableCell","attrs":{\"caller_id_name\": \"$cv(caller_id_name)\",","marks},"content":[{"type":"paragraph","content":[{"type":"codetext"}]},{"typetext":"hardBreak/extension/@ext_id/callback/"}]},{"type":"textparagraph","textcontent":"\"dst_num\": \"string\",","marks":[{"type":"code"}]},[]}]},{"type":"tableCell","attrs":{},"content":[{"type":"hardBreakparagraph"},"content":[{"type":"text","text":"{\"srccaller_id_numname\": [\"string\"]}","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[]}]},"id":"1ab97921-e7ca-452f-965a-4a763b57f8d3","label":"Интерактивный обозреватель API ",\"$cv(caller_id_name)\",","marks":[{"type":"code"}]},{"type":"hardBreak"},{"type":"tabtext"},{"contenttext":{"version":1,"type":"doc"\"dst_num\": \"string\",","contentmarks":[{"type":"paragraphcode"}]},{"contenttype":["hardBreak"},{"type":"text","text":"Для отправки запросов с помощью программы cURL установим значения переменных "},"\"src_num\": [\"string\"]}","marks":[{"type":"text","textcode"}]}]}]}]}]},{"type":"url paragraph","markscontent":[{"type]}]},"id":"strong"}]},{"type":"text","text":"и 1ab97921-e7ca-452f-965a-4a763b57f8d3","label":"Интерактивный обозреватель API ","type":"tab"},{"typecontent":{"textversion":1,"texttype":"access_tokendoc","markscontent":[{"type":"strongparagraph"}]},,"content":[{"type":"text","text":":"}]},{"type":"paragraph","content":[Для отправки запросов с помощью программы cURL установим значения переменных "},{"type":"text","text":"exporturl url=\"https://<hostname>/api/ver1.0\"","marks":[{"type":"codestrong"}]},{"type":"text","text":"и "},{"type":"hardBreaktext"},{"typetext":"textaccess_token","textmarks":"(где hostname — hostname API-сервера провайдера IP-телефонии),[{"type":"strong"}]},{"type":"paragraphtext","contenttext":[{"type":"text"}]},{"texttype":"export access_token=\"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"paragraph","markscontent":[{"type":"codetext"}]},{"type":"text,"text":"export url=\"https://<hostname>/api/ver1.0\"","textmarks":" "},[{"type":"hardBreakcode"}]},{"type":"text","text":"(полученный токен доступа)."}]},{"type":"paragraphhardBreak"},"content":[{"type":"text","text":"Отправим запрос:"}]},{"type":"codeBlock","attrs":{"language":"shell"}(где hostname — hostname API-сервера провайдера IP-телефонии),"}]},{"type":"paragraph","content":[{"type":"text","text":"curl -H \"Authorization: Bearer ${export access_token}=\" -H \"Content-Type: application/json\" -d '{\"caller_id_name\": \"$cv(caller_id_name)\",\"dst_num\": \"string\",\"src_num\": [\"string\"]}' -X POST ${url}/extension/@ext_id/callback/"}]}]},"id":"59f02ace-6798-4ee6-8ed3-7c878969f35b","label":"Программа cURL ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph"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 отправки запросов на языке 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-телефонии),"}]},-H \"Authorization: Bearer ${access_token}\" -H \"Content-Type: application/json\" -d '{\"caller_id_name\": \"$cv(caller_id_name)\",\"dst_num\": \"string\",\"src_num\": [\"string\"]}' -X POST ${url}/extension/@ext_id/callback/"}]}]},"id":"59f02ace-6798-4ee6-8ed3-7c878969f35b","label":"Программа cURL ","type":"tab"},{"content":{"version":1,"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"ACCESS_TOKEN = \"8SNsrS0jV35vfmKqKeKtRrHfpbg4UX\"","marks":[{"type":"code"":"Для отправки запросов на языке Python установим значения переменных URL и ACCESS_TOKEN:"}]},{"type":"hardBreakparagraph"},"content":[{"type":"text","text":"(полученныйURL токен= доступа)."}]},{"type":"codeBlock\"https://<hostname>/api/ver1.0\"","attrsmarks":[{"languagetype":"pythoncode"}]},"content":[{"type":"texthardBreak"},{"texttype":"#!/usr/bin/python\r\n\r\nimport requests\r\n\r\nurl = f'{URL}/extension/@ext_id/callback/'\r\nheaders = {\r\n 'Authorization': f'Bearer {ACCESS_TOKEN}',\r\n 'Content-Type': 'application/json'\r\n}\r\ndata = '''{\"caller_id_name\": \"$cv(caller_id_name)\",\"dst_num\": \"string\",\"src_num\": [\"string\"]}'''\r\nresponse = requests.post(url, headers=headers, data=data)\r\nprint(response.text)"}]}]},"id":"fe3b5416-5aa2-4f51-b4b2-2d3f3e4d8438","label":"На языке Python3 ","type":"tab"}] |
Ресурсы раздела "Внутренний номер"
Expand | ||
---|---|---|
| ||
POST /extension/{extension_id}/callback/ Инициировать вызов. Указанный в пути extension_id должен быть идентификатором внутреннего номера типа ‘phone’ Параметры URL | ||
Имя | Тип | |
extension_id | string | |
Имя | Тип | Обязательный |
allow_public_transfer | boolean | нет |
announce_sound_id | long | нет |
call_duration | long | нет |
caller_id_name | string | нет |
caller_id_number | string | нет |
dst_ani | string | нет |
dst_announce_sound_id | long | нет |
dst_dtmf | string | нет |
dst_num | string | да |
src_caller_id_name | string | нет |
src_caller_id_number | string | нет |
src_num | array [string] | да |
transfer_after_dst_hangup | string | нет |
transfer_after_src_hangup | string | нет | wait_for_pickup | long | нет
Ресурсы раздела "Внутренний номер"
Expand | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||
POST /extension/{extension_id}/callback/ Инициировать вызов. Указанный в пути extension_id должен быть идентификатором внутреннего номера типа ‘phone’ Параметры URL
Параметры JSON
Поля ответа
|