get getNum

https://onlinesim.io/api/getNum.php
single-service activations

Requests a 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.

IMPORTANT NOTES!

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

Parameters

service
Required

Service name (can only accept values of services in this list)

In: query
Schema:
  • string
    Example: "facebook"
country

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

In: query
Schema:
  • integer
    Example: 46
    >= 1
reject
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*.
In: query
Schema:
  • array<string>
    Example: ["911"]
    Items:
    • string
      Example: "string"
dev_id
Account ID for software developers (Onlinesim profile's ID).
In: query
Schema:
  • integer
    Example: 100000
number
Display number in response. If `true`, the phone number will be displayed in the response.
In: query
Schema:
  • boolean
    Example: false
lang

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.

In: query
Schema:
  • string
    Example: "en"
    Enum: fr de ru en zh

Responses

200

Successful response for `getNum` request: the server issues a dedicated virtual number for specified service or throws an exception.
Content Type:
application/json
  • Schema
  • Examples
  • object
    Example: {"response":1,"tzid":10000}
    Properties:
    • response
      mixed
      Required
      1, if the request has been completed successfully, or an error message
      Example: 1
      One Of:
      • integer
        Example: 0
      • string
        Example: "string"
    • tzid
      integer
      Required
      Operation ID
      Example: 10000
      >= 1