ドキュメント·アクティベーション
⚡

アクティベーション

単一SMS認証——リクエストから請求までのワンタイムコードのライフサイクル。

アクティベーションとは

アクティベーションは1回のSMS-OTPのための短期的な番号レンタルです。リクエストすると、プラットフォームが番号を予約し、受信SMSのコードを読み取り、アクティベーションが閉じます——成功(請求)またはexpired(無料)として。

ワンタイムコードのみが必要な場合(サインアップ、パスワードリセット、KYC)はアクティベーションを使用します。より長い期間で複数のSMSが必要な場合は Rentals を参照してください。

ライフサイクル

waiting ─► sms_received ─► finished       (確認;請求)
   │                  └──► refunded       (コードなし;無料)
   └─► expired                            (タイムアウト;無料)
  • waiting — 番号予約済み、SMSはまだ。
  • sms_received — 少なくとも1つの受信SMSをキャプチャ。
  • finished — finishを呼び出した;請求。
  • expired — SMSなしで期限切れ;請求なし。
  • refunded — 確認前にキャンセル;請求なし。

作成

curl -X POST https://api.eveses.com/v1/activations \
  -H "Authorization: Bearer $EVESES_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "country": "ua",
    "service": "telegram",
    "duration_minutes": 15,
    "max_price_cents": 12
  }'
フィールド 必須 注意
country はい ISO-2 国コード
service はい サービスカタログのslugまたは any
duration_minutes いいえ 5〜60。デフォルト 20
max_price_cents いいえ 上限以下のフェイルオーバープロバイダプールを拡大

ポーリング

curl https://api.eveses.com/v1/activations/9a1f2c3d-4e5b-6a7c-8d9e-0f1a2b3c4d5e \
  -H "Authorization: Bearer $EVESES_API_KEY"

1.5〜2秒間隔のポーリングは問題ありません。秒以下のポーリングはレート制限されます。本番環境ではWebhookを強く推奨します。

Finish

アクティベーションを確認し、課金をトリガーします。冪等——2回呼び出しても安全です。

curl -X POST https://api.eveses.com/v1/activations/9a1f2c3d-4e5b-6a7c-8d9e-0f1a2b3c4d5e/finish \
  -H "Authorization: Bearer $EVESES_API_KEY"

Cancel

SMSが届く前にキャンセル。SMSがすでに到着している場合は409を返します(その場合は finish を呼ぶ)。

curl -X POST https://api.eveses.com/v1/activations/9a1f2c3d-4e5b-6a7c-8d9e-0f1a2b3c4d5e/cancel \
  -H "Authorization: Bearer $EVESES_API_KEY"