POSThttps://{ourserver.com}/api/auth/me

Изменить список исключений сервисов

Этот запрос позволяет добавлять сервисы в список исключений, запрещая выдавать Ваши номера клиентам для приема SMS от указанных сервисов.

Данный запрос может пригодиться, когда Вы используете свои номера для SMS верификации отдельных сервисов для своих собственных нужд или проектов. Этот запрос заблокирует возможность использовать все номера Вашего аккаунта для данных сервисов, присваивая им статус USED и не допуская их выдачи клиентам под указанные сервисы.

Параметры

header1
НазваниеТипОписание
Authorization*string

Смотрите подробнее тут

Тело запроса

Тело запроса saveConfig

Content-Typeapplication/json
Схема
schemaobject
disabled_serviceobject

Объект, где ключи и значения — это короткие имена (slug) сервисов, продажу которых необходимо выключить на Вашем аккаунте. Имена должны быть согласованы со списком сервисов

Примеры

Example payload for adding VKcom and Facebook to the blacklist
{
  "disabled_service": {
    "vkcom": "vkcom",
    "facebook": "facebook"
  }
}

Ответы

200

Успешный ответ с данными профиля партнера

Content-Typeapplication/json
Схема
schemaobject
idinteger

Уникальный идентификатор партнера

namestring

Отображаемое имя пользователя / Логин

emailstring

Адрес электронной почты текущего аккаунта

Формат:email
groupinteger

ID группы, к которой принадлежит текущий аккаунт: 0 - общая, 2 - партнеры, предоставляющие номера для услуги "Прием SMS", 3 - партнеры, предоставляющие номера для услуги "Аренда номера", 4 - партнеры, предоставляющие номера для услуги "Аренда номера с продлением"

blockboolean

Флаг блокировки текущего аккаунта (true - аккаунт заблокирован)

По умолчанию:false
telegramstring | nullМожет быть null

Telegram юзернейм, привязанный к текущему аккаунту

telegram_keyinteger | nullМожет быть null

ID привязки к Telegram-боту

commentstring | nullМожет быть null

Комментарий к текущему аккаунту

По умолчанию:
apikeystring

API-ключ текущего аккаунта

allowed_ipsstring[]

Перечень IP-адресов, с которых разрешен доступ через API (см. <поле > ). По умолчанию доступ разрешен со всех IP-адресов.

По умолчанию:[]
typeinteger

Тип используемого оборудования. Это поле является справочной меткой профиля и не влияет на логику выдачи номеров

countrystring

Страна оператора, по умолчанию 0. Это поле является справочной меткой профиля и не влияет на логику выдачи номеров

referral_idinteger | nullМожет быть null

ID реферрера

disabled_serviceobject

Объект, где ключи и значения — это слаги сервисов (согласно списку сервисов), продажа которых отключена на этом аккаунте. Ключ и значение совпадают. После редактирования списка необходимо повторно отправить запрос sendNumbersOnline, чтобы изменения вступили в силу.

disabled_service_adminstring[]

Список сервисов, отключенных администратором для заказа на поставленных номерах (пустой массив, если таких нет).

settingsobject

Настройки текущего аккаунта

created_atstring

Дата и время создания аккаунта

updated_atstring

Дата и время последнего обновления аккаунта

is_adminboolean

Флаг, указывающий, является ли текущий аккаунт администратором

По умолчанию:false
balanceobject

Информация о балансе аккаунта

teststring

Опциональное поле для тела запросов Reseller API v2. Может принимать одно из двух значений: test1 или test2.

Будучи равным test1 отправит запрос на сервер, но данные, переданные таким запросом не будут сохранены нашим сервером (не вызовет исполнения функции).

Если параметр будет равен test2, то сервер Onlinesim в ответе вернет тело Вашего запроса.

Может передаваться как query-параметр (для GET) или как поле в теле запроса (для POST). Оба способа эквивалентны, но одновременно использовать их не рекомендуется.

Перечисление:test1test2

Примеры

Example response from Onlinesim server for successfuly modified service blacklistexample_lines
{
  "id": 12345,
  "name": "partner_name",
  "email": "partner@example.com",
  "group": 3,
  "block": false,
  "telegram": null,
  "telegram_key": null,
  "comment": null,
  "apikey": "<api_key>",
  "allowed_ips": [],
  "type": 0,
  "country": "0",
  "referral_id": null,
  "disabled_service": {
    "vkcom": "vkcom",
    "facebook": "facebook"
  },
  "disabled_service_admin": [],
  "settings": {
    "ussdCommands": {},
    "logLevel": "debug",
    "number_notification": 65,
    "balance_notification": 3500,
    "disabled_templates": []
  },
  "created_at": "2024-01-15 10:00:00",
  "updated_at": "2026-08-26 12:00:00",
  "is_admin": false,
  "balance": {
    "sum": 100.5,
    "block": 0,
    "spend": 50,
    "income": 150.5,
    "sms_count": 10,
    "purse": null,
    "additional_info": null
  }
}
Incorrect key passed
[
  {
    "response": "ERROR_WRONG_KEY"
  }
]
400

Отсутствуют или неверно указаны параметры (запрос должен содержать параметры в теле с правильными именами, как описано в документации)

Content-Typeapplication/json
Схема
schemaobject
responsestringОбязательный
Перечисление:ERROR_PARAMS
messagestringОбязательный
401

Не авторизован. В запросе отсутствует или использован некорректный API-ключ. Некоторые эндпоинты могут возвращать статус 200 с сообщением ERROR_WRONG_KEY вместо 401 — проверяйте тело ответа

Content-Typetext/plain
Схема
schemastring
Перечисление:Unauthorized
403

Доступ запрещен. Запрос был понят сервером, но отклонён из-за недостаточных прав доступа

Content-Typeapplication/json
Схема
schemaobject
errorobjectОбязательный
messagestringОбязательный
Перечисление:ERROR_DISABLEDERROR_IPERROR_RENT
detailsobject[]Обязательный
422

Необрабатываемая сущность. Запрос был корректно сформирован, но содержит семантические ошибки.

Поля response и message содержат одинаковую строку с детализированной картой ошибок. Распарсите эту строку как JSON, чтобы определить, какие поля не прошли валидацию.

Content-Typeapplication/json
Схема
schemaobject
responsestringОбязательный

Код ошибки. Содержит ту же JSON-строку, что и поле message, с указанием ошибок валидации по конкретным полям

messagestringОбязательный

Человекочитаемое сообщение об ошибке. Содержит ту же JSON-строку, что и поле response, с указанием ошибок валидации по полям. Распарсите эту строку как JSON, чтобы получить детальную карту ошибок

Примеры кода

Генерация примеров...