gethttps://onlinesim.io/api/rent/tariffsRent.php

GET /api/rent/tariffsRent.php

Get information on tariffs for rent numbers

Returnes information on available for rent numbers of specified country (or all of countries, if not specified): rental plans and other parameters of rent.

Unlike regular SMS receiving, rental implies a longer period of use. Also, unlike regular receiving, you can receive any number of SMS messages during the entire rental period from various senders: from websites and applications to SMS sent from regular mobile numbers.

If you initially chose a number with the extention option, you can extend the rental at any time before it expires.

Security

apikey

BearerAuth

OAuth2Scopes: rent-scope

rent-scope: grants access to renting phone numbers from Onlinesim

Parameters

query2

Name	Type	Description
`country`	`string` minLen: 1	'International dialing code of the country (Е.164 standard, without "+" sign), see country list' Example:`7`
`lang`	`string`	Response language: `fr` - French, `de` - German, `ru` - Russian, `en` - English, `zh` - Chinese. Please note that the translation applies only to string field values, such as service names or country names. Field names themselves, error messages, and standard values (for example, true/false for boolean fields) remain in English. Enum:`frderuenzh`Default:`ru`Example:`en`

Responses

200

'Successful response for tariffsRent request: the server returns information on available rental plans or throws an exception.'

Content-Typeapplication/json

Schema

Responseobject

codeinteger

'International dialing code of the country (Е.164 standard, without "+" sign), see country list'

≥ 1

Default:7Example:46

enabledboolean

Availability of virtual numbers of a country (available/unavailable)

newboolean

Was the country recently added to the list (true/false)

positioninteger

Country position in the list in the user dashboard (by default)

≥ 0

Example:1

countobject

Contains information on the amount of available numbers for each available rental period

"period_in_days"integer

Amount of available numbers for each initial rental period

≥ 0

Example:20

daysobject

Contains information on the price for each initial rental period

"period_in_days"number

Price of rent for each inital rental period

extendinteger

Amount of available numbers for rent with extention option

confirmboolean

Examples

Successful tariffsRent response example523 lines

{
  "1": {
    "code": 1,
    "enabled": true,
    "name": "usa",
    "new": false,
    "position": 1,
    "count": {
      "7": 10
    },
    "days": {
      "7": 6615.5
    },
    "extend": 0,
    "confirm": true
  },
  "7": {
    "code": 7,
    "enabled": true,
    "name": "russia",
    "new": false,
    "position": 7,
    "count": {
      "1": 1153,
      "3": 1153,
      "7": 1153,
      "15": 1153,
      "30": 1153
    },
    "days": {
      "1": 121,
      "3": 215.5,
      "7": 400,
      "15": 700,
      "30": 1078.5
    },
    "extend": 1153,
    "confirm": false
  },
  "31": {
    "code": 31,
    "enabled": true,
    "name": "netherlands",
    "new": false,
    "position": 31,
    "count": {
      "7": 16,
      "15": 16,
      "30": 16
    },
    "days": {
      "7": 1150,
      "15": 2013,
      "30": 3451.5
    },
    "extend": 16,
    "confirm": false
  },
  "33": {
    "code": 33,
    "enabled": true,
    "name": "france",
    "new": false,
    "position": 33,
    "count": {
      "7": 15,
      "15": 15,
      "30": 15
    },
    "days": {
      "7": 2876,
      "15": 5177,
      "30": 9203.5
    },
    "extend": 15,
    "confirm": false
  },
  "34": {
    "code": 34,
    "enabled": true,
    "name": "spain",
    "new": false,
    "position": 34,
    "count": {
      "7": 3,
      "30": 3
    },
    "days": {
      "7": 4194.5,
      "30": 9287.5
    },
    "extend": 0,
    "confirm": true
  },
  "39": {
    "code": 39,
    "enabled": true,
    "name": "italy",
    "new": false,
    "position": 39,
    "count": {
      "30": 10
    },
    "days": {
      "30": 14980
    },
    "extend": 0,
    "confirm": true
  },
  "40": {
    "code": 40,
    "enabled": true,
    "name": "romania",
    "new": false,
    "position": 40,
    "count": {
      "7": 1,
      "15": 1
    },
    "days": {
      "7": 3745.5,
      "15": 7490
    },
    "extend": 1,
    "confirm": false
  },
  "44": {
    "code": 44,
    "enabled": true,
    "name": "united_kingdom",
    "new": false,
    "position": 44,
    "count": {
      "7": 93,
      "15": 93,
      "30": 93
    },
    "days": {
      "7": 1323.5,
      "15": 2876,
      "30": 5752.5
    },
    "extend": 72,
    "confirm": false
  },
  "45": {
    "code": 45,
    "enabled": true,
    "name": "denmark",
    "new": false,
    "position": 45,
    "count": {
      "7": 9,
      "30": 9
    },
    "days": {
      "7": 4098.5,
      "30": 11360.5
    },
    "extend": 9,
    "confirm": false
  },
  "46": {
    "code": 46,
    "enabled": true,
    "name": "sweden",
    "new": false,
    "position": 46,
    "count": {
      "7": 7,
      "30": 7
    },
    "days": {
      "7": 4494,
      "30": 9587
    },
    "extend": 0,
    "confirm": true
  },
  "48": {
    "code": 48,
    "enabled": false,
    "name": "poland",
    "new": false,
    "position": 48,
    "count": {
      "1": 0,
      "3": 0,
      "7": 0,
      "15": 0,
      "30": 0
    },
    "days": {
      "1": 460.5,
      "3": 633,
      "7": 1035.5,
      "15": 1840.5,
      "30": 2876
    },
    "extend": 0
  },
  "49": {
    "code": 49,
    "enabled": false,
    "name": "germany",
    "new": false,
    "position": 49,
    "count": {
      "7": 0,
      "15": 0,
      "30": 0
    },
    "days": {
      "7": 1438,
      "15": 3020,
      "30": 6040
    },
    "extend": 0
  },
  "57": {
    "code": 57,
    "enabled": true,
    "name": "colombia",
    "new": false,
    "position": 57,
    "count": {
      "1": 4,
      "3": 4,
      "15": 4,
      "30": 4
    },
    "days": {
      "1": 599,
      "3": 839,
      "15": 2277,
      "30": 3595
    },
    "extend": 4,
    "confirm": false
  },
  "61": {
    "code": 61,
    "enabled": true,
    "name": "australia",
    "new": false,
    "position": 61,
    "count": {
      "30": 10
    },
    "days": {
      "30": 15028
    },
    "extend": 0,
    "confirm": true
  },
  "63": {
    "code": 63,
    "enabled": true,
    "name": "philippines",
    "new": false,
    "position": 63,
    "count": {
      "1": 1,
      "3": 1,
      "15": 1,
      "30": 1
    },
    "days": {
      "1": 575,
      "3": 790.5,
      "15": 2301,
      "30": 3595
    },
    "extend": 0,
    "confirm": false
  },
  "77": {
    "code": 77,
    "enabled": true,
    "name": "kazakhstan",
    "new": false,
    "position": 77,
    "count": {
      "1": 13,
      "3": 13,
      "7": 13
    },
    "days": {
      "1": 569.5,
      "3": 1198.5,
      "7": 2397
    },
    "extend": 13,
    "confirm": false
  },
  "212": {
    "code": 212,
    "enabled": true,
    "name": "morocco",
    "new": false,
    "position": 212,
    "count": {
      "7": 4,
      "15": 4,
      "30": 4
    },
    "days": {
      "7": 863,
      "15": 1150,
      "30": 1726
    },
    "extend": 4,
    "confirm": false
  },
  "223": {
    "code": 223,
    "enabled": true,
    "name": "mali",
    "new": false,
    "position": 223,
    "count": {
      "1": 9,
      "3": 9,
      "15": 9,
      "30": 9
    },
    "days": {
      "1": 575,
      "3": 790.5,
      "15": 2301,
      "30": 3595
    },
    "extend": 9,
    "confirm": false
  },
  "351": {
    "code": 351,
    "enabled": true,
    "name": "portugal",
    "new": false,
    "position": 351,
    "count": {
      "7": 7,
      "30": 7
    },
    "days": {
      "7": 5033.5,
      "30": 9287.5
    },
    "extend": 0,
    "confirm": true
  },
  "358": {
    "code": 358,
    "enabled": true,
    "name": "finland",
    "new": false,
    "position": 358,
    "count": {
      "7": 7,
      "30": 7
    },
    "days": {
      "7": 4494,
      "30": 9587
    },
    "extend": 0,
    "confirm": true
  },
  "370": {
    "code": 370,
    "enabled": true,
    "name": "lithuania",
    "new": false,
    "position": 370,
    "count": {
      "7": 6,
      "15": 6,
      "30": 6
    },
    "days": {
      "7": 1222.5,
      "15": 1438,
      "30": 2876
    },
    "extend": 6,
    "confirm": false
  },
  "371": {
    "code": 371,
    "enabled": true,
    "name": "latvia",
    "new": false,
    "position": 371,
    "count": {
      "7": 7,
      "30": 7
    },
    "days": {
      "7": 5033.5,
      "30": 7478
    },
    "extend": 3,
    "confirm": true
  },
  "372": {
    "code": 372,
    "enabled": true,
    "name": "estonia",
    "new": false,
    "position": 372,
    "count": {
      "1": 10,
      "7": 10,
      "30": 10
    },
    "days": {
      "1": 719,
      "7": 3295.5,
      "30": 7430
    },
    "extend": 0,
    "confirm": true
  },
  "373": {
    "code": 373,
    "enabled": true,
    "name": "moldova",
    "new": false,
    "position": 373,
    "count": {
      "1": 17,
      "3": 17,
      "15": 17,
      "30": 17
    },
    "days": {
      "1": 575,
      "3": 790.5,
      "15": 2301,
      "30": 3595
    },
    "extend": 1,
    "confirm": false
  },
  "380": {
    "code": 380,
    "enabled": true,
    "name": "ukraine",
    "new": false,
    "position": 380,
    "count": {
      "7": 13,
      "15": 13,
      "30": 13
    },
    "days": {
      "7": 402.5,
      "15": 633,
      "30": 920.5
    },
    "extend": 13,
    "confirm": false
  },
  "385": {
    "code": 385,
    "enabled": true,
    "name": "croatia",
    "new": false,
    "position": 385,
    "count": {
      "7": 1,
      "15": 1
    },
    "days": {
      "7": 3745.5,
      "15": 7490
    },
    "extend": 1,
    "confirm": false
  },
  "420": {
    "code": 420,
    "enabled": false,
    "name": "czech",
    "new": false,
    "position": 420,
    "count": {
      "1": 0,
      "3": 0,
      "7": 0,
      "15": 0,
      "30": 0
    },
    "days": {
      "1": 575,
      "3": 790.5,
      "7": 1294,
      "15": 2301,
      "30": 3595
    },
    "extend": 0
  },
  "998": {
    "code": 998,
    "enabled": true,
    "name": "uzbekistan",
    "new": false,
    "position": 998,
    "count": {
      "1": 2,
      "3": 2,
      "7": 2
    },
    "days": {
      "1": 719,
      "3": 1534.5,
      "7": 2685
    },
    "extend": 2,
    "confirm": false
  }
}

Code Samples

Generating examples...