Skip to main content
Skip to content
ScrapingBuddyDevelopers
On this page Persist before purchasing

SMS API/Guides

Safe purchases & retries

Recover uncertain requests without accidentally buying another number.

Persist before purchasing

POST /orders requires a UUID v4 Idempotency-Key header and a quoteId in its JSON body. Persist both values before sending the request.

Treat that pair as the identity of one purchase. Reusing a quote can recover its existing order; reusing a key with a different quote returns a conflict.

Generate a key once, then persist it
import { randomUUID } from "node:crypto";

const purchaseKey = randomUUID();
// Save purchaseKey and the approved quote.id in durable storage.
// Only then send POST /orders. Reuse both values on retry.

Recover an uncertain response

If POST /orders times out, do not assume it failed. Retry the same request with the original saved key and quote ID.

When you already have an order ID, retrieve that order first. A successful HTTP response may contain purchasing, failed or purchase_unknown; inspect the returned record.

Do not silently create a new quote and purchase if the original outcome is unknown. That can buy a second number.

Back off on temporary errors

For 429, honor Retry-After. The response currently uses 60 seconds, but hourly or active-order account limits can last longer.

For temporary 503 or network failures, use bounded retries with backoff. Preserve purchase identity across every retry and process restart. Set a timeout for each HTTP request.

Do not blindly retry validation, authentication or balance errors. Correct the underlying issue first.

Handle expiry and stock changes

Quotes expire after two minutes and do not reserve stock. A known, rejected purchase may need a new quote, but first establish that the earlier request did not create an order.

Review the new quote price against your budget. A previous quote does not guarantee the same price or stock on a later request.

SMS API v1
Getting startedIntroductionYour first numberAuthentication
Integration guidesOrder lifecycle & messagesSafe purchases & retriesErrors & limits

Explore the documentation

SMS APIIntroduction

Virtual numbers, quotes, verification messages and order management.

GuidesYour first number

Go from a server-side API key to an allocated number and your first verification message.

GuidesAuthentication

Create a customer key and connect your backend securely.

GuidesOrder lifecycle & messages

Know when a number is ready, when a message has arrived and when to stop polling.

GuidesSafe purchases & retries

Recover uncertain requests without accidentally buying another number.

GuidesErrors & limits

Understand response errors and the limits shared by your account.

GET /balanceGet balance

Read the wallet balance shared by your dashboard and API purchases. balanceUsd is the exact available USD balance as a decimal string, including fractional cents from CAPTCHA charg

GET /countriesList countries

Find the country identifiers used by catalogue and purchase requests. Use the id from this response in subsequent requests. Country names and dialling prefixes are display informat

GET /servicesList services

Find service IDs, stock and indicative prices for a country. Catalogue prices are indicative, not a purchase commitment. Always create a fresh quote before purchasing. Stock can ch

GET /operatorsList operators

Find available operators for a country and service. Pass an operator id to Create a quote when you need a specific operator. Omit operator or use any for automatic selection. Chang

POST /quotesCreate a quote

Get a live price before committing to a number purchase. A quote expires after two minutes. Check amountCents against your budget and expiresAt before purchasing. A quote does not

POST /ordersCreate an order

Purchase a number using an approved quote and a persisted idempotency key. This request spends wallet funds. Persist a UUID v4 Idempotency-Key and quoteId before sending it. Reuse

GET /ordersList orders

Read your order history, newest first, in pages of up to 20 orders. Start with offset=0 and increase by 20 while hasMore is true. Stop when hasMore is false. This is offset paginat

GET /orders/{id}Get an order

Retrieve an allocated number, its current status and all received messages. Poll every 10 seconds while the order is active. Background checks continue even if your application dis

POST /orders/{id}/refreshRefresh an order

Request a status check for an existing order. Checks are throttled and also run automatically in the background. Repeated refresh requests do not guarantee a fresh provider request

POST /orders/{id}/cancelCancel an order

Cancel an active order before an SMS has arrived. Only cancel when the order is active and sms is empty. The server checks whether the action is still allowed. Check refunded_at to

POST /orders/{id}/finishFinish an order

Complete an active order after receiving and using your SMS. Finish only after the sms array contains a message. This action ends the order; keep the message you need before finish