AddSipDevicePushToken

Метод AddSipDevicePushToken

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

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

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

Авторизация

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

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

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

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

Параметр Тип Описание
sip_username uint64 юзернейм SIP ID
device_token string токен устройства
device_token_type enum DeviceTokenType тип устройства
dev_mode boolean True - включить отладочный режим для push-уведомлений, False - боевой режим

DeviceTokenType

Параметр Тип Описание
1 enum Android
2 enum iOS
3 enum iOS + VoIP
4 enum Huawei

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

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

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

Код Статус Пример сообщения Описание
401 Unauthorized Unauthorized отсутствует/не валидный API-ключ
404 Not Found not found указанный юзернейм SIP ID не принадлежит приложению
400 Bad Request invalid AddSipDevicePushTokenRequest.SipUsername: value length must be between 11 and 15 runes, inclusive значение в поле sip_username не валидно (принимает от 11 до 15 символов включительно)
400 Bad Request invalid AddSipDevicePushTokenRequest.DeviceToken: value length must be between 1 and 1024 runes, inclusive поле device_token пустое
400 Bad Request invalid AddSipDevicePushTokenRequest.DeviceTokenType: value must be one of the defined enum values значение в поле device_token_type не валидно, должно быть одно из заданных значений
400 Bad Request cant decode json поле device_token_type пустое

Примеры

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

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

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

{}

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