मौजूदा संदेश अभियान निष्क्रिय करें
खाते के स्वामित्व वाला अभियान बंद करते समय इस रूट का उपयोग करें। मिलान और ऐतिहासिक रिकॉर्ड के लिए उसकी अभियान आईडी सुरक्षित रखें। सामग्री में सुधार या सहमति के पाठ में बदलाव के लिए इसके बजाय संदेश अभियान अपडेट करें का उपयोग करें।
अनुमत स्रोत आईपी पते से HTTPS के माध्यम से सक्षम API खाते का उपयोग करके प्रमाणीकरण करें। पहले अभियान का विवरण पढ़ें और उससे जुड़े ब्रांड तथा संदेश भेजने वाले नंबरों की जाँच करें। निष्क्रिय करने से पंजीकरण बदलता है; इससे कोई प्रतिस्थापन अभियान नहीं बनता और न ही नंबर किसी अन्य अभियान में स्थानांतरित होते हैं।
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"पहले प्रभावित नंबरों के आवंटन हटाएँ
अभियान का सार्वजनिक DELETE फ़ोन नंबरों को संदेश सेवा प्रदाता से अलग नहीं करता और न ही उनका स्थानीय आवंटन हटाता है। नंबर का अभियान से आवंटन हटाने की कार्यप्रक्रिया का उपयोग खाते के स्वामित्व वाले प्रत्येक प्रभावित नंबर के लिए करें, फिर उसके आवंटन की पुष्टि करें। आवंटन हटाने से फ़ोन नंबर मुक्त नहीं होता।
पोर्टल की अधिक व्यापक ‘ब्रांड हटाएँ’ कार्यप्रक्रिया उस ब्रांड को हटाने से पहले उसके अभियानों और नंबरों की सफ़ाई करती है। यदि आप ब्रांड और उसके अन्य अभियान बनाए रखना चाहते हैं, तो उस कार्रवाई का उपयोग न करें। वर्तमान सामान्य अभियान संपादक में इस सीधे API रूट के समकक्ष अभियान हटाने का कोई अलग बटन उपलब्ध नहीं है।
इच्छित निष्क्रियकरण अनुरोध भेजें
अभियान आईडी और प्रभावित संदेश-प्रेषण व्यवस्था की समीक्षा करने के बाद, बिना JSON बॉडी के DELETE भेजें:
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
--request DELETE \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
"https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"दस्तावेज़ के अनुसार सफल प्रतिक्रिया खाली बॉडी के साथ HTTP 204 है। JSON status/response आवरण की अपेक्षा करने के बजाय HTTP स्थिति जाँचें। हटाने का अनुरोध स्वीकार होने पर, वर्तमान सेवा स्थानीय रूप से अभियान संसाधन को हटाया गया और समाप्त चिह्नित करती है तथा उसके पुराने अभियान रिकॉर्ड को समाप्त चिह्नित करती है। इस कार्रवाई के परिणामस्वरूप ब्रांड नहीं हटता।
इस इच्छित अनुरोध के लिए एक ही इडेम्पोटेंसी कुंजी का उपयोग करें और पुनः भेजने के लिए विधि, पथ, क्वेरी तथा बॉडी के बाइट हूबहू सुरक्षित रखें। पहले से संसाधित हो रहे अनुरोध की प्रतिलिपि भेजने पर Retry-After के साथ 409 मिल सकता है; पूरे हो चुके अनुरोधों को दोहराने पर संग्रहीत परिणाम फिर मिल सकता है। कैश में संग्रहीत त्रुटि या कनेक्शन टूटने से यह निश्चित नहीं होता कि रजिस्ट्री पहले ही कार्रवाई कर चुकी है या नहीं। अभियान आईडी और उपलब्ध होने पर requestId सुरक्षित रखें।
पंजीकरण और आवंटन, दोनों की पुष्टि करें
अनुरोध के बाद पोर्टल में अभियान की वर्तमान स्थिति और प्रभावित नंबरों की जाँच करें। अभियान बंद होने के बाद भी API स्थानीय स्वामित्व मेटाडेटा बनाए रख सकता है, ताकि स्वामित्व वाले पहचानकर्ता की जाँच की जा सके; यह न मानें कि उसी आईडी पर हमेशा स्थानीय 404 मिलना ही चाहिए। बंद किए गए रिकॉर्ड के लिए लौटाई जाने वाली स्थिति या उसकी उपलब्धता रजिस्ट्री तय करती है।
यदि कोई नंबर अब भी आवंटित है, तो उस मौजूदा आवंटन का मिलान करें। केवल निष्क्रियकरण का दोबारा प्रयास करने के लिए दूसरा अभियान न बनाएँ और न ही यह मानें कि HTTP 204 से सेवा प्रदाता के स्तर पर सफ़ाई हो जाने की पुष्टि होती है। यदि रजिस्ट्री द्वारा अनुरोध स्वीकार करने के बाद स्थानीय समन्वयन विफल हो जाता है, तो API 500 लौटा सकता है, भले ही बाहरी प्रणाली में निष्क्रियकरण पहले ही हो चुका हो।
| परिणाम | अगला कदम |
|---|---|
| 204 | प्रतिक्रिया में बॉडी अपेक्षित नहीं है। अभियान की स्थिति और स्वतंत्र रूप से प्रबंधित नंबर आवंटनों की पुष्टि करें। |
| 400 | दी गई सत्यापन या रजिस्ट्री की स्थिति संबंधी त्रुटि पढ़ें। अभियान की सटीक आईडी और मौजूदा स्थिति जाँचें। |
| 401, 403, 404 | API क्रेडेंशियल, अनुमत स्रोत आईपी और खाते के स्वामित्व की जाँच करें। किसी अन्य ग्राहक की आईडी का उपयोग न करें। |
| 409, 429 | प्रगति में चल रहे या टकराव वाले इडेम्पोटेंट अनुरोध और अनुरोध-दर सीमा लागू होने के बीच अंतर पहचानें; जहाँ Retry-After दिया गया हो, उसका पालन करें। |
| 500, 502 या समय-सीमा समाप्त होना | अनुरोध का विवरण सुरक्षित रखें, मौजूदा अभियान का विवरण पढ़ें और दोबारा अनुरोध भेजने से पहले मिलान करें। |
अभियान बंद करना खाते के वित्तीय निपटान से अलग है
वर्तमान DELETE सेवा अभियान पंजीकरण के लिए तत्काल राशि काटने का निर्देश नहीं भेजती। इससे धनवापसी का वादा नहीं होता, कोई मौजूदा प्रतिबद्धता समाप्त नहीं होती और न ही किराए के नंबर मुक्त होते हैं। पोर्टल में खाते की अभियान संबंधी शर्तें और बकाया चालान जाँचें। नंबरों का किराया और संदेशों का उपयोग अभियान पंजीकरण से अलग हैं।
यदि अभियानों और आवंटनों का मिलान करने के बाद पूरे व्यवसाय का पंजीकरण बंद किया जा रहा है, तो आगे ब्रांड का पंजीकरण बंद करने की प्रक्रिया अपनाएँ।