Onlinesim

https://onlinesim.io/openapi_docs
Admin
Onlinesim is an SMS verification and virtual number rental platform that allows users to receive SMS...
Tokens:45,114
Snippets:431
Trust Score:9.2
Update:5 months ago
Show doc for...
Tokens:
Raw
### API Key as Query Parameter Example

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/auth

Demonstrates how to include an API key as a query parameter in a GET request. This is a simplified authorization method.

```url
https://onlinesim.io/getTariffs.php?apikey={apikey}
```

--------------------------------

### Get Available Services (cURL)

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-post-getservices

Example of how to make a POST request to the /getServices endpoint using cURL. Ensure the Authorization header and the JSON payload with 'action' and 'key' are correctly formatted.

```bash
curl --request POST \
  --url https://api.example.com/getServices \
  --header 'Authorization: Bearer apikey' \
  --data '{
  "action": "GET_SERVICES",
  "key": "apikey"
}'
```

--------------------------------

### Get Tariffs cURL Example

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-gettariffs-php

Use this cURL command to fetch tariff information for SMS receiving services. Parameters like locale_price, country, and lang can be adjusted to filter results.

```bash
curl --request GET \
  --url 'https://onlinesim.io/api/getTariffs.php?locale_price=en&country=1&filter_country=1&count=1&page=1&lang=en'
```

--------------------------------

### OAuth 2.0 Authorization Request

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/auth

Example of initiating the OAuth 2.0 Authorization Code flow by making a GET request to the authorization endpoint. Ensure all parameters match your app registration.

```url
https://onlinesim.io/oauth/authorize?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}
```

--------------------------------

### Error Response Example

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/auth

An example of an error response indicating an invalid or expired access token. This typically requires token refreshment.

```json
{
  "response": "ERROR_WRONG_KEY"
}
```

--------------------------------

### API Key in Authorization Header Example

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/auth

Shows how to use an API key for authorization in the request header using the 'Bearer' scheme. This is an alternative to query parameters.

```bash
Authorization: Bearer {apikey}
User-Agent: PostmanRuntime/7.29.2
Accept: */*
Cache-Control: no-cache
Postman-Token: 948bc880-8d25-4298-994f-fe6e22ada339
Host: onlinesim.io
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Cookie: xxxx
```

--------------------------------

### Get User Balance (cURL)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getbalance

Use this cURL command to make a GET request to the API endpoint for retrieving the current user balance. Ensure you have the correct URL, which includes the 'action=getBalance' parameter.

```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getBalance'
```

--------------------------------

### Get Service Names List (cURL)

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-get-services

Use this cURL command to make a GET request to the /services endpoint and retrieve a list of all available service names. Ensure your server responses use these exact service names.

```bash
curl --request GET \
  --url https://api.example.com/services
```

--------------------------------

### cURL Request to Finish Activation Rent

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-post-finishactivationrent

Example cURL request to send the FINISH_ACTIVATION action to the /finishActivationRent endpoint. Includes required parameters like activationId, status, key, and service.

```bash
curl --request POST \
  --url https://api.example.com/finishActivationRent \
  --header 'Authorization: Bearer apikey' \
  --data '{
  "action": "FINISH_ACTIVATION",
  "activationId": 75491,
  "status": 3,
  "key": "apikey",
  "service": "rent",
  "sum": 2408
}'
```

--------------------------------

### Get Rent Tariffs with cURL

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-rent-tariffsrent-php

Use this cURL command to fetch available rental plans for phone numbers. Specify the country code and desired response language.

```bash
curl --request GET \
  --url 'https://onlinesim.io/api/rent/tariffsRent.php?country=7&lang=en'
```

--------------------------------

### Send Finish Activation Request (cURL)

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-post-finishactivation

Example of sending a POST request to the /finishActivation endpoint using cURL. Ensure the Authorization header and request body parameters are correctly formatted.

```bash
curl --request POST \
  --url https://api.example.com/finishActivation \
  --header 'Authorization: Bearer apikey' \
  --data '{
  "action": "FINISH_ACTIVATION",
  "activationId": 75489,
  "sum": 4.5,
  "status": 3,
  "key": "apikey"
}'
```

--------------------------------

### Get Service Names List

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-get-services

Retrieves a list of all available service names.

```APIDOC
## GET /services

### Description
This request returns a list of names for all services. Your GET_SERVICES server response must use service names listed here. Please note that some services might be disabled for certain countries as some apps and websites target specifically one or a few regions, disabling the ability to use phone numbers from other countries.

### Method
GET

### Endpoint
/services

### Responses
#### Success Response (200)
- **responsestring** (string) - 1, if request was successful, otherwise error message will come up
- **services** (object) - List of services

### Response Example
```json
{
  "responsestring": "1",
  "services": {
    "service1": {
      "name": "Example Service 1",
      "price": "0.10"
    },
    "service2": {
      "name": "Example Service 2",
      "price": "0.20"
    }
  }
}
```

### Code Samples
#### cURL
```bash
curl --request GET \
  --url https://api.example.com/services
```
```

--------------------------------

### Authorize User and Get Token (Implicit Flow)

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/auth

Initiates the Implicit flow by redirecting the user to the authorization server to grant access and receive an access token directly.

```APIDOC
## GET /oauth/authorize

### Description
Redirects the user to the Onlinesim authorization page to grant access to your application. Upon successful authorization, the user is redirected back to your `redirect_uri` with an `access_token`.

### Method
GET

### Endpoint
https://onlinesim.io/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (STRING) - Required - `Client ID` (returned when the app registration process is complete).
- **redirect_uri** (STRING) - Required - Redirect destination for the client after a successful authorization, it must match the `Redirect URL` parameter used during app registration process.
- **response_type** (STRING) - Required - Use `token` as a value for Implicit flow.
- **scope** (STRING) - Optional - Access rights that your app asks from the user. Possible values: `sms-scope`, `rent-scope`, `free-scope`. You can specify multiple values separated by spaces.
- **state** (STRING) - Required - A random string for CSRF protection (verify it after the redirect).

### Response
#### Redirect
Upon successful authorization, the user is redirected to the `redirect_uri` with the `access_token` as a URL fragment.

### Response Example (URL Fragment)
```
YOUR_REDIRECT_URI#access_token=USER_ACCESS_TOKEN&token_type=Bearer&expires_in=3600&state=PROVIDED_STATE
```
```

--------------------------------

### Confirm Server Uptime Status with cURL

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-get-api-resellers

Use this cURL command to send a GET request to the /api/resellers endpoint. Ensure you replace 'apikey' with your actual API key.

```bash
curl --request GET \
  --url https://api.example.com/api/resellers \
  --header 'Authorization: Bearer apikey'
```

--------------------------------

### Get Access Token (Authorization Code Flow)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/auth

Request an access token using the Authorization Code flow. Ensure `redirect_uri` matches your app registration.

```http
POST https://onlinesim.io/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code
client_id=YOUR_CLIENT_ID
client_secret=YOUR_CLIENT_SECRET
redirect_uri=YOUR_REDIRECT_URI
code=AUTHORIZATION_CODE
```

--------------------------------

### Get Rent State Information

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-rent-getrentstate-php

Use this cURL command to retrieve the status of active rental operations. You can specify 'tzid' for a specific operation, or omit it to get all active rentals. 'pagination' controls message browsing, and 'lang' sets the response language.

```bash
curl --request GET \
  --url 'https://onlinesim.io/api/rent/getRentState.php?tzid=0&pagination=false&lang=en'
```

--------------------------------

### POST /getServicesRent

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-post-getservicesrent

This endpoint is called by the Onlinesim server to your server to get a list of available services and countries for rent. Your server should return a list of numbers in the specified format.

```APIDOC
## POST /getServicesRent 

### Description
This request is sent from the Onlinesim server to yours to get a list of available for rent numbers. Your server should return a list of numbers in the format described below. Your partner's API key will be passed in the request in a payload.

### Method
POST

### Endpoint
/getServicesRent

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Headers
- **Authorization** (string) - Required - Example: `Bearer apikey`

### Request Body
Request payload from Onlinesim server
Content-Type: `application/json`

#### Schema
- **action** (string) - Required - Enum: `GET_SERVICES` - Default: `GET_SERVICES` - Example: `GET_SERVICES`
- **key** (string) - Required - API key of your Onlinesim partner’s profile

### Request Example
```json
{
  "action": "GET_SERVICES",
  "key": "apikey"
}
```

### Response
#### Success Response (200)
- **countryList** (object[]) - List of countries and services available for rent.
- **status** (string) - Request status (`SUCCESS` or `ERROR`) - Enum: `SUCCESS`, `ERROR` - Example: `SUCCESS`

#### Response Example
```json
{
  "countryList": [
    {
      "country": "USA",
      "services": [
        {
          "service": "SMS",
          "operator": "any",
          "quantity": 100
        }
      ]
    }
  ],
  "status": "SUCCESS"
}
```
```

--------------------------------

### Get Countries List (cURL)

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-get-countries

Use this cURL command to fetch the list of available country names from the API. Ensure you use the correct URL for your requests.

```bash
curl --request GET \
  --url https://api.example.com/countries
```

--------------------------------

### Get Rent Services and Countries

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getrentservicesandcountries

This cURL command retrieves a list of countries and their rental details. It defaults to country ID 0 if no specific country is provided.

```cURL
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getRentServicesAndCountries&country=0'
```

--------------------------------

### Get Countries List (cURL)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getcountries

Use this cURL command to fetch the list of countries and their available services for ordering phone numbers. Ensure you have the correct API endpoint.

```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getCountries'
```

--------------------------------

### Get Rent Tariffs

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-rent-tariffsrent-php

Retrieves information on available rental plans and parameters for phone numbers in a specified country or all countries. This is useful for understanding rental options, pricing, and availability.

```APIDOC
## GET /api/rent/tariffsRent.php 

### Description
Get information on tariffs for rent numbers. Returns information on available for rent numbers of specified country (or all of countries, if not specified): rental plans and other parameters of rent. Rental implies a longer period of use and allows receiving any number of SMS messages during the entire rental period.

### Method
GET

### Endpoint
/api/rent/tariffsRent.php

### Parameters
#### Query Parameters
- **country** (string) - Optional - International dialing code of the country (Е.164 standard, without "+" sign). Example: `7`
- **lang** (string) - Optional - Response language. Enum: `fr`, `de`, `ru`, `en`, `zh`. Default: `ru`. Example: `en`

### Responses
#### Success Response (200)
- **code** (integer) - International dialing code of the country.
- **enabled** (boolean) - Availability of virtual numbers of a country.
- **new** (boolean) - Was the country recently added to the list.
- **position** (integer) - Country position in the list.
- **count** (object) - Contains information on the amount of available numbers for each available rental period.
- **days** (object) - Contains information on the price for each initial rental period.
- **extend** (integer) - Amount of available numbers for rent with extension option.
- **confirm** (boolean) - Indicates if confirmation is required.

### Request Example
```bash
curl --request GET \
  --url 'https://onlinesim.io/api/rent/tariffsRent.php?country=7&lang=en'
```
```

--------------------------------

### Get Virtual Number (cURL)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getnumber

Use this cURL command to order a virtual number for a specified service and country. Include `phoneException` to exclude numbers matching a certain pattern.

```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getNumber&service=3223&country=46&phoneException=908'
```

--------------------------------

### Get Rent Services and Countries

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getrentservicesandcountries

Retrieves a list of countries available for rent, including rent details. This can be used to check availability and quantity of numbers for a desired country.

```APIDOC
## GET /stubs/handler_api.php?action=getRentServicesAndCountries 

### Description
Get list of countries and rent details for virtual number renting. This request returns a list of countries available for rent with rent details. You might want to use it to check if the numbers of desired country are available for rent and if so, how many.

### Method
GET

### Endpoint
/stubs/handler_api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Method name, in this case `getRentServicesAndCountries`. Enum: `getRentServicesAndCountries`. Default: `getRentServicesAndCountries`
- **country** (integer) - Optional - Country ID (according to getCountries). Default: `0`

### Responses
#### Success Response (200)
- **countries** (object) - Detailed information on available numbers for rent by country.
- **operators** (object)
- **services** (object)

### Request Example
```
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getRentServicesAndCountries&country=0'
```
```

--------------------------------

### Get User Balance

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-getbalance-php

Retrieves the current user balance. This can be used to monitor your account and top it up when necessary, for example, to handle low balance warnings.

```APIDOC
## GET /api/getBalance.php 

### Description
Get information on current user balance. Returns the current user balance. You might use it to check the balance of the profile to top it up when needed (for example to handle `WARNING_LOW_BALANCE` exceptions).

### Method
GET

### Endpoint
/api/getBalance.php

### Query Parameters
- **income** (boolean) - Optional - Information on affiliate program earnings
- **lang** (string) - Optional - Response language. Enum: `fr`, `de`, `ru`, `en`, `zh`. Default: `ru`.

### Responses
#### Success Response (200)
- **balance** (string) - Current available balance.
- **zbalance** (number) - Frozen balance (the funds reserved for active operations, which will be returned if those operations are cancelled).

### Request Example
```json
{
  "example": "1"
}
```

### Response Example
```json
{
  "balance": "230.25",
  "zbalance": "120.5"
}
```

### Code Samples
```bash
curl --request GET \
  --url 'https://onlinesim.io/api/getBalance.php?income=true&lang=en'
```
```

--------------------------------

### Get New SMS via cURL

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-newsms

Use this cURL command to make a GET request to the /newSms endpoint. Ensure you have the necessary authentication headers or API keys configured.

```bash
curl --request GET \
  --url https://onlinesim.io/newSms
```

--------------------------------

### Get User Balance with cURL

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-getbalance-php

Use this cURL command to fetch your current account balance. You can include parameters like 'income' to check affiliate earnings and 'lang' to set the response language.

```bash
curl --request GET \
  --url 'https://onlinesim.io/api/getBalance.php?income=true&lang=en'
```

--------------------------------

### cURL Request for GET_SERVICES

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-post-getservicesrent

This cURL command demonstrates how to send a POST request to the /getServicesRent endpoint to retrieve available services. It includes the necessary Authorization header and a JSON payload with the action and API key.

```bash
curl --request POST \
  --url https://api.example.com/getServicesRent \
  --header 'Authorization: Bearer apikey' \
  --data '{ 
  "action": "GET_SERVICES",
  "key": "apikey"
}'
```

--------------------------------

### Get Status cURL Request

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getstatus

Use this cURL command to send a GET request to the API to retrieve the status and short code from an SMS. Ensure you replace '10000' with the actual operation ID.

```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getStatus&id=10000'
```

--------------------------------

### Authorize User (Implicit Flow)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/auth

Initiate the Implicit flow by requesting authorization from the user. The `response_type` must be 'token'.

```http
GET https://onlinesim.io/oauth/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&response_type=token&scope=sms-scope&state=YOUR_STATE
```

--------------------------------

### Get List of Active Rental Numbers

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getrentlist

Retrieves a list of active rental numbers associated with the user's profile. This includes unactivated numbers if their activation period has not expired. It's useful for getting up-to-date information on all ordered rental numbers.

```APIDOC
## GET /stubs/handler_api.php?action=getRentList

### Description
Get list of active rental numbers of the profile. This request returns a list of rental numbers with current rent for your profile, including unactivated numbers, if the activation period has not expired.

### Method
GET

### Endpoint
/stubs/handler_api.php?action=getRentList

### Query Parameters
- **action** (string) - Required - Method name, in this case `getRentList`. Enum: `getRentList`. Default: `getRentList`

### Responses
#### Success Response (200)
- **status** (string) - Request execution status. Example: `success`
- **values** (object) - Array of active rental numbers data of the profile.

### Request Example
```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getRentList'
```
```

--------------------------------

### Get Numbers Status

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getnumbersstatus

Fetches the count of available numbers for a given country and service.

```APIDOC
## GET /stubs/handler_api.php?action=getNumbersStatus 

### Description
Get information on the number of available numbers by services. This request returns a list of available numbers by country and service. You might want to use it to check if the numbers of desired country are available for order and if so, how many.

### Method
GET

### Endpoint
/stubs/handler_api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Method name, in this case `getNumbersStatus`
- **country** (integer) - Optional - International dialing code of the country (Е.164 standard, without “+” sign). Default: `7`. Example: `46`

### Responses
#### Success Response (200)
- **#service_slug#** (integer) - Service name (_countryID): amount of available numbers

### Response Example
```json
{
  "service_slug": 10
}
```

### Request Example
```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getNumbersStatus&country=46'
```
```

--------------------------------

### Get Full SMS Text

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getfullsms

Fetches the complete text of a received SMS message using its operation ID.

```APIDOC
## GET /stubs/handler_api.php?action=getFullSms 

### Description
Retrieves the full context of a received SMS for a given operation ID. This is useful when the status information is insufficient and you need to extract specific data from the message content, such as promocodes, links, or timestamps.

### Method
GET

### Endpoint
`/stubs/handler_api.php`

### Parameters
#### Query Parameters
- **action** (string) - Required - Method name, must be `getFullSms`.
- **id** (integer) - Required - Operation ID obtained from `getNumber` or `getStatus` responses. Must be greater than or equal to 1.

### Responses
#### Success Response (200)
- **string** - The full text of the received SMS, formatted as `FULL_SMS:[sender] SMS_context`.

### Request Example
```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getFullSms&id=10000'
```
```

--------------------------------

### Get Status

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getstatus

Retrieves a short code from an SMS received by a specified number. Use this when only a code is needed, otherwise consider getFullSms.

```APIDOC
## GET /stubs/handler_api.php?action=getStatus

### Description
Get short code from received SMS. This request returns a short code contained in SMS received by the specified number.

### Method
GET

### Endpoint
/stubs/handler_api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Method name, in this case `getStatus`.
- **id** (integer) - Required - Operation ID (according to getNumber or getStatus responses). Example: `10000`.

### Responses
#### Success Response (200)
- **string** - Successful `getStatus` response from the server: either returns short code from a received SMS or throws an exception. Example: `STATUS:SHORT_CODE`.

### Request Example
```
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getStatus&id=10000'
```
```

--------------------------------

### Get Rent State

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-rent-getrentstate-php

Retrieves a list of active rental numbers and their received messages. Supports filtering by operation ID, pagination, and language.

```APIDOC
## GET /api/rent/getRentState.php

### Description
Get information about the state of virtual phone number rent operation. This request returns a list of active rental numbers. You can use it to quickly browse all your active rental numbers (or only specific one) and their received messages.

### Method
GET

### Endpoint
/api/rent/getRentState.php

### Query Parameters
- **tzid** (integer) - Optional - Operation ID. If not specified, request will return the entire list of active rental operations.
- **pagination** (boolean) - Optional - Pagination mode for message browsing (disabled if `false`). Default: `false`.
- **lang** (string) - Optional - Response language: `fr`, `de`, `ru`, `en`, `zh`. Default: `ru`.

### Responses
#### Success Response (200)
- **response** (object) - Successful response for `getRentState` request: the server returns information of specified active rental operation (or all of them) or throws an exception.
  - **list** (array) - List of active rental operations.

### Request Example
```bash
curl --request GET \
  --url 'https://onlinesim.io/api/rent/getRentState.php?tzid=0&pagination=false&lang=en'
```
```

--------------------------------

### Get Takeoff Numbers with cURL

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-get-api-resellers-takeoffnumbers

Use this cURL command to retrieve income information for online numbers, filtering by a sum of 50 rubles. Ensure you replace 'apikey' with your actual authorization token.

```bash
curl --request GET \
  --url 'https://api.example.com/api/resellers/takeOffNumbers?sum=50' \
  --header 'Authorization: Bearer apikey'
```

--------------------------------

### Order Phone Number Rent (cURL)

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-post-getnumberrent

Use this cURL command to send a POST request to order a phone number for rent. Ensure you replace 'apikey' with your actual API key and adjust parameters like 'country', 'operator', 'service', and 'sum' as needed.

```bash
curl --request POST \
  --url https://api.example.com/getNumberRent \
  --header 'Authorization: Bearer apikey' \
  --data '{
  "action": "GET_NUMBER",
  "key": "apikey",
  "country": "germany",
  "operator": "any",
  "service": "rent",
  "sum": 400,
  "exceptionPhoneSet": "+1234567890"
}'
```

--------------------------------

### Change Operation Status (cURL)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-setstatus

Use this cURL command to change the status of an operation, for example, to close it. Ensure you have the correct operation ID and status code.

```cURL
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=setStatus&id=10000&status=6'
```

--------------------------------

### Authorize User (Implicit Flow)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/auth

Initiates the authorization process for the Implicit flow, redirecting the user to grant access to your application.

```APIDOC
## GET /oauth/authorize

### Description
Initiates the OAuth 2.0 Implicit flow to authorize a user and obtain an access token.

### Method
GET

### Endpoint
https://onlinesim.io/oauth/authorize

### Parameters
#### Query Parameters
- **client_id** (STRING) - Required - Your application's Client ID.
- **redirect_uri** (STRING) - Required - The URL to redirect to after authorization.
- **response_type** (STRING) - Required - Use `token` for the Implicit flow.
- **scope** (STRING) - Optional - The requested access scope (e.g., `sms-scope`, `rent-scope`).
- **state** (STRING) - Required - A random string for CSRF protection.

### Response
#### Redirect
Upon successful authorization, the user is redirected to the `redirect_uri` with the `access_token` as a URL parameter.
```

--------------------------------

### OAuth 2.0 Authorization Request

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/auth

This is the initial GET request to authorize a user and obtain an authorization code. Ensure all parameters match your app registration details.

```http
GET https://onlinesim.io/oauth/authorize?client_id={client_id}&redirect_uri={redirect_uri}&response_type=code&scope={scope}&state={state}
```

--------------------------------

### Order a Virtual Number (cURL)

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/Reseller-API-UN-post-getnumber

Use this cURL command to send a POST request to the /getNumber endpoint to order a virtual number for a specific service. Ensure you replace 'apikey' with your actual API key and adjust parameters like country, operator, service, and sum as needed.

```bash
curl --request POST \
  --url https://api.example.com/getNumber \
  --header 'Authorization: Bearer apikey' \
  --header 'Content-Type: application/json; charset=utf-8' \
  --data '{ 
  "action": "GET_NUMBER",
  "country": "russia",
  "operator": "any",
  "service": "vk",
  "sum": 40,
  "key": "apikey",
  "exceptionPhoneSet": "+1234567890"
}'
```

--------------------------------

### Rent a Virtual Number (cURL)

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getrentnumber

Use this cURL command to rent a virtual number for receiving SMS. Specify the country ID and the desired rental period in hours.

```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getRentNumber&country=1&time=24'
```

--------------------------------

### Get Active Numbers Information

Source: https://onlinesim.io/openapi_docs/Onlinesim-API-UN/Onlinesim-API-UN-get-api-getstate-php

Fetches detailed information on all active numbers or a specific one. Useful for monitoring operations and retrieving messages from ordered numbers.

```APIDOC
## GET /api/getState.php

### Description
Get information on numbers with active operations. Returns detailed information on all active numbers you have (or specific one). It allows you to check the status of operations of your account and read the messages received on ordered numbers.

### Method
GET

### Endpoint
/api/getState.php

### Query Parameters
- **tzid** (integer) - Optional - Operation ID. Example: `10000`
- **message_to_code** (integer) - Optional - SMS display mode: `0` - show the entire SMS, `1` - display only the code from the SMS. Enum: `0`, `1`. Example: `1`
- **orderby** (string) - Optional - Sorting order: `asc` - ascending; `desc` - descending. Enum: `asc`, `desc`. Default: `asc`. Example: `asc`
- **msg_list** (integer) - Optional - Message list display mode: `0` - show only the active message, `1` - show the whole list. Enum: `0`, `1`. Example: `1`
- **clean** (integer) - Optional - Message display mode (only for msg_list = 0): `0` - show previously shown messages, `1` - do not show previously shown messages. Enum: `0`, `1`. Example: `1`
- **lang** (string) - Optional - Response language: `fr` - French, `de` - German, `ru` - Russian, `en` - English, `zh` - Chinese. Default: `ru`. Example: `en`

### Responses
#### Success Response (200)
- **Array of objects**: Each object represents an active number and contains operation information.

#### Response Example
```json
[
  {
    "id": "12345",
    "number": "+1234567890",
    "country": "USA",
    "operator": "Verizon",
    "balance": "0.5",
    "status": "active",
    "rent_type": "day",
    "time_left_order": "1440",
    "sms": [
      {
        "id": "sms1",
        "from": "sender",
        "message": "Your code is 12345",
        "received_at": "2023-10-27 10:00:00"
      }
    ]
  }
]
```

### Code Samples
#### cURL
```bash
curl --request GET \
  --url 'https://onlinesim.io/api/getState.php?tzid=10000&message_to_code=1&orderby=asc&msg_list=1&clean=1&lang=en'
```
```

--------------------------------

### Common Parameters

Source: https://onlinesim.io/openapi_docs/Reseller-API-UN/components

These parameters are commonly used across various Reseller API requests.

```APIDOC
## Common Parameters

### Parameters

#### Header Parameters

- **Authorization** (string) - Required - Authentication token. Example: `Bearer apikey`
- **Content-Type** (string) - Required - Specifies the content type and encoding. Enum: `application/json; charset=utf-8`. Example: `application/json; charset=utf-8`
```

--------------------------------

### Get Virtual Number

Source: https://onlinesim.io/openapi_docs/Alternative-API-UN/Alternative-API-UN-get-stubs-handler_api-php-action-getnumber

This request allows you to order a phone number of a specific country to receive SMS from a selected service. The number is issued for 15 minutes.

```APIDOC
## GET /stubs/handler_api.php?action=getNumber 

### Description
Buy virtual number for selected service. This request allows you to order a phone number of a specific country to receive SMS from a selected service. This is the main service provided by Onlinesim: you can use virtual numbers to receive verification codes or any other information contained in SMS messages.

**WARNING**: Please note, that number is issued for 15 minutes (time period depends on the country and service and can differ) and after the operation is closed this number will not be available.

### Method
GET

### Endpoint
/stubs/handler_api.php

### Query Parameters
- **action** (string) - Required - Method name, in this case `getNumber`.
- **service** (string) - Required - Service slug (short service name, required upon ordering a number, according to getNumbersStatus response).
- **country** (integer) - Optional - Country ID (according to getCountries response). Default: `7`.
- **phoneException** (oneOf) - Optional - Array for mask exception (including the country code). For example: with value [911,912123] won’'t issue numbers of India, that start with 911* and 912123*.

### Responses
#### Success Response (200)
- **Response** (string) - Successful `getNumber` response from the server: either returns an operation ID and issued number for SMS receiving or throws an exception.
  Format: `ACCESS_NUMBER`:`OPERATION_ID`:`ISSUED_NUMBER` (in international format)

### Request Example
```bash
curl --request GET \
  --url 'http://api-conserver.onlinesim.io/stubs/handler_api.php?action=getNumber&service=3223&country=46&phoneException=908'
```

### Response Example
```
ACCESS_NUMBER:10000:46050608210
```
```
Tokens:
Raw