開発者ガイド

開発者ドキュメント

SMS Activateは、一時電話番号を大規模にレンタルしたいプログラマティックユーザー向けに、完全自動化APIを提供します。

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.

はじめに

ダッシュボードでAPIキーを作成し、サーバー側のリクエストで使用してください。

本番のAPIキーを、ブラウザのコード、スクリーンショット、公開リポジトリに絶対に置かないでください。

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

アカウントダッシュボードの設定からAPIキーを取得してください。すべてのAPIリクエストには次のヘッダーが必要です:

X-API-KEY: your_api_key_here

2. ベースURL

すべてのAPIリクエストは次のベースURLを使用します:

https://api.smsactivate.uk

リクエスト例

このリクエストは注文を作成し、ウォレットに課金される場合があります。例のサービスと国を、アカウントで利用可能な選択に置き換えてください。

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リファレンス

各操作には、入力、リクエスト例、代表的なレスポンス、主なエラーが記載されています。既存のAPI連携は従来のエンドポイントを引き続き使用できます。新規連携には、以下の商品ベースのエンドポイントを推奨します。例ではプレースホルダーのIDと値を使用しています。認証済みリクエストは、サーバーからAPIキーのヘッダー付きで送信してください。

はじめに

GET/balanceウォレットの現在の残高を取得します。

APIキーが必要です。

パラメータ

なし
クエリパラメータはありません。

リクエスト例

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

レスポンス

{ "balance": "10.0000" }

Errors

このエンドポイントは、認証済みアカウントの現在の残高を返します。

番号の取得と管理

POST/get_numbersアクティベーション注文を作成します。

APIキーが必要です。

パラメータ

service
必須の文字列。サービスコード。例: tg。
country
必須の整数。数値の国ID。
operator
任意の文字列。デフォルトは any。
max_price
任意の数値。最大価格。maxPrice も使用できます。
min_price
任意の数値。minPrice も使用できます。
any_price
任意のブール値。anyPrice も使用できます。
product
任意: standard(デフォルト)または api_links。API Linksは返金不可の在庫購入です。
idempotency_key
標準アクティベーション用の任意のUUID。結果を確認している同じ購入リクエストにのみ、同じキーを再利用してください。
quantity
API Links在庫注文用の1〜100の任意の整数。デフォルトは1。標準アクティベーション注文は1番号です。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: 選択が利用不可、価格上限、または残高不足。HTTP 409: 以前の注文がまだ確認中です。HTTP 503: 一時的な障害または結果不明の注文。レスポンスに照合が必要と示されている場合は、再試行せずサポートに連絡してください。

GET/sms/{order_id}アクティブな注文のステータスを再確認するようリクエストします。

APIキーが必要です。このエンドポイントにはレート制限があります。

パラメータ

order_id
注文作成時に返される必須のパス値。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: この注文ではSMSの確認ができません。HTTP 404: 注文が見つかりません。HTTP 502: 一時的な確認の失敗。期限切れの注文は、新たな外部確認なしで保存済みのステータスを返します。

GET/status/{order_id}注文のステータスと受信したSMSを取得します。

APIキーが必要です。

パラメータ

order_id
注文作成時に返される必須のパス値。

リクエスト例

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

レスポンス

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

Errors

レスポンスは認証済みアカウントの注文に限定されます。ステータスの取得に失敗した場合、APIはエラーを返します。注文IDを確認し、サービスが一時的に利用できない場合は後で再試行してください。

POST/resend/{order_id}対応するアクティブなアクティベーションに対して、もう一度SMSをリクエストします。

APIキーが必要です。

パラメータ

order_id
必須のパス値。リクエストボディなし。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: 再送が受け付けられないか、注文の期限が切れています。HTTP 409: この注文では再送を利用できません。HTTP 500: 再送を完了できませんでした。

POST/cancel/{order_id}キャンセル可能なアクティベーションのキャンセルをリクエストします。

APIキーが必要です。

パラメータ

order_id
必須のパス値。リクエストボディなし。

リクエスト例

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

レスポンス

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

Errors

キャンセルは、購入から2〜20分後でSMSが届く前の、対象のアクティブなアクティベーションに限り可能です。レンタルは /rent/cancel/{order_id} を使用します。API Linksは返金不可です。対象外または未確認のキャンセルはエラーを返します。再試行する前にキャンセルのレスポンスを確認してください。

GET/reactivate/{order_id}/options現在の再アクティベーション価格と詳細を確認します。

APIキーが必要です。

パラメータ

order_id
元の注文の必須のパス値。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: 再アクティベーションは未対応か利用できません。HTTP 409: この注文では再アクティベーションを利用できません。HTTP 503: 有効な現在の価格を確認できませんでした。

POST/reactivate/{order_id}キャンセル可能なアクティベーションを現在の価格で再アクティベートします。

APIキーが必要です。

パラメータ

order_id
元の注文の必須のパス値。リクエストボディなし。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: 再アクティベーションは未対応か、ウォレット残高が不足しています。HTTP 409: この注文では利用できません。HTTP 503: 結果を確認できませんでした。再試行する前にサポートに連絡してください。

GET/orders/{order_id}自分の注文の詳細を取得します。

APIキーが必要です。

パラメータ

order_id
注文作成時に返される必須のパス値。

リクエスト例

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

レスポンス

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: 注文が見つからないか、あなたのアカウントの注文ではありません。

サービス、国、価格の選択

サービス名前またはコードでサービスカタログを検索します。在庫状況は変わることがあるため、注文前にライブのエンドポイントを確認してください。
名前 / コード1,638 件のカタログエントリ
  • 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

ライブの在庫状況とレスポンス例:

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

カタログは検索用の名前とコードを提供します。在庫状況はリアルタイムで、この一覧と異なる場合があります。このJSONはレスポンスの形式を示すもので、現在の在庫ではありません。

国ダッシュボードカタログの数値の国IDです。標準アクティベーション向けの汎用の国一覧APIエンドポイントはありません。
国 / 数値ID206 件のカタログエントリ
  • 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

1つのサービスと国のオファーのレスポンス形式:

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

カタログIDは国の選択肢を識別するもので、ライブのオファーを保証するものではありません。 在庫状況は /offers/{service}/{country} で確認してください。

GET/servicesサービスの現在の在庫状況を確認します。

公開 - APIキーは不要です。

パラメータ

なし
このエンドポイントはクエリパラメータを受け付けません。

リクエスト例

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

レスポンス

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

在庫状況は変わることがあります。注文前にライブのエンドポイントと /offers/{service}/{country} を確認してください。

GET/countries/{service}サービスで現在番号がある国のID一覧を取得します。

公開 - APIキーは不要です。

パラメータ

service
必須のサービスコード。例: tg。

リクエスト例

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

レスポンス

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

Errors

国IDは下の国カタログと一致します。在庫状況は変わります。注文前に /offers/{service}/{country} を確認してください。このエンドポイントにはレート制限があります。

GET/offers/{service}/{country}/delivery価格帯ごとの最近のコード受信率を確認します。

公開 - APIキーは不要です。

パラメータ

service
必須のサービスコード。例: tg。
country
必須の数値の国ID。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: 無効なサービスまたは国。配信済みコードのない価格帯は一覧に含まれません。結果は約5分間キャッシュされ、直近の window_days 日分が対象です。このエンドポイントにはレート制限があります。

GET/operators?service={service}&country={country}サービスと国で利用可能なオペレーター一覧を取得します。

公開 - APIキーは不要です。

パラメータ

service
必須のサービスコード。例: tg。
country
必須の数値の国ID。

リクエスト例

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

レスポンス

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

Errors

一覧は選択した国と現在の在庫状況によって変わります。service と country の両方が必須で、欠落または無効な値はHTTP 422を返します。

GET/offers/{service}/{country}1つのサービスと国の組み合わせのオファーを確認します。

公開 - APIキーは不要です。

パラメータ

service
必須のパス値。/services が返すサービスコードを使用します。例: tg。
country
必須のパス値。数値の国ID。標準アクティベーションにはダッシュボードの国カタログを使用してください。これらの国IDを一覧表示する汎用APIエンドポイントはありません。

リクエスト例

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

レスポンス

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

Errors

未対応または利用できない組み合わせは空のリストを返すことがあります。オファーデータはキャッシュされており、キャッシュにない場合は在庫確認のため時間がかかることがあります。

過去のアクティビティの確認

GET/orders注文履歴を新しい順に閲覧します。

APIキーが必要です。

パラメータ

page
任意のページ番号。デフォルトは1。
per_page
任意のページサイズ。デフォルトは20、上限は100。
status
任意: active、completed(または received)、cancelled、expired、refunded。すべてのステータスを含めるには省略するか all を使用します。
search
任意の電話番号検索。
category
任意: rents、links、または numbers。

リクエスト例

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

レスポンス

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

next_page_url が null になるまで辿ってください。page のデフォルトは1、per_page のデフォルトは20で、値は1〜100に制限されます。status は active、completed/received、cancelled、expired、refunded を受け付けます。all または不明な値は status を絞り込みません。search は電話番号に一致します。category は rents、links、numbers を受け付け、不明なカテゴリは無視されます。履歴が多い場合は複数回のページリクエストが必要です。

レンタル

GET/rent/services国と期間ごとのレンタルサービスを確認します。

APIキーが必要です。

パラメータ

country
任意の整数の国ID。デフォルトは2。
duration
任意の時間数。デフォルトは24。許可範囲: 24〜1,344時間。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: 選択に対して利用可能なレンタル番号がありません。HTTP 422: 無効な国または期間。HTTP 503: レンタルカタログが一時的に利用できません。

POST/rent/orderレンタル注文を作成します。

APIキーが必要です。

パラメータ

service
必須のサービスコード(文字列)。
country
必須の国ID(整数)。
duration
必須の時間数、24〜1,344。
operator
任意の文字列。デフォルトは any。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: 無効なリクエストまたは残高不足。HTTP 409: 利用可能なレンタルがありません。HTTP 503: 結果は審査待ちです。サポートが注文を確認するまで再試行しないでください。

POST/rent/cancel/{order_id}キャンセル可能なレンタルのキャンセルをリクエストします。

APIキーが必要です。

パラメータ

order_id
必須のパス値。リクエストボディなし。

リクエスト例

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

レスポンス

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

Errors

キャンセルは、購入から2〜20分後でSMSが届く前の、対象のアクティブなレンタルに限られます。HTTP 404: レンタルが見つかりません。HTTP 409: レンタルは対象外です。受理された場合、返金は確認待ちのままになることがあります。

GET/rent/extend/{order_id}/optionsレンタルで利用可能な延長オプションを確認します。

APIキーが必要です。

パラメータ

order_id
レンタルの必須のパス値。

リクエスト例

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

レスポンス

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

Errors

HTTP 404: レンタルが見つかりません。HTTP 409: レンタルは対象外です(延長は最初の20分後に開始され、レンタルは active または received である必要があり、以前の延長が審査待ちでないことが必要です)。HTTP 503: 延長が一時的に利用できないか、オプションを読み込めませんでした。後で再試行してください。このエンドポイントにはレート制限があります。

POST/rent/extend/{order_id}アクティブなレンタルを延長します。

APIキーが必要です。

パラメータ

order_id
レンタルの必須のパス値。
duration
必須: 24、72、168、336、720、1,440、2,160、または4,320時間。現在のオプションのレスポンスから選択してください。
expected_price
現在のオプションのレスポンスからコピーした必須の数値。
Idempotency-Key
必須のUUID v4リクエストヘッダー。同じ延長の試行を安全に再試行する場合にのみ再利用してください。

リクエスト例

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

レスポンス

{
  "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: duration、expected_price、または Idempotency-Key が欠落しているか無効です。HTTP 409: レンタルが対象外、期間または価格がすでに提供されていない、または Idempotency-Key がすでに使用されています。HTTP 202: 延長は審査待ちです。新しい冪等性キーで再試行しないでください。HTTP 503: 延長を確認できませんでした。サポートに連絡してください。

メール認証

GET/emails/catalog?site={site}サイトで利用可能な認証用アドレスのドメインを一覧表示します。

APIキーが必要です。

パラメータ

site
必須のウェブサイトドメイン。例: example.com。

リクエスト例

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

レスポンス

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

Errors

HTTP 422: 無効な site の値。HTTP 503: メールカタログが一時的に利用できません。

POST/emails/buy認証用アドレスを1つ購入します。

APIキーが必要です。

パラメータ

site
必須のウェブサイトドメイン。
domain
現在のカタログのレスポンスから選択した必須のドメイン。

リクエスト例

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

レスポンス

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

Errors

HTTP 400: ウォレット残高が不足しています。HTTP 409: ドメインの在庫切れ。HTTP 503: 購入は審査待ちです。サポートが注文を確認するまで再試行しないでください。

POST/emails/{order_id}/reorder前の注文が終了した後、同じアドレスを再注文します。

APIキーが必要です。

パラメータ

order_id
終了したメール注文の必須のパス値(数値)。リクエストボディなし。

リクエスト例

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

レスポンス

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: 注文が見つかりません。HTTP 409: 前の注文が終了していない、再注文がすでに進行中、またはこのアドレスは現在再注文できません。HTTP 503: メール認証は一時的に利用できません。このエンドポイントにはレート制限があります。

GET/emails/historyメール認証の注文を一覧表示します。

APIキーが必要です。

パラメータ

page
任意のページ番号。デフォルトは1。
per_page
任意のページサイズ。デフォルトは20、上限は50。

リクエスト例

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

レスポンス

Returns paginated order data and page metadata.

Errors

メール注文テーブルが利用できない場合、APIは空の data 配列を返します。

GET/emails/status/{order_id}認証注文を取得または更新します。

APIキーが必要です。

パラメータ

order_id
購入レスポンスで返される必須のパス値。

リクエスト例

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

レスポンス

Returns the order status and available verification result fields.

Errors

HTTP 404: 注文が見つかりません。HTTP 503: ステータスを更新できませんでした。レスポンスには、その注文で利用可能なフィールドのみが含まれます。

DELETE/emails/{order_id}メール認証注文のキャンセルをリクエストします。

APIキーが必要です。

パラメータ

order_id
購入レスポンスで返される必須のパス値。

リクエスト例

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

レスポンス

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

Errors

注文はあなたのアカウントのもので、キャンセル可能である必要があります。現在の注文状態は返されたエラーメッセージを確認してください。レスポンスにキャンセルがまだ確認されていないと示されている場合(HTTP 503)、数分待ってからリクエストを再送してください。

Webhook

GET/webhookWebhookの設定を取得します。

APIキーが必要です。

パラメータ

なし
クエリパラメータはありません。

リクエスト例

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

レスポンス

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

Errors

認証済みアカウントの現在の設定を返します。

PUT/webhookWebhook URLを作成または更新します。

APIキーが必要です。

パラメータ

url
443番ポートの必須の公開HTTPS URL。ローカルおよびプライベートアドレスは拒否されます。

リクエスト例

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

レスポンス

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

Errors

HTTP 422: URLは受け付けられる公開HTTPSアドレスではありません。

POST/webhook/rotate-secret設定済みWebhookの署名シークレットを置き換えます。

APIキーが必要です。

パラメータ

なし
リクエストボディなし。先にWebhookを設定してください。

リクエスト例

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

レスポンス

{ "secret": "NEW_SECRET_SHOWN_ONCE" }

Errors

HTTP 404: Webhookが設定されていません。新しいシークレットは安全に保存してください。読み取りエンドポイントではなく、このローテーションのレスポンスで返されます。

DELETE/webhookWebhookの設定を削除します。

APIキーが必要です。

パラメータ

なし
リクエストボディなし。

リクエスト例

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

レスポンス

{ "configured": false }

Errors

認証済みアカウントのWebhook設定を削除します。

POST/webhook/test設定済みのエンドポイントにテストイベントを送信します。

APIキーが必要です。

パラメータ

なし
リクエストボディなし。先にWebhookを設定してください。

リクエスト例

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

レスポンス

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

Errors

HTTP 404: Webhookが設定されていません。サーバーが受け付けなかった場合、テスト配信は delivered=false を報告します。

GET/webhook/deliveries最大50件の最近のWebhook配信試行を確認します。

APIキーが必要です。

パラメータ

なし
クエリパラメータはありません。

リクエスト例

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

レスポンス

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

Errors

最新のHTTP Webhook配信50件を新しい順に返します。

POST/webhook/deliveries/{id}/retryWebhook配信のいずれかを今すぐ再試行します。

APIキーが必要です。

パラメータ

id
配信レコードの必須のパス値。

リクエスト例

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

レスポンス

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

Errors

HTTP 404: 配信が見つかりません。このエンドポイントにはレート制限があります。

4. 請求

注文時に残高から料金が引き落とされます。20分の有効時間内にSMSを受信できなかったアクティベーションは残高に返金されます。キャンセルと返金のルールは、レンタル、メール、API Linksで異なります。

5. キャンセルと返金

番号の注文(アクティベーション)は、最初の2分を過ぎてから20分のアクティベーション時間が終わるまでの間で、SMSがまだ届いていない場合に限り、キャンセルを申請できます。条件を満たして確認されたキャンセルでは、注文金額が残高に返金されます。

SMSが届いた後、またはアクティベーション時間が終了した後は、キャンセルできません。対象のアクティベーションが20分の間にSMSを受信しなかった場合、注文金額は残高に返金されます。

レンタルは、コードがまだ届いていなければ、同じ2分から20分の間にキャンセルできます。レンタルの返金は確認後の対応となり、自動ではありません。

一括番号、API Links、メールの注文は、ダッシュボードに別途記載がない限り、納品後の返金はできません。

キャンセルを確認できない場合は、再試行する前にサポートへご連絡ください。

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.

より高いレート制限やカスタム統合が必要ですか? チームに連絡. または ダッシュボードを開く.