Page History

destination

string

Направление вызова

curr

string

Валюта клиента

date_from

string

Начальная дата и время (необязательный)

date_to

string

Конечная дата  и время (необязательный)

incoming

array

История входящих звонков

missed

array

История пропущенных звонков

dialed

array

История исходящих звонков

forwarded

array

История переадресованных вызовов

destination

string

Направление вызова

h323_conf_id

string

Идентификатор записи, по которому можно получить ссылку на скачивание

h323_incoming_conf_id

string

Идентификатор записи входящего вызова, h323_conf_id в массиве incoming

curr

string

Валюта клиента

sid_id

string

Идентификатор SIP

followmeStruct

array of followmeStruct

Структуру followmeStruct см. ниже в примере успешного запроса

timeout

string

Таймаут (в секундах)

redirect_number

string

Номер для перенаправления вызова

name

string

Символьное имя номера для перенаправления вызова

active

string

Активность (Y/N)

period

string

Период (дни недели и диапазон времени) активности перенаправления на данный номер

period_description

string

Описание периода перенаправления вызова

follow_order

string

Порядок следования номера при перенаправлении вызова

domain**

string

Домен

use_tcp**

string

Использовать TCP (Y/N)

keep_original_cli**

string

Оставлять оригинальный CLI (Y/N)

keep_original_cld**

string

Оставлять оригинальный CLD (Y/N)

success

number

1 = список успешно обновлён

    Ответ:

         Успешный ответ:

{

    "jsonrpc": "2.0",

    "id": "1",

    "result":

    {

        "sip_id": "883140776011039",

        "i_account": "44635974",

        "followme_struct":

        [

            3,

            [

                {

                    "I_FOLLOW_ORDER": "1",

                    "ACTIVE": "Y",

                    "NAME": "79684881033",

                    "REDIRECT_NUMBER": "79684881033",

                    "PERIOD": "hr{9}min{0-59}wd{mo-fr},hr{10}min{0-58}wd{mo-fr}",

                    "PERIOD_DESCRIPTION": "hr{9}min{0-59}wd{mo-fr},hr{10}min{0-58}wd{mo-fr}",

                    "TIMEOUT": "15"

                },

                {

                    "I_FOLLOW_ORDER": "2",

                    "ACTIVE": "Y",

                    "NAME": "79684881034",

                    "REDIRECT_NUMBER": "79684881034",

                    "PERIOD": "hr{11}min{0-59}wd{mo-fr},hr{12}min{0-58}wd{mo-fr}",

                    "PERIOD_DESCRIPTION": "hr{11}min{0-59}wd{mo-fr},hr{12}min{0-58}wd{mo-fr}",

                    "TIMEOUT": "15"

                },

                {

                    "I_FOLLOW_ORDER": "3",

                    "ACTIVE": "Y",

                    "NAME": "79684881035",

                    "REDIRECT_NUMBER": "79684881035",

                    "PERIOD": "hr{13}min{0-59}wd{mo-fr},hr{14-17}wd{mo-fr},hr{18}min{0-58}wd{mo-fr}",

                    "PERIOD_DESCRIPTION": "hr{13}min{0-59}wd{mo-fr},hr{14-17}wd{mo-fr},hr{18}min{0-58}wd{mo-fr}",

                    "TIMEOUT": "15"

                }

            ]

        ]

    }

}

         Не успешный ответ: 

// не установлено ни одной переадресации

{

    "jsonrpc": "2.0",

    "id": "1",

    "error":

    {

        "code": -32001,

        "message": "Data not found",

        "data": "No followMe on this account"

    }

}

// Аккаунт не существует

{

    "jsonrpc": "2.0",

    "id": "1",

    "error":

    {

        "code": -32001,

        "message": "Data not found",

        "data": "This account does not exist"

    }

}

// У агента нет доступа к аккаунта

{

    "jsonrpc": "2.0",

    "id": "1",

    "error":

    {

        "code":-32002,

        "message":"Permission denied",

        "data":"You can not access to this sip_id"

    }

}

Точка подключения: https://webapicommon.mtt.ru/index.php

Авторизация: Basic Auth

Метод: POST

Описание:

Данная функция возвращает баланс кастомера

Входные параметры:

Name

Type

Description

customer_name*

String

Имя существующего кастомера = лицевой счет

Выходные параметры:

Name

Type

Description

balance

numeric

Баланс кастомера

real_balance

numeric

Полный баланс кастомера

pending_payment

* Обязательные поля 

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

    Запрос:

     JSON:

{

    "jsonrpc":"2.0",

    "method":"getCustomerBalance",

    "params":

    [

        "110000000"

    ],

    "id":1

}

    Ответ:

         Успешный ответ:

{

    "jsonrpc":"2.0",

    "id":1,

    "result":

    {

        "balance":121.54,

        "real_balance":711.54

    }

}

         Не успешный ответ:

{

    "jsonrpc": "2.0",

    "id": "1",

    "error":

    {

        "code": -32001,

        "message": "Data not found"

    }

}

// Данный проверочный код невалиден для переданных sip_id и phone_num

Точка подключения: https://webapicommon.mtt.ru/index.php

Описание:

Данная функция возвращает все аккаунты кастомера.

Выходные параметры:

Name

Type

Description

account_list

array of AccountInfo

Список аккаунтов кастомера

AccountInfo

Name

Type

Description

sip_id

string

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

activation_date

date(format:Y-m-d)

Дата активации аккаунта

* Обязательные поля

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

    Запрос:

     JSON:

    Ответ:

         Успешный ответ:

{

   "jsonrpc":"2.0",

   "id":"1",

   "result":

   {

      "accountList":

      [

         {

            "sip_id":"883140005556637",

            "activation_date":"2016-11-18"

         },

         {

            "sip_id":"883140005556631",

            "activation_date":"2016-07-29"

         },

         {

            "sip_id":"883140005556632",

            "activation_date":"2016-07-29"

         }

      ]

   }

}

         Не успешный ответ:

{

   "jsonrpc":"2.0",

   "id":"1",

   "error":

   {

      "code":-32002,

      "message":"Permission denied",

      "data":"agent does not have access to this account"

   }

}

Функционал позволяет по API:

• Осуществить быстрый дозвон и соединение требуемых номеров A (клиент) и B (пользователь)
• Вызывать сразу несколько номеров клиента (персональных менеджеров) с необходимой логикой дозвона: последовательно, параллельно, рандомно
• Проиграть аудиосообщение или синтезированный текст в сторону клиента (персонального менеджера), так и в сторону абонента заказавшего звонок (пользователя) при снятии трубки
• Записать разговор клиента и пользователя, записывается разговор по обоим плечам
• Задать максимально возможную длительность разговора клиента и пользователя
• Получать online уведомления о ходе вызова
• Настроить свой собственный сервис CallBack на базе предоставляемого функционала

Точка подключения: https://webapicommon.mtt.ru/index.php

Авторизация: Basic Auth

Метод: POST

Описание:

Данная функция осуществляет callback между А-номером или номерами переданным в поле simpleCallBackFollowmeStruct  и B-номером.

Входные параметры:

Name

Type

Description

string

id, маркер запроса, будет выдан в ответе на запрос.

customer_name*

string

Имя кастомера/Лицевой счет.

b_number*

string

Номер плеча B (по умолчанию). Номер, на который будет совершён звонок, по фактическому ответу плеча A.

caller_id

string

Номер, который будет показан абоненту плеча В. Данный параметр должен устанавливаться, либо в функции setCallBackFollowme либо в функции makecallbackfollowme.

callBackURL

string

URL, на который, будут посылаться уведомления о ходе вызова. Строго без http/www. Конечный файл, куда будут отправляться events должен называться event.php

simpleCallBackFollowmeStruct

array of simpleCallBackFollowmeStruct

Структуру simpleCallBackFollowmeStruct см. в примере успешного запроса 

recordEnable

number

Запись звонка. По умолчанию - 1. Записывается.

duration

number

Общая продолжительность попытки вызова (сек.)

client_caller_id

string

Номер, который будет показан абоненту плеча A. По умолчанию - b_number

direction

numberr

Значение 0 или 1. Направление вызова. По умолчанию 0 - redirect_number (Плечо А)-->b_number (плечо B), 1 - b_number (плечо А)-->redirect_number (Плечо B)

callDescription

string

Комментарий к вызову.

dtmf_number

string

Дополнительный номер при наборе.

* обязательные поля

simpleCallBackFollowmeStruct:

Name

Type

Description

order

number

Порядок следования номера при перенаправлении вызова

timeout

number

Таймаут (в секундах)- время дозвона с момента отправки Json запроса на осуществление вызова до прекращения дозвона. 

Рекомендуется устанавливать значение от 15 секунд.

redirect_number

string

Номер плеча А, по умолчанию.

type

string

Тип очереди, файла, текста, etc

name

string

Символьное имя номера для перенаправления вызова

side

string

Плечо для проигрывания файла или сообщения (А или В)

value

string

Информация для проигрывания или имя файла

Выходные параметры:

callBackCall_id

string

Уникальный идентификатор вызова

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример запроса с ранее установленной структурой вызова (см. п. 2.5):

     JSON:

     JSON:

{

  "id": "1",

  "jsonrpc": "2.0",

  "method": "makeCallBackCallFollowme",

  "params": {

    "customer_name": "883140500000000",

    "b_number": "7xxxxxxx",

    "callBackURL": "example.com", - СТРОГО без http/www 

    "caller_id" : "7xxxxxxxxxx",

    "recordEnable" : 1,

    "client_caller_id" : "7xxxxxxxxxx",

    "simpleCallBackFollowmeStruct": [

      {

        "order": 1,

        "timeout": 25,

        "redirect_number": "7xxxxxxxxxx",

        "caller_id": "7xxxxxxxxxx",

        "type": "ringall",

        "name": "sales"

      },

      {

        "order": 2,

        "timeout": 25,

        "redirect_number": "7xxxxxxxxxx",

        "caller_id": "7xxxxxxxxxx",

        "type": "ringall",

        "name": "sales_2"

      },

      {

        "order": 3,

        "type": "text", - задается  "Text to speech"( текст в речь)

        "value": "Звонок с сайта все продам ру",

        "side": "A" 

       },

       {

        "order": 4,

        "type": "file", - задается ранее установленный файл в функции "SetCallBackPrompt"

        "value": "for_all_sales",

        "side": "B"

       }

    ]

  }

 }

Успешный ответ:

{

    "jsonrpc": "2.0",

    "id": "1",

    "result":

    {

        "callBackCall_id": "1256ffb10774226b390ad1a2bc892c9c"

    }

}

Не успешный ответ: 

{

    "jsonrpc":"2.0",

    "id":"iar_ringall",

    "result":

    {

        "error":1,

         "message":"Incorrect redirect_number format" - указан некорректный А - номер ( redirect_number)

         "message" : "Incorrect B-number format"- указан некорректный B-номер.

    }

}

Описание:

Данная функция позволяет получить информацию об осуществленном CallBack вызове по его идентификатору.

Входные параметры:

Name

Type

Description

customer_name

string

Имя Кастомера, созданного в функции 

callBackCall_id

string

Уникальный идентификатор вызова

Выходные параметры:

Name

Type

Description

callBackFollowmeCallInfoStruct

array of callBackFollowmeCallInfo

Структуру callBackFollowmeCallInfo см. ниже в примере успешного запроса

callBackFollowmeCallInfo:

Name

Type

Description

destination_A

string

Номер, куда дозвонилось плече А

destination_B

string

Номер, куда дозвонилось плече В

waiting_period_A

string

Период ожидания плеча А 

waiting_period_В

string

Период ожидания плеча В 

call_back_charged_length_A

string

Длительность вызова плеча А (биллинговая)

call_back_real_length_A

string

Длительность вызова плеча А (реальная)

call_back_charged_length_B

string

Длительность вызова плеча B (биллинговая)

call_back_real_length_B

string

Длительность вызова плеча B (реальная)

call_back_cost

number

Стоимость вызова

call_back_status

string

Статус вызова

call_back_record_URL_A

array

URL для получения записи вызова плеча А (срок действия ссылки 60 сек)

call_back_record_URL_B

array

URL для получения записи вызова плеча В (срок действия ссылки 60 сек)

callDescription

string

Комментарий к вызову

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

    Запрос:

     JSON:

{

    "id": "101",

    "jsonrpc": "2.0",

    "method": "getCallBackFollowmeCallInfo",

    "params": { 

                "customer_name" : "883140500000000",

                "callBackCall_id" : "1256ffb10774226b390ad1a2bc892c9c"

    }

}

Ответ:

 Успешный ответ:

{

"jsonrpc": "2.0",

"id": "1",

"result":

{

"callBackFollowmeCallInfoStruct":

{

"destination_A": "+79162795520",

"destination_B": "+79852970306",

"waiting_period_A": "12",

"waiting_period_B": "9",

"call_back_charged_length_A": "60",

"call_back_real_length_A": "15",

"call_back_charged_length_B": "60",

"call_back_real_length_B": "5",

"call_back_cost": 2.98,

"call_back_currency": "RUB",

"call_back_status": "ok",

"call_back_record_URL_A":

{

"downloadURL": "http:\/\/fuds.mtt.ru\/download\/75GV5LxVNdQuohMge0NMFpS2Oxwc3jKTmhjWE3987oPTOhCJ7o"

},

"call_back_record_URL_B":

{

"downloadURL": "http:\/\/fuds.mtt.ru\/download\/0bbDerTSCQFVmqzOdFu6pNX1STQCh5dTrdQ3PdajN3ICHdWyyV"

},

"callDescription": ""

}

}

}

Вызов закончился по timeout на стороне А:

  { "jsonrpc":"2.0",

   "id":"101",

   "error":

   {

      "code":-32001,

      "message":"Data not found",

      "data":"Call ended by timeout on side A"

   }

}

Вызов отбит на стороне А:

  {

   "jsonrpc":"2.0",

   "id":"101",

   "error":

   {

      "code":-32001,

      "message":"Data not found",

      "data":"Call ended by cancel on side A"

   }

}

Вызов отбит на стороне B:

{

   "jsonrpc":"2.0",

   "id":"101",

   "error":

   {

      "code":-32001,

      "message":"Data not found",

      "data":"Call ended by cancel on side B"

   }

}

Описание:

Данная функция позволяет получить данные для загрузки файла CallBack prompt.

Входные параметры: 

customer_name*

string

Имя Кастомера

file_name

string

(Максимум 255 символов)

Выходные параметры:

uploadURL

statusURL

maxsize

accepted_formats

Для загрузки файла клиент должен отправить содержимое файла посредством POST запроса на сформированный uri для загрузки файла. В теле POST данных необходимо передавать только контент файла и ничего более. В результате будет выдан ответ в виде json объекта c полем status имеющем одно из следующих значений:

• wait_porta_upload - файл принят и ожидает загрузки на porta
• error_maxfilesize - в случае превышения максимального размера файла
• error_fileformat - в случае несоответствия формата файла ожидаемому
• error_not_found - в случае если запрос на загрузку файла не найден в БД
• error_invalid_state - в случае если запрос на загрузку файла находится в состоянии отличном от wait_client_upload
• error_internal - в случае, если произошла внутренняя ошибка сервиса

Для проверки состояния загрузки файла клиент должен отправить GET запрос на сформированный uri для проверки статуса загрузки файла. В результате будет выдан ответ в виде json объекта c полем status имеющем одно из следующих значений:

• ok - файл загружен
• wait_client_upload - ожидается загрузка файлов от клиента
• wait_upload - файл принят и ожидает загрузки
• error_maxfilesize - при принятии файла от клиента обнаружено превышение максимального размера файла
• error_fileformat - при принятии файла от клиента обнаружено несоответствие формата файла ожидаемому
• error_upload - загрузка файлапо каким-то причинам оказалась неуспешной
• error_timout - истекло время ожидания загрузки файла от клиента

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

    Запрос:

     JSON:

    Ответ:

         Успешный ответ:

{

    "jsonrpc":"2.0",

    "id":"1",

    "result":

    {

        "uploadURL":"https:\/\/fuds1.mtt.ru\/upload\/fd36dc6c32ce0bb33d5084c877b09675",

        "statusURL":"https:\/\/fuds1.mtt.ru\/status\/fd36dc6c32ce0bb33d5084c877b09675",

        "maxsize":1048576,

        "accepted_formats":

        {

            "aif":[

              "audio\/x-aiff",

              "audio\/aiff"

            ],

            ...

        }

    }

}

         Не успешный ответ: 

{

    "jsonrpc": "2.0",

    "id": "1",

    "error":

    {

        "code": -32002,

        "message": "Permission denied",

        "data": "agent does not have access to this customer"

    }

}

Описание:

Данная функция позволяет получить список загруженных клиентом промтов.

Входные параметры:

customer_name

string

Имя Кастомера

Выходные параметры:

result

array 

Список загруженных клиентом промптов и дат их загрузки.

result:

file_name

string

Имя файла, содержащего загруженный промпт

date_upload

string

Дата загрузки промпта

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

    Запрос:

     JSON:

    Ответ:

         Успешный ответ:

{

:   "jsonrpc":"2.0",

:   "id":"1",

:   "result":

:   [

:   :   {

:   :   :   "file_name":"01_mamita_surumi.wav",

:   :   :   "date_upload":"12.08.2015"

:   :   },

:   :   {

:   :   :   "file_name":"Enchantment.wav",

:   :   :   "date_upload":"12.08.2015"

:   :   }

:   ]

}

         Не успешный ответ: 

{

   "jsonrpc":"2.0",

   "id":"101",

   "error":

   {

      "code":-32001,

      "message":"Data not found",

      "data":"Error on get CallBack Prompt Info"

   }

}

Описание:

Данная функция создает список номеров, на которые будет осуществляться переадресация CallBack вызова, плечо А.

Предварительная установка структуры вызова (callBackFollowmeStruct)

Входные параметры:

Name

Type

Description

customer_name*

string

Имя Кастомера, созданного в функции 

callBackFollowmeStruct*

array of callBackFollowmeStruct

Структуру callBackFollowmeStruct см. ниже в примере успешного запроса

caller_id

string

Номер, который будет показан абоненту плеча В.

Данный параметр должен устанавливаться, либо в функции setCallBackFollowme либо в функции makecallbackfollowme.

defaultBNumber

string

Номер по умолчанию, для дозвона на плечо B

callBackFollowmeStruct:

Name

Type

Description

order

number

Порядок следования номера при перенаправлении(переадресации) вызова

timeout

number

Таймаут (в секундах)- время дозвона с момента отправки Json запроса на осуществление вызова до прекращения дозвона. 

Рекомендуется устанавливать значение от 10 секунд.

redirect_number

string

Номер для перенаправления вызова (реальный номер, который будет осуществлен вызов. Плечо А.)

type

string

Тип очереди, файла, текста.

name

string

Символьное имя номера для перенаправления вызова, например "sales1"/"sales2"/"boss"

side

string

Плечо для проигрывания файла или сообщения (А или В)

value

string

Информация для проигрывания или имя файла

Пояснения к параметру "type"

1) Тип очереди:

Ringall - вызываются все участники структуры, переданные в callBackFollowmeStruct  ( плечо А) 

Lineral -  вызов участников группы ( плечо А), переданных в callBackFollowmeStruct, происходит последовательно.

2) Тип проигрываемого сообщения для плеча А/B

  "type": "text", - задается "Text to speech"( текст в речь)

  "type": "file", задается ранее установленный файл в функции "SetCallBackPrompt"

Выходные параметры:

success

number

1 = Структура успешно добавлена

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

    Запрос:

     JSON:

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "setCallBackFollowme",

    "params": {

        "customer_name": "883140500000000",

        "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,

                "value": "Звонок с сайта все продам ру",

                "side": "A" 

            },

            {

                "order": 6,

                "type": "file", задается ранее установленный файл в функции "SetCallBackPrompt"

                "value": "for_all_sales",

                "side": "B"

            }

        ],

        "caller_id": "74951001010",

        "defaultBNumber": "79511234567"

    }

}

    Ответ:

         Успешный ответ:

         Не успешный ответ: 

    {

    "jsonrpc":"2.0",

    "id":"101",

    "result":

    {

        "error":1,

        "error_description":"Side A not clear. Delete before insert" - попытка установки логики звонка поверх имеющейся логики. Необходимо выполнить deleteCallBackFollowme.

    }

}

Описание:

Данная функция позволяет получить список номеров, на которые будет осуществляться переадресация CallBack вызова, плечо А.

Вывод предварительно установленной структуры вызова setCallBackFollowme

Входные параметры:

callBackFollowmeStruct:

Name

Type

Description

order

number

Порядок следования номера при перенаправлении вызова

timeout

number

Таймаут (в секундах)

redirect_number

string

Номер для перенаправления вызова

type

string

Тип очереди, файла, текста, etc

name

string

Символьное имя номера для перенаправления вызова

side

string

Плечо для проигрывания файла или сообщения (А или В)

value

string

Информация для проигрывания или имя файла

Выходные параметры:

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

    Запрос:

     JSON:

    Ответ:

         Успешный ответ:

         Не успешный ответ: 

{

    "jsonrpc": "2.0",

    "id": "101",

    "error":

    {

        "code": -32602,

        "message": "Invalid params",

        "data": "Invalid type"

    }

}

Описание:

Данная функция удаляет список номеров, на которые будет осуществляться переадресация 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"

    }

}

Уведомления о ходе вызова

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 и А

Описание: функционал позволяющий Клиенту, в момент поступления звонка от Пользователя Клиента, осуществить онлайн перенаправление данного звонка на определенный номер телефона.

В момент входящего вызова на номер клиента платформа МТТ производит запрос к API клиента методом getControlCallFollowMe по полученному номеру.

Пример запроса к API клиента:

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "getControlCallFollowMe",

    "params":

    {

       "sip_id": " 79586488002",

       "numberA": "79154368886"               

    }

}

, где:

"sip_id" - номер клиента по которому запрашивается алгоритм переадресации вызова. Формат номера 7+10 цифр (E.164), всегда.

"numberA" - оригинальный А-номер РФ, номер с которого поступил вызов на "sip_id". Формат номера, тот который пришел на сеть МТТ, может быть и +7/8/7 + 10 цифр.

Пример ответа от API клиента:

{

      "jsonrpc": "2.0",

      "id": "1",

      "result": {

            "redirect_type": 3,

            "followme_struct": [

                  3, [{

                        "I_FOLLOW_ORDER": "1",

                        "ACTIVE": "Y",

                        "NAME": "79684881033",

                        "REDIRECT_NUMBER": "79684881033",

                        "PERIOD": "always",

                        "PERIOD_DESCRIPTION": "always",

                        "TIMEOUT": "15"

                  }, {

                        "I_FOLLOW_ORDER": "2",

                        "ACTIVE": "Y",

                        "NAME": "79684881034",

                        "REDIRECT_NUMBER": "79684881034",

                        "PERIOD": "always",

                        "PERIOD_DESCRIPTION": "always",

                        "TIMEOUT": "15"

                  }, {

                        "I_FOLLOW_ORDER": "3",

                        "ACTIVE": "Y",

                        "NAME": "79684881035",

                        "REDIRECT_NUMBER": "79684881035",

                        "PERIOD": "always",

                        "PERIOD_DESCRIPTION": "always",

                        "TIMEOUT": "15"

                  }]

            ]

      }

Должен соответствовать нотации JsonRPC

Выходные параметры:

Response

Name

Type

Description

redirect_type

int

Тип переадресации 1 - одиночная, 2- последовательная, 3- параллельная

followme_struct

структура

Структура с параметрами и номерами переадресации (REDIRECT_NUMBER)

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

Таймаут (в секундах), время ожидания ответа.

Получив ответ от API клиента API МТТ переводит вызовы согласно полученным параметрам переадресации.

Запрос к API клиента отправляется на URL.

Формат URL: <схема>://<логин>:<пароль>@<хост>:<порт>/<URL-путь>

В данном случае:

• в качестве схемы могут быть использованы протоколы http/https
• в качестве логина/пароля будут переданы реквизиты аутентификации
• хост - доменное имя или IP-адрес сервера API клиента.
• порт 80/443

URL-путь - путь к методам получения параметров переадресации.

Точка входа : https://webapicommon.mtt.ru/index.php

Авторизация: Basic Auth

API реализован в виде POST-запросов в соответствии со спецификацией JSON-RPC (http://www.jsonrpc.org/specification).

Функциональность автоматического обзвона (MIVR) реализован на базе функции API: makeCallBackCallIVR, к которой Вам предоставляется доступ:

Входные параметры:

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 новые параметры не заданы - используются старые.

Выходные параметры:

Авторизация:

Авторизация осуществляется штатными средствами 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

    ]

}

    Ответ:

         Успешный ответ:

          Не успешный ответ (неправильный 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-номер):

         Не успешный ответ (у пользователя нет прав использовать данный SIP id):

          Не успешный ответ (недостаточно средств): 

{

    "jsonrpc": "2.0",

    "id": "1",

    "error": {

        "code": -32009,

        "message": "Account error",

        "data": "Insufficient funds to initiate callback"

    }

}

Вы, используя данную функцию, отправляете нам запрос, где в параметрах указываете нам следующие данные:

1. Номер Вашего Клиента. Которому необходимо позвонить;
2. Тип IVR ветки, на которой должен обслуживаться Ваш Клиент (схема веток во вложение), после поднятия трубки, у нас в данный момент реализовано 3 ветки IVR:
   1. Type 1 – ветка требующая от Пользователя факта подтверждения;
   2. Type 2 – ветка проигрывающее информационное сообщение с дальнейшим соединением пользователя с оператором Call Centre Клиента;
   3. Type 3 – ветка проигрывающее только информационное сообщение с дальнейшем разъединением соединения.

Мы, обработав Ваш запрос, инициируем звонок до указанного Вами номера, как только Ваш Клиент поднимает трубку, мы переключаем его на указанную Вами ветку IVR, при этом мы отправляем Вам запрос на Ваш URL для получение текста который необходимо проиграть Клиенту, преобразование полученного текста в звуковой файл производиться на нашей стороне с использованием «text2speech».  Есть возможность проиграть клиенту перед текстом приветственное сообщение, загруженного предварительно аудио файла (welcome file).

 Дополнительно мы со своей стороны производим в режиме online, с момента начало звонка, отправку event уведомлений на Ваш URL, который Вы нам предварительно сообщаете. Данные event уведомления содержат информацию о прохождении вызова (звонок абоненту, абонент поднял трубку, абонент нажал клавишу 1, абонент положил трубку) и позволят Вам всегда иметь актуальную информацию и вносить её в Вашу корпоративную информационную систему.

Для получения текста который необходимо преобразовать и проиграть Клиенту мы отправляем запрос getCustomerTextMessage методом POST:

Входящие параметры:

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

    }

}

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

{

}

}

Точка подключения:https://msapi.mtt.ru:443/

Для получения номеров аккаунта необходимо сделать GET запрос к /accounts/{accountSID}/numbers

Входящие параметры:

Name

Type

Description

limit

int

Лимит выводимых данных

offset

int

Смешение относительно начала

Возвращаемые параметры:

Name

Type

Description

page

int

Номер страницы, начинается с 0.

limit

int

Количество возвращенных записей на странице (по умолчанию 20(максимальное кол-во)).

next

string

URI к следующей части списка.

prev

string

URI, к предыдущей части списка.

total

int

Общее количество записей в списке.

numbers

Json array

Список номеров.

numbers/number

string

Номер

numbers/direction

string

Разрешенное направление отправки

Примерзапроса:
curl –X GET 'v2/accounts/{accountSID}/numbers' \

-u {Login}:{Password} 

Ответ SMSM:

{

   "page": 1,

   "total": 1,

   "limit": 20,

   "offset": 0,

   "prev": "",

   "next": "",

   "numbers": [

      {

         "number": "35800445016",

         "direction": "OUT"

}

   ]

}

Примерзапросас limit, offset

v2/accounts/{accountSID}/numbers?offset=5&limit=5

Запрос возвращает список из 5-ти номеров начиная с 6-го номера.

Для отправки сообщения необходимо сделать POST запрос к

/v2/accounts/{account_sid}/messages

Входящиепараметры:

Name

Type

Description

from

string

Номер отправителя

to

string

Номер получателя

text

string

Текст сообщения

tag

string

Необязательное пользовательское поле, может использоваться для установки уникального идентификатора каждого сообщения.

Возвращаемые параметры:

Name

Type

Description

status_code

integer 

Статус запроса

status_message

string

Статус сообщения

uri

string

url откуда может быть загружена информация о созданном сообщении, msg(последняя часть uri) - идентификатор успешно созданного сообщения;

request_id

string

Уникальный идентификатор ошибки

error

string

Описание ошибки

Authorization:

Basic HTTP auth

 Example:

Request:

JSON:

/v2/accounts/accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe/messages

{

   "from": "79587625004",

   "to": "79587625004",

   "text": "Hello, I am sending message"

}

 Response:

Successfull:

{

   "status_code": 201,

   "status_message": "CREATED",

   "uri": "/v2/accounts/accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe/messages/msgb0789d2f-8932-400d-8768-b6c12abbb872"

}

Unsuccessfull:

{

   "status_code": 400,

   "request_id": "7f4d9823-fd41-4697-ba9b-11940e7932d0",

   "error": "Invalid params: text shouldn't be empty"

}

{

   "status_code": 400,

   "request_id": "7f4d9823-fd41-4697-ba9b-11940e7932d0",

   "error": "Invalid params: text shouldn't be empty"

}

Для получения истории сообщений необходимо выполнить GET запрос к /accounts/{accountSID}/messages

Name

Type

Description

AccountSID

string

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

authToken

string

Пароль

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

curl –X GET 'v2/accounts/{accountSID}/messages?limit=5' \
-u {accountSID}:{authToken} 

Возвращаемые параметры:

JSON

{

               "page": 1,

               "total": 379,

               "limit": 5,

               "offset": 0,

               "prev": "",

               "next": "http://172.16.102.108:8985/v2/accounts/accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe/messages?limit=5&offset=5",

               "messages": [

                               {

                                              "account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",

                                              "message_sid": "msg204815e0-68d3-4193-999b-d142b749fd39",

                                              "text": "работают",

                                              "created_at": 1518091728,

                                              "direction": "inbound",

                                              "number": "79587625002",

                                              "external_number": "79057259771",

                                              "status": "received",

                                              "segment_count": 1,

                               },

                               {

                                              "account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",

                                              "message_sid": "msg660c1d96-bdd3-4e62-a682-9665309b5cc3",

                                              "text": "tester2 Privet!",

                                              "created_at": 1518091728,

                                              "direction": "inbound",

                                              "number": "79587625002",

                                              "external_number": "79166597045",

                                              "status": "received",

                                              "segment_count": 1,

                               },

                               {

                                              "account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",

                                              "message_sid": "msgfe14221b-4dff-4959-9962-de507af92f4a",

                                              "text": "оистатусики",

                                              "created_at": 1518091728,

                                              "direction": "inbound",

                                              "number": "79587625002",

                                              "external_number": "79057259771",

                                              "status": "received",

                                              "segment_count": 1,

                               },

                               {

                                              "account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",

                                              "message_sid": "msg9c8045b5-0fab-4b8f-b0ee-278dcd93fdfc",

                                              "text": "шик",

                                              "created_at": 1518091728,

                                              "direction": "inbound",

                                              "number": "79587625002",

                                              "external_number": "79057259771",

                                              "status": "received",

                                              "segment_count": 1,

                               },

                               {

                                              "account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",

                                              "message_sid": "msg9b23d61c-c28b-40cb-bd2c-adf290a3219c",

                                              "text": "статусы в группе не проверишь)",

                                              "created_at": 1518091728,

                                              "direction": "inbound",

                                              "number": "79587625002",

                                              "external_number": "79166597045",

                                              "status": "received",

                                              "segment_count": 1,

                               }

               ]

}

Возможна фильтрация возвращаемого списка по следующим параметрам:

·         limit, 

·         message_sid, 

·         number, 

·         external_number, 

·         number_sid, 

·         direction, 

·         status,

Для получения информации по сообщении необходимо выполнить GET запрос к /accounts/{accountSID}/messages/{messageSID}

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

JSON

curl –X GET 'v2/accounts/{accountSID}/messages/{messageSID} \

-u {accountSID}:{authToken}

JSON

{

    "page": 1,

    "total": 1,

    "limit": 5,

    "offset": 0,

    "prev": "",

    "next": "",

    "messages": [

        {

            "account_sid": "accefd5c385-f2aa-3dd4-9c0b-01abf00cccfe",

            "message_sid": "msg204815e0-68d3-4193-999b-d142b749fd39",

            "text": "работают",

            "created_at": 1518091728,

            "direction": "inbound",

            "number": "79587625002",

            "external_number": "79057259771",

            "status": "received",

"segment_count": 1,

        }

    ]

}

Premedia API позволяет:

ü  Загружать промт и воспроизводить его в сторону звонящего и/либо в сторону принимающего вызов при переадресации;

ü  Устанавливать text-to-speech и воспроизводить его в сторону звонящего и/либо в сторону принимающего вызов при переадресации;

ü  Управление основными сценариями Premedia API:

• "scenario_id": "1" - проигрывание промта/TTS в сторону А-номера
• "scenario_id": "2" - проигрывание промта/TTS в сторону принимающего вызов (С-номер)
• "scenario_id": "3" - проигрывание промта/TTS в сторону А-номера и в сторону принимающего вызов (С-номер - redirect number)

Точка подключения: https://gapi.mtt.ru:6443/v1/api

Авторизация: Basic Auth

Метод: POST

Создаёт prompt/TTS

Входные параметры:

Name

Type

Description

customer_name*

string

Идентификатор customer'а.

prompt_type

string

'file' || 'text' (дефолтное значение 'file'). Если 'text', то prompt_file_contents посредством TextToSpeech преобразуется в mp3 файл.

prompt_name*

string

Название prompt'а (обязательно наличие расширения mp3 !!!)

prompt_file_contents*

string

Содержимое файла prompt'а в кодировке base64. Формат файлов mp3. (для TTS - UTF-8!!!)

* - обязательные поля

Выходные параметры:

success

boolean

Флаг успеха

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

Запрос:

JSON

Загрузка prompta (аудио файла)

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "createCustomerPrompt",

    "params":

    {

        "customer_name" : "110000777",

        "prompt_name": "116",

        "prompt_type" : "file",

        "prompt_file_contents": "����h���'�"

    }

}

 {

"id": "1",

"jsonrpc": "2.0",

"method": "createCustomerPrompt",

"params":

{

"customer_name" : "110000777",

"prompt_name": "116",

"prompt_type" : "text",

"prompt_file_contents": "Ваш звонок судьбоносен для нас"

}

}

 Ответ:

 Успешный ответ:

JSON

Не успешный ответ:

JSON

{

  "jsonrpc": "2.0",

  "id": "1",

  "error": {

    "code": -32601,

    "message": "Data not found",

    "data": [

        {

                "code": "V_VALUE_NOT_FOUND",

                "attribute": "customer_id",

                "message": "customer_name «79991234568» not found.",

                "tpl": "{attribute} «{value}» not found.",

                "tplParams": {

                    "value": "79991234568",

                    "attribute": "customer_name"

                }

        }

    ]

  }

}

{

   "jsonrpc":"2.0",

   "id":55585,

   "error":

   {

      "code":-32602,

      "message":"Invalid params",

      "data":

      [

         {

            "code":"V_VALUE_ALREADY_EXISTS",

            "attribute":"prompt_name",

            "message":"prompt_name «TTS_file12.wav» already exists.",

            "tpl":"{attribute} «{value}» already exists.",

            "tplParams":

            {

               "value":"TTS_file12.wav",

               "attribute":"prompt_name"

            }

         }

      ]

   }

}

Возвращает информацию о всех промтах предустановленных для customer'а в premedia api.

Входные параметры:

Name

Type

Description

customer_name*

string

Идентификатор customer'а.

* - обязательные поля

Выходные параметры:

Name

Type

Description

id

integer

Идентификатор промта в premedia api

name

string

Название файла промта

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

Запрос:

JSON

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "getCustomerPrompts",

    "params":

    {

        "customer_name": 110000777

    }

}

 Ответ:

 Успешный ответ:

JSON

{

     "jsonrpc":"2.0",

   "id":"1",

   "result":

   {

      "prompts_list":

      [

         {

            "id":1,

            "name":"116.mp3"

         },

         {

            "id":2,

            "name":"TTS_116.mp3"

         }

      ]

   }

}

Не успешный ответ:

JSON

{

  "jsonrpc":"2.0",

    "id":"1",

    "error":

    {

        "code":-32001,

        "message":"Data not found",

        "data":

        [

            {

                "code":"V_VALUE_NOT_FOUND",

                "attribute":"i_customer",

                "message":"customer_name «1012» not found.",

                "tpl":"{attribute} «{value}» not found.",

                "tplParams":

                {

                    "value":1012,

                    "attribute":"customer_name"

                }

            }

        ]

    }

}

Описание:

Удаляет prompt customer'а

Входные параметры:

customer_name*

string

Идентификатор customer'а. По соглашению было принято использовать i_customer.

Имя prompt'а

* - обязательные поля

Выходные параметры:

success

bool 

Успешность выполнения

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

Запрос:

JSON

 Ответ:

 Успешный ответ:

JSON

Не успешный ответ:

JSON

{

  "jsonrpc":"2.0",

   "id":"1",

   "error":

   {

      "code":-32001,

      "message":"Data not found",

      "data":

      [

         {

            "code":"V_VALUE_NOT_FOUND",

            "attribute":"prompt_name",

            "message":"prompt_name «file4.wav.mp3a» not found.",

            "tpl":"{attribute} «{value}» not found.",

            "tplParams":

            {

               "value":"file4.wav.mp3a",

               "attribute":"prompt_name"

            }

         }

      ]

   }

}

@  "scenario_id": "1" - проигрывание промта/TTS в сторону А-номера

@  "scenario_id": "2" - проигрывание промта/TTS в сторону принимающего вызов (С-номер)

@  "scenario_id": "3" - проигрывание промта/TTS в сторону А-номера и в сторону принимающего вызов (С-номер - redirect number)

Входные параметры:

sip_id*

string

Идентификатор account'а.

scenario_id*

integer

answer

integer

* - обязательные поля

Выходные параметры:

success

bool 

Успешность выполнения

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

Запрос:

JSON

 Ответ:

 Успешный ответ:

JSON

Не успешный ответ:

JSON

{

    "jsonrpc": "2.0",

    "id": 1,

    "error": {

        "code": -32001,

        "message": "Data not found",

        "data": [

            {

                "code": "V_VALUE_NOT_FOUND",

                "attribute": "sip_id",

                "message": "sip_id «79991111112» not found.",

                "tpl": "{attribute} «{value}» not found.",

                "tplParams": {

                    "value": "79991111112",

                    "attribute": "sip_id"

                }

            }

        ]

    }

}

{

   "jsonrpc":"2.0",

   "id":45630,

   "error":

   {

      "code":-32001,

      "message":"Data not found",

      "data":

      [

         {

            "code":"V_VALUE_NOT_FOUND",

            "attribute":"scenario_id",

            "message":"scenario_id «4» not found.",

            "tpl":"{attribute} «{value}» not found.",

            "tplParams":

            {

               "value":"4",

               "attribute":"scenario_id"

            }

         }

      ]

   }

}

{

   "jsonrpc":"2.0",

   "id":45630,

   "error":

   {

      "code":-32602,

      "message":"Invalid params",

      "data":

      [

         {

            "code":"V_VALUE_NOT_IN_LIST",

            "attribute":"answer",

            "message":"answer 3 must be one of those valid values 0,1.",

            "tpl":"{attribute} {currentvalue} must be one of those valid values {value}.",

            "tplParams":

            {

               "attribute":"answer",

               "currentvalue":"3",

               "value":"0,1"

            }

         }

      ]

   }

}

Метод привязывает к аккаунту уже загруженный ранее промт, согласно ранее установленному сценарию.

Входные параметры:

Name

Type

Description

sip_id*

string

Идентификатор account'а.

prompt_name*

integer

Имя промпта (ранее загруженного)

side*

string

Какому плечу (A или B) будет проигрываться промпт

* - обязательные поля

Выходные параметры:

success

bool 

Успешность выполнения

Авторизация:

Авторизация осуществляется штатными средствами HTTP

Пример:

Запрос:

JSON

Ответ:

 Успешный ответ:

JSON

Не успешный ответ:

JSON

{

    "jsonrpc": "2.0",

    "id": 1,

    "error": {

        "code": -32001,

        "message": "Data not found",

        "data": [

            {

                "code": "V_VALUE_NOT_FOUND",

                "attribute": "sip_id",

                "message": "sip_id «79991111112» not found.",

                "tpl": "{attribute} «{value}» not found.",

                "tplParams": {

                    "value": "79991111112",

                    "attribute": "sip_id"

                }

            }

        ]

    }

}

{

   "jsonrpc":"2.0",

   "id":45630,

   "error":

   {

     "code":-32602,

      "message":"Invalid params",

      "data":

      [

         {

            "code":"V_VALUE_NOT_IN_LIST",

            "attribute":"side",

            "message":"side C must be one of those valid values A, B.",

             "tpl":"{attribute} {currentvalue} must be one of those valid values {value}.",

            "tplParams":

            {

               "attribute":"side",

               "currentvalue":"C",

               "value":"A, B"

            }

         }

      ]

   }

}

Удаляет у account'а привязку промта, установленного для указанного плеча.

Входные параметры:

Name

Type

Description

sip_id*

string

Идентификатор account'а.

side*

string

К какому плечу (A или B) привязанный промпт нужно удалить

* - обязательные поля

Выходные параметры: