Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Интерфейс взаимодействия - REST API. Аутентификация - Basic Auth. Метод: Get Пример запроса для получения ссылки на запись разговора в формате wav: https://rc.mtt.ru/v1/records/<h323_conf_id>/urls Пример запроса для получения ссылки на запись разговора в формате mp3 необходимо обращаться на отличающийся от стандартного URL: https://rc.mtt.ru/v2/records/<h323_conf_id>/urls?format=mp3 , где h323_conf_id - параметр h323_conf_id разговора, который можно получить в результатах получения статистики 'getCallHistory' и 'getServiceHistoryByCustomer'. Пример запроса: https://rc.mtt.ru/v1/records/0000B3A4_55F311E4_A2420025_9062EDC4/urls Пример ответа (JSON): [ ] Это прямая ссылка на скачивание файла. В ситуациях определяемых вендором (в зависимости от размера записи или при логических действиях со звонком), один вызов может быть поделен на несколько записей, в таком случае ответ будут выглядеть следующим образом: [ "http://rs.mtt.ru/%/AA7C6C7E_932911E9_B87E5CB9_01FED6FC_1.wav", "http://rs.mtt.ru/%/AA7C6C7E_932911E9_B87E5CB9_01FED6FC_2.wav" ] |
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Точка подключения: https://webapicommon.mtt.ru/index.php
|
«Услуга CallBack API» Функционал позволяет по API:
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Описание: функционал позволяет клиенту, в момент поступления звонка от пользователя:
В момент входящего вызова на номер клиента платформа МТТ производит POST запрос (c ip - 80.75.132.186) к API клиента методом getControlCallFollowMe по полученному номеру. Пример POST запроса к API клиента: { "id": "1", "jsonrpc": "2.0", "method": "getControlCallFollowMe", "params": { "sip_id": " 79586488002", "numberA": "79154368886", "h323_conf_id": "BC5F236C 5AD211E9 81BA5CB9 01FED6FC" } } Входные параметры: Response
Пример ответа от API клиента: { "jsonrpc": "2.0", "id": "1", "result": { "redirect_type": 1, "event_URL": "http://домен/stub.php", "client_id": "1235", "file_to_A": "47f51cac1b50fd136334697b11aa406a", "file_to_B": "3806efe36d0f1bfccb45ffae8e152c7c", "followme_struct": [1, [ { "I_FOLLOW_ORDER": "1", "ACTIVE": "Y", "NAME": "79684881033", "REDIRECT_NUMBER": "79684881033", "PERIOD": "always", "PERIOD_DESCRIPTION": "always", "TIMEOUT": "15" } ]] } } Должен соответствовать нотации JsonRPC. Выходные параметры: Response
followme_struct
Запрос к API клиента отправляется на URL, структура: <схема>://<логин>:<пароль>@<хост>:<порт>/<URL-путь> В данном случае:
Получив ответ от API клиента, МТТ переводит вызовы согласно полученным параметрам переадресации. Отбой входящего вызова Для отбоя входящего звонка необходимо использовать след. структуру, пример: Причем, если в ответе присутствует параметр "file_to_A", пример: Предлагаем использовать данную структуру на неактивных номерах (без REDIRECT_NUMBER ). Изменение клиентского URL Клиент самостоятельно по средствам API может сменить URL для приема запроса getControlCallFollowMe, описание метода API:
Events уведомлений о ходе вызова
Резервирование переадресации входящего вызова Для осуществления резервирования переадресации входящего вызова при недоступности клиентского URL необходимо установить "оффлайн" переадресации ("number") для конкретного sip_id методом API:
Для всех кодов ответа от клиентского URL на запрос логики переадресации getControlCallFollowMe , отличных от HTTP 200, МТТ использует заранее предустановленную «оффлайн» переадресацию. Просмотр установленного клиентского URL и резервного номера для "оффлайн" переадресации Для этого используется метод API:
|
Сценарий - клиент отправляет API запрос на платформу МТТ, МТТ осуществляет вызов на полученный номер пользователя, при ответе пользователя ему проигрывается информационное сообщение с последующим отбоем. Функционал позволяет:
Точка входа : https://sb-api.mtt.ru/v1/sb Авторизация: Basic Auth API реализован в виде POST-запросов в соответствии со спецификацией JSON-RPC (http://www.jsonrpc.org/specification). Входные параметры:
Описание: Метод инициирует вызов на номер с заданными параметрами. data:
* - обязательные параметры Авторизационные данные для Basic Auth, method, sip_id выделяются на стороне МТТ при активации коммерческой среды. Возвращаемые параметры:
Пример: Запрос: JSON:
Успешный ответ:
Варианты неуспешного ответа:
Онлайн уведомления отправляются на предоставленный клиентом URL. Формат онлайн уведомлений: "date_time=дата и время&id=messId&CallID=CallID&event=o_b_number" - инициация вызова на b_number "date_time=дата и время&id=messId&CallID=CallID&event=h_b_number_cause_duration" - факт разъединения или недозвона где:
* - все существующие cause приведены в п. Получение статистики. Примеры: Абонент снял трубку, прослушал текст: [{"date_time=2019-03-29-11-37-13&id=1255490&CallID=00035c7d92bb0971&event=o_79100000000"}, {"date_time=2019-03-29-11-37-27&id=1255490&CallID=00035c7d92bb0971&event=h_79100000000_16_4"}] Абонент занят: [{"date_time=2019-03-29-09-33-46&id=1255490&CallID=00035c7d92bb0935&event=o_79100000000"}, {"date_time=2019-03-29-09-33-53&id=1255490&CallID=00035c7d92bb0935&event=h_79100000000_17_0"}] Абонент недоступен: [{"data":"date_time=2019-03-29-09-41-18&id=1255490&CallID=00035c7d92bb093b&event=o_79100000000"}, {"date_time=2019-03-29-09-41-38&id=1255490&CallID=00035c7d92bb093b&event=h_79100000000_20_0"}] |
Функционал позволяет в API запросе дополнительно указать структуру действий, наряду с текстом информирования для синтеза: перевод абонента на оператора, получения обратной связи на URL. Описание - клиент присылает API запрос на инициацию вызова, включающий текст для клиента и структуру DTMF параметров.
Точка входа : https://sb-api.mtt.ru/v1/sb
Для инициации вызова необходимо выполнить POST запрос. Входные параметры:
Описание: Метод инициирует вызов на номер с заданными параметрами.
data:
dtmf:
* - обязательные параметры
Возвращаемые параметры:
Пример: Запрос: JSON:
Успешный ответ:
Варианты неуспешного ответа:
Event уведомления - онлайн события о ходе вызова Уведомления отправляются POST запросом в формате JSON
1. Вызов b_number 1.1 Формат события инициация вызова на b_number
1.2 Формат события окончания вызова
* - в duration указано общее время вызова: TTS+разговор с оператором Примеры: Абонент снял трубку, прослушал текст:
Абонент занят
Абонент недоступен:
2. Уведомление при выборе dtmf
Инициация вызова на redirect_number:
Окончание переадресованного вызова:
* - в duration указано время переадресованного вызова, т.е. время общения с оператором Пример: Инициация вызова на redirect_number при выборе dtmf=2:
Окончание переадресованного вызова:
2.2 Формат события при type:callback
Пример:
2.3 Уведомление при не выборе абонентом dtmf Формат при не выборе dtmf
Пример:
3. Общий пример уведомлений о ходе вызова Кейс: Клиент отправил запрос указанный в примере, МТТ инициировал вызов абоненту (b_number), абонент снял трубку, прослушал сообщение (TTS), выбрал dtmf=3 и перевелся на соответствующий redirect_number, после общения с оператором вызов завершился.
* Возможные cause:
|
Точка подключения:https://msapi.mtt.ru:443/
|
Premedia API позволяет: ü Загружать промт и воспроизводить его в сторону звонящего и/либо в сторону принимающего вызов при переадресации; ü Устанавливать text-to-speech и воспроизводить его в сторону звонящего и/либо в сторону принимающего вызов при переадресации; ü Управление основными сценариями Premedia API:
Точка подключения: https://gapi.mtt.ru:6443/v1/api Авторизация: Basic Auth Метод: POST
|
Доступ к функции осуществляется по протоколу HTTPS: Точка подключения: https://gapi.mtt.ru:6443/v1/api Авторизация: Basic Auth Метод: POST
Для возможности покупки номеров определенного региона по API необходимо добавление хотя бы одного номера данного региона на лицевой счет. Данное действие производится через персонального менеджера. |
Доступ к функции осуществляется по протоколу HTTPS: Точка подключения: https://gapi.mtt.ru:6443/v1/api Авторизация: Basic Auth Метод: POST
Authorization:Basiс HTTP Auth. Пример:Запрос:JSON { "id": "1", "jsonrpc": "2.0", "method": "deleteGBLRule", "params": { "gbl_rule": "79266966166" } } Response:Successfull:JSON { "jsonrpc":"2.0", "id":"1", "result": { "success":1 } } Unsuccessfull:{
|
«WEB SDK» – продукт, предоставляющий возможность размещения в Web приложение Клиента функционала голосовой телефонной связи. Данный продукт предоставляется с необходимостью:
Данный продукт имеет следующий функционал:
Документация: https://flashphoner.com/documentation/ (Актуальная версия 5.0.2971) Демо стенд WebSdk:
Для получения параметров подключения к сети МТТ необходимо обратиться к персональному менеджеру. |