Push API

Push API - это программный интерфейс, который позволяет добавить токен устройства мобильного приложения на базе iOS, Android или Huawei в связку с SIP ID. Вам понадобится данный интерфейс при разработке мобильного приложения для звонков c использованием Exolve Mobile Voice SDK, чтобы пользователи вашего приложения могли получать push-уведомления о входящих звонках.

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

• AddSipDevicePushToken - добавляет токен устройства мобильного приложения в связку с SIP ID;

• GetDeviceList - получает список токенов устройств мобильных приложений по заданным параметрам;

• DeleteSipDevicePushToken - удаляет токен устройства мобильного приложения из связки с SIP аккаунтом.

Метод AddSipDevicePushToken

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

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

POST: https://api.exolve.ru/push/v1/AddSipDevicePushToken

Авторизация

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

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

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

DeviceTokenType

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

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

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

Примеры

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

{
    "sip_username": "883140123456789",
    "device_token": "token",
    "device_token_type": 1
}

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

{}

Метод GetDeviceList

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

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

POST: https://api.exolve.ru/push/v1/GetDeviceList

Авторизация

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

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

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

DeviceTokenType

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

Devices

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

Примеры

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

{
    "device_token_type": 1
}

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

{ 
    "devices": [
        { 
            "application_uuid": "b81ce4fc-f755-4f49-b8d3-f782f9ad9999",
            "sip_username": "883140123456789",
            "device_token": "token",
            "device_token_type": "1"
        },
        { 
            "application_uuid": "b81ce4fc-f755-4f49-b8d3-f782f9ad9999",
            "sip_username": "883140987654321",
            "device_token": "token2",
            "device_token_type": "1"
        }
    ]
}

Метод DeleteSipDevicePushToken

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

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

POST: https://api.exolve.ru/push/v1/DeleteSipDevicePushToken

Авторизация

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

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

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

DeviceTokenType

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

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

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

Примеры

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

{
    "sip_username": "883140123456789",
    "device_token": "token",
    "device_token_type": 1
}

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

{}