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 number purchase button located on the main page.

IMPORTANT NOTES! &br; You can also specify additional parameters such as masks for exception in case if the service has specific requirements. &br; Some websites and applications might ban numbers with certain digit sequence (masks) from registration. &br; In this case, this parameter might come in handy.

Security

Parameters

service
Required

Service name (can only accept values of services in response for getNumbersStats method)

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

Country code (Е.164 standard, without "+" sign), see getNumbersStats

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 query will return the ordered phone number.
In: query
Schema:
  • boolean
    Example: false
lang

Response language: fr - French, de - German, ru - Russian, en - English, zh - Chinese

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