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.
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.
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.
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.
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
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.