Expand | ||
---|---|---|
| ||
По вопросам подключения/интеграции Telecom API |
необходимо обратиться по почте |
В письме просьба указать:
Наш менеджер свяжется с Вами в ближайшее время. |
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
|
Expand | ||
---|---|---|
| Disconnect cause | |
Коды причины ISUP | ||
== 1= unallocated number | ||
== 2= no route to network | ||
== 3= no route to destination | ||
== 16 normal call clearing | ||
== 17 user busy | ||
== 18 no user responding | ||
== 19 no answer from the user | ||
== 20 subscriber absent | ||
== 21 call rejected | ||
== 22 number changed (w/o diagnostic) | ||
== 22 number changed (w/ diagnostic) | ||
== 23 redirection to new destination | ||
== 26 non-selected user clearing | ||
== 27 destination out of order | ||
== 28 address incomplete | ||
== 29 facility rejected | ||
== 31 normal unspecified | ||
Ресурсы недоступны | ||
== 34 no circuit available | ||
== 38 network out of order | ||
== 41 temporary failure | ||
== 42 switching equipment congestion | ||
== 47 resource unavailable | ||
Сервис или опция недоступны. | ||
Этот вид событий указывает, что имеются временные проблемы при обработке запроса, которые оборудование самостоятельно устранит через какое-то время. | ||
== 55 incoming calls barred within CUG | ||
== 57 bearer capability not authorized | ||
== 58 bearer capability not presently | ||
available | ||
== 65 bearer capability not implemented | ||
== 70 only restricted digital avail | ||
== 79 service or option not implemented | ||
Неверное сообщение | ||
== 87 user not member of CUG | ||
== 88 incompatible destination | ||
Ошибка протокола | ||
== 102 recovery of timer expiry | ||
== 111 protocol error | ||
Взаимодействие с другими сетям | ||
== 127 interworking unspecified | ||
Expand | ||
| ||
Expand | ||
| ||
Expand | ||
| ||
Name | Type | Description |
sid_id | string | Идентификатор SIP |
followmeStruct | array of followmeStruct | Структуру followmeStruct см. ниже в примере успешного запроса |
Name | Type | Description |
timeout | string | Таймаут (в секундах) | redirect_number | string | Номер для перенаправления
|
Интерфейс взаимодействия - 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" ] |
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
«Услуга CallBackAPI» Функционал позволяет по API:
Точка подключения: https://webapicommon.mtt.ru/index.php Авторизация: Basic Auth Метод: POST
callBackFollowmeStruct: Name Type Description order number Порядок следования номера при перенаправлении вызова timeout number Таймаут (в секундах) redirect_number string Номер для перенаправления вызова type string Тип очереди, файла, текста, etc name string Символьное имя номера для перенаправления вызова side string Плечо для проигрывания файла или сообщения (А или В) value string Информация для проигрывания или имя файла Выходные параметры: Name Type Description callBackFollowmeStruct array of callBackFollowmeStruct Структуру callBackFollowmeStruct см. ниже в примере успешного запроса caller_id string Номер, который будет показан абоненту плеча В defaultBNumber string Номер по умолчанию, для дозвона на плечо B Авторизация: Авторизация осуществляется штатными средствами HTTP. Пример: Запрос: JSON: { "id": "101", "jsonrpc": "2.0", "method": "getCallBackFollowme", "params": { "customer_name" : "883140500000000"} } Ответ: Успешный ответ: { "jsonrpc": "2.0", "id": "101", "result": { "callBackFollowmeStruct": [ { "order": 1, "timeout": 25, "redirect_number": "79684881033", "type":"ringall", "name": "sales" }, { "order": 2, "timeout": 25, "redirect_number": "79522222222", "type":"ringall", "name": "sales" }, { "order": 3, "timeout": 25, "redirect_number": "79152323233", "type":"ringall", "name": "sales" }, { "order": 4, "timeout": 15, "redirect_number": "79636793312", "type":"lineral", "name": "sales_chief" }, { "order": 5, "timeout": 20, "redirect_number": "79631112233", "type":"lineral", "name": "chief" } ], "caller_id": "74951001010", "defaultBNumber" : "79889998877" } } Не успешный ответ: { "jsonrpc": "2.0", "id": "101", "error": { "code": -32602, "message": "Invalid params", "data": "Invalid type" } } Expand |
Описание: Данная функция удаляет список номеров, на которые будет осуществляться переадресация CallBack вызова, плечо А. Входные параметры: Name Type Description customer_name string Имя Кастомера Выходные параметры: Name Type Description success number 1 = список успешно удален Авторизация: Авторизация осуществляется штатными средствами HTTP. Пример: Запрос: JSON: { "id": "1", "jsonrpc": "2.0", "method": "deleteCallBackFollowme", "params": { "customer_name":"883140500000000" } } Ответ: Успешный ответ:
Не успешный ответ: { "jsonrpc": "2.0", "id": "1", "error": { "code": -32001, "message": "Data not found", "data": "Followme not found" } } Expand |
Уведомления о ходе вызова 2015/08/13 11:45:26 http://xxx.xxx.xxx.xxx/listener/event.php?event=start_side_A&id=e031c89159fbba8b80025cd6fb534a77 2015/08/13 11:45:28 http://xxx.xxx.xxx.xxx/listener/event.php?event=pickup_side_A&id=e031c89159fbba8b80025cd6fb534a77&phone_A=+номер телефона, поднявший трубку ( плечо А) 2015/08/13 11:45:28 http://xxx.xxx.xxx.xxx/listener/event.php?event=start_side_B&id=e031c89159fbba8b80025cd6fb534a77 2015/08/13 11:45:32 http://xxx.xxx.xxx.xxx/listener/event.php?event=start_talk&id=e031c89159fbba8b80025cd6fb534a77 2015/08/13 11:45:36 http://xxx.xxx.xxx.xxx/listener/event.php?event=end_side_B&id=e031c89159fbba8b80025cd6fb534a77 2015/08/13 11:45:36 http://xxx.xxx.xxx.xxx/listener/event.php?event=end_side_A&id=e031c89159fbba8b80025cd6fb534a77 start_side_A - инициация вызова на плечо А pickup_side_A - абонент плеча А снял трубку start_side_B - инициация вызова на плечо B event=start_talk - разговор между абонентами event=end_side_B/event=end_side_A - окончание разговора по плечу B и А | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Описание: функционал позволяет клиенту, в момент поступления звонка от пользователя:
В момент входящего вызова на номер клиента платформа МТТ производит 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sip_id | string | номер клиента по которому запрашивается алгоритм переадресации вызова. Формат номера 7+10 цифр (E.164), всегда | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numberA | string | оригинальный А-номер РФ, номер с которого поступил вызов на "sip_id". Формат номера, тот который пришел на сеть МТТ, может быть и +7/8/7 + 10 цифр | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
h323_conf_id | string | Уникальный id звонка на платформе МТТ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
redirect_type* | int | Тип переадресации 1 - одиночная, 2- последовательная, 3- параллельная | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
followme_struct* | структура | Структура с параметрами и номерами переадресации (REDIRECT_NUMBER) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
event_URL | string | URL для отправки онлайн уведомлений о ходе звонка* | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
I_FOLLOW_ORDER | string | Порядок следования номера при перенаправлении вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ACTIVE | string | Активность (Y/N), Y - вызов пройдет на REDIRECT_NUMBER, N - вызов отобьется. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NAME | string | Символьное имя номера для перенаправления вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
REDIRECT_NUMBER | string | Номер для перенаправления вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PERIOD | string | Always | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
DTMF | string | Ввод добавочного номера. Список возможных символов: 0-9,*#,w,W. w - пауза на пол секунды, W - пауза на одну секунду. Пример: "WWW1W3151#" - после ответа IVR клиента, через 3 секунды будет отправлена цифра "1", далее через 1 секунду отправлена последовательность из 4-х цифр "3151", # - символ окончания ввода. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PERIOD_DESCRIPTION | string | Описание периода перенаправления вызова | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TIMEOUT | string | Таймаут (в секундах), время ожидания ответа. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sip_id | string | sip_id аккаунта, для обнуления передается пустое значение | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
url | string | Строка содержащая url, для обнуления передается пустое значение | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
success | number | Индикатор успеха | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ "id": "1", "jsonrpc": "2.0", "method": "updateCallControlURL", "params": { "sip_id":"73432143178", "url":"" } } |
{ "jsonrpc": "2.0", "id": 1, "result": { "success":1 } } |
Не успешный ответ:
{
"jsonrpc": "2.0",
"id": "1",
"error": {
"code": -32002,
"message": "Permission denied",
"data": "agent does not have access to this account"
}
}
Events уведомлений о ходе вызова
Expand | |||
---|---|---|---|
| |||
1. Инициация вызова на REDIRECT_NUMBER { "date_time": 1558613711, "data": "event=o
Успешный ответ:
Не успешный ответ:
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
Описание: Данная функция позволяет получить список номеров, на которые будет осуществляться переадресация CallBack вызова, плечо А. Вывод предварительно установленной структуры вызова setCallBackFollowme. Входные параметры:
callBackFollowmeStruct:
Выходные параметры:
Авторизация: Авторизация осуществляется штатными средствами HTTP. Пример: JSON запрос:
Успешный ответ:
Не успешный ответ:
|
Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
Описание: Данная функция удаляет список номеров, на которые будет осуществляться переадресация CallBack вызова, плечо А. Входные параметры:
Выходные параметры:
Авторизация: Авторизация осуществляется штатными средствами HTTP. Пример: JSON запрос:
Успешный ответ:
Не успешный ответ:
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Описание: функционал позволяет клиенту, в момент поступления звонка от пользователя:
В момент входящего вызова на номер клиента платформа МТТ производит POST запрос (c ip - 80.75.132.186) к API клиента методом getControlCallFollowMe по полученному номеру. Пример POST запроса к API клиента:
Входные параметры: Response
Пример ответа от API клиента:
Должен соответствовать нотации JsonRPC. Выходные параметры: Response
followme_struct
* Минимальное оптимальное время timeout при redirect_type 3 = 55-60 секунд. Также необходимо учитывать, что длительность промтов file_to_А и file_to_B не входит во время таймаута.
В данном случае:
Получив ответ от API клиента, МТТ переводит вызовы согласно полученным параметрам переадресации. Отбой входящего вызова Для отбоя входящего звонка необходимо использовать след. структуру, пример:
Причем, если в ответе присутствует параметр "file_to_A", пример:
Перед отбоем входящего вызова, звонящий абонент услышит информационное сообщение (например: "номер не используется") - file_to_A. Предлагаем использовать данную структуру на неактивных номерах (без REDIRECT_NUMBER ). Изменение клиентского URL Клиент самостоятельно по средствам API может сменить URL для приема запроса getControlCallFollowMe, описание метода API:
Events уведомления о ходе вызова При "event_extended": "N"
При "event_extended": "Y" (расширенная статистика)
Резервирование переадресации входящего вызова Для осуществления резервирования переадресации входящего вызова при недоступности клиентского URL необходимо установить "оффлайн" переадресации ("number") для конкретного sip_id методом API:
Для всех кодов ответа от клиентского URL на запрос логики переадресации getControlCallFollowMe , отличных от HTTP 200, МТТ использует заранее предустановленную «оффлайн» переадресацию. Просмотр установленного клиентского URL и резервного номера для "оффлайн" переадресации Для этого используется метод API:
|
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, после общения с оператором вызов завершился. { "date_time": "2019-03-29-11-37-13", "id": "1255490", "CallID": "00035c7d92bb0971", "event": "o_79103880489" } вызов завершился.
* Возможные cause:
|
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:Basiс HTTP Auth. Пример:Запрос:JSON
Response:Successfull:JSON
Unsuccessfull:
|
Expand | ||
---|---|---|
| ||
«WEB SDK» – продукт, предоставляющий возможность размещения в Web приложение Клиента функционала голосовой телефонной связи. Данный продукт предоставляется с необходимостью:
Данный продукт имеет следующий функционал:
Документация: https://flashphoner.com/documentation/ (Актуальная версия 5.0.2971) Демо стенд WebSdk:
Для получения параметров подключения к сети МТТ необходимо обратиться к персональному менеджеру. |
По умолчанию в запросах в сторону API клиента отрыты только 80 и 443 порты.