Purchase a new rental.
Parameter | Description |
key | Your API Key. (Required) |
country | The country you wish the rental to be from (NL/UK) (Required) |
Possible Responses:
NO_STOCK
- There is unfortunately no phone available for the specified country.
NO_BALANCE
- There is unfortunately not enough balance on your account for this order.
Success:
You will get a JSON response with success and the details about the new rental number.
For
example:
{
"success": true,
"contract_id": 34405,
"phone_number": "07684563067",
"country": "UK"
}
Extend the rental with one month
Parameter | Description |
key | Your API Key. (Required) |
contract_id | The ID of the rental you wish to extend. (Required) |
Possible Responses:
NUMBER_EXPIRED
- The contract has already been expired.
NO_BALANCE
- You dont have balance to extend the number
Success:
You will get a JSON response with success and the new expire of the rental number.
For
example:
{
"success": true,
"new_expire": "2023-11-03T12:57:03.000000Z"
}
Enable or disable autorenew.
Parameter | Description |
key | Your API Key. (Required) |
contract_id | The ID of the rental you wish to edit. (Required) |
auto_renew | The new value of the auto renew setting (true/false) (Required) |
Possible Responses:
Success:
You will get a JSON response with success and the new auto renew setting of the rental number.
For example:
{
"success": true,
"auto_renew": false
}
Get all the information and SMS of the rental number
Parameter | Description |
key | Your API Key. (Required) |
contract_id | The ID of the rental you wish to view. (Required) |
Possible Responses:
Success:
You will get a JSON response with success and the info of the rental number.
For example:
{
"success": true,
"contract_id": 33405,
"phone_number": "07684563067",
"country": "UK",
"auto_renew": false,
"expire_on": "2023-11-03T12:57:03.000000Z",
"received_sms": [
{
"id": 1,
"sender": "Uber",
"body": "Your Uber code is 0183. Never share this code.",
"receive_date": "2023-08-02T14:30:23.000000Z"
},
{
"id": 2,
"sender": "SinchVerify",
"body": "Your Tinder code is 417097 Don’t share @tinder.com #417097",
"receive_date": "2023-08-02T14:30:42.000000Z"
}
]
}