Expand | ||
---|---|---|
| ||
По вопросам подключения/интеграции Telecom API необходимо обратиться по почте api.sale@mtt.ru В письме просьба указать:
Наш менеджер свяжется с Вами в ближайшее время. |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Expand | ||
---|---|---|
| ||
Интерфейс взаимодействия - REST API. Аутентификация - Base 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): [ ] Это прямая ссылка на скачивание файла. | ||
Expand | ||
| ||
В ситуациях определяемых вендором (в зависимости от размера записи или при логических действиях со звонком), один вызов может быть поделен на несколько записей, в таком случае ответ будут выглядеть следующим образом: [ "http://rs.mtt.ru/%/AA7C6C7E_932911E9_B87E5CB9_01FED6FC_1.wav", "http://rs.mtt.ru/%/AA7C6C7E_932911E9_B87E5CB9_01FED6FC_2.wav" ] |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Expand | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Точка подключения: https://webapicommon.mtt.ru/index.php
Выходные параметры:
* Обязательные поля
Авторизация: Авторизация осуществляется штатными средствами HTTP Пример: Запрос: JSON запрос:
Ответ:
Успешный ответ:
{
Не успешный ответ:
Не успешный ответ:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
«Услуга CallBackAPI» – сервис, предоставляющий возможность Функционал позволяет по API заказать :
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Описание: функционал позволяющий Клиентупозволяет клиенту, в момент поступления звонка от Пользователя Клиента, осуществить онлайн перенаправление данного звонка на определенный номер телефона.В момент входящего вызова на номер клиента платформа МТТ производит пользователя:
В момент входящего вызова на номер клиента платформа МТТ производит POST запрос (c ip - 80.75.132.186) к API клиента методом getControlCallFollowMe по полученному номеру. Пример POST запроса к API клиента:
, где: "Входные параметры: Response
Пример ответа от API клиента:
3, [{ "I_FOLLOW_ORDER": "1", "ACTIVE": "Y", "NAME": "79684881033", "REDIRECT_NUMBER": "79684881033", "PERIOD": "always", "PERIOD_DESCRIPTION": "always", "TIMEOUT": "15" }, {
Name Type Description
}, { "I_FOLLOW_ORDER": "3", "ACTIVE": "Y", "NAME": "79684881035", "REDIRECT_NUMBER": "79684881035", "PERIOD": "always", "PERIOD_DESCRIPTION": "always", "TIMEOUT": "15" }] ] } Должен соответствовать нотации JsonRPC
Выходные параметры: Response
Должен соответствовать нотации JsonRPC. Выходные параметры: Response
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
I_FOLLOW_ORDER | string | Порядок следования номера при перенаправлении вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||
ACTIVE | string | Активность (Y/N) | ||||||||||||||||||||||||||||||||||||||||||||||||||
NAME | string | Символьное имя номера для перенаправления вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||
REDIRECT_NUMBER | string | Номер для перенаправления вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||
PERIOD | string | Период (дни недели и диапазон времени) активности перенаправления на данный номер | ||||||||||||||||||||||||||||||||||||||||||||||||||
PERIOD_DESCRIPTION | string | Описание периода перенаправления вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||
TIMEOUT | string | Таймаут (в секундах) | ||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Доступ к функциям осуществляется по протоколу HTTPS: URL: https://webapicommon.mtt.ru/index.php (порт 443) API реализован в виде POST-запросов в соответствии со спецификацией JSON-RPC (http://www.jsonrpc.org/specification). Функциональность автоматического обзвона (MIVR) реализован на базе функции API: makeCallBackCallIVR, к которой Вам предоставляется доступ: Expand | | |||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||
sip_id | string | Идентификатор SIP (883140xxxxxxxxx), выделяется МТТ | ||||||||||||||||||||||||||||||||||||||||||||||||||
a_number | string | Номер, выделенный МТТ | ||||||||||||||||||||||||||||||||||||||||||||||||||
b_number | string | Номер, на который будет совершён звонок | ||||||||||||||||||||||||||||||||||||||||||||||||||
ivr_type | int | Номер IVR префикса. 1 - звонок на b_number с проигрыванием TTS с подтверждением от абонента (b_number), перевод на оператора 2 - звонок на b_number с проигрыванием TTS без подтверждения абонентом (b_number), перевод на оператора 3 - звонок на b_number с проигрыванием TTS и отбой | ||||||||||||||||||||||||||||||||||||||||||||||||||
use_tech_account | bool | Использовать ли технический аккаунт (необходимо установить false) | ||||||||||||||||||||||||||||||||||||||||||||||||||
isNewVersion | bool | Использовать ли новые параметры подключения к колбэк. По умолчанию false. Если в user_parameters новые параметры не заданы - используются старые. |
Name | Type | Description |
success | number | Флаг успеха |
Авторизация:
Авторизация осуществляется штатными средствами HTTP
Пример:
Запрос:
JSON:
{
"id": "1",
"jsonrpc": "2.0",
"method": "makeCallBackCallIVR",
"params":
[
"sip_id" : "883140776012760",
"a_number" : "79636793312",
"b_number" : "79684881033",
"ivr_type" : 2,
"use_tech_account" : false,
"isNewVersion" : false
]
}
Ответ:
Успешный ответ:
{ "jsonrpc": "2.0", "id": "1", "result": { "success": 1 } } |
Не успешный ответ (неправильный sip id):
{
"jsonrpc": "2.0",
"id": "1",
"error": {
"code": -32001,
"message": "Data not found",
"data": "Unable to get account data by SIP id"
}
}
Не успешный ответ (неправильный A- или B-номер):
{ "jsonrpc": "2.0", "id": "1", "error": { "code": -32602, "message": "Invalid params", "data": "Invalid [A|B] number" } } |
Не успешный ответ (у пользователя нет прав использовать данный SIP id):
{ "jsonrpc": "2.0", "id": "1", "error": { "code": -32002, "message": "Permission denied", "data": "You can not access to this sip_id" } } |
Не успешный ответ (недостаточно средств):
{
"jsonrpc": "2.0",
"id": "1",
"error": {
"code": -32009,
"message": "Account error",
"data": "Insufficient funds to initiate callback"
}
}
Вы, используя данную функцию, отправляете нам запрос, где в параметрах указываете нам следующие данные:
- Номер Вашего Клиента. Которому необходимо позвонить;
- Тип IVR ветки, на которой должен обслуживаться Ваш Клиент (схема веток во вложение), после поднятия трубки, у нас в данный момент реализовано 3 ветки IVR:
- Type 1 – ветка требующая от Пользователя факта подтверждения;
- Type 2 – ветка проигрывающее информационное сообщение с дальнейшим соединением пользователя с оператором Call Centre Клиента;
- Type 3 – ветка проигрывающее только информационное сообщение с дальнейшем разъединением соединения.
Мы, обработав Ваш запрос, инициируем звонок до указанного Вами номера, как только Ваш Клиент поднимает трубку, мы переключаем его на указанную Вами ветку IVR, при этом мы отправляем Вам запрос на Ваш URL для получение текста который необходимо проиграть Клиенту, преобразование полученного текста в звуковой файл производиться на нашей стороне с использованием «text2speech». Есть возможность проиграть клиенту перед текстом приветственное сообщение, загруженного предварительно аудио файла (welcome file).
Дополнительно мы со своей стороны производим в режиме online, с момента начало звонка, отправку event уведомлений на Ваш URL, который Вы нам предварительно сообщаете. Данные event уведомления содержат информацию о прохождении вызова (звонок абоненту, абонент поднял трубку, абонент нажал клавишу 1, абонент положил трубку) и позволят Вам всегда иметь актуальную информацию и вносить её в Вашу корпоративную информационную систему.
Для получения текста который необходимо преобразовать и проиграть Клиенту мы отправляем запрос getCustomerTextMessage методом Get:
Входящие параметры:
Name
Type
Description
a_number
string
А-номер
b_number
string
B-номер
time
string
Время ожидания ответа B-номера
Возвращаемые параметры:
Name
Type
Description
status*
string
1
message*
string
Текст для B-номера
b_number_pause
string
Пауза в сек перед переводом на оператора (для type 2)
skip_play_stay
string
1- пропуск проигрывания АИ по умолчанию "Оставайтесь на линии для связи с оператором", при отсутствии параметра АИ будет проигрываться (для type 2)
announce_to_operator
string
"текст для оператора"(для type 2)
* обязательные параметры
Пример запроса:
{
"id": "1",
"jsonrpc": "2.0",
"method": "getCustomerTextMessage",
"params":
{
"a_number": "74996481578",
"b_number": "79103880489",
"time": 60
}
}
Пример ответа:
{
"jsonrpc": "2.0","id": "1","result": {"status": "1","message": "Здравствуйте, Вас приветствует .......","announce_to_operator" : "Абонент по акции"}
}
Expand | ||
---|---|---|
| ||
Отправка event уведомления на Ваш URL о прохождении вызова, примеры event уведомлений: [{"id":"280323","date_time":"1523436315","data":"event=o_79103880489_2018-04-11-11-45-34&id=7242ab5a172e645c481361236edede63"} - инициация вызова клиенту {"id":"280324","date_time":"1523436324","data":"event=s_79103880489_2018-04-11-11-45-43&id=56ad2153651501d84cbad38a0f6ad3e2"} - фактический ответ клиента {"id":"280330","date_time":"1523436365","data":"event=h_79103880489_2018-04-11-11-46-24&id=7242ab5a172e645c481361236edede63&cause=16"} - клиент снял трубку, чему соответствует cause=16 (ISUP Code) {"id":"280325","date_time":"1523436344","data":"event=0_79103880489_2018-04-11-11-46-03&id=56ad2153651501d84cbad38a0f6ad3e2"} - клиент не подтверждал и стал ожидать ответа оператора {"id":"280326","date_time":"1523436345","data":"event=o_74997090116_2018-04-11-11-46-04&id=56ad2153651501d84cbad38a0f6ad3e2"} - инициация вызова оператору коллцентра {"id":"280331","date_time":"1523436366","data":"event=h_74997090116_2018-04-11-11-46-24&id=56ad2153651501d84cbad38a0f6ad3e2&cause=17"}] - оператор был занят, чему соответствует cause=17 , где о - инициация вызова клиенту s - фактический ответ клиента h - факт снятия трубки или причина не дозвона 0 - факт перевода на оператора 1 - подтверждения по получению информации |
event_URL | string | URL для отправки онлайн уведомлений о ходе звонка* |
event_extended | string | Параметр со значениями Y/N для получения расширенных логов по звонку |
client_id | string | Сквозной идентификатор вызова от API клиента |
file_to_A | string | Аудио сообщение в сторону звонящего пользователя, при отсутствии параметра аудио сообщение проигрываться не будет. file_id, получаемый методом getCustomerPrompts, ранее загруженного промта через API метод createCustomerPrompt, см. пункт "Premedia API" |
file_to_B | string | Аудио сообщение в сторону принимающего вызов клиента, при отсутствии параметра аудио сообщение проигрываться не будет. file_id, получаемый методом getCustomerPrompts, ранее загруженного промта через API метод createCustomerPrompt, см. пункт "Premedia API" |
masking | string | (Y/N) Y – Скрытие А- номера. N – Транслирование оригинального А-номера (numberA) если параметр не указан в ответе клиента |
answer | string | (Y/N) Y – проиграть промт в ответном состоянии. N – проиграть промт в предответном состоянии. По умолчанию (если параметр не указан в ответе клиента), проигрывание промта осуществляется в предответном состоянии |
followme_struct
Name | Type | Description |
---|---|---|
I_FOLLOW_ORDER | string | Порядок следования номера при перенаправлении вызова |
ACTIVE | string | Активность (Y/N), Y - вызов пройдет на REDIRECT_NUMBER, N - вызов отобьется. |
NAME | string | Символьное имя номера для перенаправления вызова |
REDIRECT_NUMBER | string | Номер для перенаправления вызова |
PERIOD | string | Always |
PERIOD_DESCRIPTION | string | Описание периода перенаправления вызова |
TIMEOUT | string | Таймаут (в секундах), время ожидания ответа. (смотри примечание)* |
DTMF | string | Ввод добавочного номера. Список возможных символов: 0-9,*#,w,W. w - пауза на пол секунды, W - пауза на одну секунду. Пример: "WWW1W3151#" - после ответа IVR клиента, через 3 секунды будет отправлена цифра "1", далее через 1 секунду отправлена последовательность из 4-х цифр "3151", # - символ окончания ввода. |
* Минимальное оптимальное время timeout при redirect_type 3 = 55-60 секунд.
Также необходимо учитывать, что длительность промтов file_to_А и file_to_B не входит во время таймаута.
Таким образом, при наличии промтов, минимальным оптимальным временем будет:
timeout = длительность промта file_to_А + 55-60 секунд + длительность промта file_to_В.
Запрос к API клиента отправляется на URL, структура: <схема>://<логин>:<пароль>@<хост>:<порт>/<URL-путь>
В данном случае:
- в качестве схемы могут быть использованы протоколы http/https;
- в качестве логина/пароля будут переданы реквизиты аутентификации;
- хост - доменное имя или IP-адрес сервера API клиента;
- порт 80/443.
Получив ответ от API клиента, МТТ переводит вызовы согласно полученным параметрам переадресации.
Отбой входящего вызова
Для отбоя входящего звонка необходимо использовать след. структуру, пример:
{ "jsonrpc": "2.0", "id": "12345", "result": { "redirect_type": 1, "followme_struct": [1, [{ "ACTIVE": "N" }]] } } |
либо структуру с REDIRECT_NUMBER и "ACTIVE": "N", пример:
{ "jsonrpc": "2.0", "id": "12345", "result": { "redirect_type": 1, "followme_struct": [1, [{ "I_FOLLOW_ORDER": 1, "ACTIVE": "N", "NAME": "имя", "REDIRECT_NUMBER": "номер", "PERIOD": "always", "PERIOD_DESCRIPTION": "Always", "TIMEOUT": "30" }]] } } |
Причем, если в ответе присутствует параметр "file_to_A", пример:
{ "jsonrpc": "2.0", "id": "12345", "result": { "redirect_type": 1, "file_to_A": "3d221eb1aadf4d035bd87891abc82de7", "event_URL": "https://url/events/prod.php", "followme_struct": [1, [{ "ACTIVE": "N" }]] } } |
Перед отбоем входящего вызова, звонящий абонент услышит информационное сообщение (например: "номер не используется") - file_to_A.
Предлагаем использовать данную структуру на неактивных номерах (без REDIRECT_NUMBER ).
Изменение клиентского URL
Клиент самостоятельно по средствам API может сменить URL для приема запроса getControlCallFollowMe, описание метода API:
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Описание: Данный метод позволяет установить или обнулить URL. Точка входа : https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth POST запрос Входные параметры:
Выходные параметры:
Авторизация: Авторизация осуществляется штатными средствами HTTP. Пример: JSON запрос:
Успешный ответ:
Не успешный ответ:
|
Events уведомления о ходе вызова
При "event_extended": "N"
Типы событий | Значение | Описание |
---|---|---|
event=o | o | Originate. Инициации вызова на redirect_number (номер переадресации) |
event=s | s | Start. Фактический ответ стороны B (стороны redirect_number) |
event=h | h | Hungup. Разъединение/окончание вызова |
При "event_extended": "Y" (расширенная статистика)
Типы событий | Значение | Описание |
---|---|---|
event=o | o | Originate. Инициации вызова на redirect_number (номер переадресации) |
event=s | s | Start. Фактический ответ стороны B (стороны redirect_number) |
event=h | h | Hungup. Разъединение/окончание вызова |
event=sp | sp | Start_premedia. Начало проигрывания Premedia. |
event=ep | ep | End_premedia. Окончание проигрывания Premedia. |
event=t | t | Talk. Разговорная фаза. |
Параметры | Значения | Описание |
---|---|---|
side | А/B | Сторона к которой относится событие. А - параметр относится к событию для звонящей стороны B - параметр относится к событию для принимающей стороны |
date_time | Дата и время по Unix | Пример: 1558613711 Соответствует 23.05.2019, 15:15:11 |
data | "event=type_a_number/redirect_number_data-время" | Пример: "data": "event=o_79684881033_2019-05-23-15-15-19" Инициации вызова на redirect_number - 79684881033, дата и время события по МСК |
cause | ISUP code | Причина разъединения по ISUP |
redirect_number | Номер в формате E.164 | Номер для перенаправления вызова. |
sip_id | Номер в формате E.164 | Номер клиента по которому запрашивается алгоритм для перенаправления вызова. Формат номера 7+10 цифр (E.164), всегда |
numberA | Оригинальный А-номер РФ, номер с которого поступил вызов на "sip_id". Формат номера, тот который пришел на сеть МТТ, может быть и +7/8/7 + "10 цифр" | |
h323_conf_id | Уникальный id звонка в сети МТТ в запросе getControlCallFollowMe Пример: BC5F236C 5AD211E9 81BA5CB9 01FED6FC | |
client_id | Идентификатор вызова от API клиента |
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
|
Резервирование переадресации входящего вызова
Для осуществления резервирования переадресации входящего вызова при недоступности клиентского URL необходимо установить "оффлайн" переадресации ("number") для конкретного sip_id методом API:
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
Точка входа : https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth POST запрос Описание: Метод Входные параметры:
Выходные параметры:
Авторизация: Авторизация осуществляется штатными средствами HTTP Пример: JSON запрос:
Успешный ответ:
Не успешный ответ:
|
Для всех кодов ответа от клиентского URL на запрос логики переадресации getControlCallFollowMe , отличных от HTTP 200, МТТ использует заранее предустановленную «оффлайн» переадресацию.
Просмотр установленного клиентского URL и резервного номера для "оффлайн" переадресации
Для этого используется метод API:
Expand | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||
Точка входа : https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth POST запрос Описание: Метод getAccountCustomFields позволяет получить установленный URL и резервный номер для "оффлайн" переадресации Входные параметры:
Выходные параметры:
Авторизация: Авторизация осуществляется штатными средствами HTTP Пример: Запрос: JSON:
Ответ:
Не успешный ответ (не предоставлен доступ к указанному методу):
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Сценарий - клиент отправляет 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"}] |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Функционал позволяет в 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, после общения с оператором вызов завершился.
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Точка подключения:https://msapi.mtt.ru:443/
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Premedia API позволяет: ü Загружать промт и воспроизводить его в сторону звонящего и/либо в сторону принимающего вызов при переадресации; ü Устанавливать text-to-speech и воспроизводить его в сторону звонящего и/либо в сторону принимающего вызов при переадресации; ü Управление основными сценариями Premedia API:
Точка подключения: https://gapi.mtt.ru:6443/v1/api Авторизация: Basic Auth Метод: POST
|
Expand | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
Доступ к функции осуществляется по протоколу HTTPS: Точка подключения: https://gapi.mtt.ru:6443/v1/api Авторизация: Basic Auth Метод: POST
Для возможности покупки номеров определенного региона по API необходимо добавление хотя бы одного номера данного региона на лицевой счет. Данное действие производится через персонального менеджера. |
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Доступ к функции осуществляется по протоколу HTTPS: Точка подключения: https://gapi.mtt.ru:6443/v1/api Авторизация: Basic Auth Метод: POST
Authorization:Basis Basiс HTTP Auth. Пример:Запрос:JSON
Response:Successfull:
JSON
Unsuccessfull:
|
Expand | ||
---|---|---|
| ||
«WEB SDK» – продукт, предоставляющий возможность размещения в Web приложение Клиента функционала голосовой телефонной связи. Данный продукт предоставляется с необходимостью:
Данный продукт имеет следующий функционал:
Библиотека javascript: Документация: https://flashphoner.com/documentation/ (Актуальная версия 5.10.2971) Демо стенд WebSdk:
Для получения параметров подключения к сети МТТ необходимо обратиться к персональному менеджеру. |
По умолчанию в запросах в сторону API клиента отрыты только 80 и 443 порты.