Компоненты

Схемы

CountryListSchema

Список стран с количеством доступных номеров по операторам и сервисам

Тип: array

V1GetNumberResponse

Тип: object

Название	Тип	Обязательный	Описание
number	integer	✓	Номер телефона в международном формате, согласно указанным в запросе параметрам
activationId	integer	✓	ID операции (присваивается Вашим сервером)
status	string	✓	Статус выполнения запроса (SUCCESS - при успешной выдаче номера, NO_NUMBERS - если доступных номеров нет, ERROR - при прочих ошибках)

NumberInfo

Объект с данными о каждом номере, где ключ — это номер телефона

Тип: object

Название	Тип	Обязательный	Описание
id	integer		ID номера
balance	integer		Баланс номера
country_id	integer		Код страны (согласно списку стран)
errors	integer		Какое количество раз номер был заказан, но не сумел получить SMS (количество неудачных операций)
number	string		Номер телефона в международном формате
port_id	string		Уникальное имя порта, которое будет отображаться в нашем интерфейсе на странице управления Вашими номерами. Значение по умолчанию совпадает с номером телефона (значением параметра number)
sum	integer		Общий доход, полученный данным номером, в рублях
used_service	object		Объект, где ключи — это короткие имена (slug) использованных на текущем номере сервисов, согласно списку сервисов, для услуги "Аренда" - ключ rent
banned_service	object		Объект, где ключи — это короткие имена (slug) заблокированных на текущем номере сервисов, согласно списку сервисов, для услуги "Аренда" - ключ rent
history	object[]
banned	boolean		Если true, номер заблокирован (блокировка применяется автоматически, после 3 неудачных операций). Блокировка снимается автоматически раз в 24 часа или по нажатию на кнопку Сброс банов/Clean all banned services на странице PSA.
reseller_id	integer		ID аккаунта партнера Onlinesim
rent	boolean		При значении true, у Вашего аккаунта есть возможность предоставлять номера в аренду
status	integer		Текущий статус номера, enum: 1 - номер работает 2 - номер загружается на сервер (после добавления в список номеров) 3 - (deprecated) 4 - указанный Вами номер отсутствует на Вашем аккаунте (некорректный номер) 5 - (deprecated) 6 - null, ошибка аренды: данный номер ранее был успешно использован для аренды и больше не будет генерировать доход. Вам необходимо заменить номер на новый. 7 - (deprecated)
status_text	string		Текущий статус номера, текстовое описание
clearable	boolean		Доступность функции Сброс банов/Clean all banned services (доступно раз в 24 часа)
created_at	object

NumberItem

Тип: object

Название	Тип	Обязательный	Описание
number	string	✓	Номер телефона в международном формате
country_id	integer	✓	Код страны (согласно списку стран)
operator	integer		MCC + MNC коды оператора (эти коды содержатся в первых 5 цифрах IMSI)
date_start	integer<date-time>		Дата и время размещения номера в формате UNIX timestamp
port_id	string		Уникальное имя порта, которое будет отображаться в нашем интерфейсе на странице управления Вашими номерами. Значение по умолчанию совпадает с номером телефона (значением параметра number)
used	string[]
rent	integer	✓	Режим аренды для этого номера: 1 - включен, 0 - выключен,

MessageItem

Тип: object

Название	Тип	Обязательный	Описание
number	integer | string	✓	Номер телефона в международном формате или ID номера (смотри ответ сервера на запрос sendNumbersOnline)
from	string	✓	Имя или номер отправителя
message	string	✓	Текст сообщения
date	string		Дата и время приема сообщения (в любом формате, например UNIX timestamp)

test

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

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

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

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

Тип: string

Перечисление: test1, test2