स्वीकार किया गया संदेश बाद में डिलीवरी के दौरान विफल हो सकता है। अगर आप उसकी प्रतिक्रिया के हेडर सहेजकर रखते हैं, तो सपोर्ट मूल कॉल और संदेश के बाद के इवेंट, दोनों की एक साथ जाँच कर सकता है।
मुझे request ID कहाँ मिलेगी?
सफल और विफल दोनों कॉल पर X-Request-Id प्रतिक्रिया हेडर पढ़ें। विफलता होने पर Bird शीर्ष-स्तरीय error ऑब्जेक्ट के अंदर request_id भी शामिल करता है।
जब आपके क्लाइंट को प्रतिक्रिया मिले, तब हेडर सहेज लें। सफल भेजे गए संदेशों के लॉग में भी इसे शामिल करें, क्योंकि डिलीवरी का अप्रत्याशित परिणाम बाद में आ सकता है।
मुझे सपोर्ट को क्या भेजना चाहिए?
प्रभावित प्रयास की request ID, उसका समय, ऑपरेशन और अप्रत्याशित परिणाम भेजें। HTTP स्टेटस और त्रुटि का कोई भी code और name भी शामिल करें।
हर फिर से प्रयास की अपनी request ID होती है। अगर पहला प्रयास विफल रहा और दूसरा सफल हुआ, तो विफलता के बारे में पूछते समय पहले प्रयास की ID शामिल करें।
डिलीवरी से जुड़े सवालों के लिए message ID भी शामिल करें। एक ईमेल बैच अनुरोध एक ही request ID के तहत 100 तक संदेश कतार में डाल सकता है।
मेरे क्लाइंट को क्या लॉग करना चाहिए?
हर प्रयास के लिए प्रतिक्रिया हेडर, HTTP स्टेटस, अनुरोध का समय और ऑपरेशन लॉग करें। त्रुटियों के लिए त्रुटि प्रतिक्रिया से code, name और request_id भी दर्ज करें।
ये फ़ील्ड अलग-अलग सवालों के जवाब देते हैं। कोड दस्तावेज़ में दी गई विफलता की पहचान करता है। नाम से लॉग पढ़ने में आसान होते हैं। request ID से सपोर्ट उस प्रयास का पता लगा सकता है।
लौटाई गई message ID को अपने एप्लिकेशन के उस रिकॉर्ड के साथ रखें जो भेजे गए संदेश को दर्ज करता है। सिर्फ़ इन पहचानकर्ताओं को रखने के लिए क्रेडेंशियल या संदेश का मुख्य भाग लॉग न करें।
मैं इवेंट को अपने रिकॉर्ड से कैसे जोड़ूँ?
भेजने वाला एंडपॉइंट जिन फ़ील्ड्स को सपोर्ट करता है, उनके ज़रिए अपने एप्लिकेशन का पहचानकर्ता जोड़ें। ईमेल भेजने पर, metadata और tags वेबहुक इवेंट में वापस लौटाए जाते हैं।
उदाहरण के लिए, ऑर्डर पहचानकर्ता किसी डिलीवरी इवेंट को उस ऑर्डर से जोड़ सकता है जिसके कारण ईमेल भेजा गया था। API कॉल की जांच के लिए अनुरोध ID को अलग से रखें।
मुझे कौन सा पहचानकर्ता इस्तेमाल करना चाहिए?
किसी एक API प्रयास के लिए अनुरोध ID और डिलीवरी इतिहास के लिए संदेश ID इस्तेमाल करें।
| पहचानकर्ता | इसका उपयोग |
|---|---|
X-Request-Id | किसी एक API प्रयास के बारे में सपोर्ट से पूछने के लिए। |
| संदेश ID | किसी एक संदेश को उसके डिलीवरी इवेंट में ट्रैक करने के लिए। |
Idempotency-Key | जानबूझकर कोई दूसरा ऑपरेशन बनाए बिना उसी राइट को फिर से प्रयास करने के लिए। |
webhook-id | एक ही इवेंट की दोहराई गई डिलीवरी को हटाकर केवल एक रखें। |
metadata या tags में आपका पहचानकर्ता | समर्थित इवेंट को अपने एप्लिकेशन के रिकॉर्ड से जोड़ें। |
एक ही राइट के हर फिर से प्रयास में आइडेम्पोटेंसी कुंजी एक जैसी रखें। रिक्वेस्ट ID हर प्रयास के साथ बदल जाती है। वेबहुक इवेंट की डिलीवरी दोबारा होने पर भी उसका पहचानकर्ता वही रहता है।
त्रुटि गाइड बताती है कि त्रुटि प्रतिक्रियाओं में रिक्वेस्ट ID कहाँ दिखाई देती है।
संक्षेप में
प्रतिक्रिया का हेडर लॉग करें।
X-Request-Idप्रयास की पहचान करता है, चाहे वह सफल हुआ हो या विफल। त्रुटियों के एनवेलप मेंrequest_idभी शामिल होता है।हर फिर से प्रयास को अलग रखें।
फिर से प्रयास करने पर नया अनुरोध ID मिलता है, भले ही उसमें वही idempotency कुंजी इस्तेमाल हो।
डिलीवरी से जुड़े सवालों के लिए संदेश ID शामिल करें।
एक API कॉल कई संदेशों को कतार में डाल सकती है, इसलिए केवल उसके अनुरोध ID से प्रभावित प्राप्तकर्ता की पहचान शायद न हो पाए।
रिकॉर्ड जोड़ने के लिए अपने एप्लिकेशन के पहचानकर्ताओं का उपयोग करें।
ईमेल भेजते समय, metadata और tags आपके पहचानकर्ताओं को वेबहुक इवेंट तक पहुँचाते हैं।