profile

Изменить профиль (webhook URL и значения по умолчанию)

POSThttps://onlinesim.io/api/profile.php

Сохраняет поля, переданные в profile, и возвращает обновлённый аккаунт. Непереданные поля не меняются. Работают и JSON, и данные формы (profile[webhook_url]=…).

number_region сервисом не используется и всегда равен null; переданное значение не сохраняется.

Безопасность

Параметры

query1
НазваниеТипОписание
langstring

Язык текстов в ответе (названия стран и сервисов, тексты статусов): fr, de, ru, en или zh. Принимается любым методом; методы без таких текстов отвечают одинаково на любом языке. Названия полей, коды ошибок и другие фиксированные значения остаются на английском. Без параметра: ru для getTariffs, getNumbersStats и getFreeList; в остальных — язык профиля для запросов с ключом, английский для запросов без ключа. Неподдерживаемое значение заменяется языком по умолчанию

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

Тело запроса

Обязательный
Content-Typeapplication/json
Схема
schemaobject
profileobjectОбязательныйПоля для изменения.

Ответы

200Сохранённый аккаунт, ошибки валидации или код ошибки:
  • ERROR_PARAMS — profile не передан или не является объектом
  • Query Exception — база данных отклонила изменение
Content-Typeapplication/json
Схема
schemaoneOf
Одно из
[0]object
[1]objectОшибки валидации: поле → список сообщений; неверный old_password даёт {"old_password": "<сообщение>"}.
[2]object
[3]object

Примеры

Validation error

webhook_url — не URL

{
  "response": {
    "webhook_url": [
      "The webhook url field must be a valid URL."
    ]
  }
}
ERROR_PARAMS

profile не передан

{
  "response": "ERROR_PARAMS"
}
429HTTP 429: больше 400 запросов в минуту с одного профиля (с одного IP для запросов без ключа) или больше 200 запросов в минуту с одного профиля к getNum, getPrice, getState и setOperationOk вместе
Content-Typeapplication/json
Схема
schemaobject
responsestringОбязательный
Код ошибки. Коды, которые может вернуть любой метод, перечислены во введении; у каждого метода — свои. Список не закрыт: неизвестный код обрабатывайте как общую ошибку и записывайте в лог.

Примеры

Rate limit

Превышен лимит запросов

{
  "response": "TRY_AGAIN_LATER"
}
456HTTP 456: API-ключ неверный или OAuth-токен истёк. Публичные методы отвечают так же, если передан неверный ключ
Content-Typeapplication/json
Схема
schemaobject
responsestringОбязательный
Код ошибки. Коды, которые может вернуть любой метод, перечислены во введении; у каждого метода — свои. Список не закрыт: неизвестный код обрабатывайте как общую ошибку и записывайте в лог.

Примеры

Invalid key

Неверный API-ключ или истёкший токен

{
  "response": "ERROR_WRONG_KEY"
}

Примеры кода

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