API

Endpoint: /api/makeorder?key=APIKEY&serviceId=SERVICEID&country=NL Method: GET

To make an order you need to send a request to the endpoint above providing the right serviceId. To view the serviceIds go to your account page and click 'Show API ID's On Service Page'.

Parameter	Description
key	Your API Key. (Required)
serviceId	The ID of the service you wish to make an order for. (Required)
country	Specify the country you wish the number to be from. Options: USA, NL or UK (Optional NL by default)

Possible Responses:

NO_PHONE_AVAILABLE - There is unfortunately no phone available for the specified service.
ORDER_ALREADY_OPEN_{ORDER_ID} - There is an order already open. Please finish or cancel this one before making a new order.
NO_BALANCE - There is unfortunately not enough balance on your account for this order.

Success:
ORDER_ID_{ORDER_ID}_NUMBER_{PHONE_NUMBER} - Your order has been successfully made.

Endpoint: /api/getsms?key=APIKEY&orderId=ORDERID Method: GET

With this method you can see the SMS that came in for the order.

Parameter	Description
key	Your API Key. (Required)
orderId	The ID of the order you wish to check if a SMS came in. (Required)

Possible Responses:

ORDER_EXPIRED - The order has been canceled or has been expired.
WAITING - The order is still open waiting for a SMS to come in.

Success:
SUCCESS_{SMS_CONTENT} - Your SMS has been successfully received.

Endpoint: /api/cancelorder?key=APIKEY&orderId=ORDERID Method: GET

With this method you can cancel an active order.

Parameter	Description
key	Your API Key. (Required)
orderId	The ID of the order you wish to cancel. (Required)

Possible Responses:

ORDER_ALREADY_EXPIRED - The order has already been expired.
ORDER_ALREADY_COMPLETED - The order has already been completed.

Success:
ORDER_CANCELED - Your order has been canceled.

Endpoint: /api/skipnumber?key=APIKEY&orderId=ORDERID Method: GET

With this method you can skip a number of an active order so you dont get it again in the future.

Parameter	Description
key	Your API Key. (Required)
orderId	The ID of the order you wish to skip the number on. (Required)

Possible Responses:

ORDER_ALREADY_EXPIRED - The order has already been expired.
ORDER_ALREADY_COMPLETED - The order has already been completed.

Success:
NUMBER_SKIPPED_ORDER_CANCELED - Your order has been canceled and the number has been skipped. You can make a new order with a fresh number.

Endpoint: /api/getbalance?key=APIKEY Method: GET

With this method you can get your current balance in USD.

Parameter	Description
key	Your API Key. (Required)

Possible Responses:

{YOUR_BALANCE} - Your current balance in USD

Endpoint: /api/reuse?key=APIKEY&orderId=ORDERID Method: GET

In case you wish to use the same number again for the same service as an already completed order you can use this API call.
NOTE: Re-using is only available for a very short time after the initial order. (A few hours usually)

Parameter	Description
key	Your API Key. (Required)
orderId	The ID of the order you already completed and wish to re-use. (Required)

Possible Responses:

NUMBER_OFFLINE - The number has been replaced and is gone.
ORDER_ALREADY_OPEN_{ORDER_ID} - There is an order already open. Please finish or cancel this one before making a new order.
NO_BALANCE - There is unfortunately not enough balance on your account for this order.

Success:
ORDER_ID_{ORDER_ID}_NUMBER_{PHONE_NUMBER} - Your order has been successfully made.

Endpoint: /api/rental/new Method: POST

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"
}
                

Endpoint: /api/rental/extend Method: POST

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"
}
                

Endpoint: /api/rental/edit Method: POST

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
}
                

Endpoint: /api/rental/view Method: POST

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"
        }
    ]
}