SMSPVA

https://docs.smspva.com
Admin
SMSPVA is an SMS activation and phone number rental API platform that provides virtual phone numbers...
Tokens:35,992
Snippets:238
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Service Price Response Example

Source: https://docs.smspva.com/

Example JSON response when successfully retrieving the price for a service.

```json
{
  "response": 1,
  "country": "EN",
  "service": "opt4",
  "price": "0.50"
}
```

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

### Response Example: Rental Order History

Source: https://docs.smspva.com/

Example JSON response for retrieving rental order history. Includes details like order ID, resource code, number, and availability for restoration.

```JSON
{
  "status": 1,
  "data": [
    {
      "orderId": 857191,
      "resourceCode": "opt9",
      "number": "37067787324",
      "branchId": 684,
      "haveSms": false,
      "isAvailForRestore": true,
      "days": 30,
      "country": "LT",
      "begin": 1768902473,
      "end": 1771494473,
      "closed": 1768903921
}
]

}
```

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

### Get Phone Number Response Sample

Source: https://docs.smspva.com/

Example JSON response when successfully obtaining a phone number.

```json
{
  "response": "1",
  "number": "9871234567",
  "id": "25623"

}
```

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

### Get Phone Number Response Example

Source: https://docs.smspva.com/

Example JSON response when successfully obtaining a phone number. It includes the status, the assigned number, and the order ID.

```json
{
  "response": "1",
  "number": "9871234567",
  "id": "25623"
}
```

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

### Response Example: Restoration Pre-calculation

Source: https://docs.smspva.com/

Example JSON response for the pre-calculation of restoring an expired order. Provides details such as country code, resource code, price, and restoration period.

```JSON
{
  "status": 1,
  "data": {
    "ccode": "LT",
    "scode": "opt9",
    "price": 1.5,
    "sname": "Instagram",
    "pnumber": "37067787324",
    "outdays": 5,
    "orderid": 857191,
    "prolongTo": 30
}

}
```

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

### Get available services with providers and prices

Source: https://docs.smspva.com/

Get a list of available services for a country with detailed information about operators, prices, and availability. This method shows the price per day for each service and which operators provide that service.

```APIDOC
## GET /api/rent.php?method=getdataWithProviders

### Description
Get a list of available services for a country with detailed information about operators, prices, and availability. This method shows the price per day for each service and which operators provide that service.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Example: `getdataWithProviders`
- **apikey** (string) - Required - Example: `yourapikeyhere`
- **country** (string) - Required - Example: `KZ`
- **dtype** (string) - Required - Example: `week`
- **dcount** (integer) - Required - Example: `1`

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=getdataWithProviders&apikey=yourapikeyhere&country=KZ&dtype=week&dcount=1'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure
- **data** (object) - Contains service and operator details
  - **services** (Array of objects)
    - **name** (string)
    - **service** (string)
    - **price_day** (integer)
    - **img** (string)
    - **procent_days** (integer)
    - **procent** (integer)
    - **day_step** (integer)
    - **count** (object)
    - **totalCount** (integer)
  - **totalAmount** (integer)
  - **allOperators** (Array of strings)

#### Response Example
```json
{
  "status": 1,
  "data": {
    "services": [
      {
        "name": "1cupis & okcupid & winline",
        "service": "opt48",
        "price_day": 5,
        "img": "images/ico/cupis_okcupid_winline.ico",
        "procent_days": 0,
        "procent": 0,
        "day_step": 0,
        "count": {
          "Claro_AR": 27
        },
        "totalCount": 12
      }
    ],
    "totalAmount": 1735,
    "allOperators": [
      "Claro_AR"
    ]
  }
}
```
```

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

### Check SMS Availability Response Example

Source: https://docs.smspva.com/

Example JSON response indicating the status of an SMS availability check.

```json
{
  "response": "ok",
  "number": "9685156912",
  "id": 25623
}
```

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

### Get Available Services List

Source: https://docs.smspva.com/

Retrieves a list of all available services.

```APIDOC
## Getting available services list 
Get a list of available services

### Description
Retrieves a list of all available services.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Specifies the action to perform, e.g., `getservices`.
- **apikey** (string) - Required - Your unique API key.

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (Array of objects) - Contains a list of available services.
```

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

### Get Available Countries List

Source: https://docs.smspva.com/

Retrieves a list of countries for which services are available. No authentication is required.

```Shell
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=getcountries'
```

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

### Get User Info

Source: https://docs.smspva.com/

Retrieves user balance and karma information.

```APIDOC
## GET /priemnik.php?method=get_userinfo

### Description
Get the user's balance and karma information.

### Method
GET

### Endpoint
https://smspva.com/priemnik.php?method=get_userinfo

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key. Example: apikey=DSWAFvdedrE4
- **service** (string) - Required - Services code (see services list). Example: service=opt4
- **metod** (string) - Required - Method name. Example: metod=get_userinfo

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt4&metod=get_userinfo&method=get_userinfo' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **response** (integer) - Status. Example: 1
- **balance** (string) - Current balance. Example: "385.00"
- **karma** (string) - Current rating value. Example: "10"

#### Response Example
```json
{
  "response": 1,
  "balance": "385.00",
  "karma": "10"
}
```
```

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

### Successful Prolongation Response

Source: https://docs.smspva.com/

Example of a successful response when prolonging an order.

```json
{
  "status": 1

}
```

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

### Get prices for all services

Source: https://docs.smspva.com/

Retrieves a list of all available services with their prices across different countries. Requires an API key.

```APIDOC
## Get prices for all services

### Description
Retrieves a list of all available services with their prices across different countries. Requires an API key.

### Method
GET

### Endpoint
/activation/servicesprices

### Parameters
#### Request Headers
- **apikey** (string) - Required - Your API key.

### Response
#### Success Response (200)
- **statusCode** (integer) - Result status code.
- **data** (array) - An array of objects, where each object contains service details, country, and price.
  - Each item in the array is an object with:
    - **service** (string) - The service code.
    - **serviceDescription** (string) - A description of the service.
    - **country** (string) - The country code.
    - **price** (number) - The price of the service.

### Request Example
```curl
curl --request GET \
  --url https://api.smspva.com/activation/servicesprices \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response Example
```json
{
  "statusCode": 200,
  "data": [
    [
      {
        "service": "opt0",
        "serviceDescription": "myopinions & erewards",
        "country": "CY",
        "price": 0.5
      }
    ]
  ]
}
```
```

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

### Get SMS Request Sample (cURL)

Source: https://docs.smspva.com/

This cURL command demonstrates how to request an SMS using the API. Ensure you replace 'REPLACE_KEY_VALUE' with your actual API key.

```bash
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt42&country=KZ&id=3421&metod=get_sms&method=get_sms' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Get Price with Operators

Source: https://docs.smspva.com/

Requests prices with operators for a given country.

```APIDOC
## GET /priemnik.php?method=get_price

### Description
Requests prices with operators for a given country.

### Method
GET

### Endpoint
https://smspva.com/priemnik.php

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **method** (string) - Required - Method name, should be `get_price`.
- **country** (string) - Optional - Country code.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&method=get_price&country=UK' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
An array of objects, each containing service, price, mobile operator, and country.
- **Service** (string) - Service code.
- **Price** (string) - Service price.
- **MobileOperator** (string) - Operator name.
- **Country** (string) - Country code.

#### Response Example
```json
[
  {
    "Service": "opt0",
    "Price": "0.50",
    "MobileOperator": "Giffgaff_UK",
    "Country": "UK"
  },
  {
    "Service": "opt0",
    "Price": "0.50",
    "MobileOperator": "Other_UK",
    "Country": "UK"
  }
]
```
```

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

### Getting SMS

Source: https://docs.smspva.com/

Request an SMS code for activation confirmation. The server searches for SMS for 10 minutes. You can request a re-SMS using the 'sms=sms' parameter.

```APIDOC
## GET /priemnik.php?method=get_sms

### Description
This API allows requesting an SMS code for activation confirmation. The server searches for SMS for 10 minutes. You can request a re-SMS using the 'sms=sms' parameter.

### Method
GET

### Endpoint
https://smspva.com/priemnik.php

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key
- **service** (string) - Required - Service code
- **country** (string) - Required - Country code
- **id** (string) - Required - ID of the order
- **metod** (string) - Required - Method name (e.g., get_sms)
- **sms** (string) - Optional - If provided as 'sms', allows re-SMS without closing the order.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt42&country=KZ&id=3421&metod=get_sms&method=get_sms' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **response** (string) - Status. Possible values:
    - "1": SMS received, funds debited. Fields: "text" - contains the code from the SMS, "sms" - the full text of the message.
    - "2": The SMS has not yet arrived, you must continue to request.
    - "3": The order was not found or closed.
    - "4": Repeated free viewing of a previously received SMS within one order.
- **number** (string) - Number to receive SMS (e.g., "9871234567")
- **sms** (string) - Code from SMS (e.g., "234562")
- **text** (string) - The code from the SMS (only for response "1" and "4")

#### Response Example (SMS received)
```json
{
  "response": "1",
  "number": "9871234567",
  "sms": "234562"
}
```

#### Response Example (SMS not received yet)
```json
{
  "response": "2"
}
```

#### Response Example (Order not found or closed)
```json
{
  "response": "3"
}
```

#### Response Example (Re-viewing a received SMS)
```json
{
  "response": "4",
  "text": "23456",
  "sms": "Your code: 123456 - Just (test) BC Google"
}
```
```

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

### Get Balance

Source: https://docs.smspva.com/

Retrieves the current balance of the user's account.

```APIDOC
## GET /priemnik.php?method=get_balance

### Description
Get the user's current balance.

### Method
GET

### Endpoint
https://smspva.com/priemnik.php?method=get_balance

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key. Example: apikey=DSWAFvdedrE4

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&method=get_balance' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **response** (string) - Status. Example: "1"
- **balance** (string) - Current balance. Example: "385.00"

#### Response Example
```json
{
  "response": "1",
  "balance": "385.00"
}
```
```

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

### Response Example: Order Extended Successfully

Source: https://docs.smspva.com/

A successful response when an order has been extended. The 'status' field indicates success.

```JSON
{
  "status": 1
}
```

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

### Get Orders

Source: https://docs.smspva.com/

Retrieves a list of all active rental orders with their current status and prolongation availability.

```APIDOC
## GET /api/rent.php?method=orders

### Description
Gets all active rental orders with current status and prolongation availability.

### Method
GET

### Endpoint
https://smspva.com/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - `orders`
- **apikey** (string) - Required - Your API key

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure
- **data** (Array of objects) - Array containing order details
  - **id** (string) - Order ID
  - **scode** (string) - Service code
  - **sname** (string) - Service name
  - **state** (string) - Order state
  - **pnumber** (string) - Rented phone number
  - **ccode** (string) - Country code
  - **cname** (string) - Country name
  - **hasnewsms** (boolean) - Indicates if there are new SMS
  - **until** (string) - Timestamp until the rental is valid
  - **canprolong** (boolean) - Indicates if the order can be prolonged
  - **canprolongmax** (integer) - Maximum days the order can be prolonged
  - **canprolonguntil** (integer) - Timestamp until which the order can be prolonged
  - **lastonline** (integer) - Timestamp of the last online activity

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=orders&apikey=yourapikeyhere'
```

### Response Example
```json
{
  "status": 1,
  "data": [
    {
      "id": "40300",
      "scode": "opt16",
      "sname": "Instagram",
      "state": "0",
      "pnumber": "9096068511",
      "ccode": "+7",
      "cname": "KZ",
      "hasnewsms": false,
      "until": "1587552240",
      "canprolong": true,
      "canprolongmax": 162,
      "canprolonguntil": 1634883780,
      "lastonline": 1586947920
    }
  ]
}
```
```

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

### Get Balance

Source: https://docs.smspva.com/

Retrieves the current balance of the user's account. Requires an API key.

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

### Description
Retrieves the user's account balance.

### Method
GET

### Endpoint
https://smspva.com/stubs/handler_api.php

### Parameters
#### Query Parameters
- **action** (string) - Required - Example: `action=getbalance`
- **api_key** (string) - Required - Example: `api_key=yourapikeyhere`

### Responses
#### Success Response (200)
- **text/plain** - Returns `ACCESS_BALANCE:BALANCE VALUE HERE` on success, or `Error. Bad apikey`.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/stubs/handler_api.php?action=getbalance&api_key=yourapikeyhere'
```
```

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

### Get Available Countries List

Source: https://docs.smspva.com/

Retrieves a list of countries for which services are available.

```APIDOC
## Getting available countries list 
Get available countries list

### Query Parameters
| method (string) - Required |
|---|
| method=getcountries |

### Description
Retrieves a list of countries for which services are available.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Specifies the action to perform, e.g., `getcountries`.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=getcountries'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (Array of objects) - Contains a list of countries, each with a `name` and `code`.
```

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

### Get Available Services with Providers

Source: https://docs.smspva.com/

Retrieves a list of available services, including operators and prices, for a specified country and time period.

```APIDOC
## GET /api/rent.php?method=getdataWithProviders

### Description
Get a list of available services for a country with detailed information about operators, prices, and availability. This method shows the price per day for each service and which operators provide that service.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Example: `getdataWithProviders`
- **apikey** (string) - Required - Your API key. Found in your profile settings.
- **country** (string) - Required - The country code of the number (e.g., KZ).
- **dtype** (string) - Required - Type of period: `week` or `month`.
- **dcount** (integer) - Required - Count of the period type (e.g., if `dtype` is `week`, this is the number of weeks).

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=getdataWithProviders&apikey=yourapikeyhere&country=KZ&dtype=week&dcount=1'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (object) - Contains service and provider information.
  - **services** (array) - List of available services.
    - **name** (string) - Name of the service.
    - **service** (string) - Internal service identifier.
    - **price_day** (integer) - Price per day for the service.
    - **img** (string) - Path to the service icon.
    - **procent_days** (integer) - Percentage of days.
    - **procent** (integer) - Percentage value.
    - **day_step** (integer) - Day step for the service.
    - **count** (object) - Object containing counts per operator.
      - **Claro_AR** (integer) - Example count for a specific operator.
    - **totalCount** (integer) - Total count of available numbers for the service.
  - **totalAmount** (integer) - Total amount of services available.
  - **allOperators** (array) - List of all operators providing services.

#### Response Example
```json
{
  "status": 1,
  "data": {
    "services": [
      {
        "name": "1cupis & okcupid & winline",
        "service": "opt48",
        "price_day": 5,
        "img": "images/ico/cupis_okcupid_winline.ico",
        "procent_days": 0,
        "procent": 0,
        "day_step": 0,
        "count": {
          "Claro_AR": 27
        },
        "totalCount": 12
      }
    ],
    "totalAmount": 1735,
    "allOperators": [
      "Claro_AR"
    ]
  }
}
```
```

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

### Get Service Price

Source: https://docs.smspva.com/

Retrieves the price for a specific service in a given country.

```APIDOC
## GET /priemnik.php?method=get_service_price

### Description
Retrieves the price for a specific service in a given country.

### Method
GET

### Endpoint
`https://smspva.com/priemnik.php`

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **service** (string) - Required - Services code (see services list).
- **country** (string) - Required - Country code.
- **method** (string) - Required - Should be `get_service_price`.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt42&country=KZ&method=get_service_price' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **response** (integer) - Indicates success (1 for success).
- **country** (string) - The country code.
- **service** (string) - The service code.
- **price** (string) - The price of the service.

#### Response Example
```json
{
  "response": 1,
  "country": "EN",
  "service": "opt4",
  "price": "0.50"
}
```
```

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

### Get Price with Operators

Source: https://docs.smspva.com/

Request prices for services, including operator information. Requires your API key and optionally a country code.

```shell
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&method=get_price&country=UK' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Get Count of Available Phones

Source: https://docs.smspva.com/

Requests the amount of free activations for a certain service and country.

```APIDOC
## GET /priemnik.php?method=get_count_new

### Description
Requests the amount of free activations for a certain service and country.

### Method
GET

### Endpoint
https://smspva.com/priemnik.php

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **service** (string) - Required - Services code.
- **country** (string) - Required - Countries code.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt52&country=KZ&method=get_count_new' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **service** (string) - Services code.
- **online** (integer) - Number of available activations now.
- **total** (integer) - Total available activations.
- **forTotal** (integer) - Total available for call forwarding.
- **forOnline** (integer) - Available now for call forwarding.
- **country** (string) - Country code.

#### Response Example
```json
{
  "service": "opt52",
  "online": 128,
  "total": 228,
  "forTotal": 10,
  "forOnline": 20,
  "country": "KZ"
}
```
```

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

### Get Account Balance with Curl

Source: https://docs.smspva.com/

Retrieve your current account balance. This requires your API key.

```curl
curl --request GET \
  --url 'https://smspva.com/stubs/handler_api.php?action=getbalance&api_key=yourapikeyhere'
```

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

### Get List of Orders

Source: https://docs.smspva.com/

Retrieve a list of all your active rental orders, including their current status, prolongation availability, and other details. Only requires your API key.

```shell
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=orders&apikey=yourapikeyhere'
```

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

### Get List of Orders

Source: https://docs.smspva.com/

Retrieves a list of all active rental orders with their current status and prolongation availability.

```APIDOC
## Getting list of orders 
Get all your active rental orders with current status and prolongation availability.

### Query Parameters
| method (string) - Required | apikey (string) - Required |
|---|---|
| method=orders | apikey=yourapikeyhere |

### Description
Retrieves a list of all active rental orders with their current status and prolongation availability.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Specifies the action to perform, e.g., `orders`.
- **apikey** (string) - Required - Your unique API key.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=orders&apikey=yourapikeyhere'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (Array of objects) - Contains a list of active rental orders.
```

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

### Get User Balance with cURL

Source: https://docs.smspva.com/

Use this endpoint to retrieve your current account balance. Ensure your API key is correctly included.

```shell
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&method=get_balance' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Get User Info with cURL

Source: https://docs.smspva.com/

Retrieve user-specific information including balance and karma. This requires the service code, method name, and your API key.

```shell
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt4&metod=get_userinfo&method=get_userinfo' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Get Operators List (Shell + Curl)

Source: https://docs.smspva.com/

Retrieves a list of available mobile operators for a specified country. Requires an API key for authorization.

```shell
curl --request GET \
  --url https://api.smspva.com/activation/operators/UK \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Get User Information

Source: https://docs.smspva.com/

Retrieve user-specific information including balance, name, and karma. Requires an API key for authorization.

```curl
curl --request GET \
  --url https://api.smspva.com/activation/userinfo \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Get operators list

Source: https://docs.smspva.com/

Retrieves a list of available mobile operators for a specified country. Requires an API key for authorization.

```APIDOC
## Get operators list

### Description
Get a list of available mobile operators for a specific country. This method returns all operators that provide services in the selected country.

### Method
GET

### Endpoint
/activation/operators/{country}

### Parameters
#### Path Parameters
- **country** (string) - Required - Country code (e.g., UK)

#### Request Headers
- **apikey** (string) - Required - Your API key

### Response
#### Success Response (200)
- **statusCode** (integer) - Result status code
- **data** (object) - Response data
  - **country** (string) - The country code for which operators were retrieved.
  - **operators** (array of strings) - A list of mobile operators available in the specified country.

#### Error Response (400)
- No ApiKey found
```

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

### Get user's info

Source: https://docs.smspva.com/

Retrieve user-specific information including balance, name, and karma. Requires an API key for authorization.

```APIDOC
## Get user's info 
Get user's info
##### Authorizations:
_apikey_
### Responses
**200**
Successful operation
##### Response Schema: application/json
statusCode| integer Example:  "200"Result status code  
---|---  
data| object Response data  
get/activation/userinfo
https://api.smspva.com/activation/userinfo
###  Request samples 
  * Shell + Curl
  * Php + Curl
  * Node + Request
  * Python + Python3


Copy
```
curl --request GET \
  --url https://api.smspva.com/activation/userinfo \
  --header 'apikey: REPLACE_KEY_VALUE'
```

###  Response samples 
  * 200


Content type
application/json
Copy
Expand all  Collapse all 
`{
  * "statusCode": 200,
  * "data": {
    * "balance": 10.5,
    * "name": "user123",
    * "karma": 100.5
}

}`
```

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

### Get Rental History

Source: https://docs.smspva.com/

Retrieves a list of completed rental orders that can potentially be restored. Use this to find orders you want to extend or get information about previous rentals.

```APIDOC
## GET /api/rent.php?method=get_rent_history

### Description
Get the history of completed rental orders. This method returns a list of past orders that can potentially be restored (renewed).

### Method
GET

### Endpoint
https://smspva.com/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Example: `get_rent_history`
- **apikey** (string) - Required - Your API key. Example: `yourapikeyhere`
- **skip** (integer) - Number of items to skip. Example: `0`
- **take** (integer) - Number of items received. Example: `10`

### Response
#### Success Response (200)
Success.
- **status** (integer) - Status of the response: 1 for success, 0 for failure. Example: `1`
- **data** (Array of objects) - List of rental order objects.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=get_rent_history&apikey=yourapikeyhere&skip=0&take=10'
```

### Response Example
```json
{
  "status": 1,
  "data": [
    {
      "orderId": 857191,
      "resourceCode": "opt9",
      "number": "37067787324",
      "branchId": 684,
      "haveSms": false,
      "isAvailForRestore": true,
      "days": 30,
      "country": "LT",
      "begin": 1768902473,
      "end": 1771494473,
      "closed": 1768903921
    }
  ]
}
```
```

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

### Get Available Numbers Count by Country

Source: https://docs.smspva.com/

Get the count of available phone numbers for a specific country. Requires an API key for authorization. The country code should be in ISO 3166-2 format and uppercase.

```curl
curl --request GET \
  --url https://api.smspva.com/activation/countnumbers/UK \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Create Order with Multiple Services

Source: https://docs.smspva.com/

Rents a phone number for a specified duration and multiple services. Requires an API key.

```APIDOC
## GET /api/rent.php?method=create_multi

### Description
Rents a phone number for a specified duration and multiple services. Requires an API key.

### Method
GET

### Endpoint
https://smspva.com/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Must be 'create_multi'.
- **apikey** (string) - Required - Your API key. Found in your profile settings.
- **dtype** (string) - Required - Type of rental period: 'week' or 'month'.
- **dcount** (integer) - Required - Count of the rental period (e.g., number of weeks or months).
- **country** (string) - Required - The country code for the phone number (e.g., 'KZ').
- **services** (string) - Required - Service codes separated by commas (e.g., 'opt6,opt7,opt8').
- **provider** (string) - Optional - Provider name. If not specified, a random provider is chosen.

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (array) - Array of objects containing rented number details for each service.
```

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

### Create Order

Source: https://docs.smspva.com/

Creates a new order for a phone number rental with specified parameters.

```APIDOC
## GET /api/rent.php?method=create

### Description
Creates a new order for a phone number rental.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Example: `create`
- **apikey** (string) - Required - Your API key.
- **dtype** (string) - Required - Type of period: `week` or `month`.
- **dcount** (integer) - Required - Count type of period, i.e., if `dtype=week` then counts of weeks.
- **country** (string) - Required - Country code of the number.
- **service** (string) - Required - Service code.
- **provider** (string) - Optional - Provider name. If not specified, a provider will be chosen randomly.

### Request Example
```
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=create&apikey=yourapikeyhere&dtype=week&dcount=1&country=KZ&service=opt6&provider=T-Mobile'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (Array of objects) - Contains details of the rental order.

#### Response Example
```json
{
  "status": 1,
  "data": [
    {
      "id": 40370,
      "pnumber": "9096037108",
      "ccode": "+7",
      "service": "opt6",
      "until": 1587633960
    }
  ]
}
```
```

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

### Get Service Prices with Operators by Country (Shell + Curl)

Source: https://docs.smspva.com/

Retrieves a list of all services, their base prices, and operator-specific prices for a particular country. An API key is necessary for this request.

```shell
curl --request GET \
  --url https://api.smspva.com/activation/serviceprice/UK \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Restore User Order Response (JSON)

Source: https://docs.smspva.com/

This is a sample successful response when restoring a user order. A status of 1 indicates success, and 'data: true' confirms the order has been restored.

```json
{
  "status": 1,
  "data": true

}
```

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

### Create New Order

Source: https://docs.smspva.com/

Rents a phone number for a specified duration and service. Requires an API key.

```APIDOC
## GET /api/rent.php?method=create

### Description
Rents a phone number for a specified duration and service. Requires an API key.

### Method
GET

### Endpoint
https://smspva.com/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Must be 'create'.
- **apikey** (string) - Required - Your API key. Found in your profile settings.
- **dtype** (string) - Required - Type of rental period: 'week' or 'month'.
- **dcount** (integer) - Required - Count of the rental period (e.g., number of weeks or months).
- **country** (string) - Required - The country code for the phone number (e.g., 'KZ').
- **service** (string) - Required - The service code for the number (e.g., 'opt6').
- **provider** (string) - Optional - Provider name. If not specified, a random provider is chosen.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=create&apikey=yourapikeyhere&dtype=week&dcount=1&country=KZ&service=opt6&provider=T-Mobile'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (array) - Array of objects containing rented number details.
  - **id** (integer) - The ID of the rented number.
  - **pnumber** (string) - The rented phone number.
  - **ccode** (string) - The country code of the phone number.
  - **service** (string) - The service code.
  - **until** (integer) - Timestamp indicating when the rental expires.

#### Response Example
```json
{
  "status": 1,
  "data": [
    {
      "id": 40370,
      "pnumber": "9096037108",
      "ccode": "+7",
      "service": "opt6",
      "until": 1587633960
    }
  ]
}
```
```

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

### Get SMS of Order

Source: https://docs.smspva.com/

Retrieves all SMS messages associated with a specific order.

```APIDOC
## Getting all SMS of order 
Get SMS of number

### Query Parameters
| method (string) - Required | apikey (string) - Required | id (integer) - Required |
|---|---|---|
| method=sms | apikey=yourapikeyhere | id=123 |

### Description
Retrieves all SMS messages associated with a specific order.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Specifies the action to perform, e.g., `sms`.
- **apikey** (string) - Required - Your unique API key.
- **id** (integer) - Required - The ID of the order for which to retrieve SMS messages.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=sms&apikey=yourapikeyhere&id=123'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure.
- **data** (object) - Contains SMS details, including `SmsList` and `OtherSms`.
```

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

### Get SMS Price

Source: https://docs.smspva.com/

Requests the current price for SMS for a specific country and service.

```APIDOC
## GET /priemnik.php?method=get_service_price

### Description
Requests the current price for SMS for a specific country and service.

### Method
GET

### Endpoint
https://smspva.com/priemnik.php

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **service** (string) - Required - Services code.
- **country** (string) - Required - Countries code.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt42&country=KZ' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **response** (string) - Status of the request.
- **country** (string) - Countries code.
- **service** (string) - Services code.
- **price** (string) - The price of receiving 1 SMS.

#### Response Example
```json
{
  "response": "1",
  "country": "EN",
  "service": "opt4",
  "price": "0.50"
}
```
```

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

### Get SMS Status

Source: https://docs.smspva.com/

Retrieves the status of a specific SMS order using its ID.

```APIDOC
## GET /priemnik.php?method=get_clearsms

### Description
Retrieves the status of a specific SMS order.

### Method
GET

### Endpoint
https://smspva.com/priemnik.php

### Parameters
#### Query Parameters
- **apikey** (string) - Required - Your API key.
- **service** (string) - Required - Services code.
- **id** (string) - Required - Order ID.
- **metod** (string) - Required - Method name, should be `get_clearsms`.

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/priemnik.php?apikey=DSWAFvdedrE4&service=opt4&id=SOME_STRING_VALUE&metod=get_clearsms&method=get_clearsms' \
  --header 'apikey: REPLACE_KEY_VALUE'
```

### Response
#### Success Response (200)
- **response** (string) - Status of the operation.
- **clearsms** (string) - Result of the operation, e.g., "ok".

#### Response Example
```json
{
  "response": "2",
  "clearsms": "ok"
}
```
```

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

### Get Prices for All Services (Shell + Curl)

Source: https://docs.smspva.com/

Retrieve a list of all available SMS services and their prices across different countries. An API key is required for authentication.

```shell
curl --request GET \
  --url https://api.smspva.com/activation/servicesprices \
  --header 'apikey: REPLACE_KEY_VALUE'
```

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

### Get count of numbers with providers for services

Source: https://docs.smspva.com/

Request for the number of numbers with providers for services.

```APIDOC
## GET /api/rent.php?method=getCountWithProviders

### Description
Request for the number of numbers with providers for services.

### Method
GET

### Endpoint
/api/rent.php

### Parameters
#### Query Parameters
- **method** (string) - Required - Example: `getCountWithProviders`
- **apikey** (string) - Required - Example: `yourapikeyhere`
- **country** (string) - Required - Example: `KZ`
- **dtype** (string) - Required - Example: `week`
- **dcount** (integer) - Required - Example: `1`

### Request Example
```curl
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=getCountWithProviders&apikey=yourapikeyhere&country=KZ&dtype=week&dcount=1'
```

### Response
#### Success Response (200)
- **status** (integer) - Status of the response: 1 for success, 0 for failure
- **data** (object) - Contains the count of numbers per provider
  - **Amount** (object)
    - **ProviderName** (integer)
  - **Total** (integer)

#### Response Example
```json
{
  "status": 1,
  "data": {
    "opt48": {
      "Amount": {
        "Limbo_AT": 12,
        "Tele2_AT": 1,
        "yesss_AT": 69
      },
      "Total": 82
    }
  }
}
```
```

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

### Create Multi-Rent Order

Source: https://docs.smspva.com/

Use this endpoint to create multiple rental orders for phone numbers. Ensure you provide all required parameters like API key, service type, count, country, and desired services.

```shell
curl --request GET \
  --url 'https://smspva.com/api/rent.php?method=create_multi&apikey=yourapikeyhere&dtype=week&dcount=1&country=KZ&services=opt6%2Copt7%2Copt8&provider=T-Mobile'
```

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

### Get User Balance

Source: https://docs.smspva.com/

Retrieve the current user balance. Requires an API key for authorization.

```curl
curl --request GET \
  --url https://api.smspva.com/activation/balance \
  --header 'apikey: REPLACE_KEY_VALUE'
```
Tokens:
Raw