Get-SMS's own API

Here's a description of how our API works. The API will allow you to integrate your software solutions with our service, allowing you to speed up the account verification process and get rid of the manual "work".

Receiving the user's balance

GET or POST request to url:
https://get-sms.com/api/v1/?method=getbalance&userkey=testapikey
Parameters:
method = getbalance
userkey = YOUR_APIKEY
Response:
If the request is successful, a json with "status" 200 is returned.
The "balance" key from the "data" object describes your current balance:
{
   "status": 200,
   "data": {
      "balance": 100,00
   }
}
Error codes (status):
500 - query processing error
401 - user API KEY not specified or incorrect
404 - incorrect method parameter

Getting a list of services and the number of available numbers

If you need a list of services with their current number on the system, you should use this method.

GET or POST request to url:
https://get-sms.com/api/v1/?method=getcount&userkey=testapikey&country=indonesia
Параметры:
method = getcount
userkey = YOUR_APIKEY
country = indonesia Country. Optional parameter. The default is ru (Russia). A full list of possible country values can be found in the "List of countries" section
Response:
If the query succeeds, a json with "status" 200 is returned. The result of the query is an object which has two keys: "status" and "data". The "status" key is represented by the value which characterises the result of the query. The value "200" for "status" indicates that the query was successful. The key "data" contains the object with the operator keys. Each statement key has a value in the form of an object which characterises the services.
Each service object has two keys: "count" - the current quantity, "price" - the price.
You may be wondering, "Why is there a hierarchy of objects?
This object is returned because this structure allows you to easily get to the information you need.
For example, you are writing in PHP and want to know the number of numbers under WhatsApp with any operator. You can easily do it like this (after you decoded json): $decoded_json['ANY']['wapp]['count'].
The codes for all services can be found in the “List of services” section.
{
   "status": 200,
   "data": {
   // any operator
      "ANY": {
         "vk": {
            "count": 0,
            "price": "5"
         },
         "ok": {
            "count": 0,
            "price": "5"
         },
         "wapp": {
            "count": 1,
            "price": "2"
         },
         "vbr": {
            "count": 10,
            "price": "2"
         }
      }
      ...
      // Only Tele2
      "TELE2": {
         ...
      },
      // Only Beeline
      "BEELINE": {
         ...
      },
      // Only Megafon
      "MEGAFON": {
         ...
      },
      // Only MTS
      "MTS": {
         ...
      }
   }
}
If an error occurs during query execution, a json with "status" 500 is returned. The problem is caused by an error while working with the database.
If you receive this error on this request, please contact the administration of the Get-SMS project immediately:
{
   "status": 500,
   "data": {
      "msg": "Failed to generate a service count"
   }
}
Error codes (status):
500 - query processing error
401 - API user KEY is not specified or incorrect
404 - incorrect method parameter

Obtaining a telephone number

The main part of the whole project is the issuing of phone numbers for activation. Before you get a phone number you should check whether you have enough money on your balance and whether there are free numbers in the system.
A little digression and information.
When the phone number is issued, we create a virtual order that allows you to receive an SMS from the issued number within 15 minutes. For the life time of the order, we transfer a part of your balance to the reserve, it is necessary to avoid erroneous charges during multi-stream work with API, as well as to prevent users from "quitting" the order without receiving an SMS.

GET or POST request to url:
https://get-sms.com/api/v1/?method=getnumber&service=vk&userkey=testapikey&country=ru
Parameters:
method = getnumber
service = vk Service. Mandatory parameter. A complete list of service values can be found in the"Service list" section.
userkey = YOUR_APIKEY
country = ruCountry. Optional parameter. The default is ru (Russia). A full list of possible country values can be found in the "List of countries" section
Response:
If the query succeeds, it will retrieve a json with the "status" key equal to 200.
The "data" key will have an object with the keys "order_id" - the order number to work with the phone number subsequently, and the "phone" key containing the phone number to receive the SMS message with the verification code.
The telephone number is in international format with the country code without the + sign. Take this into account.
{
   "status": 200,
   "data": {
      "order_id": "377253343",
      "phone": "79969817867",
      "start_time": "2023-02-23T13:11:57.373Z"
   }
}
It may be that we have temporarily run out of phone numbers for the service being ordered, then the "status" will be 500:
{
   "status": 500,
   "data": {
      "msg": "No phone number was found for this request",
      "advice": "Please try to retrieve the phone number later, after new numbers become available"
   }
}
Error codes (status):
401 - user API KEY not specified
404 - incorrect method parameter
500 - no number available
502 - service does not exist
503 - operator does not exist
504 - insufficient funds
505 - country does not exist
506 - you are temporarily blocked until the next day
507 - technical work in progress

Retrieving a code from an SMS

The final activation step is to receive a code and a full text message to confirm the account number.
Algorithm of receiving sms is specific:
1. send sms request, where in order_id key you substitute value from getnumber request.
2. If "status" is 200, then sms is received.
3. If "status" is 400, then SMS hasn't arrived yet or not found, then in 5 seconds repeat from step 1.
4. If "status" is 500, it means the order time has expired.

What should I do if my order has expired and I haven't received an SMS?
This could be due to a number of reasons:
- the sms has not been sent by the ordering service
- the sms search template is not up to date
- An error during the operation of our equipment
- You entered a wrong phone number by mistake.
In any case money will not be deducted from your account if no SMS was received.
If you are sure that the error is due to our fault. We will be happy to assist you with technical support.

GET or POST request to the URL:
https://get-sms.com/api/v1/?method=getcode&order_id=377253343&userkey=testapikey
Parameters:
method = getcode
order_id = 377253343 Order number derived from number request. Required value.
userkey = YOUR_APIKEY
Response:
On successful execution of the query, a json will be received with the "status" key equal to 200.
The "data" key will contain the object with the text message details:
code - the code that the system has found the text message. The code may be null, as the code could not be detected
fullSms - the full text message that came
phone - the telephone number to which the text message was sent in international format without the + sign
receivedDate - date of receipt of SMS in ISO format
sender - the sender indicated in the text message. Can be blank.
id - sms identifier for wrongcode method (additional sms as parameter "last_id")
phonePass - the password for the service provider's personal account. Can be blank.
{
   "status": 200,
   "data": {
      "code": "753455",
      "fullSms": "753455",
      "phone": "79969817867",
      "receivedDate": "2023-02-23T13:18:57.373Z",
      "sender": "",
      "id": "377253343",
      "phonePass": ""
   }
}
You can also get a json with "status" 400, this is not an error but a natural response from the system when your text message has not yet arrived.
To continue, you simply need to repeat the code request after 5 seconds.
It must be repeated either until you receive an SMS or until an error occurs stating that the life of the order has expired (error 500):
{
   "status": 400,
   "data": {
      "msg": "The SMS has not been found yet",
      "advice": "The SMS has probably not been received yet. Please try the request again in 10 seconds"
   }
}
Error codes (status):
500 - order lifetime expired
502 - internal error, try again
504 - insufficient funds
505 - order not found in the system
506 - order_id parameter is not specified
401 - user's API KEY is not specified
404 - incorrect method parameter

Retrieving the code

Under our project, you do not pay for each code, but for a kind of temporary rental of a phone number for a particular service. In practice, you have 15 minutes during which you can receive all the text messages that come to the issued phone number for the ordered service.
Where would you need this functionality? For example, you register a Qiwi Wallet. And you need to receive an SMS to disable the security function in Qiwi. To do this, you receive the first sms, register a wallet, disable the security function in Qiwi wallet, send us this request wrongcode, and we give you absolutely free second sms, which came to the phone number from Qiwi. There is no limit to the number of additional sms you can receive as part of your order.
WARNING!
With us you can only receive additional codes within the lifetime of the order, i.e. within 15 minutes of receiving the phone number.

GET or POST request to url:
https://get-sms.com/api/v1/?method=wrongcode&order_id=377253343&userkey=testapikey&last_id=377253343
Параметры:
method = wrongcode
order_id = 377253343 Order number derived from number request. Required value.
userkey = ВАШ_APIKEY
last_id = 377253343 Identifier of last sms you received via getcode or previous wrongcode request. Almost always the same as order_id, but may be different, be careful. Required value.
Response:
On successful execution of the query, a json will be received with the "status" key equal to 200.
The "data" key will contain the object with the text message details:
code - the code that the system has found the text message. The code may be null, as the code could not be detected
fullSms - the full text message that came
phone - the telephone number to which the text message was sent in international format without the + sign
receivedDate - date of receipt of SMS in ISO format
sender - the sender indicated in the text message. Can be blank.
id - sms identifier for wrongcode method (additional sms as parameter "last_id")
phonePass - the password for the service provider's personal account. Can be blank.
{
   "status": 200,
   "data": {
      "code": "753455",
      "fullSms": "753455",
      "phone": "79969817867",
      "receivedDate": "2023-02-23T13:18:57.373Z",
      "sender": "",
      "id": "377253343",
      "phonePass": ""
   }
}
You can also get a json with "status" 400, this is not an error but a natural response from the system when your text message has not yet arrived.
To continue, you simply need to repeat the code request after 5 seconds.
It must be repeated either until you receive an SMS or until an error occurs stating that the life of the order has expired (error 500):
{
   "status": 400,
   "data": {
      "msg": "The SMS has not been found yet",
      "advice": "The SMS has probably not been received yet. Please try the request again in 10 seconds"
   }
}
Error codes (status):
500 - order lifetime expired
501 - parameter method is incorrect
502 - internal error, try the request again
504 - you have not yet received the first sms from the getcode method.
505 - order not found in the system
506 - order_id parameter is not specified
401 - API user KEY is not specified
404 - wrong method parameter

Canceling a number order

If you have received a telephone number in the process but, for reasons known only to you, want to cancel the order, you need to carry out the process of cancelling the telephone number using this refusenumber method.

GET or POST request to url:
https://get-sms.com/api/v1/?method=refusenumber&order_id=377253343&userkey=testapikey
Parameters:
method = refusenumber
order_id = 377253343 Order number derived from number request. Required value.
userkey = YOUR_APIKEY
Response:
If the query succeeds, the json with the "status" key set to 200 will be retrieved:
{
   "status": 200,
   "data": {
      "msg": "The phone number order has been canceled"
   }
}
If you receive a different message, refer to the error codes below.

Error codes (status):
500 - order lifetime expired
502 - internal error, try again
506 - order_id parameter is not specified
401 - user's API KEY is not specified
404 - wrong method parameter

Ban phone number

If during the account registration process it turns out that the phone number given to you is not suitable for registration, you are advised to use this bannumber method to bann your phone number.

GET or POST request to url:
https://get-sms.com/api/v1/?method=bannumber&order_id=377253343&userkey=testapikey
Parameters:
method = bannumber
order_id = 377253343 Order number derived from number request. Required value.
userkey = YOUR_APIKEY
Response:
If the query succeeds, the json with the "status" key set to 200 will be retrieved:
{
   "status": 200,
   "data": {
      "msg": "The phone number is banned"
   }
}
If you receive a different message, refer to the error codes below.

Error codes (status):
500 - order lifetime expired
502 - internal error, try again
506 - order_id parameter is not specified
401 - user's API KEY is not specified
404 - wrong method parameter

Getting all values of countries and services available in it

Наш новый метод, который позволяет получить значения всех стран и все сервисы доступных в ней.
Also the method allows you to specify a certain service and get the number and prices of all countries for a certain service.

GET or POST request to url:
https://get-sms.com/api/v1/?method=getallcount&service=tg&userkey=testapikey
Параметры:
method = getallcount
service = tg Optional parameter. If not specified, the method will return all countries and all services
userkey = YOUR_APIKEY
Response:
If the request is successful, a json without the service parameter will be retrieved:
{
 "ru": [
  {
   "vk": {
    "name": "VK",
    "price": "62.3",
    "count_all": "3712"
   },
   "wa": {
    "name": "Whatsapp",
    "price": "195",
    "count_all": "3740"
   },
   "vi": {
    "name": "Viber",
    "price": "6.55",
    "count_all": "3876"
   },
   "tg": {
    "name": "Telegram",
    "price": "209.49",
    "count_all": "3861"
   },
   "ask": {
    "name": "SVOE",
    "price": "8.98",
    "count_all": "3525"
   }
  }
 ],
 "england": [
  {
   "vk": {
    "name": "VK",
    "price": "2.28",
    "count_all": "3909"
   },
   "ok": {
    "name": "Ok.ru",
    "price": "38.2",
    "count_all": "4026"
   },
   "atp": {
    "name": "Vonage",
    "price": "2.13",
    "count_all": "3979"
   }
  }
 ],
 ...
}
OR:
If the request is successful, a json with the service parameter will be retrieved:
{
   "ru": {
      "price": "214.15",
      "count_all": "4036"
   },
   "england": {
      "price": "98.67",
      "count_all": "3654"
   },
   "canada": {
      "price": "28.57",
      "count_all": "3970"
   },
   "germany": {
      "price": "295.73",
      "count_all": "1499"
   },
   "ssha": {
      "price": "41.03",
      "count_all": "4459"
   },
   "brazil": {
      "price": "178.28",
      "count_all": "4157"
   },
   ...
}
If you receive a different message, please refer to the error codes below.

Error codes (status):
502 - internal error, try making the request again
401 - API KEY of the user is not specified
404 - method parameter set incorrectly
Compatible API with other activation services

If you choose to work in compatibility with another activation service and not rewrite your software, you can use our compatible API. But we strongly discourage you from doing this, as it is not updated or properly supported.
The first thing you need to do to start using our compatible API is to enter the host file in Windows, which can be found at the following address
C:\Windows\System32\drivers\etc\
and add the following line to it:
5.253.63.28 domain.com (the domain name of another activation service)

If you do not want to put anything in the host file, then change the domain in your software from the domain of the other activation service to give-sms.com. And the address of your requests should take the following form:
https://get-sms.com/stubs/handler_api.php
You can send all requests either POST or GET.
Please note that there is no call forwarding yet! And most likely will not be in this version of the API!
Otherwise all of our compatible ones are absolutely identical! So we decided to just copy the instructions, so as not to multiply and mislead our users.

Request for the number of available numbers (getNumbersStatus)

GET or POST request to the URL:
https://get-sms.com/stubs/handler_api.php?action=getNumbersStatus&api_key=testapikey&country=0
Parameters:
action = getNumbersStatus
api_key = ВАШ_APIKEY
country = 0 Country. Optional parameter. Default is 0 (Russia). A full list of possible country values can be found in the "List of countries" section
Response:
If the query succeeds, you will receive a json of this type:
{
   "vk_0": 28,
   "ok_0": 4,
   "wa_0": 9,
   "vi_0": 19,
   "tg_0": 30,
   "wb_0": 21,
   "go_0": 30,
   "av_0": 8,
   "av_0": 23,
   "fb_0": 24
}

Balance request (getBalance)

GET or POST request to url:
https://get-sms.com/stubs/handler_api.php?action=getBalance&api_key=testapikey
Parameters:
action = getBalance
api_key = YOUR_APIKEY
Response:
If the query succeeds, you will receive TEXT of this type:
ACCESS_BALANCE:100 // where 100 is your current balance in $
Possible errors:
BAD_KEY - Invalid API key
ERROR_SQL - SQL server error

Ordering a number (getNumber)

GET or POST request to the URL:
https://get-sms.com/stubs/handler_api.php?action=getNumber&service=vk&country=0&api_key=testapikey
Parameters:
action = getNumber
service = vk Service. Mandatory parameter. The full list of service values can be found in the "List of services" section. 
country = 0 Country. Optional parameter. Default value is 0 (Russia). The full list of possible country values can be found in the "List of Countries" section
api_key = YOUR_APIKEY
Response:
If the query succeeds, you will receive TEXT of this type, where $id is the transaction id and $number is the phone number:
ACCESS_NUMBER:$id:$number
Other responses:
NO_NUMBERS - no numbers available
NO_BALANCE - no balance
Possible errors:
BAD_ACTION - invalid action
BAD_SERVICE - invalid service name
WRONG_SERVICE - The service is not in the system
BAD_KEY - Invalid API key
ERROR_SQL - SQL server error
YOU_TEMPORARY_BANNED - You are banned until the next day

Changing activation status (setStatus)

GET or POST request to url:
https://get-sms.com/stubs/handler_api.php?action=setStatus&status=1&id=1234567&api_key=testapikey
Parameters:
action = setStatus
status = STATUS CODE Possible status codes are listed below
id = OPERATION ID Order ID received from getNumber request
api_key = YOUR_APIKEY
Possible statuses:
1 notify that the number is ready (text message sent to the number)
3 request another code ( for free)
6 complete activation If the status was 'code received', mark it as successful and complete. If the status was 'preparing', delete it and mark it as an error. If the status was 'waiting for retry', change the activation to 'awaiting SMS'.
8 report that the number has been used and cancel the activation.

Response:
If the request is successful, you will receive TEXT, depending on the status:
ACCESS_READY - the readiness of the number has been confirmed
ACCESS_RETRY_GET - waiting for a new SMS
ACCESS_ACTIVATION - service successfully activated
ACCESS_CANCEL - activation cancelled
Possible errors:
BAD_ACTION - invalid action
NO_ACTIVATION - activation id does not exist
BAD_STATUS - Incorrect status
BAD_KEY - Invalid API key
ERROR_SQL - SQL server error

Get activation status (getStatus)

GET or POST request to url:
https://get-sms.com/stubs/handler_api.php?action=getStatus&id=1234567&api_key=testapikey
Parameters:
action = getStatus
id = OPERATION ID Order ID received from getNumber request
api_key = YOUR_APIKEY
Response:
If the request is successful, you will receive TEXT, depending on the status:
STATUS_WAIT_CODE - waiting for SMS
STATUS_WAIT_RETRY:'The previous code that did not work' - waiting for further clarification on the code
STATUS_WAIT_RESEND - waiting for the sms to be resent (the software should press resend sms and change the status to 6)
STATUS_CANCEL - activation cancelled
STATUS_OK: 'activation code' - code received
Possible errors:
BAD_ACTION - invalid action
NO_ACTIVATION - activation id does not exist
NO_BALANCE - insufficient balance
BAD_KEY - Invalid API key
ERROR_SQL - SQL server error

Get all prices for services (getPrices)

GET or POST request to the URL:
https://get-sms.com/stubs/handler_api.php?action=getPrices&api_key=testapikey&service=SERVICE&country=0
Parameters:
action = getPrices
service = vk Service. Optional parameter. A complete list of service values can be found in the "List of services" section.
api_key = YOUR_APIKEY
country = 0 Country. Mandatory parameter. Default is 0 (Russia). A full list of possible country values can be found in the "List of countries" section
Response:
If the query succeeds, you will receive a json of this type:
{
 "0": {
    "vk": {
        "25": 36
    },
    "lb": {
        "25": 169
    },
    "wa": {
        "51": 178
    },
    "vi": {
        "2.96": 0
    },
    "tg": {
        "38.8": 0
    },
    "wb": {
        "6.56": 3580
    },
    "go": {
        "7.87": 4433
    },
    "av": {
        "6.69": 3595
    },
    "fb": {
        "3.94": 3932
    },
    "qw": {
        "20": 3759
    }
  }
}
The hierarchy takes the following form - { "Country": { "Service": { "Price": { "Quantity"}}}
API for renting a phone number for an extended period

Here is the instruction on using the API for renting a phone number. The API will enable you to integrate your software solutions with our service.
If you have any questions, you can always contact our support service.

The API server can handle both POST and GET requests
Requests should be sent to the following address -  https://get-sms.com/api/v2/rent/

Fetching the count of available phone numbers, services, and rental prices.

GET or POST request to the URL:
https://get-sms.com/api/v2/rent/?userkey=testapikey&method=getcountprices&country=ru
Parameters:
method = getcountprices
userkey = YOUR_APIKEY
country = ru Country. Mandatory parameter. Default is ru (Russia). The full list of possible country values can be found in the "Country List"
Response:
If the request is successful, a JSON with the key "status" equal to 200 will be received.
The key "data" will contain an object with service objects:
vk (example) - an object with a key from the service's code name containing the count of available rental numbers and rental prices for a specific period
count - the count of available numbers
price - an object containing prices for a specific time period
1day - price for one day of rental (24 hours)
2day - price for two days of rental (48 hours)
3day - price for three days of rental (72 hours)
4day - price for four days of rental (96 hours)
5day - price for five days of rental (120 hours)
6day - price for six days of rental (144 hours)
7day - price for seven days of rental (168 hours)
{
   "status": 200,
   "data": {
      "vk":{
         "count":"233",
         "price":{
             "1day":"101.9",
             "2day":"144.7",
             "3day":"182.4",
             "4day":"215",
             "5day":"241.5",
             "6day":"251.7",
             "7day":"275.1"
         }
      },
      "wa":{
         "count":"182",
         "price":{
            "1day":"250.5",
            "2day":"355.7",
            "3day":"448.4",
            "4day":"528.6",
            "5day":"593.7",
            "6day":"618.7",
            "7day":"676.4"
         }
      },
      "vi":{
         "count":"316",
         "price":{
            "1day":"17.7",
            "2day":"25.1",
            "3day":"31.7",
            "4day":"37.3",
            "5day":"41.9",
            "6day":"43.7",
            "7day":"47.8"
         }
      }
      ...
   }
}

Obtaining a telephone number for rent

Please make sure to verify the rented number within 20 minutes by sending a message to it from the selected service. If you do not receive an SMS within 15 minutes, you have the option to cancel the order, and the full amount will be refunded. After 20 minutes, refunds are not available. Please be attentive and considerate.

GET or POST request to the URL:
https://get-sms.com/api/v2/rent/?userkey=testapikey&method=getnumber&type=day&period=1&service=ig&country=ru
Parameters:
method = getnumber
userkey = YOUR_APIKEY
type = day Mandatory parameter. Period type: day (days) or week (weeks).
period = 1 Number of days or weeks. Mandatory parameter. A value of 1 and a period type of 'day' indicates that we want to rent a phone number for 1 day.
service = ig Service. Mandatory parameter. The complete list of service values can be found in the "Services List section.".
country = ru Country. Mandatory parameter. Default is ru (Russia). The full list of possible country values can be found in the "Country List section."
Response:
Upon successful execution of the request, a JSON with the key 'status' equal to 200 will be received.
The key 'data' will contain an object with keys 'order_id' - the order number for subsequent work with the phone number, and 'phone' - containing the phone number to receive SMS verification codes.
The phone number is provided in international format with the country code, without the plus sign. Please take this into account.

For convenience, time intervals are presented in UNIX timestamp and regular 24-character format:
end_time_timestamp - UNIX timestamp before the end of the rental period
end_time - Date and time of the phone number rental expiration.
start_timestamp - Date and time of the phone number rental commencement in UNIX timestamp
{
   "status":200,
   "data":{
      "order_id":14763471,
      "phone":"79510405923",
      "end_time_timestamp":1702981048,
      "end_time":"2023-12-19 13:17:29",
      "start_timestamp":1702881048
   }
}
Error codes (status):
401 - User API KEY not provided
404 - Incorrectly specified 'method' parameter
500 - No available numbers for rental
502 - Service does not exist
503 - Internal error, please try to order a number later
504 - Insufficient funds
505 - Country does not exist
506 - Incorrectly specified period or period type
507 - Technical maintenance in progress

Receiving all SMS on the rented number

GET or POST request to the URL:
https://get-sms.com/api/v2/rent/?userkey=testapikey&method=getcode&rentid=888
Parameters:
method = getcode
userkey = YOUR_APIKEY
rentid= 888 Mandatory parameter. Order ID obtained from the request to get a rental number. This parameter can also be obtained from the request to get all active orders.
Response:
Upon successful execution of the request, a JSON with the key "status" equal to 200 will be received.
The key "data" will have an object with the key "sms_list" containing all the SMS messages received on this phone number.
{
   "status":200,
   "data": {
      "msg":"List of all SMS",
      "sms_list":[
         {
            "date":"2023-12-14 17:11:51",
            "text":"Verification code for Rambler&Co: 435345"
         },
         {
            "date":"2023-12-15 15:36:56",
            "text":"Verification code for Rambler&Co: 520455"
         }
      ]
   }
}
You can receive JSON with "status" 400, which is not an error but a natural system response when no SMS has been received on the number yet.
To continue, you simply need to repeat the code retrieval request after 15-30 seconds.
{
   "status":400,
   "data": {
      "msg":"No SMS received on this number yet",
      "advice":"No SMS received on this number yet"
   }
}
Error codes (status):
401 - User API KEY not provided
404 - Incorrectly specified 'method' parameter
501 - Rental was canceled or the rental order time has expired
502 - Rental completed
503 - Order not found

Extension of rental order

GET or POST request to the URL:
https://get-sms.com/api/v2/rent/?userkey=testapikey&method=prolong&type=day&period=1&rentid=888
Parameters:
method = prolong
userkey = YOUR_APIKEY
type = day Mandatory parameter. Period type: day (days) or week (weeks).
period = 1 Number of days or weeks. Mandatory parameter. A value of 1 and a period type of 'day' indicates that we want to rent a phone number for 1 day.
rentid= 888 Mandatory parameter. Order ID obtained from the request to get a rental number. This parameter can also be obtained from the request to get all active orders.
Response:
Upon successful execution of the request, a JSON with the key "status" equal to 200 will be received, indicating that the extension of the number is successfully completed.
{
   "status":200,
   "data": {
      "phone":"79510405923",
      "msg":"You have extended the rental of the number"
   }
}
Error codes (status):
401 - User API KEY not provided
404 - Incorrectly specified 'method' parameter
502 - Rent ID not provided or no such order in the system
504 - Incorrectly specified period or period type
505 - Insufficient funds to extend the rental
506 - Unable to extend the rental for the specified period
507 - Internal error, please try to resend the request

Cancellation of Rental Order

GET or POST request to the URL:
https://get-sms.com/api/v2/rent/?userkey=testapikey&method=refuse&rentid=888
Parameters:
method = refuse
userkey = YOUR_APIKEY
rentid= 888 Mandatory parameter. Order ID obtained from the request to get a rental number. This parameter can also be obtained from the request to get all active orders.
Response:
Upon successful execution of the request, a JSON with the key "status" equal to 200 will be received, indicating that the rental of the number is successfully canceled. The funds for the rental are returned to the user's balance.
{
   "status":200,
   "data": {
      "msg":"Rental canceled",
      "advice":"Your phone number rental order is canceled. The money is refunded."
   }
}
Error codes (status):
400 - Unable to cancel the rental of this number, as more than 20 minutes have passed or SMS has already been received
401 - User API KEY not provided
404 - Incorrectly specified 'method' parameter
500 - Rent ID not provided
501 - Rental has already been canceled
502 - Rental is completed
503 - Order not found

Deleting Rental Order

GET or POST request to the URL:
https://get-sms.com/api/v2/rent/?userkey=testapikey&method=delete&rentid=888
Parameters:
method = delete
userkey = YOUR_APIKEY
rentid= 888 Mandatory parameter. Order ID obtained from the request to get a rental number. This parameter can also be obtained from the request to get all active orders.
Response:
Upon successful execution of the request, a JSON with the key "status" equal to 200 will be received, indicating that the order for renting the number has been successfully deleted from the system.
{
   "status":200,
   "data": {
      "msg":"Order deleted",
      "advice":"The phone number rental order has been deleted from the system"
   }
}
Error codes (status):
401 - User API KEY not provided
404 - Incorrectly specified 'method' parameter
500 - Rent ID not provided

Getting All Rental Orders

GET or POST request to the URL:
https://get-sms.com/api/v2/rent/?userkey=testapikey&method=getorders
Parameters:
method = getorders
userkey = YOUR_APIKEY
Response:
Upon successful execution of the request, a JSON with an array of all ordered phone numbers will be received, including those numbers whose rental has been canceled or completed.
Decoding the 'status' key:
status = 0 Rental period has expired
status = 1 Rental is active
status = 2 Rental canceled by the user

Decoding the 'date_at' key:
date_at = 2023-10-10 07:15:07 Date and time until which the rental of the number was ordered
[
   {
      "id":"512",
      "phone":"79222222222",
      "status":"0",
      "date_at":"2023-09-29 09:56:38"
   },
   {
      "id":"559",
      "phone":"79222222222",
      "status":"1",
      "date_at":"2023-10-10 07:15:07"
   },
   {
      "id":"886",
      "phone":"79222222222",
      "status":"2",
      "date_at":"2023-12-19 13:00:58"
    }
]
If there are no rented numbers, you will receive an empty array:
[]

List of countries

Value Name Compatible API value
ru Russia 0
ukr Ukraine 1
kazakhstan Kazakhstan 2
england England 16
canada Canada 36
germany Germany 43
usavirt USA (Virtual) 12
brazil Brazil 73
estonia Estonia 34
france France 78
indonesia Indonesia 6
kyrgyzstan Kyrgyzstan 11
laos Laos 25
lithuania Lithuania 44
netherlands Netherlands 48
poland Poland 15
romania Romania 32
sweden Sweden 46
indiia India 22
malaiziia Malaysia 7
vetnam Vietnam 10
filippiny Philippines 4
turtsiia Turkey 62
moldova Moldova 85
uzbekistan Uzbekistan 40
gruziia Georgia 128
irlandiia Ireland 23
portugaliia Portugal 117
ispaniia Spain 56
chekhiia Czech Republic 63
bangladesh Bangladesh 60
ssha USA 187
gonkong Hong Kong 14
tailand Thailand 52
meksika Mexico 54
latviia Latvia 49
pakistan Pakistan 66
gretsiia Greece 129
nikaragua Nicaragua 90
argentina Argentina 39
gaiti Haiti 26
mongoliia Mongolia 72
izrail Israel 13
egipet Egypt 21
gvatemala Guatemala 94
liviia Libya 102
iran Iran 57
iemen Yemen 30
tadzhikistan Tajikistan 143
kitai China 3
shrilanka Sri Lanka 64
siriia Syria 110
livan Lebanon 153
boliviia Bolivia 92
serbiia Serbia 29
kolumbiia Colombia 33
avstriia Austria 50
alzhir Algeria 58
peru Peru 65
gonduras Honduras 88
marokko Morocco 37
venesuela Venezuela 70
nigeriia Nigeria 19
iamaika Jamaica 103
salvador Salvador 101
botsvana Botswana 123
paragvai Paraguay 87
nepal Nepal 81
uganda Uganda 75
irak Iraq 47
iordaniia Jordan 116
mianma Myanmar 5
demkongo Dem.Congo 18
keniia Kenya 8
kambodzha Cambodia 24
belarus Belarus 51
kotdivuar Ivory Coast 27
saudaraviia Saud. Arabia 53
oae UAE 95
khorvatiia Croatia 45
papuanovaiagvineia Papua New Guinea 79
tanzaniia Tanzania 9
gvineia Guinea 68
mali Mali 69
kamerun Cameroon 41
mavritaniia Mauritania 114
serraleone Sierra Leone 115
burkinafaso Burkina Faso 152
daniia Denmark 172
tunis Tunisia 89
dominikanskaiarespublika Dominican Republic 109
iuzhnaiaafrika South Africa 31
ekvador Ecuador 105
liberiia Liberia 135
senegal Senegal 61
afganistan Afghanistan 74
novaiazelandiia New Zealand 67
chad Chad 42
angola Angola 76
gana Ghana 38
iuzhnaiakoreia South Korea 190
sudan Sudan 98
taivan Taiwan 55
zimbabve Zimbabwe 96
turkmenistan Turkmenistan 161
reiunon Reunion 146
kipr Cyprus 77
gaiana Guyana 131
maldivy Maldives 159
mozambik Mozambique 80
gambiia Gambia 28
trinidaditobago Trinidad and Tobago 104
gabon Gabon 154
brunei Brunei 121
butan Bhutan 158
surinam Suriname 142
armeniia Armenia 148
benin Benin 120
mavrikii Mauritius 157
fidzhi Fiji 189
kongo Congo 150
dominika Dominica 126
bermudy Bermuda 195
aruba Aruba 179
chili Chili 151
finliandiia Finland 163
italiia Italy 86
bolgariia Bulgaria 83
vengriia Hungary 84
sloveniia Slovenia 59
khorvatiia Croatia 45
norvegiia Norway 174

List of services

Value Name
ai CELEBe
do Leboncoin
dh EBay
sk Skroutz
lq Potato
mh Ashan
wv AIS
ia Socios
bf Keybase
mm Microsoft
qd Taobao
at Perfluence
qf RedBook
dp ProtonMail
mi Zupee
yb Quartet+
wa Whatsapp
uz OffGamers
ou Gabi
he Mewt
jj Aitu
ez GoerliFaucet
ts PayPal
ta Wink
qt MoneyСontrol
ef Nextdoor
ad Iti
cg Gemgala
nu Stripe
rf Akudo
kj YAPPY
ul Getir
nv Naver
fw 99acres
ud Disney Hotstar
lw MrGreen
io ZdravCity
oy CashFly
qm RosaKhutor
mn RRSA
dt Delivery Club
lt BitClout
ui RuTube
qw Qiwi
fj Potato Chat
tx Bolt
kc Vinted
xd Tokopedia
pp Huya
qj Whoosh
qh Oriflame
jt TurkiyePetrolleri
ok Ok.ru
wk Mobile01
bn Alfagift
wh TanTan
vm OkCupid
ri BillMill
bs TradeUP
tw Twitter
ey Miloan
je Nanovest
hr JKF
kn Verse
yf Citymobil
aj OneAset
bx Dosi
ca SuperS
gr Astropay
rv Kotak811
bp GoFundMe
ni Gojek
fy Mylove
dk Pairs
bk G2G
bb LazyPay
vo Brand20ua
bh Uteka
gz LYKA
ww BIP
ur MyDailyCash
cx Icrypex
sh VkusVill
gv Humta
ve Dream11
kp HQ Trivia
uf Eneba
aa Probo
tk MVideo
iq Icq
ej MrQ
ss Hezzl
sf SneakersnStuff
ce Mosru
dc YikYak
sl SberApteka
dl Lazada
uo CafeBazaar
uh Yubo
pl Perekrestok
dg Mercari
cb Bazos
pu Justdating
gh GyFTR
ev Picpay
qg MoneyPay
bw Signal
cc Quipp
jf Likee
eq Qoo10
dd CloudChat
jc IVI
er Kwork
ip Burger King
bu MonobankIndia
nq Trip
qi 23red
eg ContactSys
cp Uklon
sg OZON
xr Tango
uk Airbnb
ko AdaKami
nf Netflix
vy Meta
dy Zomato
ha My11Circle
tg Telegram
dq IceCasino
rs Lotus
bc GCash
ne Coindcx
mr Fastmail
we DrugVokrug
ry McDonalds
qa MyFishka
pm AOL
la Ssoidnet
ak Douyu
go Google,youtube,Gmail
oi Tinder
dn Paxful
xl Wmaraci
vz Hinge
rd Lenta
wb WeChat
ew Nike
gm Mocospace
wj 1хbet
xe GalaxyChat
sn OLX
ae MyGLO
ch Pocket52
py Monese
hn 1688
qy Zhihu
ck BeReal
kw Foody
ml ApostaGanha
ci RedBus
wc Craigslist
pd IFood
be SberMegaMarket
xy Depop
cf Irancell
wp 163СOM
rx Sheerid
su LOCO
ho Cathay
af GalaxyWin
bq Adani
oq Vlife
ru HOP
om Corona
sb Lamoda
ig Instagram
uj СhampionСasino
mu MyMusicTaste
cq Mercado
ti Cryptocom
uu Wildberries
ub Uber
ln Grofers
me Line msg
of Urent
fz KFC
un Humblebundle
ug Fiqsy
kr Eyecon
vn Yaay
qe GG
ds Discord
gg PagSmile
uw Kirana
vs WinzoGame
gt Gett
uy Meliuz
hq Magicbricks
im Imo
bv Metro
po Premium.one
jg Grab
es IQIYI
bo Wise
kb Kufarby
wq Leboncoin1
jh PingPong
tt Ziglu
rr Wolt
ih TeenPattiStarpro
od FWDMAX
iv Inboxlv
xh OVO
ra KeyPay
bz Blizzard
rc Skype
pt Bitaqaty
gu Fora
ma Mail.ru
ji Monobank
op MIRATORG
hk 4Fun
gp Ticketmaster
up Magnolia
dr OpenAI
bd X5ID
gl GlobalTel
gx Hepsiburadacom
ay Ruten
sr Starbucks
pa Gamekit
ct KuhnyaNaRayone
ht Bitso
ft Bookmakers
ka Shopee
mx SoulApp
wt IZI
sw NCsoft
ep Temu
mc Michat
qr MEGA
ee Twilio
le E bike Gewinnspiel
ec RummyCulture
qu Agroinform
oh MapleSEA
fa XadrezFeliz
cm Prom
bt Alfa
ya Yandex
ot Any other
cj Dotz
hh Uplay
gc TradingView
sm YoWin
ki 99app
tu Lyft
de Karusel
pq CDkeys
fm Touchance
lr Okta
ly Olacabs
va SportGully
df Happn
kf Weibo
vc Banqi
fk BLIBLI
xn Familia
th WestStein
fs Şikayet var
rz EasyPay
cn Fiverr
dx Powerkredite
pg NRJ Music Awards
bg MIXMART
mj Zalo
xw Taki
ua BlaBlaCar
pf Pof.com
an Adidas
mk LongHu
lh 24betting
hg Switips
sq KuCoinPlay
lx DewuPoison
gf GoogleVoice
iy FoodHub
nz Foodpanda
ah EscapeFromTarkov
nw Ximalaya
sj HandyPick
et Clubhouse
tl Truecaller
md Banks
co Rediffmail
ga Roposo
oc DealShare
og Okko
rh Ace2Three
rl InDriver
dj LUKOIL-AZS
pr Trendyol
bj Vita Express
rk Fotka
ao UU163
nr Tosla
ph SnappFood
ar Wondermart
ij Revolut
qc Primaries 2020
gd Surveytime
ky SpatenOktoberfest
sp HappyFresh
xj SberMarket
ac DoorDash
ba Expressmoney
kz NimoTV
np Siply
vf Q12 Trivia
tf Noon
iz Global24
jz Kaya
yd 米画师Mihuashi
cl UWIN
fx PGbonus
jr Scooter
px Nifty
nl Myntra
tn LinkedIN
dw Divar
ke Eldorado
ku RoyalWin
el Bisu
bm MarketGuru
nn Giftcloud
lp Algida
eo Sizeer
cw PaddyPower
gw CallApp
wo Parkplus
si Cita Previa
xt Flipkart
wx Apple
qz Faceit
di Loanflix
kx Vivo
nb Faithful
xi InFund
pw SellMonitor
fb Facebook
ex Linode
st Ashan
mt Steam
av Avito
db Ezbuy
wn GameArena
sa AGIBANK
re Coinbase
no Virgo
ls Careem
ql CMTcuzdan
tm Akulaku
rb Tick
ei Taksheel
hc MOMO
qk Bit
gs SamsungShop
lf TikTok/Douyin
vd Betfair
so RummyWealth
wl YouGotaGift
yx JTExpress
vj Stormgain
sv Dostavista
ob Onlinerby
rp Hamrahaval
tc Rambler
vx HeyBox
ab Alibaba
eh Telegram 2.0
jm Mzadqatar
fo MobiKwik
az CityBase
ny Pyro Music
xu RecargaPay
yk SportMaster
zw Quack
lv Megogo
fh Lalamove
ja Weverse
xq MPL
lc Subito
ea JamesDelivery
qn Blued
ib Immowelt
wg Skout
ff AVON
jx Swiggy
au Haraj
uv BinBin
eb Voltz
ju Indomaret
kt KakaoTalk
km Rozetka
yg CourseHero
cd SpotHit
xk DiDi
qo Moneylion
sd Dodopizza
fe CliQQ
ed Gamer
bi 勇仕网络Ys4fun
yz Around
xf LightChat
tj DbrUA
mf Weidian
rg Porbet
xv Wish
mb Yahoo
mg Magnet
gi Hotline
hm Globus
ol KazanExpress
xb RummyOla
vk Vkontakte
hw Alipay/Alibaba
oz Poshmark
tq Swvl
fc PharmEasy
ue Onet
aq Glovo
mq GMNG
my CAIXA
vw CoinField
dm Iwplay
fg IndianOil
xs GroupMe
hx AliExpress
yj EWallet
eu LiveScore
cy РСА
us IRCTC
br Vkusno i Tochka
jb Wing Money
fl RummyLoot
fr Dana
aw Taikang
zh Zoho
zj ROBINHOOD
zi LoveLocal
yp Payzapp
zd Zilch
yo Amasia
zs Bilibili
zm OfferUp
yw Grindr
yy Venmo
zl Airtel
yl Yalla
zn Biedronka
fv Vidio
fu Snapchat
cr TenChat
hi JungleeRummy
nk Gittigidiyor
vv Seosprint
dv NoBroker
hl Band
ll 888casino
hb Twitch
vp Kwai
td ChaingeFinance
xz Paycell
li Baidu
lj Santander
xx Joyride
yq Foxtrot
mo Bumble
ge Paytm
lb Mailru Group
zq IndiaPlays
ik GuruBets
cu 炙热星河
oe Codashop
kh Bukalapak
sy Brahma
vi Viber
os Dhani
uc Tatneft
ym Yula
rm Faberlic
cv WashXpress
pz Lidl
kl Kolesa.kz
gj Carousell
zf OnTaxi
gb YouStar
en Hermes
jl Hopi
hy Ininal
ax CrefisaMais
iu Bykea
fi Dundle
gk AptekaRU
rt Hily
cz Getmega
dz Dominos Pizza
fd Mamba
kg FreeChargeApp
il IQOS
hz Drom
xm Létoile
qq Tencent QQ
tp IndiaGold
am Amazon
qb Payberry
hu Ukrnet
em ZéDelivery
vg ShellBox
tr Paysend
cs AgriDevelop
lk PurePlatfrom
rj Kids' World
wf YandexGo
zu BigC
jq Paysafecard
nm Thisshop
bl BIGO LIVE
sz Pivko24
hj Stoloto
da MTS CashBack
du AUBANK
yn Allegro
zo Kaggle
zv Digikala
yu Xiaomi
yv IPLwin
zg Setel
yi Yemeksepeti
zk Deliveroo
zt Budweiser
zr Papara
zz Dent
zx CommunityGaming
zy Nttgame
ys ZCity
za JDcom
call Receiving a reset call