अपने खाते का कोई मौजूदा ब्रांड चुनें
अपने MultiTEL खाते से पहले से संबद्ध रजिस्ट्री ब्रांड आईडी से शुरू करें। यह खोज न तो कोई ब्रांड बनाती है और न ही किसी अन्य व्यक्ति का ब्रांड आपके खाते से जोड़ती है। मौजूदा ग्राहक कार्यप्रवाह पात्रता की जानकारी माँगने से पहले स्वामित्व की जाँच करता है। यदि खोज में 404 मिलता है, तो उसकी जगह स्थानीय पंक्ति की आईडी देने के बजाय चुने गए खाते और ब्रांड की पुष्टि करें।
इस परिणाम से उपयोग के मामलों के विकल्प तैयार करें
उपयोग के मामलों की सामान्य सूची रजिस्ट्री के विकल्पों का वर्णन करती है। यह ब्रांड-विशिष्ट खोज चुने गए ब्रांड के लिए विकल्प देती है। लौटाए गए प्रत्येक usecase मान को बनाए रखें और उसे सूची के प्रदर्शन लेबल और विवरण से जोड़ें। सामान्य सूची की हर प्रविष्टि को इस तरह प्रस्तुत न करें मानो ब्रांड उसके लिए पात्र हो।
पोर्टल अपेक्षा करता है कि यह प्रतिक्रिया एक JSON सूची हो। यदि प्रतिक्रिया अनुपस्थित है, उसका प्रारूप गलत है या उसमें त्रुटि है, तो ग्राहक का फ़ॉर्म सुरक्षित रखें और दिखाएँ कि पात्रता की जानकारी लोड नहीं हो सकी। बिना बताए इसे किसी डिफ़ॉल्ट उपयोग के मामले की स्वीकृति न मानें। रजिस्ट्री संक्षिप्त उदाहरण में दिखाए गए फ़ील्ड के अतिरिक्त फ़ील्ड भी लौटा सकती है।
चुने गए उपयोग के मामले की आवश्यकताएँ लोड करें
ग्राहक द्वारा लौटाए गए उपयोग के मामले का कोई मान चुनने के बाद, उसी ब्रांड के लिए अनुरोध करें: /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase}। उस प्रतिक्रिया में उपयोग के उप-मामलों की सीमाएँ और दूरसंचार ऑपरेटर के अनुसार आवश्यकताएँ मिलती हैं। उसके आधार पर संदेशों के नमूने, सहमति और अन्य आवश्यक घोषणाएँ एकत्र करें। केवल पात्रता सूची के आधार पर संपूर्ण अभियान पंजीकरण तैयार नहीं किया जा सकता।
खाते की कीमतों की अलग से समीक्षा करें
प्रदाता के फ़ील्ड, जैसे monthlyFee, quarterlyFee या annualFee, लौटाए जाने पर प्रदाता के शुल्क संबंधी मेटाडेटा का वर्णन करते हैं। वे ग्राहक के खाते की कीमत या पंजीकरण की शर्तों का स्थान नहीं लेते। मौजूदा पोर्टल अभियान की खुदरा कीमतें अलग से पढ़ता है और अपनी समीक्षा स्क्रीन के लिए उन्हें पात्रता डेटा से जोड़ता है। पुराने एनम सहायक में हार्डकोड की गई कीमतों से ग्राहक पर लगने वाले शुल्क का अनुमान न लगाएँ।
ब्रांड या उपयोग का मामला बदलने पर जानकारी ताज़ा करें
ब्रांड बदलते समय पिछले ब्रांड के विकल्प हटा दें और नए चयन की पात्रता की जानकारी लोड करें। सबमिट करने से पहले चुने गए उपयोग के मामले की आवश्यकताएँ ताज़ा करें। ये GET अनुरोध न तो पंजीकरण सबमिट करते हैं, न अभियान सक्रिय करते हैं और न ही नंबर आवंटित करते हैं।
अनुरोध
अनुमत स्रोत आईपी पते से HTTPS के ज़रिए सक्षम API खाते का उपयोग करें। मौजूदा रूट खाते की प्रमाणीकरण नीति का समर्थन करता है, जिसमें Basic प्रमाणीकरण और सक्षम बेयरर API खाते शामिल हैं। प्रदाता के क्रेडेंशियल का उपयोग न करें।
URL पथ में ब्रांड पहचानकर्ता देकर GET अनुरोध करें। अनुरोध बॉडी की आवश्यकता नहीं है।
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| नाम | प्रकार | अनिवार्य | विवरण |
|---|---|---|---|
brand_id | स्ट्रिंग | हाँ | आपके प्रमाणीकृत MultiTEL खाते से संबद्ध रजिस्ट्री ब्रांड आईडी। ब्रांड आईडी का उपयोग करें, स्थानीय डेटाबेस की पंक्ति की आईडी, अभियान आईडी या व्यवसाय की कर संख्या का नहीं। इसे URL पथ के एक ही खंड के रूप में एन्कोड करें। |
प्रतिक्रिया
मौजूदा TCR रूट रजिस्ट्री की JSON बॉडी सीधे लौटाता है और उसकी HTTP स्थिति बनाए रखता है। यह पुराने v3 का status/response आवरण नहीं जोड़ता। संक्षिप्त काल्पनिक उदाहरण पात्रता का वास्तविक, ताज़ा परिणाम नहीं है। उसका उपयोग करने से पहले HTTP स्थिति और अपेक्षित JSON संरचना जाँचें। मौजूदा पोर्टल पात्रता रिकॉर्ड की सूची की अपेक्षा करता है, जिसमें हर रिकॉर्ड एक usecase की पहचान करता है। प्रदर्शन लेबल पाने के लिए वह इन रिकॉर्ड को usecase सूची से जोड़ता है और खुदरा कीमतें अलग से पढ़ता है। प्रदाता के अतिरिक्त फ़ील्ड भी मौजूद हो सकते हैं।
प्रतिक्रिया की संरचना का उदाहरण; यह खाते का वास्तविक, ताज़ा डेटा या मौजूदा मूल्य-प्रस्ताव नहीं है।
[
{
"usecase": "2FA"
}
]त्रुटियाँ
- 401: खाते का प्रमाणीकरण विफल हुआ। API क्रेडेंशियल, खाते के सक्षम होने की स्थिति और लागू स्रोत आईपी प्रतिबंध जाँचें।
- 404: ब्रांड प्रमाणीकृत खाते से संबद्ध नहीं है, या प्रदाता अनुरोधित ब्रांड या चयन नहीं खोज पा रहा है। स्थानीय स्वामित्व जाँच में अस्वीकृति होने पर प्रदाता को अनुरोध भेजने से पहले ही अस्वीकृति लौटा दी जाती है।
- रजिस्ट्री की अन्य त्रुटियाँ: अपस्ट्रीम की HTTP स्थिति और बॉडी बनाए रखी जाती हैं। अमान्य या अनुपलब्ध उपयोग के मामले को सफलतापूर्वक प्राप्त आवश्यकताओं का खाली समूह न मानें।
- 429: खाते या साझा प्रदाता की अनुरोध सीमा पूरी हो गई है। Retry-After का पालन करें।
- 502/503: परिवहन, प्रदाता या दर-सीमक की उपलब्धता में विफलता। फ़ॉर्म सुरक्षित रखें और प्रयासों के बीच बढ़ते अंतराल के साथ पुनः प्रयास करें।
उपलब्धता और अतिरिक्त प्रभाव
- समीक्षित GET मौजूदा ब्रांड के स्वामित्व की जाँच करता है, रजिस्ट्री से संपर्क करता है और अनुरोध के ऑडिट रिकॉर्ड लिखता है। यह न तो ब्रांड या अभियान बनाता है और न ही पंजीकरण शुल्क लेता है।
- प्रदाता के शुल्क संबंधी मेटाडेटा को MultiTEL ग्राहक के लिए खुदरा मूल्य-प्रस्ताव न मानें। बाद में पंजीकरण अनुरोध भेजने से पहले पोर्टल खाते की कीमतों की अलग से समीक्षा करता है।
- पात्रता और आवश्यकताएँ बदल सकती हैं। सबमिट करने से पहले चुने गए ब्रांड और उपयोग के मामले के लिए उन्हें ताज़ा करें। सफल खोज का अर्थ अभियान की स्वीकृति, नंबर का आवंटन या संदेश भेजना शुरू करने की अनुमति नहीं है।