Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Оглавление:

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

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

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

Метод: POST

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

Name

Type

Description

id

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

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

maxtime

string

Указывается в секундах. Суммарная максимальная длительность разговора по плечу А и по плечу B. По истечении заданного времени CallBack будет завершен.

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

simpleCallBackFollowmeStruct

Name

Type

Description

order

number

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

timeout

number

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

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

redirect_number

string

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

type*

string

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

Возможные значения:
"Ringall" - вызываются все участники структуры, переданные в callBackFollowmeStruct (плечо А);
"Lineral" - вызов участников группы (плечо А), переданных в callBackFollowmeStruct, происходит последовательно.

name

string

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

side

string

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

value

string

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

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

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

Name

Type

Description

callBackCall_id

string

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

Пример

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

JSON
{
    "id": "1",
    "jsonrpc": "2.0",
    "method": "makeCallBackCallFollowme",
    "params": {
        "customer_name" : "883140500000000",
        "b_number" : "+79157775533"
     }
}

Данный пример запроса без предварительной установки структуры вызова - функцией setCallbackfollowme, передача структуры simpleCallBackFollowmeStruct в теле запроса makeCallBackCallFollowme:

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

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

JSON
{
    "jsonrpc": "2.0",
    "id": "1",
    "result":
    {
        "callBackCall_id": "1256ffb10774226b390ad1a2bc892c9c"
    }
}

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

JSON
{
    "jsonrpc":"2.0",
    "id":"iar_ringall",
    "result":
    {
        "error":1,
         "message":"Incorrect redirect_number format" - указан некорректный А - номер ( redirect_number)
         "message" : "Incorrect B-number format"- указан некорректный B-номер.
    }
}
  • No labels