दस्तावेज़ पर जाएँ
API

वेब ऐप का पता प्राप्त करें

वर्कस्पेस के वेब ऐप का पता, लोग वहाँ साइन इन कर सकते हैं या नहीं, और उसके लिए ज़रूरी CNAME रिकॉर्ड। कोई पता सेट न हो तो `status` `none` होता है और `domains` उन डोमेन की सूची देता है जिनके तहत पता बनाया जा सकता है।

GET/app-host

असली कॉल आपके वर्कस्पेस पर चलाता है।

GET /app-host

वर्कस्पेस के वेब ऐप का पता, लोग वहाँ साइन इन कर सकते हैं या नहीं, और उसके लिए ज़रूरी CNAME रिकॉर्ड। कोई पता सेट न हो तो status none होता है और domains उन डोमेन की सूची देता है जिनके तहत पता बनाया जा सकता है।

वेब ऐप का पता क्या है

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

पेड प्लान वाला वर्कस्पेस वेब ऐप को openemail.uk के साथ-साथ अपने किसी सत्यापित डोमेन के सबडोमेन पर भी खोल सकता है, जैसे mailbox.acme.com। यह वही पता है जो वर्कस्पेस की Appearance सेटिंग्स का ब्रांडेड ऐप टैब सेट करता है, और हर वर्कस्पेस का ज़्यादा से ज़्यादा एक ही होता है।

वहाँ सिर्फ़ वर्कस्पेस के सदस्य, उसके किसी पते से साइन इन करने वाले लोग और लंबित आमंत्रण वाला हर व्यक्ति साइन इन कर सकते हैं, और सिर्फ़ उन्हीं को वहाँ से पासवर्ड रीसेट और सत्यापन ईमेल मिलते हैं। जब तक वर्कस्पेस अपने Appearance पेज पर लोगो सेट नहीं करता, यह openemail.uk जैसा दिखता है, फिर हमारी जगह वर्कस्पेस का लोगो, मार्क और नाम दिखाता है। उसके बाद OpenEmail उन्हें जो ईमेल भेजता है, उन पर ब्रांड होता है, उनके लिंक इसी पते पर लौटते हैं, और उस डोमेन के साइनिंग रिकॉर्ड सत्यापित होने पर वे उसके डोमेन के noreply@ से आते हैं।

इसके लिए एक CNAME रिकॉर्ड चाहिए, जिसका पूरा ब्योरा record देता है। जब तक रिकॉर्ड जवाब न दे और उसका सर्टिफ़िकेट जारी न हो, पता pending रहता है, और उसके बाद active। फ़्री प्लान पर पता रखा जाता है, पर रोक दिया जाता है: paused true होता है और जब तक वर्कस्पेस फिर से पेड प्लान पर न आए, वहाँ कोई साइन इन नहीं कर सकता।

उदाहरण

domains:read चाहिए।

curl
curl "$OE/app-host" -H "$AUTH"
प्रतिक्रिया
{  "object": "app_host",  "id": "ahost_3f9c2a71d0b84e56a1c7f2e9",  "host": "mailbox.acme.com",  "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "status": "active",  "active": true,  "paused": false,  "target": "cname.openemail.uk",  "record": {    "type": "CNAME",    "name": "mailbox.acme.com",    "value": "cname.openemail.uk"  },  "error": null,  "checkedAt": "2026-10-01T09:12:30.000Z",  "verifiedAt": "2026-10-01T09:04:11.000Z",  "available": true,  "paidPlan": true,  "domains": ["acme.com"],  "suggested": "mailbox.acme.com"}

इसे पढ़ने पर, अगर पते की आख़िरी जाँच 15 सेकंड से पुरानी है तो पता फिर से जाँचा जाता है, इसलिए active के true होने का इंतज़ार करने का तरीका इसी रूट की polling है।

active तभी true होता है जब status active हो और वर्कस्पेस पेड प्लान पर हो। paused तब true होता है जब कोई पता सेट हो और वर्कस्पेस फ़्री प्लान पर हो।

आपका इनबॉक्स,
आपकी अपनी शर्तों पर।

व्यवसायों, AI, एजेंट और निजी ईमेल के लिए ईमेल इन्फ़्रास्ट्रक्चर। स्केल, निजता और नियंत्रण के लिए बना। वह सब जो ईमेल में पहले दिन से होना चाहिए था।

© 2026 OpenEmail. सर्वाधिकार सुरक्षित।