MakeCallBack

Метод MakeCallBack

Примените этот метод для совершения обратного звонка. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/call/v1/MakeCallback

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Параметр Тип Описание
request_description string идентификатор запроса со стороны клиента
number_code uint64 номер для создания обратного звонка
callback_resource_id uint64 уникальный идентификатор ресурса обратного звонка. Чтобы получить идентификатор, создайте ресурс обратного звонка в приложении
duration uint32 максимальная длительность соединенного вызова двух абонентов в секундах: от 300 до 3600 (по умолчанию: 1800)
line_1 Line_x настройки первого плеча
line_2 Line_x настройки второго плеча

Line_x

Параметр Тип Описание
destinations Destination Список абонентов плеча Х (до 10 на каждом)
ring_logic enum Принцип обзвона. Значение 1 для последовательного обзвона, значение 2 для параллельного. Значение 1 по умолчанию
display_number string отображаемый номер звонящего/принимающего вызов абонента
audio Audio аудиосообщение для абонента плеча Х

Destination

Параметр Тип Описание
number string номер или SIP-URI абонента
timeout uint32 максимальное время дозвона до абонента от инициации вызова в секундах: от 10 до 600 (по умолчанию: 30)

Audio

Параметр Тип Описание
media_resource_id uint64 уникальный идентификатор медиаресурса для аудиосообщения абоненту плеча Х

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

Параметр Тип Описание
call_id string уникальный идентификатор совершенного обратного звонка
request_id string идентификатор запроса со стороны клиента

Возможные ошибки

Код Статус Пример сообщения Описание
401 Unauthorized malformed token не указан / не правильно указан API-ключ приложения
403 Forbidden customer not active нет доступа к услуге обратного звонка из-за статуса аккаунта пользователя (не активирован/заблокирован)
400 Bad Request invalid MakeCallbackRequest.Line_1: embedded message failed validation невалидный запрос
504 Gateway Timeout нет ответа от внутренних систем Exolve

Примеры

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

{
    "request_description": "internal_id_148",
    "callback_resource_id": 1221,
    "number_code": 74999999999,
    "line_1": {
        "destinations": [
            {
                "number": "78129999999"
            },
            {
                "number": "74959999999"
            }
        ],
        "ring_logic": 2,
        "audio": {
            "media_resource_id": 685
        }   
    },
    "line_2": {
        "destinations": [
            {
                "number": "79599999999"
            },
            {
                "number": "79999999999"
            }
        ],
        "ring_logic": 1,
        "audio": {
            "media_resource_id": 685
        }
    }
}

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

{
    "call_id": "1890033117915127808",
    "request_description": "Идентификатор"
}

Содержание статьи