Skip to main content
Skip to content
ScrapingBuddyDevelopers
On this page Read error responses

SMS API/Guides

Errors & limits

Understand response errors and the limits shared by your account.

Read error responses

Failed requests return an HTTP status and a JSON error message. Record the status, message and order ID where available, without logging credentials.

A successful HTTP status does not replace checking order.status. Allocation failures and unresolved purchases may be represented in an order response.

Example error
{
  "error": "Insufficient balance. Top up your wallet to buy this number."
}

HTTP status reference

400: invalid parameters, JSON or UUID v4 idempotency key. Correct the request.

401: missing, invalid, revoked or expired API key. Check Bearer authentication.

402: insufficient wallet balance. Top up in the dashboard.

404: unknown endpoint or an order that does not belong to your account.

409: expired quote, unavailable stock, conflicting retry or an invalid order action. Read the message and retrieve an existing order before retrying.

413: SMS JSON request body exceeds 16 KiB.

429: request rate or account limit. Honor Retry-After; longer account limits may apply.

503: temporary service unavailability. Keep the same purchase idempotency key when recovering an uncertain request.

Account limits

60 API requests per minute per customer, shared across all of that customer's API keys.

120 quotes per hour and 30 purchases per hour, shared with the website. Up to 10 active or unresolved orders at one time.

Quotes expire in two minutes. Poll active orders every 10 seconds. Order history returns up to 20 records per page.

There is no limit on the number of API keys you can create. Creating more keys does not bypass customer-level limits.

Get help with an unresolved order

Open a support ticket from your dashboard with the order ID, HTTP status and error message. Include a redacted screenshot if it helps explain the issue.

Never send your API key. For purchase_unknown or refund_review, avoid automatically buying another number while support reviews the original order.

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