Authentication
Create or rotate an API key in your dashboard. Send it with each request in the X-API-KEY header. Keep the key on a server you control, and never include it in browser code or a public repository.
X-API-KEY: your_api_key_hereBase URL and request format
All API requests use this base URL:
https://api.smsactivate.ukExample request
This request places an order and may charge your wallet. Replace the example service and country with a selection available to your account.
curl -X POST https://api.smsactivate.uk/get_numbers -H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" -d '{"service":"tg","country":2}'API reference
Each operation lists its inputs, a request example, a representative response and the main errors. Existing API integrations can keep using their previous endpoints; the product-based endpoints below are recommended for new integrations. Examples use placeholder IDs and values. Send authenticated requests from your server with the API key header.
Start here
GET/balanceRead your current wallet balance.
API key required.
Parameters
- None
- No query parameters.
Example request
curl https://api.smsactivate.uk/balance -H "X-API-KEY: YOUR_API_KEY"Answer
{ "balance": "10.0000" }Errors
The endpoint returns the authenticated account's current balance.
Get and manage a number
POST/get_numbersPlace an activation order.
API key required.
Parameters
- service
- Required string. Service code, for example tg.
- country
- Required integer. Numeric country ID.
- operator
- Optional string. Defaults to any.
- max_price
- Optional number. Maximum price; maxPrice is also accepted.
- min_price
- Optional number; minPrice is also accepted.
- any_price
- Optional boolean; anyPrice is also accepted.
- product
- Optional: standard (default) or api_links. API Links are final-sale inventory purchases.
- idempotency_key
- Optional UUID for standard activations. Reuse the same key only for the same purchase request when its outcome is being checked.
- quantity
- Optional integer from 1 to 100 for API Links inventory orders; defaults to 1. Standard activation orders are single-number orders.
Example request
curl -X POST https://api.smsactivate.uk/get_numbers \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"service":"tg","country":2}'Answer
{
"id": "ORDER_ID",
"phone": "10000000000",
"price": "0.2500",
"balance_remaining": "9.7500"
}Errors
HTTP 400: unavailable selection, price limit or insufficient balance. HTTP 409: an earlier order is still being checked. HTTP 503: temporary failure or an uncertain order; if the response says reconciliation is required, do not retry and contact support.
GET/sms/{order_id}Ask for a fresh status check for an active order.
API key required. This endpoint is rate-limited.
Parameters
- order_id
- Required path value returned when the order was created.
Example request
curl https://api.smsactivate.uk/sms/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
{
"status": "received",
"sms_code": "123456",
"raw_sms": "Your verification code is 123456"
}Errors
HTTP 400: SMS checking is unavailable for this order. HTTP 404: order not found. HTTP 502: temporary check failure. Expired orders return their stored status without a fresh upstream check.
GET/status/{order_id}Read an order status and any SMS received.
API key required.
Parameters
- order_id
- Required path value returned when the order was created.
Example request
curl https://api.smsactivate.uk/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
{
"status": "received",
"sms_code": "123456",
"raw_sms": "Your verification code is 123456"
}Errors
The response is scoped to the authenticated account's order. If a status lookup fails, the API returns an error; check the order ID and try later if the service is temporarily unavailable.
POST/resend/{order_id}Request another SMS for a supported active activation.
API key required.
Parameters
- order_id
- Required path value. No request body.
Example request
curl -X POST https://api.smsactivate.uk/resend/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
{ "message": "Resend request successful. Waiting for new SMS." }Errors
HTTP 400: resend not accepted or order expired. HTTP 409: resend is not available for this order. HTTP 500: resend could not be completed.
POST/cancel/{order_id}Request cancellation of an eligible activation.
API key required.
Parameters
- order_id
- Required path value. No request body.
Example request
curl -X POST https://api.smsactivate.uk/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
{
"message": "Number cancelled and balance refunded",
"refunded_amount": "0.2500",
"new_balance": "10.0000"
}Errors
Cancellation is available only for eligible active activations, 2 to 20 minutes after purchase, and before an SMS arrives. Rentals use /rent/cancel/{order_id}; API Links are final sale. Ineligible or unconfirmed cancellations return an error. A cancellation response should be read before any retry.
GET/reactivate/{order_id}/optionsCheck the current reactivation price and details.
API key required.
Parameters
- order_id
- Required path value for the original order.
Example request
curl https://api.smsactivate.uk/reactivate/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"Answer
{
"price": 0.25,
"duration": 20,
"phone": "10000000000",
"service": "tg",
"country": 2
}Errors
HTTP 400: reactivation is not supported or unavailable. HTTP 409: reactivation is not available for this order. HTTP 503: a valid current price could not be confirmed.
POST/reactivate/{order_id}Reactivate an eligible activation at its current price.
API key required.
Parameters
- order_id
- Required path value for the original order. No request body.
Example request
curl -X POST https://api.smsactivate.uk/reactivate/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
{
"message": "Number reactivated successfully.",
"id": "NEW_ORDER_ID",
"phone": "10000000000",
"price": 0.25,
"balance_remaining": 9.75
}Errors
HTTP 400: reactivation is unsupported or the wallet has insufficient balance. HTTP 409: not available for this order. HTTP 503: outcome could not be confirmed; contact support before trying again.
GET/orders/{order_id}Read details for one of your orders.
API key required.
Parameters
- order_id
- Required path value returned when the order was created.
Example request
curl https://api.smsactivate.uk/orders/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
Returns the order record with buyer-facing fields, including its status and remaining time where applicable. Internal routing IDs and cost fields are not returned.Errors
HTTP 404: order not found or does not belong to your account.
Choose services, countries and prices
ServicesSearch the maintained service catalog by name or code. Availability can change; check the live endpoint before ordering.
163COMwp- 11688
hn - 11and1
ahs - 11xbet
wj - 224betting
lh - 22dehands
apd - 22domains
erc - 22ememain
blx - 22ГИС
bcg - 332Red
qi - 3360Kredi
ayo - 33Fun
auw - 44FunLite
hk - 5500px
fpx - 551exch
boc - 551exchange
exc - 77-Eleven
aws - 8888casino
ll - 9999 Md
brv
99acresfw
99appki- 999Game
qkb - 999k Outlet
amq - AA23
acv - AA9A
gn - AAadhar
hra
Abastece-aíanb- AAbbott
ags
Ace2Threerh- AAcima
cim - AAcko
amf
AdaKamiko- AAdaModal
bdo - AAdani
bq - AAdidas
an - AAditya Birla
qff - AAdmiralBet
bst - AAdobe
byh
Advertsagw- AAEG Presents
rsn - AAffirm
bow - AAfreecaTV
aip
AGIBANKsa- AAgoda
ag
AgriDevelopcs- AAgroinform
qu - AAhlan
bsm - AAiqfome
bbi - AAir Miles
bsy - AAirba Fresh
bnp
Airbnbuk- AAirtasker
byd
Airtelzl- AAirtime
acy
AISwv- AAIS PLAY
axs
Aitujj
Akudorf
Akulakutm
Alchemyaav
Alfabt
Alfagiftbn- AAlfamidi
bgt - AAlFursan
bxr - AAlgida
lp - AAlibaba
ab
AliExpresshx- AAlignable
aul
Alipay/Alibaba/1688hw
All Accessajy
Allegroyn
AlloBanknh- AAllofresh
aeo - AAltyn-i
al - AAmap 高德地图
btx - AAmarthaFin
bsv
Amasiayo- AAmaze Super App
bzk
Amazonam- AAme Digital
afi - AAmway
aee - AAngel One
aha
Ankamaalg- AAnnoncelight
byw
Any Otherot
AOLpm
ApostaGanhaml
Applewx
Apteka Aprelaeh
AptekaRUgk- AAptekiPlus
rq - AAR Lens
aco
ArenaPlusabt- AArgent
amo - AAri10
blq - AASAAS
bqr - AAsda
hs - AAsiaMiles
ajp - AAsianDating
ayb - AAskable
bpi - AAspiration
aptn
Astra Otoshopafd
AstraPayaem
Astropaygr- AASVLA
buj - AAti Su
bhl - AAtlas Earth
awq - AAtlasbus
atb
AttaPollanl- AAUBANK
du
Auchanst- AAudible
aud - AAukro
aox - AAuthentify
ccy - AAuthor24
kd - AAutodesk
bbl
Autoruaej- AAv100pro
ajl - AAvito
av
AVONff
Live availability and sample response:
GET https://api.smsactivate.uk/services{
"services": ["tg", "wa", "go"],
"providers": { "source-counts": "per active catalog" },
"generated_at": "ISO 8601 timestamp"
}The maintained catalog provides names and codes for lookup. Availability is live and may differ from this list; this JSON shows the response shape, not current inventory.
CountriesNumeric country IDs from the dashboard catalog. There is no general country-list API endpoint for standard activations.
Afghanistan74
Albania155
Algeria58
Angola76
Anguilla181
Antigua and Barbuda169
Argentina39
Armenia148
Aruba179
Australia175
Austria50
Azerbaijan35
Bahamas122
Bahrain145
Bangladesh60
Barbados118
Belarus51
Belgium82
Belize124
Benin120
Bermuda195
Bhutan158
Bolivia92
Bosnia108
Botswana123
Brazil73
Brunei121
Bulgaria83
Burkina Faso152
Burundi119
Cambodia24
Cameroon41
Canada36
Cape Verde186
Cayman Islands170
Central African Republic125
Chad42
Chile151
China3
Colombia33
Comoros133
Congo150
Costa Rica93
Croatia45
Cuba113
Cyprus77
Czech63
Denmark172
Djibouti168
Dominica126
Dominican Republic109
DR Congo18
Ecuador105
Egypt21
Equatorial Guinea167
Eritrea176
Estonia34
Ethiopia71
Faroe Islands202
Fiji189
Finland163
France78
French Guiana162
Gabon154
Gambia28
Georgia128
Germany43
Ghana38
Gibraltar201
Greece129
Grenada127
Guadeloupe160
Guatemala94
Guinea68
Guinea-Bissau130
Guyana131
Haiti26
Honduras88
Hong Kong14
Hungary84
Iceland132
India22
Indonesia6
Iran57
Iraq47
Ireland23
Israel13
Italy86
Ivory Coast27
Jamaica103
Japan182
Jersey194
Jordan116
Kazakhstan2
Kenya8
Kosovo203
Kuwait100
Kyrgyzstan11
Laos25
Latvia49
Lebanon153
Lesotho136
Liberia135
Libya102
Liechtenstein200
Lithuania44
Luxembourg165
Macao20
Madagascar17
Malawi137
Malaysia7
Maldives159
Mali69
Malta199
Mauritania114
Mauritius157
Mexico54
Moldova85
Monaco144
Mongolia72
Example offer response shape for one service and country:
[
{ "name": "any", "offers": [{ "price": 0.25, "count": 4 }] }
]Catalog IDs identify country choices, not a promise of live offers. Check /offers/{service}/{country} for availability.
GET/servicesCheck current service availability.
Public - no API key required.
Parameters
- None
- This endpoint takes no query parameters.
Example request
curl https://api.smsactivate.uk/servicesAnswer
Returns the current services array and generated_at timestamp. See the searchable Services catalog below for code/name lookup; it is a maintained reference, not a live availability guarantee.Errors
Availability can change. Check the live endpoint and /offers/{service}/{country} before an order.
GET/countries/{service}List the country IDs that currently have numbers for a service.
Public - no API key required.
Parameters
- service
- Required service code, such as tg.
Example request
curl https://api.smsactivate.uk/countries/tgAnswer
{ "countries": [2, 6, 187] }Errors
Country IDs match the Countries catalog below. Availability changes; check /offers/{service}/{country} before ordering. This endpoint is rate-limited.
GET/offers/{service}/{country}/deliverySee recent code delivery rates for each price tier.
Public - no API key required.
Parameters
- service
- Required service code, such as tg.
- country
- Required numeric country ID.
Example request
curl https://api.smsactivate.uk/offers/tg/2/deliveryAnswer
{
"window_days": 30,
"tiers": { "0.2500": { "orders": 120, "codes": 108, "delivery_pct": 90, "best": true } }
}Errors
HTTP 400: invalid service or country. Tiers with no delivered codes are not listed. Results are cached for about 5 minutes and cover the last window_days days. This endpoint is rate-limited.
GET/operators?service={service}&country={country}List available operators for a service and country.
Public - no API key required.
Parameters
- service
- Required service code, such as tg.
- country
- Required numeric country ID.
Example request
curl 'https://api.smsactivate.uk/operators?service=tg&country=2'Answer
[
{ "name": "any", "localName": "Any Operator" },
{ "name": "example", "localName": "Example operator" }
]Errors
The list depends on the selected country and current availability. Both service and country are required; missing or invalid values return HTTP 422.
GET/links/optionsList the services and country choices in the API Links catalog.
Public - no API key required.
Parameters
- None
- This endpoint takes no query parameters.
Example request
curl https://api.smsactivate.uk/links/optionsAnswer
{
"services": [{
"id": "sample_service",
"name": "Sample service",
"countries": [{ "id": 2, "name": "United States", "price": 0.25, "stock": 4 }]
}],
"countries": [{ "id": 2, "name": "United States" }]
}Errors
This list is for API Links only. It is not a general country list for standard activation orders.
GET/links/offers/{service}/{country}Check current API Links inventory prices and stock.
Public - no API key required.
Parameters
- service
- Service code from the API Links options catalog.
- country
- Numeric country ID from the selected service's API Links country list.
Example request
curl https://api.smsactivate.uk/links/offers/tg/1Answer
[{ "name": "any", "offers": [{ "price": "0.2500", "count": 4 }] }]Errors
Unavailable selections return an empty list. To buy this product, send product=api_links to /get_numbers. API Links are final sale; quantity defaults to 1 and must be between 1 and 100.
GET/offers/{service}/{country}Check offers for one service and country combination.
Public - no API key required.
Parameters
- service
- Required path value. Use a service code returned by /services, such as tg.
- country
- Required path value. Numeric country ID; use the dashboard country catalog for standard activations. There is no general API endpoint that lists these country IDs.
Example request
curl https://api.smsactivate.uk/offers/tg/2Answer
[
{
"name": "any",
"offers": [{ "price": "0.2500", "count": 4 }]
}
]Errors
An unsupported or unavailable pair can return an empty list. Offer data is cached; a cache miss may take longer while availability is checked.
Review past activity
GET/ordersBrowse your order history, newest first.
API key required.
Parameters
- page
- Optional page number; defaults to 1.
- per_page
- Optional page size; defaults to 20 and is capped at 100.
- status
- Optional: active, completed (or received), cancelled, expired, refunded. Omit or use all to include every status.
- search
- Optional phone-number search.
- category
- Optional: rents, links, or numbers.
Example request
curl 'https://api.smsactivate.uk/orders?page=2&per_page=100&status=received&category=numbers' -H "X-API-KEY: YOUR_API_KEY"Answer
{
"current_page": 2,
"data": [{ "id": "ORDER_ID", "status": "received", "phone": "10000000000" }],
"first_page_url": "…?page=1",
"last_page": 4,
"last_page_url": "…?page=4",
"next_page_url": "…?page=3",
"per_page": 100,
"prev_page_url": "…?page=1",
"total": 350
}Errors
Follow next_page_url until it is null. page defaults to 1; per_page defaults to 20 and values are clamped to 1–100. status accepts active, completed/received, cancelled, expired or refunded; all or an unknown value leaves status unfiltered. search matches phone numbers. category accepts rents, links or numbers; unknown categories are ignored. Large histories need multiple page requests.
Rentals
GET/rent/servicesCheck rental services for a country and duration.
API key required.
Parameters
- country
- Optional integer country ID; defaults to 2.
- duration
- Optional hours; defaults to 24. Allowed range: 24–1,344 hours.
Example request
curl 'https://api.smsactivate.uk/rent/services?country=2&duration=24' -H "X-API-KEY: YOUR_API_KEY"Answer
Returns rental availability, with service codes and current prices for the selected country and duration.Errors
HTTP 400: no rental number available for the selection. HTTP 422: invalid country or duration. HTTP 503: rental catalog temporarily unavailable.
POST/rent/orderPlace a rental order.
API key required.
Parameters
- service
- Required string service code.
- country
- Required integer country ID.
- duration
- Required hours, 24–1,344.
- operator
- Optional string; defaults to any.
Example request
curl -X POST https://api.smsactivate.uk/rent/order \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"service":"tg","country":2,"duration":24}'Answer
{
"message": "Number rented successfully.",
"id": "ORDER_ID",
"phone": "10000000000",
"price": 2.50,
"balance_remaining": 7.50
}Errors
HTTP 400: invalid request or insufficient balance. HTTP 409: no rental available. HTTP 503: the result is pending review; do not retry until support checks the order.
POST/rent/cancel/{order_id}Request cancellation of an eligible rental.
API key required.
Parameters
- order_id
- Required path value. No request body.
Example request
curl -X POST https://api.smsactivate.uk/rent/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
Returns the cancellation result. Refunds may remain pending verification after cancellation is accepted.Errors
Cancellation is limited to eligible active rentals 2 to 20 minutes after purchase, before an SMS arrives. HTTP 404: rental not found. HTTP 409: rental is not eligible. If accepted, its refund can remain pending verification.
GET/rent/extend/{order_id}/optionsCheck available extension options for a rental.
API key required.
Parameters
- order_id
- Required path value for the rental.
Example request
curl https://api.smsactivate.uk/rent/extend/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"Answer
{
"options": [{ "duration": 24, "price": 2.50 }],
"expires_at": "2026-10-06T12:00:00Z"
}Errors
HTTP 404: rental not found. HTTP 409: the rental is not eligible (extension opens after the first 20 minutes, the rental must be active or received, or an earlier extension is pending review). HTTP 503: extension is temporarily unavailable or the options could not be loaded; retry later. This endpoint is rate-limited.
POST/rent/extend/{order_id}Extend an active rental.
API key required.
Parameters
- order_id
- Required path value for the rental.
- duration
- Required: one of 24, 72, 168, 336, 720, 1,440, 2,160 or 4,320 hours. Choose from the current options response.
- expected_price
- Required number copied from the current options response.
- Idempotency-Key
- Required UUID v4 request header. Reuse it only to safely retry the same extension attempt.
Example request
curl -X POST https://api.smsactivate.uk/rent/extend/ORDER_ID \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-H "Idempotency-Key: 3f6c1a52-8b1e-4c47-9d0a-6a1f2c9e7b10" \
-d '{"duration":24,"expected_price":2.50}'Answer
{
"message": "Rental extended successfully.",
"attempt_id": "REQUEST_UUID",
"status": "settled",
"charged": 2.50,
"new_expires_at": "2026-10-10T12:00:00Z",
"balance_remaining": 7.50
}Errors
HTTP 422: missing/invalid duration, expected_price or Idempotency-Key. HTTP 409: the rental is not eligible, the duration or price is no longer offered, or the Idempotency-Key was already used. HTTP 202: extension is pending review; do not retry under a new idempotency key. HTTP 503: extension could not be confirmed; contact support.
Email verification
GET/emails/catalog?site={site}List available verification-address domains for a site.
API key required.
Parameters
- site
- Required website domain, for example example.com.
Example request
curl 'https://api.smsactivate.uk/emails/catalog?site=example.com' -H "X-API-KEY: YOUR_API_KEY"Answer
[{ "name": "sample-domain.test", "price": 0.10, "stock": 5 }]Errors
HTTP 422: invalid site value. HTTP 503: email catalog temporarily unavailable.
POST/emails/buyPurchase one verification address.
API key required.
Parameters
- site
- Required website domain.
- domain
- Required domain chosen from the current catalog response.
Example request
curl -X POST https://api.smsactivate.uk/emails/buy \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"site":"example.com","domain":"sample-domain.test"}'Answer
Returns an order object and balance_remaining when the purchase is confirmed.Errors
HTTP 400: insufficient wallet balance. HTTP 409: domain is out of stock. HTTP 503: purchase is pending review; do not retry until support checks the order.
POST/emails/{order_id}/reorderOrder the same address again after the earlier order has finished.
API key required.
Parameters
- order_id
- Required path value of a finished email order (numeric). No request body.
Example request
curl -X POST https://api.smsactivate.uk/emails/ORDER_ID/reorder -H "X-API-KEY: YOUR_API_KEY"Answer
Returns the new email order, same shape as the email order response. The price is quoted at order time and charged from your balance.Errors
HTTP 404: order not found. HTTP 409: the earlier order has not finished, a reorder is already in progress, or this address cannot be reordered now. HTTP 503: email verifications are temporarily unavailable. This endpoint is rate-limited.
GET/emails/historyList your email verification orders.
API key required.
Parameters
- page
- Optional page number; defaults to 1.
- per_page
- Optional page size; defaults to 20 and is capped at 50.
Example request
curl 'https://api.smsactivate.uk/emails/history?page=1&per_page=20' -H "X-API-KEY: YOUR_API_KEY"Answer
Returns paginated order data and page metadata.Errors
If the email order table is not available, the API returns an empty data array.
GET/emails/status/{order_id}Read or refresh a verification order.
API key required.
Parameters
- order_id
- Required path value returned by the purchase response.
Example request
curl https://api.smsactivate.uk/emails/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
Returns the order status and available verification result fields.Errors
HTTP 404: order not found. HTTP 503: status could not be refreshed. The response only includes fields available for the order.
DELETE/emails/{order_id}Request cancellation of an email verification order.
API key required.
Parameters
- order_id
- Required path value returned by the purchase response.
Example request
curl -X DELETE https://api.smsactivate.uk/emails/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"Answer
Returns the cancellation result. The refund can remain pending verification.Errors
The order must belong to your account and be eligible for cancellation; see the returned error message for the current order state. If the response says the cancellation was not confirmed yet (HTTP 503), wait a couple of minutes and send the request again.
Webhooks
GET/webhookRead your webhook configuration.
API key required.
Parameters
- None
- No query parameters.
Example request
curl https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"Answer
Returns the saved endpoint configuration. The signing secret is not returned by this read request.Errors
Returns the current configuration for the authenticated account.
PUT/webhookCreate or update your webhook URL.
API key required.
Parameters
- url
- Required public HTTPS URL on port 443. Local and private addresses are rejected.
Example request
curl -X PUT https://api.smsactivate.uk/webhook \
-H "X-API-KEY: YOUR_API_KEY" -H "Content-Type: application/json" \
-d '{"url":"https://example.com/hooks/sms"}'Answer
Returns the saved configuration. On first setup the signing secret is returned once; store it safely.Errors
HTTP 422: URL is not an accepted public HTTPS address.
POST/webhook/rotate-secretReplace the signing secret for your configured webhook.
API key required.
Parameters
- None
- No request body. Configure a webhook first.
Example request
curl -X POST https://api.smsactivate.uk/webhook/rotate-secret -H "X-API-KEY: YOUR_API_KEY"Answer
{ "secret": "NEW_SECRET_SHOWN_ONCE" }Errors
HTTP 404: no webhook is configured. Save the new secret securely; it is returned by this rotation response, not by the read endpoint.
DELETE/webhookRemove your webhook configuration.
API key required.
Parameters
- None
- No request body.
Example request
curl -X DELETE https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"Answer
{ "configured": false }Errors
Removes the webhook configuration for the authenticated account.
POST/webhook/testSend a test event to your configured endpoint.
API key required.
Parameters
- None
- No request body. Configure a webhook first.
Example request
curl -X POST https://api.smsactivate.uk/webhook/test -H "X-API-KEY: YOUR_API_KEY"Answer
{
"delivered": true,
"http_status": 200,
"message": "Your server accepted the test message."
}Errors
HTTP 404: no webhook is configured. A test delivery reports delivered=false when your server does not accept it.
GET/webhook/deliveriesReview up to 50 recent webhook delivery attempts.
API key required.
Parameters
- None
- No query parameters.
Example request
curl https://api.smsactivate.uk/webhook/deliveries -H "X-API-KEY: YOUR_API_KEY"Answer
{
"data": [{ "id": 42, "event_id": "EVENT_ID", "event_type": "sms.received", "status": "success", "attempts": 1, "http_status": 200 }]
}Errors
Returns the 50 most recent HTTP webhook deliveries, newest first.
POST/webhook/deliveries/{id}/retryRetry one of your webhook deliveries now.
API key required.
Parameters
- id
- Required path value of the delivery record.
Example request
curl -X POST https://api.smsactivate.uk/webhook/deliveries/42/retry -H "X-API-KEY: YOUR_API_KEY"Answer
{ "status": "success", "http_status": 200 }Errors
HTTP 404: delivery not found. This endpoint is rate-limited.
Charges and safe retries
The API uses JSON request bodies for POST calls and returns JSON responses. Wallet charges and any eligible refunds follow the rules shown in your dashboard and the current Terms. An uncertain order response may require support review; do not repeat a purchase request until its status is clear.
Rentals, email verification and webhooks
Rentals: GET /rent/services lists availability. POST /rent/order places a rental order. GET /rent/extend/{order_id}/options checks extension options, POST /rent/extend/{order_id} extends an active rental, and POST /rent/cancel/{order_id} requests cancellation. Rentals support durations from 24 to 1,344 hours. A rental cancellation can be accepted while its refund remains pending verification.
Email verification: GET /emails/catalog?site={site} lists available email domains for a verification site; POST /emails/buy purchases an address; GET /emails/history and GET /emails/status/{order_id} check orders; DELETE /emails/{order_id} requests cancellation. The API provides verification addresses, not mailbox accounts. Cancelling before a code arrives refunds the order price to your wallet; the response includes refunded: true. Cancellation is available from 2 minutes after purchase.
Webhooks: configure a public HTTPS endpoint with GET or PUT /webhook. Events are JSON envelopes with id, type, created_at and data. Verify X-SMSActivate-Signature as sha256= followed by the hex HMAC-SHA256 of <timestamp>.<raw request body>, using your webhook secret; read the timestamp from X-SMSActivate-Timestamp and reject timestamps more than five minutes from your server clock. X-SMSActivate-Event-Id repeats the event id. Use POST /webhook/test to check your endpoint and GET /webhook/deliveries to review delivery attempts.
API Links and manually supplied numbers are a separate product path. Their cancellation and refund handling is not the same as standard activations; check the dashboard and Terms before ordering.
Frequently asked questions
How do I authenticate with the API?
Create or rotate a key in your dashboard. Send it in the X-API-KEY header with every request. The key is shown once when you create or rotate it. Keep it server-side. Open your dashboard.
What do I need for my first order?
A service code and a numeric country ID. Find them with GET /services and GET /countries/{service}, then check GET /offers/{service}/{country}. Prices are shown live in the dashboard. See live prices.
How do I read the code that arrives?
Poll GET /status/{order_id} and read sms_code when the status is received. GET /sms/{order_id} is rate-limited; do not use it for routine polling.
What if no SMS arrives?
An eligible activation with no SMS in its 20-minute window is refunded. You can also cancel an eligible active activation 2 to 20 minutes after purchase, before an SMS arrives. If a purchase response is uncertain, do not retry it; contact support. Read the FAQ.
Can I cancel an order?
For eligible active activations: POST /cancel/{order_id}, 2 to 20 minutes after purchase, before an SMS arrives. Rentals use POST /rent/cancel/{order_id}. API Links are final sale.
Does this API send verification codes to my users?
No. It receives codes on a number you order. If you need to send codes to your own users, this API is not the tool for that job.
How do webhooks work?
Set a public HTTPS URL on port 443 with PUT /webhook; the signing secret is returned once. Verify the signature as sha256= HMAC-SHA256 of "
Need help with an integration? Contact support. Manage your key in the dashboard.
