Sign inGet Started

अपना पहला ईमेल भेजें

एक API कुंजी बनाएँ, Bird के साझा ऑनबोर्डिंग डोमेन से भेजें, और परिणाम जाँचें। इस गाइड के लिए आपको कोई सेंडिंग डोमेन सत्यापित करने या DNS रिकॉर्ड प्रकाशित करने की ज़रूरत नहीं है। ग्राहकों को भेजने से पहले अपना डोमेन सत्यापित करें।

1. एक API कुंजी बनाएँ

डैशबोर्ड में Developers > API keys पर जाएँ और एक कुंजी बनाएँ। कुंजियाँ किसी एक क्षेत्र तक सीमित होती हैं और bk_us1_... या bk_eu1_... जैसी दिखती हैं; प्रीफ़िक्स में दिया क्षेत्र बताता है कि आपको किस API होस्ट को कॉल करना है: https://us1.platform.bird.com या https://eu1.platform.bird.com।

Bird डैशबोर्ड में API Keys पेज, जिसमें कुंजियाँ उनके छिपे हुए प्रीफ़िक्स, स्कोप और पिछली बार उपयोग के समय के साथ सूचीबद्ध हैं

पूरी कुंजी केवल एक बार, बनाते समय दिखाई जाती है। इसे किसी सुरक्षित जगह कॉपी करें, फिर इसे एक्सपोर्ट करें ताकि चरण 2 के स्निपेट इसे पढ़ सकें:

कोड उदाहरण
export BIRD_API_KEY="bk_us1_..."

2. एक ईमेल भेजें

onboarding@messagebird.dev से भेजें, जो Bird का साझा ऑनबोर्डिंग डोमेन है और बिना किसी सेटअप के आपके वर्कस्पेस में उपलब्ध है। इसे delivered@messagebird.dev पर भेजें, जो एक सैंडबॉक्स प्राप्तकर्ता है और हमेशा डिलीवर होता है, ताकि असली मेलबॉक्स के बिना भी परिणाम निश्चित रहे।

cURL कॉल में US होस्ट दिया गया है। अगर आपकी कुंजी bk_eu1_ से शुरू होती है, तो इसके बजाय https://eu1.platform.bird.com को कॉल करें। SDK आपकी कुंजी से क्षेत्र पढ़कर होस्ट चुनता है। TypeScript टैब के लिए npm install @messagebird/sdk ज़रूरी है।

import { BirdClient } from "@messagebird/sdk";

const bird = new BirdClient({ apiKey: process.env.BIRD_API_KEY! });

const msg = await bird.email.send({
  from: { email: "onboarding@messagebird.dev", name: "Bird" },
  to: ["delivered@messagebird.dev"],
  subject: "Hello from Bird",
  html: "<p>My first Bird email.</p>",
});

console.log(msg.id, msg.status);

हर भाषा या फ़्रेमवर्क में इंस्टॉल करने और चलाने के पूरे चरणों के लिए SDK क्विकस्टार्ट देखें।

3. परिणाम देखें

API 202 के साथ जवाब देता है: Bird ने भेजने के अनुरोध को एसिंक्रोनस प्रोसेसिंग के लिए स्वीकार कर लिया है। डिलीवरी की स्थिति अलग से जाँचें। *_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"
}

संदेश की वर्तमान अवस्था देखने के लिए उसे उसकी em_ ID से प्राप्त करें। संदेश accepted से processed होते हुए delivered तक पहुँचता है। जब तक सैंडबॉक्स संदेश delivered तक न पहुँच जाए, तब तक पोल करें:

const msg = await bird.email.get("em_abc123");
msg.status; // "accepted" | "processed" | "delivered" | "bounced" | …
msg.delivered_count;
msg.bounced_count;

cURL टैब में {region} और {message_id} को बदलें, और $TOKEN की जगह $BIRD_API_KEY का उपयोग करें।

अब रीड में status: "delivered", delivered_count: 1 और एक delivered_at टाइमस्टैम्प दिखता है। किसी वास्तविक प्राप्तकर्ता के लिए delivered से क्या पुष्टि होती है, यह जानने के लिए इवेंट गाइड देखें।

आपने delivered@messagebird.dev पर भेजा है, इसलिए परिणाम निश्चित है: संदेश Bird की वास्तविक डिलीवरी पाइपलाइन से गुज़रता है, जिसमें प्रोडक्शन जैसे इवेंट और वेबहुक का स्वरूप भी शामिल है, लेकिन किसी वास्तविक मेलबॉक्स तक नहीं पहुँचता। बाउंस का परीक्षण करने के लिए bounce@messagebird.dev पर भेजें। टेस्टिंग सैंडबॉक्स गाइड में हर सैंडबॉक्स पता और उसका सिम्युलेटेड परिणाम दिया गया है।

ऑनबोर्डिंग डोमेन के बारे में

साझा onboarding@messagebird.dev प्रेषक ऑनबोर्डिंग के लिए उपलब्ध है और इसकी ये सीमाएँ हैं:

  • @messagebird.dev सैंडबॉक्स पतों के अलावा, यह केवल आपके वर्कस्पेस के सत्यापित सदस्यों को डिलीवर करता है; किसी भी अन्य प्राप्तकर्ता को 422 के साथ अस्वीकार कर दिया जाता है।
  • भेजने की सीमा हर संगठन के लिए प्रति UTC दिन 50 प्राप्तकर्ता है, जिसमें हर to, cc और bcc पता गिना जाता है, सैंडबॉक्स प्राप्तकर्ता भी। सीमा पार होने पर API एक 429 लौटाता है।

जब आप वास्तविक ग्राहकों को ईमेल भेजने के लिए तैयार हों, तो अपना भेजने वाला डोमेन सत्यापित करें और from में अपना पता डालें; अनुरोध में बाकी सब कुछ वैसा ही रहता है।

अगले कदम

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