GET /api/rent/getRentNum.php
Buy virtual phone number for rent
This request allows you to rent a number of a specific country for SMS receiving.
You can use this request when you need to receive messages from multiple different services or from a single one, but over a long time period.
WARNING
Please note that every new rent operation has a 20 minute protective interval, during which SMS must be received by issued number. If you won't use the number within this timeframe the operation will be terminated automatically and the cost of rent will be refunded.
INFO
Also some services are prohibited for use (and SMS from these services are not available), you can find the list of such services on the front page or in Public offer.
Security
- apikey
- BearerAuth
- OAuth2 (Scopes: rent-scope)
rent-scope: grants access to renting phone numbers from Onlinesim
Parameters
| Name | Type | Description |
|---|---|---|
country | integer≥ 1 | ‘International dialing code of the country (Е.164 standard, without Default: 7Example:46 |
days* | integer≥ 1 | ‘Initial rental period (in days), see available values in Example: 1 |
extension | boolean | ‘Auto-renewal (when enabled, automatically extends the rental for Default: true |
pagination | boolean | Message pagination |
lang | string | Response language: Enum: frderuenzhDefault:ruExample:en |
Responses
200
Successful response for getRentNum request: the server issues a number with requested parameters for rent or throws an exception.
Code Samples
No code samples available