Sign inGet Started

CLI

macOS या Linux टर्मिनल से अपना पहला ईमेल भेजें: bird CLI इंस्टॉल करें, एक बार लॉग इन करें और भेजें। आपको कोई API कुंजी कॉपी करने की ज़रूरत नहीं है।

1. इंस्टॉल करें

कोड उदाहरण
curl -fsSL https://cli.bird.com/install.sh | sh

इंस्टॉलेशन सफल हुआ है, यह पुष्टि करने के लिए bird version चलाएँ। Windows और इंस्टॉलेशन के अन्य विकल्पों के लिए CLI इंस्टॉल करें देखें।

2. लॉग इन करें

कोड उदाहरण
bird auth login --scope emails:write

इससे ब्राउज़र में एक सहमति पेज खुलता है, जहाँ आप वर्कस्पेस चुनते हैं और अनुमति स्वीकृत करते हैं। emails:write स्कोप की वजह से चरण 3 में ईमेल भेजा जा सकता है। इसके बिना bird auth login केवल पढ़ने की अनुमति माँगता है और भेजने का अनुरोध अस्वीकार हो जाता है। CLI वर्कस्पेस से जुड़ा OAuth टोकन ~/.config/bird/credentials.json में सहेजता है, ज़रूरत पड़ने पर उसे रीफ़्रेश करता है और वर्कस्पेस का क्षेत्र दर्ज करता है।

3. ईमेल भेजें

Bird के साझा ऑनबोर्डिंग डोमेन से delivered@messagebird.dev सैंडबॉक्स पते पर भेजें: इसके लिए न डोमेन सत्यापन चाहिए, न कोई असली मेलबॉक्स।

कोड उदाहरण
bird email send \
  --from onboarding@messagebird.dev \
  --to delivered@messagebird.dev \
  --subject "Hello from Bird" \
  --html "<p>My first Bird email.</p>"

CLI स्वीकार किए गए संदेश को JSON के रूप में प्रिंट करता है। *_count फ़ील्ड डिलीवरी की अलग-अलग स्थितियों में प्राप्तकर्ताओं को ट्रैक करते हैं। शुरुआती प्रतिक्रिया में एक प्राप्तकर्ता स्वीकार किया गया होता है और किसी को भी डिलीवरी नहीं हुई होती:

कोड उदाहरण
{
  "id": "em_01ky7ma8y2es1s2akzk53tmjn0",
  "status": "accepted",
  "category": "marketing",
  "from": { "email": "onboarding@messagebird.dev" },
  "to": [{ "email": "delivered@messagebird.dev" }],
  "subject": "Hello from Bird",
  "accepted_count": 1,
  "processed_count": 0,
  "delivered_count": 0,
  "deferred_count": 0,
  "bounced_count": 0,
  "complained_count": 0,
  "rejected_count": 0,
  "open_count": 0,
  "click_count": 0,
  "track_opens": true,
  "track_clicks": true,
  "created_at": "2026-07-23T13:58:20.866Z"
}

कई प्राप्तकर्ताओं के लिए --to को बार-बार दिया जा सकता है, --text सादा-टेक्स्ट बॉडी भेजता है, और --dry-run अनुरोध भेजे बिना उसका अंतिम रूप प्रिंट करता है।

4. परिणाम जाँचें

accepted का अर्थ है कि Bird ने संदेश स्वीकार कर लिया है और उसे एसिंक्रोनस रूप से डिलीवर करेगा। उसकी em_ ID से संदेश को वापस पढ़ें और स्टेटस के delivered तक पहुँचने पर नज़र रखें:

कोड उदाहरण
bird email get em_01ky7ma8y2es1s2akzk53tmjn0

JSON के बजाय आसानी से पढ़ा जा सकने वाला कार्ड पाने के लिए --format text जोड़ें।

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

अगले कदम

इस विषय के लिए दस्तावेज़, गाइड और उदाहरणों के साथ आगे बढ़ें।