TempMailg एपीआई दस्तावेज़ीकरण

अपनी व्यक्तिगत एपीआई कुंजी उत्पन्न करने, समर्पित उपयोगकर्ता एपीआई होस्ट से कनेक्ट करने, मेलबॉक्स संदेश पढ़ने, स्वामित्व वाले मेलबॉक्स प्रबंधित करने और अपने स्वयं के ऐप्स या स्वचालन में Temp Mail एकीकृत करने के लिए इस प्रलेखन का उपयोग करें।

उपयोगकर्ता एपीआई बेस यूआरएल

अनुरोध प्रारूप केवल अधिकृत बियरर हेडर में अपनी एपीआई कुंजी का उपयोग करें और एंडपॉइंट यूआरएल को साफ रखें।

लॉग इन करें एपीआई कुंजी बनाने के लिए खाता बनाएं

त्वरित सेटअप चेकलिस्ट

अपने डैशबोर्ड एपीआई प्रबंधन पृष्ठ खोलें और अपनी व्यक्तिगत एपीआई कुंजी बनाएं।
वहां दिखाए गए सटीक उपयोगकर्ता एपीआई बेस यूआरएल की प्रतिलिपि बनाएं, उदाहरण के लिए https://v1.yourdomain.com/api.
उस एपीआई होस्ट के साथ हर अनुरोध भेजें Authorization: Bearer YOUR_USER_API_KEY और Accept: application/json.
उसी डैशबोर्ड पेज से और हर उपयोगकर्ता एपीआई प्रतिक्रिया पर लौटाए गए कोटा हेडर से अपने मासिक अनुरोध कोटा को ट्रैक करें। केवल सफल 2xx अनुरोध ही कोटा की ओर गिने जाते हैं।

यदि एपीआई 404 लौटाता है सुनिश्चित करें कि आप विशिष्ट उपयोगकर्ता एपीआई होस्ट को बिल्कुल उसी तरह से कॉल कर रहे हैं जैसा आपके एपीआई प्रबंधन पेज पर दिखाया गया है।

एपीआई कुंजी एक्सेस

लॉग इन करें अपनी व्यक्तिगत एपीआई कुंजी बनाने और लाइव कोटा विवरण देखने के लिए।

लॉग इन साइन अप करें

प्रमाणीकरण प्रवाह

डैशबोर्ड एपीआई प्रबंधन पेज से अपनी व्यक्तिगत एपीआई कुंजी उत्पन्न करें।
हर अनुरोध में कुंजी को एक बियरर टोकन के रूप में भेजें।
अपने एपीआई प्रबंधन पेज पर दिखाए गए विशिष्ट उपयोगकर्ता एपीआई बेस यूआरएल का उपयोग करें।
पुरानी कुंजी को अमान्य करने और तुरंत एक नई कुंजी का उपयोग शुरू करने के लिए कुंजी को पुनः उत्पन्न करें।

कुंजी दृश्यता आपकी उपयोगकर्ता एपीआई कुंजी आपके एपीआई प्रबंधन पेज के भीतर तब तक दिखाई देती है जब तक आप इसे पुनः उत्पन्न या रद्द नहीं करते।

आवश्यक हेडर

Authorization: Bearer YOUR_USER_API_KEY
Accept: application/json

हर प्रतिक्रिया पर लौटाए गए कोटा हेडर

ये कोटा मान केवल सफल 2xx प्रतिक्रियाओं के बाद बढ़ते हैं।

X-RateLimit-Limit: 50000
X-RateLimit-Used: 124
X-RateLimit-Remaining: 49876
X-RateLimit-Reset: 2026-05-01T00:00:00+05:00

उपयोगकर्ता एपीआई एंडपॉइंट

नीचे दिए गए हर एंडपॉइंट में समान बेस यूआरएल और समान बियरर टोकन का उपयोग किया जाता है। मेलबॉक्स, संदेश और अनुलग्नक अनुरोध प्रमाणित उपयोगकर्ता खाते के खिलाफ जाँचे जाते हैं।

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

वर्तमान उपयोगकर्ता योजना और खाते के लिए अनुमत डोमेन प्राप्त करें।

अनुमत प्रकार मान: free, premium, all. मुफ्त योजना का उपयोग केवल free. प्रीमियम योजना का उपयोग कर सकते हैं free, premium, या all.

अनुमत डोमेन प्राप्त करें

const response = await fetch('https://v1.tempmailg.com/api/domains?type=free', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/domains?type=free', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/domains?type=free');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

उदाहरण प्रतिक्रिया

{
    "status": true,
    "data": {
        "requested_type": "free",
        "allowed_types": [
            "free"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}

POST https://v1.tempmailg.com/api/emails

प्रमाणित उपयोगकर्ता द्वारा स्वामित्व वाला एक नया यादृच्छिक मेलबॉक्स बनाएं।

यादृच्छिक मेलबॉक्स बनाएं

const response = await fetch('https://v1.tempmailg.com/api/emails', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.post('https://v1.tempmailg.com/api/emails', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/emails');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

उदाहरण प्रतिक्रिया

{
    "status": true,
    "data": {
        "id": 2301,
        "email": "randombox@example.com",
        "domain": "example.com",
        "expire_at": "2026-06-28T11:11:07+00:00",
        "expires_in_seconds": 600,
        "created_at": "2026-06-28T11:01:07+00:00",
        "email_token": "encrypted-email-token"
    }
}

POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}

एक मौजूदा स्वामित्व वाले मेलबॉक्स को एक नए उपयोगकर्ता नाम और अनुमत डोमेन में अद्यतन या स्विच करें।

{email} में एक मौजूदा स्वामित्व वाले मेलबॉक्स ईमेल का उपयोग करें।

स्वामित्व वाले मेलबॉक्स को अद्यतन करें

const response = await fetch('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.post('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

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'

उदाहरण प्रतिक्रिया

{
    "status": true,
    "data": {
        "id": 2302,
        "email": "demo123@example.com",
        "domain": "example.com",
        "expire_at": "2026-06-28T11:11:07+00:00",
        "expires_in_seconds": 600,
        "created_at": "2026-06-28T11:01:07+00:00",
        "email_token": "encrypted-email-token"
    }
}

DELETE https://v1.tempmailg.com/api/emails/{email}

२५. एक स्वामित्व वाला मेलबॉक्स हटाएं।

स्वामित्व वाले मेलबॉक्स को हटाएं

const response = await fetch('https://v1.tempmailg.com/api/emails/demo123@example.com', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.delete('https://v1.tempmailg.com/api/emails/demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/emails/demo123@example.com');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

उदाहरण प्रतिक्रिया

{
    "status": true,
    "message": "Email has been successfully deleted."
}

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

स्वामित्व वाले मेलबॉक्स के लिए संदेश सूची।

ईमेल प्रश्न प्रतिबंध प्रमाणित उपयोगकर्ता खाते से संबंधित होना चाहिए।

मेलबॉक्स संदेश पढ़ें

const response = await fetch('https://v1.tempmailg.com/api/messages?email=demo123@example.com', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/messages?email=demo123@example.com', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/messages?email=demo123@example.com');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

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'

उदाहरण प्रतिक्रिया

{
    "status": true,
    "mailbox": "randombox@example.com",
    "messages": [
        {
            "is_seen": false,
            "subject": "Welcome to Temp Mail",
            "from": "Example Sender",
            "from_email": "hello@example.org",
            "to": "randombox@example.com",
            "receivedAt": "2026-06-28 11:01:07",
            "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
            "html": true,
            "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"
                }
            ]
        }
    ]
}

GET https://v1.tempmailg.com/api/messages/{messageId}

एक एकल स्वामित्व वाले संदेश को पढ़ें।

एक संदेश पढ़ें

const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

उदाहरण प्रतिक्रिया

{
    "status": true,
    "data": {
        "is_seen": true,
        "subject": "Welcome to Temp Mail",
        "from": "Example Sender",
        "from_email": "hello@example.org",
        "to": "randombox@example.com",
        "receivedAt": "2026-06-28 11:01:07",
        "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
        "html": true,
        "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"
            }
        ]
    }
}

DELETE https://v1.tempmailg.com/api/messages/{messageId}

एक एकल स्वामित्व वाले संदेश को हटाएं।

एक संदेश हटाएं

const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.delete('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1', headers=headers, timeout=30)
response.raise_for_status()

print(response.json())

<?php

$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

$response = curl_exec($ch);

if ($response === false) {
    throw new RuntimeException(curl_error($ch));
}

$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

var_dump($statusCode, json_decode($response, true));

curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

उदाहरण प्रतिक्रिया

{
    "status": true,
    "message": "Message was deleted successfully."
}

GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}

स्वामित्व वाले संदेश से एक संलग्नक डाउनलोड करें।

यह एंडपॉइंट सीधे फ़ाइल डाउनलोड करता है।

एक संलग्नक डाउनलोड करें

const response = await fetch('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
  },
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const blob = await response.blob();
const downloadUrl = window.URL.createObjectURL(blob);
const link = document.createElement('a');
link.href = downloadUrl;
link.download = 'file.txt';
document.body.appendChild(link);
link.click();
link.remove();
window.URL.revokeObjectURL(downloadUrl);

import requests

headers = {
    'Authorization': 'Bearer YOUR_USER_API_KEY',
    'Accept': 'application/json',
}

response = requests.get('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt', headers=headers, stream=True, timeout=30)
response.raise_for_status()

with open('file.txt', 'wb') as handle:
    for chunk in response.iter_content(chunk_size=8192):
        if chunk:
            handle.write(chunk)

<?php

$fileHandle = fopen('file.txt', 'w');
$ch = curl_init('https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt');

curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_FILE => $fileHandle,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer YOUR_USER_API_KEY',
        'Accept: application/json',
    ],
]);

if (curl_exec($ch) === false) {
    fclose($fileHandle);
    throw new RuntimeException(curl_error($ch));
}

curl_close($ch);
fclose($fileHandle);

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

डाउनलोड व्यवहार यह एंडपॉइंट अनुरोधित फ़ाइल को सीधे लौटाता है, जेसन बॉडी के बजाय।

सामान्य त्रुटियाँ और समस्या निवारण

ये सबसे सामान्य प्रतिक्रिया कोड हैं जिन्हें आप उपयोगकर्ता एपीआई को एकीकृत करते समय देख सकते हैं।

401 अमान्य या गुम बियरर टोकन।

403 वर्तमान उपयोगकर्ता योजना के लिए उपयोगकर्ता एपीआई एक्सेस अक्षम है।

404 संसाधन अनुमति प्राप्त होस्ट पर नहीं मिला या उपयोगकर्ता के स्वामित्व में नहीं है।

410 मेलबॉक्स समाप्त हो गया या निष्क्रिय है।

422 सत्यापन विफल हुआ या अनुरोधित मेलबॉक्स/डोमेन अनुमति नहीं है।

429 मासिक उपयोगकर्ता एपीआई कोटा से अधिक हो गया है।

त्वरित चेकलिस्ट

401 - बियरर टोकन गायब है, गलत है, रद्द किया गया है, या गलत तरीके से कॉपी किया गया है।
403 - वर्तमान योजना में अभी उपयोगकर्ता एपीआई एक्सेस नहीं है।
404 - मेलबॉक्स, संदेश, या अनुलग्नक उस उपयोगकर्ता का नहीं है या गलत होस्ट का उपयोग किया जा रहा है।
410 - मेलबॉक्स समाप्त हो गया है या अब सक्रिय नहीं है।
429 - मासिक अनुरोध कोटा वर्तमान अवधि के लिए पूरी तरह से उपयोग किया जा चुका है।

अगले चरण की सिफारिश की जाती है

यदि आप साइन इन हैं, तो पहले एपीआई प्रबंधन खोलें और डीबगिंग आपके बाहरी ऐप से पहले अपनी कुंजी, कोटा, योजना एक्सेस स्थिति और सटीक उपयोगकर्ता एपीआई बेस यूआरएल की पुष्टि करें।

लॉग इन करें एपीआई कुंजी कॉन्फ़िगर करने के लिए