profile

Получить профиль

GEThttps://onlinesim.io/api/getProfile.php

Возвращает аккаунт владельца ключа: настройки, которые используют другие методы (number_country, number_reject, webhook_url), доступ к API, язык и валюту. Только GET.

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

Параметры

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

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

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

Ответы

200Профиль или общая ошибка
Content-Typeapplication/json
Схема
schemaoneOf
Одно из
[0]object
[1]object
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"
}

Примеры кода

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