Callback API

Callback API — программный интерфейс, который позволяет пользователям управлять ресурсами обратных звонков в Личном кабинете и совершать эти звонки.

Callback API Exolve предлагает пользователям следующие методы для управления ресурсами обратных звонков и их совершения:

• Create - создает ресурс обратного звонка в приложении Личного кабинета;

• GetList - получает информацию обо всех ресурсах обратных звонков в приложении Личного кабинета;

• GetInfo - получает информацию о конкретном ресурсе обратного звонка в приложении Личного кабинета;

• Delete - удаляет ресурс обратного звонка в приложении Личного кабинета;

• Update - изменяет имя и описание ресурса обратного звонка в приложении Личного кабинета;

• MakeCallBack - совершает обратный звонок.

Решения, где используется Callback API

Попробовать бесплатно

Метод Create

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

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

POST: https://api.exolve.ru/callback/v1/Create

Авторизация

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

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

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

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

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

Примеры

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

{
    "callback_name": "Наименование",
    "description": "Описание"
}

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

{
    "callback_resource_id": "1657"
}

Метод GetList

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

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

POST: https://api.exolve.ru/callback/v1/GetList

Авторизация

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

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

Пустой JSON

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

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

Примеры

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

{}

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

{
    "callbacks": [
        {
            "callback_resource_id": "138825",
            "callback_name": "Test",
            "description": "Test",
            "created_at": "2023-03-10T11:14:07.990035Z"
        },
        {
            "callback_resource_id": "138872",
            "callback_name": "Наименование",
            "description": "Описание",
            "created_at": "2023-03-12T12:20:08.971486Z"
        }
    ]
}

Метод GetInfo

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

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

POST: https://api.exolve.ru/callback/v1/GetInfo

Авторизация

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

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

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

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

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

Примеры

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

{
    "callback_resource_id": 138873
}

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

{
    "callback": {
        "callback_resource_id": "138873",
        "callback_name": "Наименование",
        "description": "Описание",
        "created_at": "2023-03-12T12:20:41.112301Z"
    }
}

Метод Delete

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

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

POST: https://api.exolve.ru/callback/v1/Delete

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом.

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

Примеры

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

{
    "callback_resource_id": 1657
}

Метод Update

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

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

POST: https://api.exolve.ru/callback/v1/Update

Авторизация

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

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

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

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

Пустой JSON с 200 OK статусом

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

Примеры

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

{
    "callback_resource_id": 1212,
    "callback_name": "Новое наименование",
    "description": "Новое описание"
}

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

{}

Метод MakeCallBack

Примените этот метод для совершения обратного звонка: платформа позвонит абонентам (например, оператору и клиенту), затем объединит их для разговора. Обоим абонентам можно перед соединением проиграть аудиосообщение — предварительно записанное или синтезированное в режиме онлайн в рамках этого же звонка.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

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

Авторизация

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

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

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

Line_x

Destination

Audio

ВАЖНО! Для одного плеча можно указать только один из параметров:

• media_resource_id — проиграть принимающим абонентам предзаписанное аудио
• tts — (Text-to-Speech) — синтезировать речь по заданным параметрам в режиме онлайн

TTS

SynthesisSettings

ВАЖНО! Каждый голос поддерживает определённые параметры языка и эмоции. При формировании API-запроса важно, чтобы выбранный голос был доступен с указанным языком и эмоцией

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

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

Примеры

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

{
    "request_description": "internal_id_148",
    "number_code": 74999999999,
    "callback_resource_id": 1221,
    "line_1": {
        "destinations": [
            {
                "number": "78129999999"
            },
            {
                "number": "74959999999"
            }
        ],
        "ring_logic": 1,
        "audio": {
            "tts": {
                "text": "МТС Exolve — конструктор омниканальных диалогов для бизнеса",
                "voice": 1,
                "lang": 1,
                "volume": -19,
                "speed": 1.1,
                "emotion": 2
            }
        }
    },
    "line_2": {
        "destinations": [
            {
                "number": "79599999999"
            },
            {
                "number": "79999999999"
            }
        ],
        "ring_logic": 1,
        "audio": {
            "media_resource_id": 685
        }
    }
}

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

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