Sign inGet Started

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

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

1. एक API key बनाएँ

डैशबोर्ड में Developers > API keys पर जाएँ और एक key बनाएँ। Keys एक रीजन से जुड़ी होती हैं और bk_us1_... या bk_eu1_... जैसी दिखती हैं; प्रीफ़िक्स में रीजन बताता है कि कौन-सा API होस्ट कॉल करना है: https://us1.platform.bird.com या https://eu1.platform.bird.com।
Bird डैशबोर्ड में API Keys पेज, जिसमें keys उनके मास्क्ड प्रीफ़िक्स, स्कोप और अंतिम उपयोग समय के साथ दिखाई गई हैं
पूरी key केवल एक बार, बनाते समय दिखाई जाती है। इसे किसी सुरक्षित जगह कॉपी करें, फिर इसे एक्सपोर्ट करें ताकि स्टेप 2 के स्निपेट इसे पढ़ सकें:
कोड उदाहरण
export BIRD_API_KEY="bk_us1_..."

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

onboarding@messagebird.dev से भेजें, जो Bird का शेयर्ड onboarding डोमेन है और आपके वर्कस्पेस में बिना किसी सेटअप के उपलब्ध है। इसे delivered@messagebird.dev को संबोधित करें, एक sandbox प्राप्तकर्ता जो हमेशा डिलीवर होता है, ताकि बिना किसी असली मेलबॉक्स के परिणाम निश्चित हो।
cURL कॉल US होस्ट का उपयोग करती है। अगर आपकी key bk_eu1_ से शुरू होती है, तो इसके बजाय https://eu1.platform.bird.com को कॉल करें। SDK आपकी key से रीजन पढ़ता है और होस्ट चुनता है। 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 quickstarts का उपयोग करें।

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 तक पहुँचता है। Sandbox मैसेज 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 क्या स्थापित करता है, यह जानने के लिए events गाइड देखें।
चूँकि आपने delivered@messagebird.dev को भेजा, परिणाम गारंटीड है: मैसेज Bird की वास्तविक डिलीवरी पाइपलाइन से गुज़रता है, जिसमें प्रोडक्शन event और webhook शेप्स शामिल हैं, लेकिन किसी असली मेलबॉक्स को नहीं छूता। बाउंस टेस्ट करने के लिए bounce@messagebird.dev को भेजें। testing sandbox गाइड में हर sandbox पता और उसका सिमुलेटेड परिणाम सूचीबद्ध है।

Onboarding डोमेन के बारे में

शेयर्ड onboarding@messagebird.dev सेंडर onboarding के लिए उपलब्ध है और इसकी ये सीमाएँ हैं:
  • @messagebird.dev sandbox पतों के अलावा, यह केवल आपके वर्कस्पेस के सत्यापित सदस्यों को डिलीवर करता है; किसी भी अन्य प्राप्तकर्ता को 422 के साथ अस्वीकार कर दिया जाता है।
  • भेजने की सीमा प्रति संगठन प्रति UTC दिन 50 प्राप्तकर्ता है, जिसमें हर to, cc, और bcc पता गिना जाता है, sandbox प्राप्तकर्ता भी शामिल हैं। सीमा पार होने पर API एक 429 लौटाता है।
जब आप असली ग्राहकों को ईमेल भेजने के लिए तैयार हों, तो अपना खुद का सेंडिंग डोमेन सत्यापित करें और from में अपना पता डालें; अनुरोध में बाकी सब कुछ वैसा ही रहेगा।

अगले कदम

संबंधित संसाधन

इस विषय के लिए डॉक्यूमेंटेशन, गाइड और उदाहरणों के साथ आगे बढ़ें। संसाधन अंग्रेज़ी में हैं।

अभ्यास करें और इम्प्लीमेंटेशन ब्रीफ़ पाएँ