TempMailg APIドキュメント

REST API v1 と Webhooks

TempMailg 開発者 API ドキュメント

このドキュメントを使用して、個人用APIキーを生成し、専用ユーザーAPIホストに接続し、メールボックスメッセージを読み取り、所有メールボックスを管理し、Temp Mailを自分のアプリまたは自動化に統合します。

ベアラートークン認証 リアルタイム Webhooks Gmail と Outlook エイリアス JSONレスポンス
ユーザーAPIベースURL HTTPS
リクエスト形式 APIキーをAuthorization Bearerヘッダーでのみ使用し、エンドポイントURLをクリーンに保ちます。

メールボックス管理

許可されたドメインを取得し、メールボックスを作成または切り替え、許可された有効期限を選択し、所有するアドレスを削除します。

GET https://v1.tempmailg.com/api/domains?type={type}
#

許可されたドメインの一覧

一時的なメールを作成するために利用可能なドメインを一覧表示します。タイプでフィルタリングすると、サブスクリプションプランでサポートされている無料、プレミアム、またはカスタムドメインのみが表示されます。

パラメータ 1
パラメータ 場所 種類 ステータス 説明
type query string 任意
ドメイン階層フィルター。省略時は、プレミアムドメインアクセスが有効な場合はすべて、そうでなければ無料を使用します。認識される値: free, basic, pro, premium, custom, ultimate, all
デフォルト: アカウント依存
許可されたドメインを取得
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "data": {
        "requested_type": "free",
        "plan": "pro",
        "plan_name": "Pro Plan",
        "allowed_types": [
            "free",
            "basic",
            "pro",
            "premium",
            "custom",
            "ultimate",
            "all"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
data.requested_type string
ドメインフィルタが適用されました。
data.plan string
現在のプランタグ。
data.plan_name string
現在のプランの読みやすい名前。
data.allowed_types array<string>
このアカウントで利用可能なドメインフィルタ。認識されたフィルタでも、プランによっては使用できない場合があります。
data.domains array
フィルタリング後の選択可能なドメイン;空の配列は有効です。
data.domains[].domain string
選択可能なドメイン名。
data.domains[].type string
読み取り可能なドメイン階層ラベル。
data.domains[].custom boolean
これはカスタムドメインかどうか。
POST https://v1.tempmailg.com/api/emails
#

一時的なメールボックスを作成

所有された一時メールボックスを作成します。ランダム生成のためにユーザー名とドメインを省略するか、許可されたカスタムユーザー名と許可されたドメインを指定してください。provider パラメータで Gmail または Outlook のエイリアス生成を選択できます。

パラメータ 8
パラメータ 場所 種類 ステータス 説明
username body string 任意
オプションのカスタムユーザー名: 2〜64 文字の ASCII の英字、数字、ドット、アンダースコア、またはハイフン。プランの権限が必要です; custom_username も受け付けられます。
デフォルト: ランダムに生成された
domain body string 任意
GET /domainsで返される許可されたドメインの1つです。省略するとランダムな許可ドメインが選択されます。
デフォルト: ランダムに許可されたドメイン
lifetime body string 任意
許可される値:
10m — 10 分間 1h — 1時間 2h — 2時間 1d — 1日 1w — 1 週間 1m — 30日間 3m — 90 日 6m — 180日間 1y — 365日間 unlimited — 無制限
デフォルト: プランのデフォルト有効期間
provider body string 任意
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
デフォルト: standard
pin_enabled body boolean 任意
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト: false
pin body string 任意
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
pin_confirmation body string 任意
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
Idempotency-Key header string 任意
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
オプションのボディパラメータ: username (プランで許可されている場合のカスタムユーザー名), domain (許可されたドメイン、例: example.com), lifetime (許可される値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。
メールボックスを作成
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2301,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-20T02:18:00+00:00",
        "expires_in_seconds": 86399.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:00+00:00",
        "email_token": "encrypted-email-token"
    }
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
data.id integer
メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。
data.pin_protected boolean
このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。
data.email string
完全なメールボックスアドレスが生成されました。
data.domain string
生成されたメールボックスのドメイン。
data.provider string
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
data.expire_at string|null
有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。
data.expires_in_seconds number|null
計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。
data.mailbox_state string
現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。
data.receiving_enabled boolean
このメールボックスが現在受信メッセージを受け付けているかどうか。
data.message_count integer
既知の総メッセージ数;最後のメールボックス同期を反映することがあります。
data.unread_message_count integer
既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。
data.last_message_received_at string|null
ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。
data.message_count_synced_at string|null
ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。
data.created_at string|null
メールボックスの作成時間(ISO-8601形式)。
data.email_token string
不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。
data.pin_grant object
条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。
data.pin_grant.mailbox_id integer
条件付き読み取り権限がバインドされているメールボックスID。
data.pin_grant.unlock_token string
同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。
data.pin_grant.scope string
条件付き作成権限のために読み取られるスコープ。
data.pin_grant.idle_timeout_seconds integer
読み取り権限の許容アイドル時間は、通常3600秒です。
data.pin_grant.absolute_timeout_seconds integer
読み取り権限の最大有効期間は、通常86400秒です。
data.pin_grant.expires_at string
ISO-8601 形式の現在の読み取り権限の有効期限。
data.pin_grant.absolute_expires_at string
ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

メールボックスを更新 / 切り替え

現在のメールボックスの所有権を確認した後、新しいユーザー名とドメインでメールボックスを作成または選択します。これは古いメールボックスの名前を変更したり、存続期間をその場で変更したりするものではありません。宛先が異なる場合、古いメールボックスは履歴に残り、アクティブメールボックスの上限により一時停止されることがあります。自分のアクティブな宛先を再利用すると、要求された存続期間またはプランのデフォルトが再適用されます。

パラメータ 9
パラメータ 場所 種類 ステータス 説明
email path string 必須
切り替える所有メールボックスの現在の完全なメールアドレス。各パスセグメントをURLエンコードしてください; プラス記号は %2B とエンコードします。
username path string 必須
新しい希望のユーザー名: 2〜64 文字の英数字; カスタムユーザー名権限の対象となります。
domain path string 必須
新しい許可されたドメイン名。
lifetime body string 任意
許可される値:
10m — 10 分間 1h — 1時間 2h — 2時間 1d — 1日 1w — 1 週間 1m — 30日間 3m — 90 日 6m — 180日間 1y — 365日間 unlimited — 無制限
デフォルト: プランのデフォルト有効期間
pin_enabled body boolean 任意
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト: false
pin body string 任意
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
pin_confirmation body string 任意
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
Idempotency-Key header string 任意
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
X-Mailbox-Unlock header string 任意
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
{email} にある既存の所有メールボックスのメールを使用します。 オプションのボディパラメータ: lifetime(許容値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited)。 ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。
所有メールボックスを更新
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2302,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-19T02:28:00+00:00",
        "expires_in_seconds": 599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:00+00:00",
        "email_token": "encrypted-email-token"
    }
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
data.id integer
メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。
data.pin_protected boolean
このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。
data.email string
完全なメールボックスアドレスが生成されました。
data.domain string
生成されたメールボックスのドメイン。
data.provider string
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
data.expire_at string|null
有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。
data.expires_in_seconds number|null
計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。
data.mailbox_state string
現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。
data.receiving_enabled boolean
このメールボックスが現在受信メッセージを受け付けているかどうか。
data.message_count integer
既知の総メッセージ数;最後のメールボックス同期を反映することがあります。
data.unread_message_count integer
既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。
data.last_message_received_at string|null
ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。
data.message_count_synced_at string|null
ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。
data.created_at string|null
メールボックスの作成時間(ISO-8601形式)。
data.email_token string
不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。
data.pin_grant object
条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。
data.pin_grant.mailbox_id integer
条件付き読み取り権限がバインドされているメールボックスID。
data.pin_grant.unlock_token string
同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。
data.pin_grant.scope string
条件付き作成権限のために読み取られるスコープ。
data.pin_grant.idle_timeout_seconds integer
読み取り権限の許容アイドル時間は、通常3600秒です。
data.pin_grant.absolute_timeout_seconds integer
読み取り権限の最大有効期間は、通常86400秒です。
data.pin_grant.expires_at string
ISO-8601 形式の現在の読み取り権限の有効期限。
data.pin_grant.absolute_expires_at string
ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。
DELETE https://v1.tempmailg.com/api/emails/{email}
#

メールボックスを削除

所有しているメールボックスを削除し、そのメッセージとファイルのクリーンアップを実行します。保持されたメールボックスレコードは内部的にソフトデリートされる可能性があり、アドレスは API からは使用できなくなります。

パラメータ 3
パラメータ 場所 種類 ステータス 説明
email path string 必須
削除する所有メールボックスの完全なメールアドレス。アドレスは URL エンコードしてください;プラス記号は %2B とエンコードします。
X-Mailbox-Unlock header string 任意
ヘッダー、保護されたメールボックスのみ:ワンタイム削除用 unlock_token を使用してください。最初に PIN を POST し、scope=delete と 423 応答で返される action/target_id を PIN アンロック URL に送ります。読み取りトークンでは削除できません。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string 任意
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
所有メールボックスを削除
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
message string
削除の結果。リソースが見つからない場合は HTTP 404 が返されます。

Gmail と Outlook エイリアス

高評価の Gmail および Outlook/Hotmail エイリアスメールボックスを生成します。

POST https://v1.tempmailg.com/api/gmail-alias/emails
#

Gmail エイリアスを作成

認証されたユーザーが所有する新しい Gmail エイリアスの一時メールボックスを作成する。

パラメータ 8
パラメータ 場所 種類 ステータス 説明
mode body string 任意
生成モード: auto、dot、plus、または plus_dot。gmail_alias_mode も受け付けます。スタイル選択が許可されていない場合は、auto が使用されます。
デフォルト: auto
username body string 任意
オプションのカスタムエイリアスサフィックス: 2〜32文字のASCII文字または数字で、小文字に正規化されます; 機能権限の対象です。また、custom_username または alias_username を受け付けます。
デフォルト: 自動生成
domain body string 任意
ランダム、gmail.com または googlemail.com を使用してください; alias_domain も受け入れられます。省略または利用できないドメイン選択権限はランダムを使用します。
デフォルト: random
lifetime body string 任意
許可される値:
10m — 10 分間 1h — 1時間 2h — 2時間 1d — 1日 1w — 1 週間 1m — 30日間 3m — 90 日 6m — 180日間 1y — 365日間 unlimited — 無制限
デフォルト: プランのデフォルト有効期間
pin_enabled body boolean 任意
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト: false
pin body string 任意
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
pin_confirmation body string 任意
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
Idempotency-Key header string 任意
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
Gmail Alias API の権限がサブスクリプションプランで有効になっているか、API クレジットパッケージで解除されている必要があります。 オプションパラメータ: mode (auto, dot, plus, plus_dot), username (カスタムエイリアスユーザー名), domain (例: gmail.com, googlemail.com), lifetime (許可される値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。
Gmailエイリアスメールボックスを作成
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2305,
        "pin_protected": false,
        "email": "example+alias123@gmail.com",
        "domain": "gmail.com",
        "provider": "gmail_alias",
        "expire_at": "2026-11-19T03:18:00+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:00+00:00",
        "email_token": "encrypted-email-token"
    }
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
data.id integer
メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。
data.pin_protected boolean
このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。
data.email string
完全なメールボックスアドレスが生成されました。
data.domain string
生成されたメールボックスのドメイン。
data.provider string
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
data.expire_at string|null
有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。
data.expires_in_seconds number|null
計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。
data.mailbox_state string
現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。
data.receiving_enabled boolean
このメールボックスが現在受信メッセージを受け付けているかどうか。
data.message_count integer
既知の総メッセージ数;最後のメールボックス同期を反映することがあります。
data.unread_message_count integer
既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。
data.last_message_received_at string|null
ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。
data.message_count_synced_at string|null
ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。
data.created_at string|null
メールボックスの作成時間(ISO-8601形式)。
data.email_token string
不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。
data.pin_grant object
条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。
data.pin_grant.mailbox_id integer
条件付き読み取り権限がバインドされているメールボックスID。
data.pin_grant.unlock_token string
同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。
data.pin_grant.scope string
条件付き作成権限のために読み取られるスコープ。
data.pin_grant.idle_timeout_seconds integer
読み取り権限の許容アイドル時間は、通常3600秒です。
data.pin_grant.absolute_timeout_seconds integer
読み取り権限の最大有効期間は、通常86400秒です。
data.pin_grant.expires_at string
ISO-8601 形式の現在の読み取り権限の有効期限。
data.pin_grant.absolute_expires_at string
ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Outlook エイリアス ドメイン

メールボックス生成に利用できるアクティブな Outlook / Hotmail エイリアスドメインを取得する。

Outlook Alias API の権限がサブスクリプションプランで有効になっているか、API クレジットパッケージで解除されている必要があります。 特定のドメイン選択がプランでロック解除されているかどうかを示します。
Outlook エイリアスドメインを取得
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "data": {
        "domains": [
            {
                "domain": "outlook.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            },
            {
                "domain": "hotmail.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            }
        ]
    }
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
data.domains array
アクティブな Outlook/Hotmail ドメイン; 空の配列は有効です。
data.domains[].domain string
利用可能なドメイン名。
data.domains[].type string
読み取り可能なプロバイダーラベル。
data.domains[].selectable boolean
アカウントがこのドメインを明示的に選択できるかどうか。
data.domains[].locked boolean
アカウントに対して明示的なドメイン選択がロックされているかどうか。
data.domains[].disabled_reason string|null
ドメイン選択がロックされている理由、または選択可能な場合はnullです。
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Outlook エイリアスを作成

認証されたユーザーが所有する新しい Outlook / Hotmail エイリアスの一時メールボックスを作成する。

パラメータ 7
パラメータ 場所 種類 ステータス 説明
domain body string 任意
ランダムまたは GET /outlook-alias/domains から取得したドメインを使用します; outlook_alias_domain も受け付けられます。選択権限がない場合、ランダムが使用されます。
デフォルト: ランダムな利用可能ドメイン
username body string 任意
オプションのカスタムエイリアスサフィックス: 2〜32文字のASCII文字または数字で、小文字に正規化されます; 機能権限の対象です。また、custom_username または alias_username を受け付けます。
デフォルト: 自動生成
lifetime body string 任意
許可される値:
10m — 10 分間 1h — 1時間 2h — 2時間 1d — 1日 1w — 1 週間 1m — 30日間 3m — 90 日 6m — 180日間 1y — 365日間 unlimited — 無制限
デフォルト: プランのデフォルト有効期間
pin_enabled body boolean 任意
プランで許可されている場合、新しいメールボックスにオプションの PIN 保護を設定できます。既存のメールボックスの PIN は変更されません。
デフォルト: false
pin body string 任意
pin_enabled が true の場合に必須: 先頭のゼロを保持するために文字列として送信される、6〜8 桁の PIN。
pin_confirmation body string 任意
pin_enabled が true の場合に必須です。pin と完全に一致する必要があります。
Idempotency-Key header string 任意
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
Outlook Alias API の権限がサブスクリプションプランで有効になっているか、API クレジットパッケージで解除されている必要があります。 オプションパラメータ: domain (例: outlook.com, hotmail.com), username (カスタムエイリアスユーザー名), lifetime (許可される値: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). ライフタイムを省略するか空欄のままにすると、現在の月額/年額プランで設定されたデフォルトのメールライフタイムが使用されます。デフォルトを上書きするには、1h などの許可されたライフタイムを送信してください。Unlimited は、プランのデフォルトとして設定されている場合、または明示的に要求され許可された場合にのみ使用されます。 ボディパラメータ mailbox_lifetime と email_lifetime も受け付けられます; 最初の空でない値が次の順序で優先されます: lifetime, mailbox_lifetime, email_lifetime. 無効または許可されていない値は、デフォルトを黙って選択する代わりに HTTP 422 を返します。
Outlook エイリアスメールボックスを作成する
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2306,
        "pin_protected": false,
        "email": "example+alias45@outlook.com",
        "domain": "outlook.com",
        "provider": "outlook_alias",
        "expire_at": "2026-11-19T03:18:00+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:00+00:00",
        "email_token": "encrypted-email-token"
    }
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
data.id integer
メールボックス ID。生成された ID、アドレス、トークンはメールボックスごとに異なります。
data.pin_protected boolean
このメールボックスがPIN保護されているかどうか。PINやPINハッシュは返されません。
data.email string
完全なメールボックスアドレスが生成されました。
data.domain string
生成されたメールボックスのドメイン。
data.provider string
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
data.expire_at string|null
有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。
data.expires_in_seconds number|null
計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。
data.mailbox_state string
現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。
data.receiving_enabled boolean
このメールボックスが現在受信メッセージを受け付けているかどうか。
data.message_count integer
既知の総メッセージ数;最後のメールボックス同期を反映することがあります。
data.unread_message_count integer
既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。
data.last_message_received_at string|null
ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。
data.message_count_synced_at string|null
ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。
data.created_at string|null
メールボックスの作成時間(ISO-8601形式)。
data.email_token string
不透明な暗号化メールボックス参照です。Bearer認証、所有権チェック、またはPIN認証の代わりにはなりません。
data.pin_grant object
条件付き: アクティブなPIN保護メールボックスの作成はこの読み取り権限を返します; 通常の保護されていない作成はそれを省略します。
data.pin_grant.mailbox_id integer
条件付き読み取り権限がバインドされているメールボックスID。
data.pin_grant.unlock_token string
同じ所有者の資格情報を使用した X-Mailbox-Unlock 用の不透明な読み取りトークンです。プライベートに保ち、メモリ内に保持してください; 読み取り権限は削除を許可しません。
data.pin_grant.scope string
条件付き作成権限のために読み取られるスコープ。
data.pin_grant.idle_timeout_seconds integer
読み取り権限の許容アイドル時間は、通常3600秒です。
data.pin_grant.absolute_timeout_seconds integer
読み取り権限の最大有効期間は、通常86400秒です。
data.pin_grant.expires_at string
ISO-8601 形式の現在の読み取り権限の有効期限。
data.pin_grant.absolute_expires_at string
ISO-8601形式の絶対的な読み取り権限の有効期限。セキュリティの変更により、権限が早期に取り消されることがあります。

メッセージと添付ファイル

受信トレイを取得し、HTML/テキストメッセージ全体を読み取り、添付ファイルをストリーミングします。

GET https://v1.tempmailg.com/api/messages?email={email}
#

メールボックスメッセージを一覧表示

利用可能なメッセージ要約とメールボックスのメタデータを取得します。標準の受信トレイスキャンは最大25件の最近のメッセージのバッチを返します; これはページングされた全履歴エンドポイントではありません。完全な本文と添付ファイルを取得するには GET /messages/{messageId} を使用してください。

パラメータ 2
パラメータ 場所 種類 ステータス 説明
email query string 必須
所有するメールボックスの完全なメールアドレス(メッセージを読むため)。クエリ値はURLエンコードしてください;プラス記号は %2B とエンコードします。
X-Mailbox-Unlock header string 任意
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
メールはあなたのアカウントに属している必要があります。Standard と Gmail のサマリーには OTP と verification-link フィールドが含まれます;Outlook には from_name、snippet、received_at、has_attachments も含まれます。プロバイダーの同期とキャッシュにより、新しいメッセージやカウントが遅れることがあります。
メールボックスメッセージを読み取り
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "mailbox": "demo123@example.com",
    "email_token": "encrypted-email-token",
    "messages": [
        {
            "is_seen": false,
            "subject": "Welcome to Temp Mail",
            "from": "Example Sender",
            "from_email": "hello@example.org",
            "receivedAt": "2026-11-19 02:18:00",
            "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
            "otp": null,
            "otp_locked": false,
            "verification_link": null,
            "verification_link_locked": false
        }
    ],
    "mailbox_provider": "standard",
    "mailbox_state": "active",
    "expire_at": "2026-11-20T02:18:00+00:00",
    "expires_in_seconds": 86399.75,
    "receiving_enabled": true,
    "mailbox_limit": {
        "limit": 50,
        "limit_label": "50",
        "active_count": 1,
        "paused_count": 0,
        "paused_mailboxes": [],
        "remaining": 49,
        "remaining_label": "49",
        "reached": false,
        "blocked": false,
        "provider": "standard"
    },
    "message_count": 1,
    "unread_message_count": 1,
    "last_message_received_at": "2026-11-19T02:18:00+00:00",
    "message_count_synced_at": "2026-11-19T02:18:00+00:00"
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
mailbox string
要求されたメッセージのメールボックスアドレス。
email_token string
不透明な暗号化メールボックス参照;通常の認証は依然として必要です。
mailbox_provider string
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
messages array
メッセージの要約。空の受信トレイは空の配列を返します; 本文と添付ファイルを取得するには単一のメッセージを取得してください。
expire_at string|null
有効期限は ISO-8601 タイムスタンプとして、無制限のメールボックスの場合は null です。
expires_in_seconds number|null
計算時の残り秒数は負でないです;小数秒も可能です。null はゼロではなく無制限を意味します。
mailbox_state string
現在のメールボックスの状態: アクティブ、ポーズ中、期限切れ、または非アクティブ。
receiving_enabled boolean
このメールボックスが現在受信メッセージを受け付けているかどうか。
message_count integer
既知の総メッセージ数;最後のメールボックス同期を反映することがあります。
unread_message_count integer
既知の未読メッセージ数; 最後のメールボックス同期を反映することがあります。
last_message_received_at string|null
ISO-8601形式の最後に知られている受信メッセージの時間、利用できない場合はnull。
message_count_synced_at string|null
ISO-8601形式の最終メッセージ数同期時刻、同期前はnullです。
mailbox_limit.limit integer
このプロバイダーのアクティブメールボックス上限; -1 は無制限を意味します。
mailbox_limit.limit_label string
メールボックス上限の表示ラベル。
mailbox_limit.active_count integer
このプロバイダーのアクティブなメールボックスの数。
mailbox_limit.paused_count integer
このプロバイダーの一時停止されたメールボックスの数。
mailbox_limit.paused_mailboxes array<string>
メールボックスの上限によりアドレスが一時停止されました。
mailbox_limit.remaining integer
残りのアクティブなメールボックススロット数; -1 は無制限を意味します。これは API リクエストクォータではありません。
mailbox_limit.remaining_label string
残りのメールボックススロットの表示ラベル。
mailbox_limit.reached boolean
アクティブなメールボックスの上限に達しているかどうか。
mailbox_limit.blocked boolean
アクティブなメールボックスの上限がゼロかどうか。
mailbox_limit.provider string|null
メールボックス制限が適用されるプロバイダー。
messages[].id string
単一メッセージ、削除、添付エンドポイントで使用される不透明なメッセージ ID。
messages[].is_seen boolean
メッセージが既読としてマークされているかどうか。
messages[].subject string
メッセージの件名。
messages[].from string
送信者の表示名またはアドレス。
messages[].from_email string
送信者のメールアドレス。
messages[].receivedAt string
アプリケーションのタイムゾーンでの受信時間、形式は YYYY-MM-DD HH:mm:ss です。
messages[].otp string|null
利用可能で許可されている場合はワンタイムコードを検出し、そうでない場合は null。
messages[].otp_locked boolean
検出されたワンタイムコードが機能権限によって非表示になるかどうか。
messages[].verification_link string|null
利用可能で許可されている場合は検出された検証URLを表示し、そうでない場合はnullです。
messages[].verification_link_locked boolean
検出された検証リンクが機能権限によって非表示になっているかどうか。
messages[].from_name string|null
Outlook の要約フィールド: 元の送信者名。Standard と Gmail の要約には含まれていません。
messages[].snippet string|null
Outlook のサマリーフィールド: 短いメッセージプレビュー。
messages[].received_at string|null
Outlook のサマリーフィールド: 既知の場合の ISO-8601 受信時刻。
messages[].has_attachments boolean
Outlook の概要フィールド: 添付メタデータが存在するかどうか。ダウンロードの可用性は別途確認されます。
GET https://v1.tempmailg.com/api/messages/{messageId}
#

単一メッセージを取得

不透明なメッセージIDで所有されたメッセージを取得します。本文の形式と添付メタデータを返します。本文フィールドはメッセージ形式に依存します;Outlookは以下に示すプロバイダー固有のフィールドを追加します。

パラメータ 2
パラメータ 場所 種類 ステータス 説明
messageId path string 必須
メッセージリストで返されるユニークなメッセージID。
X-Mailbox-Unlock header string 任意
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
1件のメッセージを読み取り
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "data": {
        "is_seen": true,
        "subject": "Welcome to Temp Mail",
        "from": "Example Sender",
        "from_email": "hello@example.org",
        "to": "demo123@example.com",
        "mailbox_provider": "standard",
        "receivedAt": "2026-11-19 02:18:00",
        "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
        "html": true,
        "html_content": "<p>Hello from the inbox.</p>",
        "text_content": "<pre>Hello from the inbox.</pre>",
        "content": "<p>Hello from the inbox.</p>",
        "attachments": [
            {
                "name": "file.txt",
                "extension": "txt",
                "size": 91,
                "url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
            }
        ]
    }
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
data.id string
不透明なメッセージ ID。
data.is_seen boolean
メッセージの既読状態。閲覧すると既読としてマークされる可能性があり、キャッシュされたデータは以前の状態を反映していることがあります。
data.subject string
メッセージの件名。
data.from string
送信者の表示名またはアドレス。
data.from_email string
送信者のメールアドレス。
data.to string
受信者のメールボックスアドレス。
data.mailbox_provider string
メールボックスプロバイダー: standard、gmail_alias、または outlook_alias。
data.receivedAt string
アプリケーションのタイムゾーンでの受信時間、形式は YYYY-MM-DD HH:mm:ss です。
data.html boolean
メッセージに HTML 本文があるかどうか。
data.html_content string
HTML本文がある場合。HTMLがない標準メッセージはこのフィールドを省略できます。メッセージ内容は信頼できないものとして扱ってください。
data.text_content string
テキスト本文が存在する場合; 標準メッセージは pre 要素内のエスケープされたテキストを含むことがあり、このフィールドを省略することもあります。
data.content string
表示用の優先本文、利用可能な場合は通常 HTML。
data.attachments array
添付ファイルのメタデータ、または空の配列。ダウンロードには通常の認証と該当する PIN 認可が必要です。
data.attachments[].name string
ダウンロード時に単一のパスセグメントとして URL エンコードするファイル名。
data.attachments[].size integer
添付ファイルのサイズ(バイト単位)。
data.attachments[].url string
認証済みユーザーAPIのダウンロードURLがファイル名付きの添付ファイルに追加されました。URLがローカルファイルの利用可能性を保証するわけではありません。
data.attachments[].extension string
標準/Gmail メタデータフィールド: 提供された場合のファイル拡張子。
data.attachments[].id string
Outlook メタデータ フィールド: プロバイダー添付ファイル ID。
data.attachments[].content_type string
Outlook メタデータフィールド: MIME コンテンツタイプ。
data.from_name string|null
Outlook 詳細フィールド: 元の送信者名。
data.to_email string|null
Outlook 詳細フィールド: 元の受信者アドレス。
data.received_at string|null
Outlook 詳細フィールド: ISO-8601 受信時間。
data.has_html boolean
Outlook 詳細フィールド: HTML 本文が存在するかどうか。
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

メッセージを削除

所有メッセージを1件削除します。

パラメータ 3
パラメータ 場所 種類 ステータス 説明
messageId path string 必須
永続的に削除するためのユニークなメッセージID文字列。
X-Mailbox-Unlock header string 任意
ヘッダー、保護されたメールボックスのみ:ワンタイム削除用 unlock_token を使用してください。最初に PIN を POST し、scope=delete と 423 応答で返される action/target_id を PIN アンロック URL に送ります。読み取りトークンでは削除できません。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string 任意
PIN保護された作成または削除に必要: 安定した 16 から 128 文字のキー。同じキーで同一リクエストを再試行し、重複作業を防止してください。
1つのメッセージを削除
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
レスポンス フィールド
フィールド 種類 説明
status boolean
操作が成功したかどうか。
message string
削除の結果。リソースが見つからない場合は HTTP 404 が返されます。
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

添付ファイルをダウンロード

所有メッセージから添付ファイルをダウンロードします。

パラメータ 3
パラメータ 場所 種類 ステータス 説明
messageId path string 必須
ファイルを含むメッセージの ID。
filename path string 必須
ダウンロードする添付ファイルのファイル名と拡張子です。
X-Mailbox-Unlock header string 任意
ヘッダー、保護されたメールボックスのみ: 読み取り用の unlock_token を使用してください。最初に PIN と scope=read を PIN アンロック URL に POST してください。通常の Bearer 認証はそのまま保持してください。 <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
成功時はJSONではなくファイルバイトが返されます。サイズが大きすぎるファイルはHTTP 403を返し、ローカルファイルが見つからないまたは利用できない場合はHTTP 404を返します。ファイル名は単一のパスセグメントとしてURLエンコードしてください。添付メタデータだけではダウンロードの可用性は保証されません。
添付ファイルをダウンロード
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY' \
  --output file.txt
ダウンロード動作 このエンドポイントは、JSONボディの代わりに、リクエストされたファイルを直接返します。
レスポンス フィールド
フィールド 種類 説明
Content-Disposition header
成功したレスポンスは要求されたファイル名をダウンロードします。
body binary
成功時はファイルバイトを返し、JSONではありません。エラー時は2xx以外のステータスでJSONを返します。

レート制限とクォータ

クレジットを消費せずに、リアルタイムのリクエスト予算、レートリミット、アカウントクォータを監視します。

GET https://v1.tempmailg.com/api/rate-limit
#

レートリミットとクォータ

API使用量を消費せずに、現在のレートリミットとクォータステータスを確認してください。このエンドポイントはクォータフリーで、月間APIクレジットを差し引きません(濫用防止制限: 60 リクエスト/分)。

X-RateLimit-* は示されたリクエスト予算を表します;X-Quota-* は利用可能な場合の月間および購入済み容量を表します。X-Mailbox-RateLimit-* はメールボックス作成/更新の別予算を報告します。メールボックスのみの拒否はメールボックススコープと独自のリトライウィンドウを使用します。分単位の制限による拒否はクォータ情報を省略することがあります。Retry-After はタイムドリトライの場合にのみ含まれます;アクセスが無効化された場合はアカウント変更が必要になることがあります。 この成功ステータス応答では、data.limit、data.remaining、data.reset は使用可能なクレジットではなく、アカウントの分単位予算を示します。data.quota オブジェクトは月間手当、クレジット残高、使用状況を示します。既存の data.monthly_limit、data.monthly_remaining、data.purchased_credits フィールドは、対応する quota フィールドのエイリアスとして残ります。 ステータスチェックが成功しても、別の API 操作が許可されるわけではありません。操作には引き続き有効なアクセス、利用可能なクォータ、すべての適用可能な制限を満たすことが必要です。クォータのスナップショットは、進行中のリクエストによってすでに予約されている容量を保証するものではありません。
レート制限ステータスを確認
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

合成データを使用した例示的なレスポンスです。ID、アドレス、トークン、タイムスタンプ、プランの制限やカウントは変動します。サンプルの有効期間はプランのデフォルトを上書きしません。レスポンスフィールドの説明は、null 許容およびプロバイダー固有のフィールドを示しています。

例レスポンス
200 OK • JSON
{
    "status": "success",
    "data": {
        "limit": 60,
        "remaining": 45,
        "reset": 32,
        "plan": "premium",
        "monthly_limit": 50000,
        "monthly_remaining": 48210,
        "purchased_credits": 5000,
        "quota": {
            "enabled": true,
            "user_api_status": true,
            "plan_name": "Premium Plan",
            "period": "2026-10",
            "base_limit": 50000,
            "extra_requests": 0,
            "monthly_limit": 50000,
            "monthly_remaining": 48210,
            "used": 1790,
            "purchased_credits": 5000,
            "bonus_credits": 1000,
            "direct_purchased_credits": 4000,
            "remaining": 53210,
            "unlimited": false,
            "usage_percent": 3,
            "reset_at": "2026-11-01T00:00:00+00:00"
        }
    }
}
レスポンス フィールド
フィールド 種類 説明
data.limit integer|string
アカウントのリクエスト/分制限。文字列 unlimited は無制限の分予算を示します; これは月間クォータとは独立しています。
data.remaining integer|string
残りのアカウント分単位予算スロット、または文字列 unlimited。正の値は API クレジットが残っていることを意味しません。
data.reset integer
アカウントの分ウィンドウの秒数であり、月間クォータリセットではありません。無効または無制限の分予算は名目上60秒の値を保持できますが、待機後のアクセスを保証するものではありません。
data.plan string
現在のプランタグです。読みやすいプラン名は data.quota.plan_name に別途提供されます。
data.quota.enabled boolean
グローバルおよびプラン/クレジットAPIアクセスが有効かどうか。これは残りの容量を示すものでも、ユーザーAPIスイッチの代わりになるものでもありません。
data.quota.user_api_status boolean
ユーザーがユーザーAPIスイッチを有効にしているかどうか。操作にはこのスイッチと有効なアクセスおよび利用可能な容量が必要です。
data.quota.plan_name string
現在のプランの読みやすい名前。
data.quota.period string
カレンダー月の使用期間はYYYY-MM形式で、アプリケーションのタイムゾーン; 必ずしもサブスクリプションの請求期間とは限りません。
data.quota.base_limit integer
基本月間プランの許容量。-1 の値は無制限を意味します。
data.quota.extra_requests integer
現在の使用期間に対して追加の月間手当が付与されました; 購入したクレジットとは別です。
data.quota.monthly_limit integer
基本割当と現在期間の追加リクエストの合計。-1 の値は無制限を意味します。購入したクレジットは含まれません。
data.quota.monthly_remaining integer|null
残りの有限月間割り当て、または月間クォータが無制限の場合は null。null はゼロとして解釈してはなりません。
data.quota.used integer
現在の使用期間における成功した、クレジットを使用した操作を含むカウントされた API 操作。ステータスチェックはこの値を増加させません。
data.quota.purchased_credits integer
現在のクレジット残高(アクティブプランのボーナスクレジットを含む)。ボーナスクレジットはこの残高に二度追加してはなりません。
data.quota.bonus_credits integer
クレジット残高のアクティブプランボーナス部分; purchased_credits の内訳であり、追加容量ではありません。
data.quota.direct_purchased_credits integer
アクティブなプランボーナス部分を除いたクレジット残高。この値に bonus_credits を加えると purchased_credits になります。
data.quota.remaining integer|null
ボーナスを二重にカウントせず、月間残り許容量に現在のクレジット残高を加算したものです。null は無制限の月間クォータを意味します。個別の機能権限やその他のリクエスト制限は引き続き適用されます。
data.quota.unlimited boolean
月間クォータが無制限かどうか。このことは、アカウントの分単位予算や他の機能制限が無制限になることを意味しません。
data.quota.usage_percent integer
ダッシュボード互換の0から100までの丸められたパーセンテージ:使用量を使用量+残量で割り、100を掛けたものです。利用可能なクレジット容量が含まれるため、再充電するとパーセンテージが下がることがあります。無制限のクォータまたはサイズゼロのプールの場合は0です;分単位のレート制限パーセンテージやアクセス決定ではありません。
data.quota.reset_at string
次のカレンダ月のクォータリセットのためのタイムゾーンオフセット付き ISO-8601 タイムスタンプです。これはサブスクリプションの有効期限ではなく、月次リセットは購入済みクレジットを補充しません。
status string
このステータスエンドポイントの文字通りの成功です。他の成功したメールボックスエンドポイントはブール値のtrueを使用します。
data.monthly_limit integer
対応する data.quota フィールドの互換エイリアス; 残高を計算する際に再度追加しないでください。
data.monthly_remaining integer|null
対応する data.quota フィールドの互換エイリアス; 残高を計算する際に再度追加しないでください。
data.purchased_credits integer
対応する data.quota フィールドの互換エイリアス; 残高を計算する際に再度追加しないでください。

メールボックス PIN 保護

続行するには PIN を入力してください。このウェブサイトのセッション中は、メールボックスはロック解除されたままです。

クッキーを受け入れますか?

私たちは、あなたのブラウジング体験を向上させるためにクッキーを使用しています。このサイトを使用することで、あなたは私たちのクッキーポリシーに同意したことになります。

もっと