GET /api/getNum.php

Buy a virtual number for a selected service

Requests a phone number for a particular service, allowing to receive SMS messages from it.

Allows you to order a number of a specified country to receive SMS from the website/app that you want.

This request in fact plays the same role as the "Buy number" button located on the user dashboard.

WARNING

You can also specify additional parameters such as masks for exception in case if the service has specific requirements.

Some websites and applications might block numbers with certain digit sequence (masks) from registration.

In this case, this parameter might come in handy.

Security

apikey
BearerAuth
OAuth2 (Scopes: sms-scope)
- sms-scope: grants access to manage numbers for the SMS receiving service from Onlinesim

Name	Type	Description
`service`*	`string`	Service name (can only accept values of services in this list) Example:`facebook`
`country`	`integer` ≥ 1	‘International dialing code of the country (Е.164 standard, without “+” sign), see country list’ Default:`7`Example:`46`
`reject`	`string[]`	Array for mask exception (including country code) Example: when [911, 912123] is passed, the server won’t issue numbers of India, that starts with +911* and +912123*. Example:`["911"]`
`dev_id`	`integer`	Account ID for software developers (Onlinesim profile’s ID). Example:`100000`
`number`	`boolean`	‘Display number in response. If `true`, the phone number will be displayed in the response.’ Example:`false`
`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`

No code samples available