Документация по Telecom API (Gnezdo)

Name

Type

Description

sip_id

string

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

date_from

string

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

date_to

string

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

incoming

array

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

missed

array

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

dialed

array

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

cli

string

А-номер

cld

string

Номер МТТ либо номер для переадресации (В-номер)

customer_local_time

string

Время платформы (UTC)

connect_time

string

Время звонка (UTC)

charged_time

Integer

Сумма charged_time всех плеч агрегированного вызова, для которых charged_amount > 0

charged

Float

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

destination

string

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

curr

string

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

disconnect_cause

Integer

Причина завершения последнего плеча вызова

used_quantity

Integer

Общее время соединений в ходе сессии, измеряется в секундах

h323_conf_id

string

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

{

    "id": "3",

    "jsonrpc": "2.0",

    "method": "getCallHistory",

   "params":

        {    

        "sip_id": "74996480000",

        "date_from": "30.10.2019 10:23:35",

        "date_to": "30.10.2019 22:23:35"

        }

}

{

    "jsonrpc": "2.0",

    "id": "3",

    "result": {

        "incoming": [],

        "missed": [],

        "dialed": [

            {

                "cli": "79103880489",

                "cld": "79103880490",

                "customer_local_time": "2018-02-06 16:51:17",

                "connect_time": "2018-02-06 16:51:17",

                "charged_time": "0",

                "charged": 0,

                "destination": "RUSSIAN FEDERATION",

                "curr": "RUB",

                "disconnect_cause": "16",

                "used_quantity":"32",

                "h323_conf_id": "07A9B59A 05F65003 13B136EE D90263EE"

            },

            {

                "cli": "79057979388",

                "cld": "79103880490",

                "customer_local_time": "2018-02-07 16:50:15",

                "connect_time": "2018-02-07 16:50:15",

                "charged_time": "0",

                "charged": 0,

                "destination": "RUSSIAN FEDERATION",

                "curr": "RUB",

                "used_quantity":"32",

                "disconnect_cause": "17"

                "h323_conf_id": "07A9B59A 05F65003 13B136EE D90263EE"

            }

        ],

        "callback": [],

        "success": 1

    }

}

{

    "jsonrpc": "2.0",

    "id": "3",

    "error": {

        "code": -32602,

        "message": "Invalid params",

        "data": "Invalid begin date"

    }

}

{

    "jsonrpc": "2.0",

    "id": "3",

    "error": {

        "code": -32001,

        "message": "Data not found",

        "data": "No data found"

    }

}

type*

string

customer_name*

string

customer_name

date_from*

string

Начальная дата и время (YYYY-MM-DD HH24:Mi-SS)

date_to*

string

Конечная дата  и время (YYYY-MM-DD HH24:Mi-SS)

filter

string

Номер, для фильтрации вызовов по "cli" и "cld"

order

string

Сортировка - возможные значения desc (по умолчанию) и asc

record_count*

int

Количество возвращаемых записей (не более 1000)

incoming

array

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

missed

array

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

dialed

array

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

forwarded

array

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

cli

string

А-номер

cld

string

Номер МТТ либо номер для переадресации (В-номер)

customer_local_time

string

Время платформы

connect_time

string

Время звонка

charged_time

Integer

Сумма charged_time всех плеч агрегированного вызова, для которых charged_amount > 0

charged

Float

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

destination

string

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

h323_conf_id

string

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

h323_incoming_conf_id

string

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

curr

string

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

disconnect_cause

Integer

Причина завершения последнего плеча вызова

setup_time_ms

Integer

время установления соединения в мс

account_id

string

Номер клиента, номер МТТ

used_quantity

Integer

Общее время соединений в ходе сессии, измеряется в секундах

h323_conf_id

string

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

voice_record_exist

Boolean

Наличие записанного разговора, false - нет записи, true - запись есть (сформировалась)

{

  "jsonrpc": "2.0",

  "id": "1",

  "method": "getServiceHistoryByCustomer",

  "params":{

    "type": "dialed",

    "customer_name": "110011256",

    "date_from": "2017-09-14 16:01:05",

    "date_to": "2017-09-14 16:01:10",

    "record_count": 20


  }

}

{

    "jsonrpc": "2.0",

    "id": "1",

    "result": {

        "dialed": [

            {

                "cli": "79066899000",

                "cld": "74959333223",

                "customer_local_time": "2017-09-14 16:01:09",

                "connect_time": "2017-09-14 16:01:09",

                "charged_time": "119",

                "charged": 2.48,

                "destination": "Россия фикс.",

                "h323_conf_id": "2B23D937 BD9BCF86 E89D407D 44DA0162",

                "h323_incoming_conf_id": "AC4D7D28 994C11E7 88C6AC16 2D8CE148",

                "curr": "RUB",

                "setup_time_ms": "4581",

                "disconnect_cause": "16",

                "account_id": "74951349387",

                "used_quantity": "119",

                "voice_record_exist": false

            },

            {

                "cli": "79262049647",

                "cld": "79775133876",

                "customer_local_time": "2017-09-14 16:01:08",

                "connect_time": "2017-09-14 16:01:08",

                "charged_time": "60",

                "charged": 0,

                "destination": "Россия фикс.",

                "h323_conf_id": "C2D68D0D 584EEE9A 2697A64B 9A0A0F53",

                "h323_incoming_conf_id": "92E21D30 994C11E7 8FD7AC16 2D8CE148",

                "curr": "RUB",

                "setup_time_ms": "8575",

                "disconnect_cause": "16",

                "account_id": "883140584982783",

                "used_quantity": "35",

                "voice_record_exist": false

            },

            {

                "cli": "74993018267",

                "cld": "79104080307",

                "customer_local_time": "2017-09-14 16:01:07",

                "connect_time": "2017-09-14 16:01:07",

                "charged_time": "0",

                "charged": 0,

                "destination": "Россия фикс.",

                "h323_conf_id": "7EFDAECB 8A53BF45 63F48E8E 273A7F83",

                "h323_incoming_conf_id": "92E26222 994C11E7 8FD7AC16 2D8CE148",

                "curr": "RUB",

                "setup_time_ms": "2000",

                "disconnect_cause": "17",

                "account_id": "883140587615452",

                "used_quantity": "0",

                "voice_record_exist": false

            }

        ],

        "success": 1

    }

}

{

    "jsonrpc": "2.0",

    "id": "3",

    "error": {

        "code": -32602,

        "message": "Invalid params",

        "data": "Invalid begin date"

    }

}

sid_id

string

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

followmeStruct

array of followmeStruct

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

timeout

string

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

redirect_number

string

Номер для перенаправления вызова. Формат номера РФ:Е.164 без "+", н-р, 74951234567 

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

Отображение АОН звонящему (Y/N/I)

Y - отображение реального номера звонящего (по умолчанию)

N - отображение в качестве номера звонящего sip_id

I - отображение реального номера звонящего, используется при настроенной схеме (на стороне МТТ) проигрывания приветственного/информационного сообщения (Premedia) для звонящего/принимающего 

вызов абонента. 

keep_original_cld*

string

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

success

number

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

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "setFollowme",

    "params": ["74951345897",

        [

            {

                "timeout": 15,

                "redirect_number": "79684881033",

                "name": "79684881033",

                "active": "Y",

                "period": "always",

                "period_description": "Always",

                "follow_order": 1

            },

            {

                "timeout": 15,

                "redirect_number": "79636793312",

                "name": "79636793312",

                "active": "Y",

                "period": "always",

                "period_description": "Always",

                "follow_order": 2

            }

        ]

    ]

}

{

    "jsonrpc": "2.0",

    "id": "1",

    "result":

    {

        "success": 1

    }

}

{

    "jsonrpc": "2.0",

    "id": "1",

    "error":

    {

        "code": -32001,

        "message": "Data not found"

    }

}

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

{

    "jsonrpc": "2.0",

    "id": "1",

    "error":

    {

        "code":-32002,

        "message":"Permission denied",

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

    }

}

sip_id

string

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

followme_struct

array of followmeStruct

followmeStruct содержит номер для переадресации вызова и временной интервал, в котором эта переадресация работает

I_FOLLOW_ORDER

string

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

ACTIVE

string

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

NAME

string

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

REDIRECT_NUMBER

string

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

PERIOD

string

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

PERIOD_DESCRIPTION

string

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

TIMEOUT

string

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

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "getFollowme",

    "params": ["74951345987"]

}

{

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

    }

}

customer_name*

String

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

balance

numeric

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

real_balance

numeric

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

pending_payment

{

    "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

customer_name

string (41)

Лицевой счет

limit

number

Количество возвращаемых аккаунтов

offset

number

Смещение

account_number 

string

Номер, вывод отсоритирован в порядке возрастания

activation_date 

string

Дата активации

status 

string

Статус номера, например "active"

{
   "id":"1",
   "jsonrpc":"2.0",
   "method":"getPersonalAccountList",
   "params":{       
        "customer_name": "110011111",
        "limit": 5,
        "offset": 1
   }
}

{
    "jsonrpc": "2.0",
    "id": "1",
    "result": [
        {
            "account_number": "74951373222",
            "activation_date": "21.01.2020 00:00:00",
            "status": "active"
        },
        {
            "account_number": "74951374017",
            "activation_date": "21.01.2020 00:00:00",
            "status": "active"
        },
        {
            "account_number": "74951340438",
            "activation_date": "21.01.2020 00:00:00",
            "status": "active"
        },
        {
            "account_number": "74951374095",
            "activation_date": "25.11.2020 00:00:00",
            "status": "active"
        },
        {
            "account_number": "74951374096",
            "activation_date": "25.11.2020 00:00:00",
            "status": "active"
        }
    ]
}

{
    "jsonrpc": "2.0",
    "id": "1",
    "error": {
        "code": -32602,
        "message": "Invalid params",
        "data": "Unknown param 'limit' value"
    }
}

string

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

customer_name*

string

Аккаунт CallBack, выдается МТТ

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

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

order

number

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

timeout

number

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

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

redirect_number

string

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

type

string

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

name

string

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

side

string

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

value

string

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

callBackCall_id

string

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

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "makeCallBackCallFollowme",

    "params": {

        "customer_name" : "883140500000000",

        "b_number" : "+79157775533"

     }

}

{

  "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-номер.

    }

}

customer_name

string

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

callBackCall_id

string

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

callBackFollowmeCallInfoStruct

array of callBackFollowmeCallInfo

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

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

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

{

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

}

}

}

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

   }

}

{

   "jsonrpc":"2.0",

   "id":"101",

   "error":

   {

      "code":-32001,

      "message":"Data not found",

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

   }

}

customer_name*

string

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

file_name

string

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

uploadURL

string

Адрес для загрузки файла (POST)

statusURL

string

Адрес для проверки состояния загрузки (POST)

maxsize

number

Максимально разрешенный размер файла в байтах

accepted_formats

object

Допустимые расширения файлов и их MIME типы

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "setCallBackPrompt",

    "params":

    {

        "customer_name":"883140500000000",

        "file_name":"sound_1.mp3"

    }

}

{

    "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 

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

file_name

string

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

date_upload

string

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

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "getCallBackPromptInfo",

    "params": {

      "customer_name" : "883140500000000"

     }

}

{

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

   }

}

customer_name*

string

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

callBackFollowmeStruct*

array of callBackFollowmeStruct

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

caller_id

string

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

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

defaultBNumber

string

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

order

number

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

timeout

number

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

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

redirect_number

string

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

type

string

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

name

string

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

side

string

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

value

string

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

success

number

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

{

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

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

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

    {

         "success": 1

    }

}

    {

    "jsonrpc":"2.0",

    "id":"101",

    "result":

    {

        "error":1,

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

    }

}

customer_name

string

Имя Customer

order

number

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

timeout

number

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

redirect_number

string

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

type

string

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

name

string

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

side

string

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

value

string

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

callBackFollowmeStruct

array of callBackFollowmeStruct

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

caller_id

string

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

defaultBNumber

string

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

{

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

    }

}

customer_name

string

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

success

number

1 = список успешно удален

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "deleteCallBackFollowme",

    "params": {

        "customer_name":"883140500000000"

    }

}

{

    "jsonrpc": "2.0",

    "id": "1",

    "result":

    {

        "success": 1

    }

}

{

    "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

sip_id 

string

sip_id аккаунта, для обнуления передается пустое значение

url

string

Строка содержащая url, для обнуления передается пустое значение

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"

    }

}

sip_id 

string

sip_id аккаунта

string

Строка содержащая number

success 

number 

Индикатор успеха 

{
    "id": "1",
    "jsonrpc": "2.0",
    "method": "setReserveCallControlNumber",
    "params":
    {
        "sip_id":"73432143178",
        "number":"79991112233"
    }
}

{
    "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"
    }
}

sip_id 

string

sip_id аккаунта, номер МТТ

GN_IP_IPCR 

number 

URL клиента для отправки запроса getControlCallFollowMe 

GN_IPCR_RESERVE

number 

Резервный номер для "оффлайн" переадресации

i_account

number 

внутренний идентификатор на платформе МТТ

{ "jsonrpc": "2.0", "method": "getAccountCustomFields", "id": "1", "params": {"sip_id":"79584630000" } }

{ "jsonrpc": "2.0", "id": "1", "result": { "account_custom_fields": { "GN_IP_IPCR": "https://www.domen.ru/mtt/", "GN_IPCR_RESERVE": "79307084160", "i_account": 113408082 } } }

{ "jsonrpc": "2.0", "id": "1", "error": { "code": -32002, "message": "Permission denied", "data": "agent does not have access to this account" } }

limit

int

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

offset

int

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

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 {accountSID}:{Token} 

{

   "page": 1,

   "total": 1,

   "limit": 20,

   "offset": 0,

   "prev": "",

   "next": "",

   "numbers": [

      {

         "number": "35800445016",

         "direction": "OUT"

}

   ]

}

from

string

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

to

string

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

text

string

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

tag

string

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

status_code

integer 

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

status_message

string

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

uri

string

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

request_id

string

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

error

string

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

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

{

   "from": "79587625004",

   "to": "79587625004",

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

}

{

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

}

AccountSID

string

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

authToken

string

Пароль

page

int

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

limit

int

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

next

string

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

prev

string

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

total

int

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

messages

Json array

Список сообщений.

messages /message_sid

string

Идентификатор сообщения.

messages /created_at

string

Дата создания.

messages /account_sid

string

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

messages /number

string

Внешний номер, с/на который отправлено сообщение
(в зависимости от направления).

messages /external_number

string

Наш номер с/на который отправлено сообщение
(в зависимости от направления).

messages /text

string

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

messages/direction

string

Направление сообщения: "inbound" или "outbound".

messages/status

string

Текущий статус сообщения.

messages/segment_count

string

Количество частей в сообщении

{

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

                               }

               ]

}

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

-u {accountSID}:{authToken}

{

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

        }

    ]

}

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

Флаг успеха

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

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "createCustomerPrompt",

    "params":

    {

        "customer_name" : "110000777",

        "prompt_name": "116.mp3",

        "prompt_type" : "file",

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

    }

}

 Загрузка текста (TTS)

 {

"id": "1",

"jsonrpc": "2.0",

"method": "createCustomerPrompt",

"params":

{

"customer_name" : "110000777",

"prompt_name": "116",

"prompt_type" : "text",

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

}

}

{

    "jsonrpc":"2.0",

   "id":55585,

   "result":

   {

      "success":true

   }

}

{

  "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_name*

string

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

id

integer

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

name

string

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

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "getCustomerPrompts",

    "params":

    {

        "customer_name": 110000777

    }

}

{

     "jsonrpc":"2.0",

   "id":"1",

   "result":

   {

      "prompts_list":

      [

         {

            "id":1,

            "name":"116.mp3",

"file_id": "c20ed66245ae695fc35f846ef3f35e94"

         },

         {

            "id":2,

            "name":"TTS_116.mp3",

"file_id": "a11b494d3952ff1fb2b7de375524db41"

         }

      ]

   }

}

{

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

                }

            }

        ]

    }

}

customer_name*

string

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

prompt_name*

string

Имя prompt'а

success

bool 

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

{

    "id": "1",

    "jsonrpc": "2.0",

    "method": "deleteCustomerPrompt",

    "params":

    {

        "customer_name" : "110000777",

        "prompt_name": "116.mp3"

    }

}

{

    "jsonrpc": "2.0",

    "id": 1,

    "result": {

        "success": true

    }

}

{

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

            }

         }

      ]

   }

}

sip_id*

string

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

scenario_id*

integer

Идентификатор сценария

answer

integer

Флаг предответного состояния - 0, 1 (default 0)

success

bool 

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

{

    "jsonrpc":"2.0",

    "method":"updatePremediaAccountSettings",

    "id":45630,

    "params":{

        "sip_id":"74951348579",

        "scenario_id": "3"

           }

}

{

    "jsonrpc": "2.0",

    "id": 1,

    "result": {

        "success": true

    }

}

{

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

            }

         }

      ]

   }

}

sip_id*

string

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

prompt_name*

integer

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