Components

Schemas

CountryListSchema

List of countries and the respective available number counts per operator and service

Type: array

V1GetNumberResponse

Type: object

Name	Type	Required	Description
number	integer	✓	Phone number in international format according to the requested parameters
activationId	integer	✓	Operation ID (assigned by your server)
status	string	✓	Request status (SUCCESS - when number is successfully issued, NO_NUMBERS - when there are no available numbers, ERROR - for other errors)

NumberInfo

An object with data about each number, where the key is the phone number

Type: object

Name	Type	Required	Description
id	integer		Number ID
balance	integer		Number balance
country_id	integer		Country code (according to the countries list)
errors	integer		How many failed operation current number has
number	string		Phone number in international format
port_id	string		Unique port name, this name will be displayed in our interface on your personal web-page. Unless specified defaults to phone number value (value of number parameter)
sum	integer		Total income earned by this number, in RUB
used_service	object		An object where the keys are the slugs of services that have been used on the current number, according to the services list. For the “Rent” service, the key is rent
banned_service	object		An object where the keys are the slugs of services that are banned on the current number, according to the services list. For the “Rent” service, the key is rent
history	object[]
banned	boolean		If true the number is banned (ban is applied after 3 failed operations). It is lifted automatically every 24 hours or upon clicking Reset bans/Clean all banned services button on your personal webpage.
reseller_id	integer		Partner's account ID
rent	boolean		If true, your account is eligible for providing long term rent service
status	integer		Current status of the number, enum: 1 - number is working 2 - number is queued up/loading (after the placement) 3 - (deprecated) 4 - such number does not exist on your account (invalid entry) 5 - (deprecated) 6 - null, rent error: this number was successfully used for long term rent and won't generate the profit anymore. You need to replace the number with a new one. 7 - (deprecated)
status_text	string		Current status of the number, textual description
clearable	boolean		Reset bans/Clean all banned services function availability (available once in 24 hours)
created_at	object

NumberItem

Type: object

Name	Type	Required	Description
number	string	✓	Phone number in international format
country_id	integer	✓	Country code (according to countries list)
operator	integer		MCC + MNC operator code (first 5 digits of IMSI)
date_start	integer<date-time>		Date and time of the start of the phone number placement in UNIX timestamp format
port_id	string		Unique port name, this name will be displayed in our interface on your personal web-page. Unless specified defaults to phone number value (value of number parameter)
used	string[]
rent	integer	✓	Rent mode for this number: 1 - enabled, 0 - disabled

MessageItem

Type: object

Name	Type	Required	Description
number	integer | string	✓	Phone number in international format or number's ID (see sendNumbersOnline server response)
from	string	✓	Name or a phone number of a sender
message	string	✓	Message text
date	string		Date and time when SMS was received (in any format, for example in UNIX timestamp)

test

Optional field for the request body of Reseller API v2. Allowed values are test1, test2.

While being assigned, test1 value will allow the request to be passed, however the data won't be saved by our server (the function will not be executed by this request).

While being assigned, test2 value will print out your request's payload in response.

Can be passed as query parameter (for GET) or as a field in request's body (for POST). Both ways are equivalent, but using them simultaneously is not recommended.

Type: string

Enum: test1, test2