Hướng dẫn cho nhà phát triển

Tài liệu nhà phát triển

SMS Activate cung cấp API tự động hoàn toàn cho người dùng cần thuê số điện thoại tạm thời với số lượng lớn.

Create an API key in your dashboard and send it in the X-API-KEY header to https://api.smsactivate.uk. Order a number with POST /get_numbers using a service code and numeric country ID, then poll GET /status/{order_id} for the code. This API receives codes on a number you order. It does not send codes to your own users.

Bắt đầu

Tạo khóa API trong bảng điều khiển, rồi dùng nó trong yêu cầu phía máy chủ.

Không bao giờ đặt khóa API đang dùng trong mã trình duyệt, ảnh chụp màn hình hoặc kho mã công khai.

Mở khóa API

What does a first integration look like, end to end?

Start with GET /balance. A failed first call usually means the key or header is wrong.

Check what is live before you order: GET /services for service codes, GET /countries/{service} for country IDs, GET /offers/{service}/{country} for current offers. Availability changes; the catalog here is a reference, not a promise of stock. Browse all services.

POST /get_numbers with service and country. The response gives you an order id and a phone number; save the id.

Poll GET /status/{order_id} until the status reads received, then read sms_code.

What happens to an order after you place it?

An order moves through states, and what you can do depends on the state.

Active means the number is waiting for an SMS. While active you can ask for another SMS with POST /resend/{order_id} on a supported activation, or cancel an eligible one with POST /cancel/{order_id}. Cancel only works 2 to 20 minutes after purchase, and only before an SMS arrives.

Received means the code arrived. An expired order ran out its 20-minute window with no SMS and returns its stored status. An eligible activation that receives no SMS is refunded to your wallet. Read the FAQ.

Check the cancel response before you retry anything. If a purchase response is uncertain, do not order again until its status is clear. Contact support.

What mistakes cost first-time integrators the most?

Putting the key in browser code or a public repo. Keep it on a server you control.

Ordering before checking availability. GET /offers/{service}/{country} first saves a failed order.

Polling without a stop. GET /sms/{order_id} is rate-limited, so use GET /status/{order_id} and stop at a final state: received, cancelled, expired or refunded.

Retrying a purchase that came back uncertain. A 503 can mean the order went through and the answer got lost. Contact support.

Reusing an idempotency key for a different purchase. Use the same key only to check the outcome of the same purchase request.

Assuming the code will be accepted. Acceptance is the receiving service's decision, not ours.

Buying a one-time activation for an account that will ask for a code again - rentals are for that: 24 to 1,344 hours on the same number.

1. Xác thực

Lấy khóa API trong phần cài đặt bảng điều khiển của bạn. Mọi yêu cầu API phải kèm theo header:

X-API-KEY: your_api_key_here

2. URL gốc

Mọi yêu cầu API đều dùng URL gốc này:

https://api.smsactivate.uk

Ví dụ yêu cầu

Yêu cầu này đặt đơn và có thể trừ tiền trong ví của bạn. Hãy thay dịch vụ và quốc gia mẫu bằng lựa chọn khả dụng cho tài khoản của bạn.

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

Tài liệu tham chiếu API

Mỗi thao tác liệt kê đầu vào, một yêu cầu mẫu, một phản hồi tiêu biểu và các lỗi chính. Các tích hợp API hiện có có thể tiếp tục dùng endpoint cũ; các endpoint theo sản phẩm bên dưới được khuyến nghị cho tích hợp mới. Ví dụ dùng ID và giá trị giả định. Hãy gửi các yêu cầu đã xác thực từ máy chủ của bạn với header khóa API.

Bắt đầu tại đây

GET/balanceXem số dư ví hiện tại của bạn.

Cần khóa API.

Tham số

Không có
Không có tham số truy vấn.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/balance -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{ "balance": "10.0000" }

Errors

Endpoint trả về số dư hiện tại của tài khoản đã xác thực.

Nhận và quản lý số

POST/get_numbersĐặt đơn kích hoạt.

Cần khóa API.

Tham số

service
Chuỗi bắt buộc. Mã dịch vụ, ví dụ tg.
country
Số nguyên bắt buộc. ID quốc gia dạng số.
operator
Chuỗi tùy chọn. Mặc định là any.
max_price
Số tùy chọn. Giá tối đa; maxPrice cũng được chấp nhận.
min_price
Số tùy chọn; minPrice cũng được chấp nhận.
any_price
Boolean tùy chọn; anyPrice cũng được chấp nhận.
product
Tùy chọn: standard (mặc định) hoặc api_links. API Links là hàng tồn kho mua đứt, không hoàn tiền.
idempotency_key
UUID tùy chọn cho kích hoạt tiêu chuẩn. Chỉ dùng lại cùng khóa cho cùng yêu cầu mua khi đang kiểm tra kết quả của nó.
quantity
Số nguyên tùy chọn từ 1 đến 100 cho đơn tồn kho API Links; mặc định là 1. Đơn kích hoạt tiêu chuẩn chỉ gồm một số.

Ví dụ yêu cầu

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

Phản hồi

{
  "id": "ORDER_ID",
  "phone": "10000000000",
  "price": "0.2500",
  "balance_remaining": "9.7500"
}

Errors

HTTP 400: lựa chọn không khả dụng, giới hạn giá hoặc không đủ số dư. HTTP 409: một đơn trước đó vẫn đang được kiểm tra. HTTP 503: lỗi tạm thời hoặc đơn chưa rõ kết quả; nếu phản hồi nói cần đối soát, đừng thử lại và hãy liên hệ hỗ trợ.

GET/sms/{order_id}Yêu cầu kiểm tra lại trạng thái của đơn đang hoạt động.

Cần khóa API. Endpoint này có giới hạn tần suất.

Tham số

order_id
Giá trị đường dẫn bắt buộc, trả về khi đơn được tạo.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/sms/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "status": "received",
  "sms_code": "123456",
  "raw_sms": "Your verification code is 123456"
}

Errors

HTTP 400: không thể kiểm tra SMS cho đơn này. HTTP 404: không tìm thấy đơn. HTTP 502: lỗi kiểm tra tạm thời. Đơn đã hết hạn trả về trạng thái đã lưu mà không kiểm tra ngoài lại.

GET/status/{order_id}Xem trạng thái đơn và các SMS đã nhận.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc, trả về khi đơn được tạo.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "status": "received",
  "sms_code": "123456",
  "raw_sms": "Your verification code is 123456"
}

Errors

Phản hồi chỉ giới hạn trong đơn của tài khoản đã xác thực. Nếu tra cứu trạng thái thất bại, API trả về lỗi; hãy kiểm tra ID đơn và thử lại sau nếu dịch vụ tạm thời không khả dụng.

POST/resend/{order_id}Yêu cầu thêm một SMS cho lượt kích hoạt đang hoạt động được hỗ trợ.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc. Không có nội dung yêu cầu.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/resend/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{ "message": "Resend request successful. Waiting for new SMS." }

Errors

HTTP 400: gửi lại không được chấp nhận hoặc đơn đã hết hạn. HTTP 409: không thể gửi lại cho đơn này. HTTP 500: không hoàn tất được việc gửi lại.

POST/cancel/{order_id}Yêu cầu hủy lượt kích hoạt đủ điều kiện.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc. Không có nội dung yêu cầu.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "message": "Number cancelled and balance refunded",
  "refunded_amount": "0.2500",
  "new_balance": "10.0000"
}

Errors

Chỉ có thể hủy các lượt kích hoạt đang hoạt động đủ điều kiện, từ 2 đến 20 phút sau khi mua và trước khi có SMS. Đơn thuê dùng /rent/cancel/{order_id}; API Links là mua đứt. Yêu cầu hủy không đủ điều kiện hoặc chưa xác nhận sẽ trả về lỗi. Hãy đọc phản hồi hủy trước khi thử lại.

GET/reactivate/{order_id}/optionsKiểm tra giá và chi tiết kích hoạt lại hiện tại.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc của đơn gốc.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/reactivate/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "price": 0.25,
  "duration": 20,
  "phone": "10000000000",
  "service": "tg",
  "country": 2
}

Errors

HTTP 400: không hỗ trợ hoặc không thể kích hoạt lại. HTTP 409: không thể kích hoạt lại cho đơn này. HTTP 503: không xác nhận được giá hiện tại hợp lệ.

POST/reactivate/{order_id}Kích hoạt lại một lượt kích hoạt đủ điều kiện theo giá hiện tại.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc của đơn gốc. Không có nội dung yêu cầu.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/reactivate/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "message": "Number reactivated successfully.",
  "id": "NEW_ORDER_ID",
  "phone": "10000000000",
  "price": 0.25,
  "balance_remaining": 9.75
}

Errors

HTTP 400: không hỗ trợ kích hoạt lại hoặc ví không đủ số dư. HTTP 409: không khả dụng cho đơn này. HTTP 503: không xác nhận được kết quả; hãy liên hệ hỗ trợ trước khi thử lại.

GET/orders/{order_id}Xem chi tiết một đơn của bạn.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc, trả về khi đơn được tạo.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/orders/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

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: không tìm thấy đơn hoặc đơn không thuộc tài khoản của bạn.

Chọn dịch vụ, quốc gia và giá

Dịch vụTìm trong danh mục dịch vụ theo tên hoặc mã. Tình trạng sẵn có có thể thay đổi; hãy kiểm tra endpoint trực tiếp trước khi đặt đơn.
Tên / mã1,638 mục trong danh mục
  • 163COMwp
  • 11688hn
  • 11and1ahs
  • 11xbetwj
  • 224bettinglh
  • 22dehandsapd
  • 22domainserc
  • 22ememainblx
  • 22ГИСbcg
  • 332Redqi
  • 3360Krediayo
  • 33Funauw
  • 44FunLitehk
  • 5500pxfpx
  • 551exchboc
  • 551exchangeexc
  • 77-Elevenaws
  • 8888casinoll
  • 9999 Mdbrv
  • 99acresfw
  • 99appki
  • 999Gameqkb
  • 999k Outletamq
  • AA23acv
  • AA9Agn
  • AAadharhra
  • Abastece-aíanb
  • AAbbottags
  • Ace2Threerh
  • AAcimacim
  • AAckoamf
  • AdaKamiko
  • AAdaModalbdo
  • AAdanibq
  • AAdidasan
  • AAditya Birlaqff
  • AAdmiralBetbst
  • AAdobebyh
  • Advertsagw
  • AAEG Presentsrsn
  • AAffirmbow
  • AAfreecaTVaip
  • AGIBANKsa
  • AAgodaag
  • AgriDevelopcs
  • AAgroinformqu
  • AAhlanbsm
  • AAiqfomebbi
  • AAir Milesbsy
  • AAirba Freshbnp
  • Airbnbuk
  • AAirtaskerbyd
  • Airtelzl
  • AAirtimeacy
  • AISwv
  • AAIS PLAYaxs
  • Aitujj
  • Akudorf
  • Akulakutm
  • Alchemyaav
  • Alfabt
  • Alfagiftbn
  • AAlfamidibgt
  • AAlFursanbxr
  • AAlgidalp
  • AAlibabaab
  • AliExpresshx
  • AAlignableaul
  • Alipay/Alibaba/1688hw
  • All Accessajy
  • Allegroyn
  • AlloBanknh
  • AAllofreshaeo
  • AAltyn-ial
  • AAmap 高德地图btx
  • AAmarthaFinbsv
  • Amasiayo
  • AAmaze Super Appbzk
  • Amazonam
  • AAme Digitalafi
  • AAmwayaee
  • AAngel Oneaha
  • Ankamaalg
  • AAnnoncelightbyw
  • Any Otherot
  • AOLpm
  • ApostaGanhaml
  • Applewx
  • Apteka Aprelaeh
  • AptekaRUgk
  • AAptekiPlusrq
  • AAR Lensaco
  • ArenaPlusabt
  • AArgentamo
  • AAri10blq
  • AASAASbqr
  • AAsdahs
  • AAsiaMilesajp
  • AAsianDatingayb
  • AAskablebpi
  • AAspirationaptn
  • Astra Otoshopafd
  • AstraPayaem
  • Astropaygr
  • AASVLAbuj
  • AAti Subhl
  • AAtlas Earthawq
  • AAtlasbusatb
  • AttaPollanl
  • AAUBANKdu
  • Auchanst
  • AAudibleaud
  • AAukroaox
  • AAuthentifyccy
  • AAuthor24kd
  • AAutodeskbbl
  • Autoruaej
  • AAv100proajl
  • AAvitoav
  • AVONff

Tình trạng sẵn có trực tiếp và phản hồi mẫu:

GET https://api.smsactivate.uk/services
{
  "services": ["tg", "wa", "go"],
  "providers": { "source-counts": "per active catalog" },
  "generated_at": "ISO 8601 timestamp"
}

Danh mục cung cấp tên và mã để tra cứu. Tình trạng sẵn có là trực tiếp và có thể khác danh sách này; JSON này cho thấy cấu trúc phản hồi, không phải tồn kho hiện tại.

Quốc giaID quốc gia dạng số từ danh mục trong bảng điều khiển. Không có endpoint API chung liệt kê quốc gia cho kích hoạt tiêu chuẩn.
Quốc gia / ID dạng số206 mục trong danh mục
  • 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

Cấu trúc phản hồi ưu đãi cho một dịch vụ và quốc gia:

[
  { "name": "any", "offers": [{ "price": 0.25, "count": 4 }] }
]

ID danh mục xác định lựa chọn quốc gia, không đảm bảo có ưu đãi trực tiếp. Hãy kiểm tra /offers/{service}/{country} để biết tình trạng sẵn có.

GET/servicesKiểm tra tình trạng sẵn có hiện tại của dịch vụ.

Công khai - không cần khóa API.

Tham số

Không có
Endpoint này không nhận tham số truy vấn.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/services

Phản hồi

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

Tình trạng sẵn có có thể thay đổi. Hãy kiểm tra endpoint trực tiếp và /offers/{service}/{country} trước khi đặt đơn.

GET/countries/{service}Liệt kê ID quốc gia hiện có số cho một dịch vụ.

Công khai - không cần khóa API.

Tham số

service
Mã dịch vụ bắt buộc, chẳng hạn tg.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/countries/tg

Phản hồi

{ "countries": [2, 6, 187] }

Errors

ID quốc gia khớp với danh mục Quốc gia bên dưới. Tình trạng sẵn có thay đổi; hãy kiểm tra /offers/{service}/{country} trước khi đặt. Endpoint này có giới hạn tần suất.

GET/offers/{service}/{country}/deliveryXem tỷ lệ gửi mã gần đây cho từng mức giá.

Công khai - không cần khóa API.

Tham số

service
Mã dịch vụ bắt buộc, chẳng hạn tg.
country
ID quốc gia dạng số bắt buộc.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/offers/tg/2/delivery

Phản hồi

{
  "window_days": 30,
  "tiers": { "0.2500": { "orders": 120, "codes": 108, "delivery_pct": 90, "best": true } }
}

Errors

HTTP 400: dịch vụ hoặc quốc gia không hợp lệ. Các mức không có mã đã gửi sẽ không được liệt kê. Kết quả được lưu đệm khoảng 5 phút và bao gồm window_days ngày gần nhất. Endpoint này có giới hạn tần suất.

GET/operators?service={service}&country={country}Liệt kê nhà mạng khả dụng cho một dịch vụ và quốc gia.

Công khai - không cần khóa API.

Tham số

service
Mã dịch vụ bắt buộc, chẳng hạn tg.
country
ID quốc gia dạng số bắt buộc.

Ví dụ yêu cầu

curl 'https://api.smsactivate.uk/operators?service=tg&country=2'

Phản hồi

[
  { "name": "any", "localName": "Any Operator" },
  { "name": "example", "localName": "Example operator" }
]

Errors

Danh sách phụ thuộc vào quốc gia đã chọn và tình trạng sẵn có hiện tại. Cả service và country đều bắt buộc; giá trị thiếu hoặc không hợp lệ trả về HTTP 422.

GET/offers/{service}/{country}Kiểm tra ưu đãi cho một cặp dịch vụ và quốc gia.

Công khai - không cần khóa API.

Tham số

service
Giá trị đường dẫn bắt buộc. Dùng mã dịch vụ do /services trả về, chẳng hạn tg.
country
Giá trị đường dẫn bắt buộc. ID quốc gia dạng số; dùng danh mục quốc gia trong bảng điều khiển cho kích hoạt tiêu chuẩn. Không có endpoint API chung liệt kê các ID quốc gia này.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/offers/tg/2

Phản hồi

[
  {
    "name": "any",
    "offers": [{ "price": "0.2500", "count": 4 }]
  }
]

Errors

Cặp không được hỗ trợ hoặc không khả dụng có thể trả về danh sách rỗng. Dữ liệu ưu đãi được lưu đệm; khi chưa có trong bộ đệm, phản hồi có thể chậm hơn trong lúc kiểm tra tình trạng.

Xem hoạt động trước đây

GET/ordersDuyệt lịch sử đơn của bạn, mới nhất trước.

Cần khóa API.

Tham số

page
Số trang tùy chọn; mặc định là 1.
per_page
Kích thước trang tùy chọn; mặc định là 20 và tối đa 100.
status
Tùy chọn: active, completed (hoặc received), cancelled, expired, refunded. Bỏ trống hoặc dùng all để gồm mọi trạng thái.
search
Tìm kiếm số điện thoại tùy chọn.
category
Tùy chọn: rents, links hoặc numbers.

Ví dụ yêu cầu

curl 'https://api.smsactivate.uk/orders?page=2&per_page=100&status=received&category=numbers' -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

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

Theo next_page_url cho đến khi nó là null. page mặc định là 1; per_page mặc định là 20 và giá trị được giới hạn trong 1–100. status chấp nhận active, completed/received, cancelled, expired hoặc refunded; all hoặc giá trị không rõ sẽ không lọc status. search khớp với số điện thoại. category chấp nhận rents, links hoặc numbers; danh mục không rõ bị bỏ qua. Lịch sử lớn cần nhiều yêu cầu trang.

Thuê số

GET/rent/servicesKiểm tra dịch vụ thuê số cho một quốc gia và thời hạn.

Cần khóa API.

Tham số

country
ID quốc gia dạng số nguyên tùy chọn; mặc định là 2.
duration
Số giờ tùy chọn; mặc định là 24. Phạm vi cho phép: 24–1.344 giờ.

Ví dụ yêu cầu

curl 'https://api.smsactivate.uk/rent/services?country=2&duration=24' -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

Returns rental availability, with service codes and current prices for the selected country and duration.

Errors

HTTP 400: không có số thuê cho lựa chọn này. HTTP 422: quốc gia hoặc thời hạn không hợp lệ. HTTP 503: danh mục thuê số tạm thời không khả dụng.

POST/rent/orderĐặt đơn thuê số.

Cần khóa API.

Tham số

service
Mã dịch vụ bắt buộc (chuỗi).
country
ID quốc gia bắt buộc (số nguyên).
duration
Số giờ bắt buộc, 24–1.344.
operator
Chuỗi tùy chọn; mặc định là any.

Ví dụ yêu cầu

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

Phản hồi

{
  "message": "Number rented successfully.",
  "id": "ORDER_ID",
  "phone": "10000000000",
  "price": 2.50,
  "balance_remaining": 7.50
}

Errors

HTTP 400: yêu cầu không hợp lệ hoặc không đủ số dư. HTTP 409: không có số thuê khả dụng. HTTP 503: kết quả đang chờ xem xét; đừng thử lại cho đến khi hỗ trợ kiểm tra đơn.

POST/rent/cancel/{order_id}Yêu cầu hủy đơn thuê đủ điều kiện.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc. Không có nội dung yêu cầu.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/rent/cancel/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

Returns the cancellation result. Refunds may remain pending verification after cancellation is accepted.

Errors

Việc hủy chỉ áp dụng cho đơn thuê đang hoạt động đủ điều kiện, từ 2 đến 20 phút sau khi mua và trước khi có SMS. HTTP 404: không tìm thấy đơn thuê. HTTP 409: đơn thuê không đủ điều kiện. Nếu được chấp nhận, khoản hoàn tiền có thể chờ xác minh.

GET/rent/extend/{order_id}/optionsKiểm tra các tùy chọn gia hạn khả dụng cho một đơn thuê.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc của đơn thuê.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/rent/extend/ORDER_ID/options -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "options": [{ "duration": 24, "price": 2.50 }],
  "expires_at": "2026-10-06T12:00:00Z"
}

Errors

HTTP 404: không tìm thấy đơn thuê. HTTP 409: đơn thuê không đủ điều kiện (gia hạn mở sau 20 phút đầu, đơn thuê phải ở trạng thái active hoặc received, hoặc lần gia hạn trước đang chờ xem xét). HTTP 503: gia hạn tạm thời không khả dụng hoặc không tải được tùy chọn; hãy thử lại sau. Endpoint này có giới hạn tần suất.

POST/rent/extend/{order_id}Gia hạn đơn thuê đang hoạt động.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc của đơn thuê.
duration
Bắt buộc: 24, 72, 168, 336, 720, 1.440, 2.160 hoặc 4.320 giờ. Chọn từ phản hồi tùy chọn hiện tại.
expected_price
Số bắt buộc sao chép từ phản hồi tùy chọn hiện tại.
Idempotency-Key
Header yêu cầu UUID v4 bắt buộc. Chỉ dùng lại để thử lại an toàn cùng một lần gia hạn.

Ví dụ yêu cầu

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

Phản hồi

{
  "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: thiếu hoặc không hợp lệ duration, expected_price hoặc Idempotency-Key. HTTP 409: đơn thuê không đủ điều kiện, thời hạn hoặc giá không còn được cung cấp, hoặc Idempotency-Key đã được dùng. HTTP 202: gia hạn đang chờ xem xét; đừng thử lại bằng khóa idempotency mới. HTTP 503: không xác nhận được gia hạn; hãy liên hệ hỗ trợ.

Xác minh email

GET/emails/catalog?site={site}Liệt kê tên miền địa chỉ xác minh khả dụng cho một trang web.

Cần khóa API.

Tham số

site
Tên miền trang web bắt buộc, ví dụ example.com.

Ví dụ yêu cầu

curl 'https://api.smsactivate.uk/emails/catalog?site=example.com' -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

[{ "name": "sample-domain.test", "price": 0.10, "stock": 5 }]

Errors

HTTP 422: giá trị site không hợp lệ. HTTP 503: danh mục email tạm thời không khả dụng.

POST/emails/buyMua một địa chỉ xác minh.

Cần khóa API.

Tham số

site
Tên miền trang web bắt buộc.
domain
Tên miền bắt buộc, chọn từ phản hồi danh mục hiện tại.

Ví dụ yêu cầu

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

Phản hồi

Returns an order object and balance_remaining when the purchase is confirmed.

Errors

HTTP 400: ví không đủ số dư. HTTP 409: tên miền hết hàng. HTTP 503: giao dịch mua đang chờ xem xét; đừng thử lại cho đến khi hỗ trợ kiểm tra đơn.

POST/emails/{order_id}/reorderĐặt lại cùng địa chỉ sau khi đơn trước đã kết thúc.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc của đơn email đã kết thúc (dạng số). Không có nội dung yêu cầu.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/emails/ORDER_ID/reorder -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

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: không tìm thấy đơn. HTTP 409: đơn trước chưa kết thúc, đang có đơn đặt lại, hoặc hiện không thể đặt lại địa chỉ này. HTTP 503: xác minh email tạm thời không khả dụng. Endpoint này có giới hạn tần suất.

GET/emails/historyLiệt kê các đơn xác minh email của bạn.

Cần khóa API.

Tham số

page
Số trang tùy chọn; mặc định là 1.
per_page
Kích thước trang tùy chọn; mặc định là 20 và tối đa 50.

Ví dụ yêu cầu

curl 'https://api.smsactivate.uk/emails/history?page=1&per_page=20' -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

Returns paginated order data and page metadata.

Errors

Nếu bảng đơn email không khả dụng, API trả về mảng data rỗng.

GET/emails/status/{order_id}Xem hoặc làm mới một đơn xác minh.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc do phản hồi mua hàng trả về.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/emails/status/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

Returns the order status and available verification result fields.

Errors

HTTP 404: không tìm thấy đơn. HTTP 503: không làm mới được trạng thái. Phản hồi chỉ gồm các trường có sẵn cho đơn.

DELETE/emails/{order_id}Yêu cầu hủy đơn xác minh email.

Cần khóa API.

Tham số

order_id
Giá trị đường dẫn bắt buộc do phản hồi mua hàng trả về.

Ví dụ yêu cầu

curl -X DELETE https://api.smsactivate.uk/emails/ORDER_ID -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

Returns the cancellation result. The refund can remain pending verification.

Errors

Đơn phải thuộc tài khoản của bạn và đủ điều kiện hủy; xem thông báo lỗi trả về để biết trạng thái đơn hiện tại. Nếu phản hồi nói việc hủy chưa được xác nhận (HTTP 503), hãy chờ vài phút rồi gửi lại yêu cầu.

Webhook

GET/webhookXem cấu hình webhook của bạn.

Cần khóa API.

Tham số

Không có
Không có tham số truy vấn.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

Returns the saved endpoint configuration. The signing secret is not returned by this read request.

Errors

Trả về cấu hình hiện tại của tài khoản đã xác thực.

PUT/webhookTạo hoặc cập nhật URL webhook của bạn.

Cần khóa API.

Tham số

url
URL HTTPS công khai bắt buộc trên cổng 443. Địa chỉ cục bộ và riêng tư bị từ chối.

Ví dụ yêu cầu

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

Phản hồi

Returns the saved configuration. On first setup the signing secret is returned once; store it safely.

Errors

HTTP 422: URL không phải địa chỉ HTTPS công khai được chấp nhận.

POST/webhook/rotate-secretThay secret ký của webhook đã cấu hình.

Cần khóa API.

Tham số

Không có
Không có nội dung yêu cầu. Hãy cấu hình webhook trước.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/webhook/rotate-secret -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{ "secret": "NEW_SECRET_SHOWN_ONCE" }

Errors

HTTP 404: chưa cấu hình webhook. Hãy lưu secret mới an toàn; nó được trả về bởi phản hồi xoay vòng này, không phải bởi endpoint đọc.

DELETE/webhookXóa cấu hình webhook của bạn.

Cần khóa API.

Tham số

Không có
Không có nội dung yêu cầu.

Ví dụ yêu cầu

curl -X DELETE https://api.smsactivate.uk/webhook -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{ "configured": false }

Errors

Xóa cấu hình webhook của tài khoản đã xác thực.

POST/webhook/testGửi sự kiện thử đến endpoint đã cấu hình.

Cần khóa API.

Tham số

Không có
Không có nội dung yêu cầu. Hãy cấu hình webhook trước.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/webhook/test -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "delivered": true,
  "http_status": 200,
  "message": "Your server accepted the test message."
}

Errors

HTTP 404: chưa cấu hình webhook. Lần gửi thử báo delivered=false khi máy chủ của bạn không chấp nhận.

GET/webhook/deliveriesXem tối đa 50 lần gửi webhook gần đây.

Cần khóa API.

Tham số

Không có
Không có tham số truy vấn.

Ví dụ yêu cầu

curl https://api.smsactivate.uk/webhook/deliveries -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{
  "data": [{ "id": 42, "event_id": "EVENT_ID", "event_type": "sms.received", "status": "success", "attempts": 1, "http_status": 200 }]
}

Errors

Trả về 50 lần gửi webhook HTTP gần nhất, mới nhất trước.

POST/webhook/deliveries/{id}/retryThử lại ngay một lần gửi webhook của bạn.

Cần khóa API.

Tham số

id
Giá trị đường dẫn bắt buộc của bản ghi gửi.

Ví dụ yêu cầu

curl -X POST https://api.smsactivate.uk/webhook/deliveries/42/retry -H "X-API-KEY: YOUR_API_KEY"

Phản hồi

{ "status": "success", "http_status": 200 }

Errors

HTTP 404: không tìm thấy lần gửi. Endpoint này có giới hạn tần suất.

4. Thanh toán

Số dư của bạn bị trừ khi bạn đặt đơn. Các kích hoạt không nhận được SMS trong khung 20 phút sẽ được hoàn tiền vào số dư. Quy tắc hủy và hoàn tiền khác nhau đối với thuê số, email và API Links.

5. Hủy đơn và hoàn tiền

Với đơn đặt số (kích hoạt), bạn có thể yêu cầu hủy sau 2 phút đầu tiên và trước khi hết khung kích hoạt 20 phút, chỉ khi chưa có SMS nào đến. Các yêu cầu hủy đủ điều kiện và đã được xác nhận sẽ hoàn phí đơn hàng vào số dư của bạn.

Không thể hủy kích hoạt sau khi SMS đã đến hoặc sau khi khung kích hoạt kết thúc. Nếu một kích hoạt đủ điều kiện không nhận được SMS trong khung 20 phút, phí đơn hàng sẽ được hoàn vào số dư của bạn.

Số thuê có thể được hủy trong cùng khung từ 2 đến 20 phút, miễn là chưa có mã nào đến. Việc hoàn tiền cho số thuê đang chờ xác minh và không tự động.

Số hàng loạt, API Links và đơn email không được hoàn tiền sau khi đã giao, trừ khi bảng điều khiển nêu khác.

Nếu không thể xác nhận việc hủy, hãy liên hệ bộ phận hỗ trợ trước khi thử lại.

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 "." and reject timestamps more than five minutes old. Test with POST /webhook/test.

Cần giới hạn cao hơn hoặc tích hợp tùy chỉnh? Liên hệ đội ngũ của chúng tôi. hoặc mở bảng điều khiển.