Sign inGet Started
शुरू करें
गाइड
API Reference
SDKs
CLI
Knowledge Base
Changelog

WhatsApp दस्तावेज़ प्राप्त करना

कोई PDF, स्प्रेडशीट, या कोई भी फ़ाइल जो कोई संपर्क अटैच करता है, document ले जाने वाले इनबाउंड मैसेज के रूप में आती है: शेयर किया गया मीडिया रेफ़रेंस, साथ ही वह नाम जो उनके अपने डिवाइस ने फ़ाइल को दिया।

इनबाउंड दस्तावेज़ में क्या होता है

कोड उदाहरण
{
  "id": "wam_01kyd6s0qfxv8t4k7n1yze6rhc",
  "direction": "inbound",
  "from": { "phone_number": "+14155550100" },
  "to": { "phone_number": "+13124495569" },
  "status": "received",
  "document": {
    "id": "waf_01kyd5p6zs9yju2f0p5rtx8vgb",
    "url": "https://platform.bird.com/v1/whatsapp/messages/wam_01kyd6s0qfxv8t4k7n1yze6rhc/media/waf_01kyd5p6zs9yju2f0p5rtx8vgb",
    "mime_type": "application/pdf",
    "filename": "invoice-A1B2C3.pdf"
  },
  "created_at": "2026-08-25T09:15:02Z"
}
फ़ील्डयह क्या रखता है
idसंग्रहित फ़ाइल, बाइट्स फ़ेच करते समय media_id के रूप में पास करें
urlएक Bird URL, आपकी API कुंजी से फ़ेच किया जाता है
mime_typeफ़ाइल के लिए WhatsApp द्वारा रिपोर्ट किया गया मीडिया टाइप, जैसे application/pdf
filenameफ़ाइल के लिए भेजने वाले का अपना नाम; जब मैसेज में कोई नहीं था तो अनुपस्थित
captionदस्तावेज़ के नीचे संपर्क ने जो टेक्स्ट टाइप किया; जब उन्होंने कुछ नहीं भेजा तो अनुपस्थित

filename वह एकमात्र फ़ील्ड है जिसे भेजने वाला पक्ष और प्राप्त करने वाला पक्ष अलग-अलग तरीके से उपयोग करते हैं: भेजते समय यह वह नाम है जो आप चैट में दिखाना चाहते हैं, और इनबाउंड मैसेज में यह वह है जो संपर्क के डिवाइस ने दिया।

बाइट्स फ़ेच करना

मैसेज ID और मीडिया id को चैनल की मीडिया मेथड में पास करें। हब का इनबाउंड मीडिया फ़ेच करना वह कॉल हर भाषा में दिखाता है, साथ ही रीडायरेक्ट और हेडर नियम जिनका वह पालन करता है, और वह रिटेंशन विंडो जिसमें फ़ाइल रहती है।

filename को जैसा आता है वैसे डिस्क पर न लिखें। यह एक अनऑथेंटिकेटेड भेजने वाले का अटैकर-नियंत्रित टेक्स्ट है: इसमें पाथ सेपरेटर, ट्रैवर्सल सीक्वेंस, भ्रामक दूसरा एक्सटेंशन, या ऐसा नाम हो सकता है जो आपकी पहले से मौजूद किसी फ़ाइल से टकराए। मीडिया id से अपनी स्टोरेज कुंजी बनाएं, filename को डिस्प्ले लेबल के रूप में रखें, और फ़ाइल के साथ क्या करना है यह mime_type से तय करें, न कि उस एक्सटेंशन से जो नाम दावा करता है।

वेबहुक पेलोड

whatsapp.received इवेंट एनवेलप पर document आर्म रखता है:

कोड उदाहरण
{
  "type": "whatsapp.received",
  "timestamp": "2026-08-25T09:15:02.336Z",
  "data": {
    "whatsapp_id": "wam_01kyd6s0qfxv8t4k7n1yze6rhc",
    "workspace_id": "ws_01ky7m235keycbnwyajabe1a6b",
    "direction": "inbound",
    "from": { "phone_number": "+14155550100" },
    "to": { "phone_number": "+13124495569" },
    "document": {
      "id": "waf_01kyd5p6zs9yju2f0p5rtx8vgb",
      "url": "https://platform.bird.com/v1/whatsapp/messages/wam_01kyd6s0qfxv8t4k7n1yze6rhc/media/waf_01kyd5p6zs9yju2f0p5rtx8vgb",
      "mime_type": "application/pdf",
      "filename": "invoice-A1B2C3.pdf"
    },
    "tags": null,
    "metadata": null
  }
}

दावों या ऑनबोर्डिंग फ़्लो जो कागज़ात इकट्ठा करता है, यहाँ mime_type पर रूट कर सकता है और फ़ेच को क्यू में डाल सकता है, क्योंकि बाइट्स पूरी रिटेंशन विंडो तक उपलब्ध रहती हैं।

ध्यान देने योग्य बातें

  • mime_type फ़ाइल के बारे में WhatsApp की रिपोर्ट है, और इसके अंदर क्या है इसके बारे में कुछ नहीं बताता। संपर्क से स्वीकार की गई हर चीज़ को स्कैन करें, और पार्स करने से पहले फ़ाइल की अपनी संरचना को वैलिडेट करें।
  • कैप्शन और फ़ाइलनाम अलग-अलग फ़ील्ड हैं। फ़ाइल अटैच करते समय जो संपर्क कोई नोट टाइप करता है वह caption भरता है; filename फिर भी उनके डिवाइस से आता है।

अगले कदम

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

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

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