DeleteSipDevicePushToken

Метод DeleteSipDevicePushToken

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

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

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

Авторизация

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

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

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

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

ПараметрТипОписание
sip_usernameuint64юзернейм SIP ID
device_tokenstringтокен устройства
device_token_typeenum DeviceTokenTypeтип устройства

DeviceTokenType

ПараметрТипОписание
1enumAndroid
2enumiOS
3enumiOS + VoIP
4enumHuawei

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

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

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

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

Примеры

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

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

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

{}