Page History

Аутентификация OAuth 2.0

...

curl --location --request GET 'https://oauth.mtt.ru/oauth/authorize?response_type=code&client_id=23c9ddf7-caec-8caa-88e6-b8f758ce0186&redirect_uri=https://oauth.myanycrm.ru&scope=https://mtt.ru/auth.tokens.readwrite'

Разрешения для токена (

Expand
title Запрос токена доступа (access_token)
Описание: Запрос производит генерацию токена доступа (access_token) и токена обновления (refresh_token). Токен доступа (access_token) – токен, с которым клиентское приложение осуществляет запросы к разрешенным Открытому API, выдается на 2 часа. Токен обновления (refresh_token) - используется для получения нового токена доступа без повторного ввода пароля. Выдается на 3 дня. Параметры: POST / https://\{{hostoauth}}oauth.mtt.ru/oauth/token Параметр Описание/значение client_id Значение генерируется и задается из ЛК МТТ Бизнес client_secret Значение генерируется и задается из ЛК МТТ Бизнес code Значение, которое было передано на redirect_uri при первичной регистрации redirect_uri URL переадресации кода (например, {+}http://localhost:9090+Image Removed/callback)для переадресации, указанный на этапе настройки, например: https://oauth.myanycrm.ru scope Обязательно должен должно быть установлено значение: https://mtt.ru/auth.tokens.readwrite Image Removed grant_type Обязательно должен быть установлено значение ": authorization_code" Параметры ответаПример запроса: Параметр Code Block	Описание/значение
access_token	Токен доступа
expires_in	Длительность действия в секундах
refresh_token	Токен обновления
scope

curl --location --request POST 'https://oauth.mtt.ru

Image Removed

)

token_type

Bearer

/oauth/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=23c9ddf7-caec-8caa-88e6-b8f758ce0186' \
--data-urlencode 'client_secret=LMZkfataV6EZFergkB36im' \
--data-urlencode 'code=NMI1NGVIMDCTNTHKOS0ZYTMYLWFKODMTZMRHMGE5YWU0MDBL' \
--data-urlencode 'redirect_uri=https://oauth.myanycrm.ru' \
--data-urlencode 'scope=https://mtt.ru/auth

Обменивает вышедший из употребления токен доступа (access_token) на новый путём использования токена обновления (refresh_token).
Параметры
POST / https://\{{hostoauth}}/oauth/token

Параметр

Описание/значение

client_id

Значение генерируется и задается из ЛК МТТ Бизнес

client_secret

Значение генерируется и задается из ЛК МТТ Бизнес

grant_type

Обязательно должно быть установлено значение "refresh_token"

Параметр

Описание/значение

access_token

Токен доступа

expires_in

Длительность действия в секундах

refresh_token

Токен обновления

scope

Разрешения для токена (

https://mtt.ru/auth.tokens.readwrite^{Image Removed}

)

token_type

Bearer

.tokens.readwrite' \
--data-urlencode 'grant_type=authorization_code'

Параметры ответа:

Пример ответа:

{
    "access_token": "MMRLZJU5NTETMTNHZI0ZNZIYLWJHOTGTNJY1M2ZMM2YZNMYX",
    "expires_in": 7200,
    "refresh_token": "YWFHNGFHYMQTMTUYMI01ZTM0LTKZM2QTYZU2YZIWNJQ0MJE0",
    "scope": "https://mtt.ru/auth/openapi.

readwrite

Image Removed

",

    "token_type": "Bearer"
}

Методы для работы с настройками ВАТС МТТ Бизнес

Группа методов запросов и нотификации предназначены для получения информации о настройке ВАТС в ЛК: внешней нумерации и составе РМ пользователей МТТ Бизнес.
При изменении настроек пользователем в ЛК МТТ Бизнес отрабатывают соответствующие методы нотификации, которые возвращают новую, обновленную информацию.

Для всех методов используется единый адрес для отправки запросов: https://openapi.mtt.ru

Для получения нотификаций необходимо настроить сервер по адресу Redirect URI указанному при подключении интеграции в ЛК МТТ Бизнес и по пути /events нужно настроить слушателя событий (обработчик POST запросов). Дополнительно специально подписываться нигде не нужно, вы будете получать все события на свой сервер redirect_uri/events.

Описание
Получает информацию о внешней нумерации пользователя МТТ Бизнес. Для работы используется auth_token в соответствии с протоколом OAuth 2.0.

Адрес для отправки запроса

https://openapi.mtt.ru

Параметры
GET / externalNumbersInfo
Параметры ответа

\\
*Пример ответа*
\{
 "result": \{
  "total": 1,
  "numbersList": \[\{
   "number": "78005560251",
   "type": null
  \}\]
 \}
\}

Описание
Получает список РМ ЛС МТТ Бизнес. Для работы используется auth_token в соответствии с протоколом OAuth 2.0.

Адрес для отправки запроса

Описание:

Обменивает вышедший из употребления токен доступа (access_token) на новый путём использования токена обновления (refresh_token).
Параметры:
POST / https://oauth.mtt.ru/oauth/token

Параметры ответа:

Пример ответа:

{
    "access_token": "MMRLZJU5NTETMTNHZI0ZNZIYLWJHOTGTNJY1M2ZMM2YZNMYX",
    "expires_in": 7200,
    "refresh_token": "YWFHNGFHYMQTMTUYMI01ZTM0LTKZM2QTYZU2YZIWNJQ0MJE0",
    "scope": "https://mtt.ru/auth.tokens.readwrite",
    "token_type": "Bearer"
}

Методы для работы с настройками ВАТС МТТ Бизнес

Группа методов запросов и нотификации предназначены для получения информации о настройке ВАТС в ЛК: внешней нумерации и составе РМ пользователей МТТ Бизнес.
При изменении настроек пользователем в ЛК МТТ Бизнес отрабатывают соответствующие методы нотификации, которые возвращают новую, обновленную информацию.

Для всех методов используется единый адрес для отправки запросов: https://openapi.mtt.ru

Параметры
GET / workPlacesInfo
Параметры ответа

...

Параметр

...

Описание/значение

...

Total

...

Общее количество РМ в ответе

...

workplacesList

...

Массив РМ с их описанием

...

workplacesList/ name

...

Наименование РМ

...

workplacesList/ workplace

...

SIP ID РМ ВАТС

...

Для получения нотификаций необходимо настроить сервер по адресу Redirect URI указанному при подключении интеграции в ЛК МТТ Бизнес и по пути /events нужно настроить слушателя событий (обработчик POST запросов). Дополнительно специально подписываться нигде не нужно, вы будете получать все события на свой сервер redirect_uri/events.

{
    "result": {
        "total": 1,
        "numbersList": [
            {
                "number": "78005560251",
                "type": null
            }
        ]
    }
}

workPlacesInfo

Пример запроса:

curl --location --request GET 'https://openapi.mtt.ru/workplacesInfo' \
--header 'Authorization: Bearer MMRLZJU5NTETMTNHZI0ZNZIYLWJHOTGTNJY1M2ZMM2YZNMYX'

Параметры ответа:

Пример ответа:

{
    "result": \{
        "total": 1,
     "terminals_list   "workplacesList": \[\{
[
            {
                "terminalworkplace": "883140777380595883140777716581",
                "workplacename": "883140777380595Администратор"
  \}\]
 \}
\          }
        ]
    }
}

Описание
Нотификация об изменении структуры РМ в ЛК МТТ Бизнес. Возникает при изменении настроек в ЛК МТТ Бизнес.
Параметры нотификации

Методы для работы с вызовами

Группа методов для работы с вызовами позволяет получать информацию о вызовах и их состояниях, осуществлять управление вызовами, настраивать режим «парковки» для внешних номеров.

Для всех методов используется единый адрес для отправки запросов: https://openapi.mtt.ru

Для получения нотификаций необходимо настроить сервер по адресу Redirect URI указанному при подключении интеграции в ЛК МТТ Бизнес и по пути /events нужно настроить слушателя событий (обработчик POST запросов). Дополнительно специально подписываться нигде не нужно, вы будете получать все события на свой сервер redirect_uri/events.

Описание
Производит инициализацию вызова с использованием пользовательского РМ или терминала и вызов указанного в запросе номера. Алгоритм работы ВАТС:

1. ВАТС инициирует вызов на рабочее место Оператора (параметр callerId).
2. Дожидается принятия вызова оператором ("поднятия трубки"). Если Оператор не отвечает в течении одной минуты, то дальнейшая работа метода прерывается.
3. После успешного ответа Оператора, ВАТС инициирует второй исходящий вызов на номер абонента (параметр calleeId) и производит объединение вызовов. 

Необходимо учесть последовательность: второе плечо (вызов на calleeId) осуществляется только после ответа «первого плеча» (SIP ID РМ callerId).

Параметр callerId обычно "подтягивается" из CRM системы по данным текущего рабочего места Оператора настроенного в CRM системе.

Адрес для отправки запроса

https://openapi.mtt.ru

Параметры
POST/ makeCall

Пример запроса
{
"params": {
"calleeId": "89219462761",
"callerId": "883140582526566"
}
}
Пример ответа
{
"result": {
"call": {
"id": "7NKe6!8fa1FMSlc6ypZdb1GSV6ZN@10.133.51.137"
},
"success": 1
},
}

Описание
Завершает плечо вызова, что позволяет продолжить обработку по стандартному маршруту, который настроен в ЛК ВАТС МТТ Бизнес. Данной командой можно прекратить «парковку» вызова, так как в момент парковки создаётся дополнительное плечо.

Адрес для отправки запроса

https://openapi.mtt.ru

Параметры
POST/ terminateCall

{
    "result": {
        "total": 1,
        "terminals_list": [
            {
                "terminal": "883140777380595",
                "workplace": "883140777380595"
            }
        ]
    }
}

{
    "event": "vpbxNotifications",
    "result": {
        "eventType": "numbersChanged"
    }
}

{
    "event": "vpbxNotifications",
    "result": {
        " eventType ": "workplacesChanged"
    }
}

Методы для работы с вызовами

Группа методов для работы с вызовами позволяет получать информацию о вызовах и их состояниях, осуществлять управление вызовами, настраивать режим «парковки» для внешних номеров.

Для всех методов используется единый адрес для отправки запросов: https://openapi.mtt.ru

Параметры
POST/transferCall

...

Параметр

...

Описание/значение

...

call

...

Идентификатор вызова

...

call/id

...

Call-ID - Идентификатор плеча вызова

...

call/tag

...

Tag вызова. Дополнительный идентификатор вызова

...

calleeId

...

Номер (SPI ID) Абонента Б 

...

transportId

...

Внутренний идентификатор транспорта из нотификации

...

Описание
Устанавливает или снимает внешний номер(а) с парковки. Если у внешнего номера активирована «парковка», то при поступлении входящего вызова он не распределяется по логике ВАТС МТТ Бизнес, а на 5 секунд устанавливается на «парковку». Нотификация об этом передаётся по API во внешнее приложение. В течении этих 5 секунд по API ожидается команда перераспределения входящего вызова. Если в течении 5 секунд команды на перенаправление вызова не последовало, то задействуется ранее настроенная для номера логика распределения вызов в ВАТС МТТ Бизнес. При помощи данного метода реализуется кейс «маршрутизация на персонального менеджера».

Адрес для отправки запроса

https://openapi.mtt.ru

Параметры
POST / setParkingNumbers
Параметры нотификации

...

Параметр

...

Описание/значение

...

numbers

...

Массив номеров из внешней нумерации клиента

...

isParking

...

True, если устанавливается

*Пример запроса*
\{
 "params": \{
  "numbers": \["880023213", "880034344"\],
  "isParking": true
 \}
\}
*Пример ответа*
\\
\{ "success": 1 \}
\\

Нотификация о вызовах

Методы нотификации о вызовах предназначены для получения информации о начале и окончании вызова, прохождении вызова по РМ пользователей МТТ Бизнес и прикрепления записи разговора.

...

...

Параметр

...

Описание/значение

...

Event

...

Тип нотификации. callNotifications для нотификации о вызовах

...

callInfo

...

Информация по вызову

...

callInfo/call

...

Идентификатор вызова

...

callInfo/call/id

...

Call-ID - Идентификатор плеча вызова

...

callInfo/call/tag

...

Tag вызова. Дополнительный идентификатор вызова

...

callInfo/callee

...

Описание Абонента Б

...

callInfo/caller

...

Описание Абонента А

...

callInfo/startTime

...

Время операции

...

callInfo/state

...

trying – пытаемся дозвониться,
connected – соединен,
finished - закончен,
recorded - записан,
showing - показывается,
hiding - скрывается

...

callInfo/transportId

...

Внутренний идентификатор транспорта

...

callInfo/type

...

Incoming – входящий,
Outgoing - исходящий

...

callInfo/duration

...

Длительность вызова

...

callInfo/{callee,caller}/accountId

...

Идентификатор аккаунта терминала

...

callInfo/{callee,caller}/centrexId

...

Идентификатор пользователя в МТТ Бизнес. Одинаковый для всех запросов в рамках одного пользователя.

...

callInfo/{callee,caller}/displayId

...

Отображаемый идентификатор

...

callInfo/{callee,caller}/dispayName

...

Отображаемое имя

...

callInfo/{callee,caller}/forwarderList

...

Список идентификаторов, через которые прошел вызов до получения сообщения

...

callInfo/{callee,caller}/id

...

SIP ID ВАТС (если есть)

...

callInfo/duration

...

Длительность вызова при завершении

...

сallInfo/ reason

...

Текст причины окончания вызова

...

сallInfo/ reasonCode

...

Код причины окончания вызова

...

сallInfo/urlRecord

...

Ссылка на запись разговора

...

Описание
Сообщение о начале входящего вызова.
При поступлении входящего вызова на внешнюю нумерацию пользователя, вызов «паркуется» на 5 сек для принятия решения о его последующем перераспределении. При «парковке» создается отдельное «плечо» вызова, которое передается в сообщении.
Сообщение предназначено для:

...

Для получения нотификаций необходимо настроить сервер по адресу Redirect URI указанному при подключении интеграции в ЛК МТТ Бизнес и по пути /events нужно настроить слушателя событий (обработчик POST запросов). Дополнительно специально подписываться нигде не нужно, вы будете получать все события на свой сервер redirect_uri/events.

curl --location --request POST 'https://openapi.mtt.ru/makeCall' \
--header 'Authorization: Bearer MMRLZJU5NTETMTNHZI0ZNZIYLWJHOTGTNJY1M2ZMM2YZNMYX' \
--header 'Content-Type: application/json' \
--data-raw '{
"params":
{ "callerId":"883140777777777", "calleeId": "89999999999" }
}'

{
    "result": {
        "call": {
            "id": "7NKe6!8fa1FMSlc6ypZdb1GSV6ZN@10.133.51.137"
        },
        "success": 1
    }
}

{
    "params": {
        "call": {
            "id": "b9111e52e5d011e9aec7ac162d8cda20_00015D95DB072BFC_7022A1~2o",
            "tag": "133609"
        },
        "transportId": "10.133.51.137:5070"
    }
}

{
    "result": {
        "success": 1
    }
}

{
    "params": {
        "call": {
            "id": "b9111e52e5d011e9aec7ac162d8cda20_00015D95DB072BFC_7022A1~2o",
            "tag": "133609"
        },
        " calleeId ": "883140582526566",
        "transportId": "10.133.51.137:5070"
    }
}

{
    "result": {
        "success": 1
    }
}

{
    "params": {
        "numbers": [
            "880023213",
            "880034344"
        ],
        "isParking": true
    }
}

{
    "success": 1
}

Нотификация о вызовах

Методы нотификации о вызовах предназначены для получения информации о начале и окончании вызова, прохождении вызова по РМ пользователей МТТ Бизнес и прикрепления записи разговора.

{
    "event": "callNotifications",
    "result": {
        "callInfo": {
            "call": {
                "id": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1",
                "tag": "sdfe2n901-281028329"
            },
            "callee": {
                "displayId": "+79219462761",
                "forwarderList": [],
                "id": "+79219462761"
            },
            "caller": {
                "accountId": "883140582526566",
                "centrexId": "48212857",
                "displayId": "78005560251",
                "forwarderList": [],
                "id": "78005560251"
            },
            "startTime": "2020-06-24 15:01:45",
            "state": "trying",
            "transportId": "10.133.51.137:5070",
            "type": "outgoing"
        }
    }
}

{
    "event": "callNotifications",
    "result": {
        "callInfo": {
            "accountId": "883140777446532",
            "call": {
                "id": "SDvapac01-3bd7d743109f2668f16de50c9ab53559100@127.0.0.1"
            },
            "state": "recorded",
            "urlRecord": "https://<serverhost>/<path>/<filename>.mp3"
        }
    }
}

{
    "event": "callNotifications",
    "result": {
        "callInfo": {
            "call": {
                "id": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1",
                "tag": "sdfe2n901-281028329"
            },
            "callee": {
                "displayId": "+79219462761",
                "forwarderList": [],
                "id": "+79219462761"
            },
            "caller": {
                "accountId": "883140582526566",
                "centrexId": "48212857",
                "displayId": "78005560251",
                "forwarderList": [],
                "id": "78005560251"
            },
            "startTime": "2020-06-24 15:01:45",
            "state": "showing",
            "transportId": "10.133.51.137:5070",
            "type": "outgoing"
        }
    }
}

{
    "event": "callNotifications",
    "result": {
        "callInfo": {
            "call": {
                "id": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1",
                "tag": "sdfe2n901-281028329"
            },
            "callee": {
                "displayId": "79219462761",
                "forwarderList": [],
                "id": "79219462761"
            },
            "caller": {
                "accountId": "883140582526566",
                "centrexId": "48212857",
                "displayId": "

78005560251",
          

      "forwarderList": 

[

],
    

    "

id": "

78005560251"

 },
     

   "startTime": "2020-06-

24 

15:

01:

55",
            "state": "

connected",
            "transportId": "10.133.

51.

137:

5070",
            "type": "

outgoing"
  

      }
 

   }

}

{
    "event": "callNotifications",
    "result": \{
        "callInfo": \{
            "call": \{
                "id": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1",
                "tag": "sdfe2n901-281028329"
            \},

            "callee": \{
                "displayId": "+79219462761",
                "forwarderList": \[\],
                "id": "+79219462761"
   \         },
            "caller": \{
                "accountId": "883140582526566",
 "883140582526566",
                "centrexId": "48212857",
                "displayId": "78005560251",
                "forwarderList": \[\],
                "id": "78005560251"
   \},
   "startTime": "2020-06-24 15:01:45",
   "state": "trying" },
   "transportId": "10.133.51.137:5070",
         "typestartTime": "outgoing"2020-06-24 15:01:45",
  \}
 \}
\}
\\

*Описание*
Сообщение о перенаправлении вызова на РМ пользователя МТТ Бизнес.
*Пример* *нотификации*
\{
           "state": "hiding",
            "transportId": "10.133.51.137:5070",
            "type": "outgoing"
        }
    }
}

{
    "event": "callNotifications",
    "result": \{
        "callInfo": \{
            "call": \{
{
                "id": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1c166e238a4c211ea9d373863bb43daf8_00015ED635780FC7~2o",
                "tag": "sdfe2n901-281028329hswddry52ykfcb2a____.o"
   \},
   "callee": \{
    "displayId": "+79219462761" },
      "forwarderList": \[\],
      "idcallee": "+79219462761"
{
       \},
   "caller": \{
      "accountId": "883140582526566883140777828305",
                "centrexId": "4821285767821426",
                "displayId": "78005560251883140777828305",
    "forwarderList": \[\],
    "id": "78005560251"
   \},
   "startTimedisplay_name": "2020-06-24 15:01:4574996497803",
   "state": "showing",
   "transportId": "10.133.51.137:5070",
         "typeextensionId": "outgoing",
  \}
 \}
\}

*Описание*
Сообщение о соединении вызова с РМ пользователя МТТ Бизнес.
*Пример* *нотификации*
\{
 "event": "callNotifications",
 "result": \{
  "callInfo": \{
   "call": \              "forwarderList": [
                    {
    "id": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1",
        "tag": "sdfe2n901-281028329"
   \},
   "callee": \{
    "displayIdid": "79219462761an_prd100275045-3881851",
      "forwarderList": \[\],
      "id": "79219462761"
   \},
   "caller": \{ },
    "accountId": "883140582526566",
    "centrexId": "48212857",
    "displayId": "78005560251",
    "forwarderList": \[\], {
    "id": "78005560251"
   \},
   "startTime": "2020-06-24 15:01:55",
   "state": "connected",
   "transportId": "10.133.51.137:5070",
   "typeid": "outgoingscheme_prd100275045-3885981"
  \}
 \}
\}
\\

*Описание*
Сообщение об окончании вызова на РМ пользователя МТТ Бизнес, например, в случае его перевода на другое РМ.
*Пример* *нотификации*
\{
 "event": "callNotifications",
 "result": \{
  "callInfo": \{
   "call": \{
   }
               "id": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1" ],
    "tag": "sdfe2n901-281028329"
   \},
   "callee": \{
    "displayIdid": "+79219462761883140777828305",
    "forwarderList": \[\],
      "id": "+79219462761"
   \},
   "caller": \{
         "accountIdcaller": "883140582526566",{
    "centrexId": "48212857",
       "displayId": "78005560251",
    "forwarderListaccountId": \[\]"78124241500@pstn",
    "id": "78005560251"
   \},
   "startTime": "2020-06-24 15:01:45",
   "statedisplayId": "hiding78124241500",
         "transportId       "forwarderList": "10.133.51.137:5070",
   "type[],
                "id": "outgoing78124241500"
            \}
 \}
\}
\\

*Описание*
Вызов завершён в рамках ВАТС МТТ Бизнес.
*Пример нотификации*
Успешный входящий вызов завершён на стороне пользователя МТТ Бизнес.
\{
 "event": "callNotifications",
 "result": \{
  "callInfo": \{
   "call": \{
    "id": "c166e238a4c211ea9d373863bb43daf8_00015ED635780FC7~2o,
            "duration": 4,
            "reason": "Answer leg disconnected",
            "reasonCode": null,
            "state": "finished",
            "transportId": "10.133.33.136:5073",
    "tag        "type": "hswddry52ykfcb2a____.oincoming"
   \},
    "callee": \{ }
    "accountId": "883140777828305",}
}

{
    "centrexIdevent": "67821426callNotifications",
    "displayIdresult": "883140777828305",
{
        "display_namecallInfo": "74996497803",{
    "extensionId": "",
        "forwarderListcall": \[\{
                "id": "an_prd100275045-3881851"SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.1",
     \},
     \{
      "idtag": "scheme_prd100275045sdfe2n901-3885981"
281028329"
            \},
        \],
    "idcallee": "883140777828305"{
   \},
   "caller": \{
    "accountId": "78124241500@pstn",
    "displayId": "7812424150079219462761",
                "forwarderList": \[\],
                "id": "7812424150079219462761"
   \},
   "duration": 4,
   "reason": "Answer leg disconnected"},
    "reasonCode": null,
   "state": "finished",
   "transportIdcaller": "10.133.33.136:5073",{
   "type": "incoming"
    \}
 \}
\}
\\
Успешный исходящий вызов завершён на стороне вызываемого абонента.
\{
 "eventaccountId": "callNotifications883140582526566",
  "result": \{
    "callInfo": \{
   "call": \{
      "idcentrexId": "SDfe2n901-b510751695c9e53584301f0c0e8d98c9200@127.0.0.148212857",
    "tag": "sdfe2n901-281028329"
   \},
   "callee": \{
    "displayId": "7921946276178005560251",
    "forwarderList": \[\],
    "id": "79219462761"
   \},
   "callerforwarderList": \{
[],
      "accountId": "883140582526566",
    "centrexId": "48212857",
    "displayIdid": "78005560251",
           "forwarderList": \[\] },
    "id": "78005560251"
     \},
   "duration": 3,
            "reason": "Originate leg disconnected",
            "reasonCode": null,
            "state": "finished",
            "transportId": "10.133.51.137:5070",
            "type": "outgoing"
       \ }
 \   }
\}