किसी ब्रांड की कैंपेन आवश्यकताएँ पढ़ें

ब्रांड और यूज़ केस को साथ रखें

अपने खाते की ब्रांड ID और उसी ब्रांड की योग्यता सूची द्वारा लौटाए गए यूज़-केस मान का उपयोग करें। ग्राहक वर्कफ़्लो प्रदाता अनुरोध से पहले स्वामित्व की जाँच करता है। पुष्टि करें कि लौटाए गए ऑब्जेक्ट का usecase चयनित मान से मेल खाता है। एक ब्रांड या यूज़ केस के लिए किया गया लुकअप किसी दूसरे के लिए आवश्यकताएँ स्थापित नहीं करता।

वर्तमान आवश्यकताएँ पढ़ें

वर्तमान कैंपेन फ़ॉर्म द्वारा उपयोग की जाने वाली आवश्यकताएँ
फ़ील्ड	पोर्टल इसका उपयोग कैसे करता है
minSubUsecases / maxSubUsecases	इस चयन के लिए सब-यूज़ केस की न्यूनतम और अधिकतम संख्या। मुक्त पाठ के बजाय मान्य सब-यूज़-केस कैटलॉग से मान चुनें।
mnoMetadata	कैरियर ID द्वारा कुंजीबद्ध कैरियर-विशिष्ट आवश्यकताएँ। कैरियर चयन के लिए वर्तमान प्रतिक्रिया में मौजूद ID का उपयोग करें।
mnoSupport / qualify	कैरियर समर्थन और योग्यता। पोर्टल उन कैरियरों को बाहर कर देता है जिन्हें इनमें से किसी भी फ़ील्ड के लिए स्पष्ट रूप से false चिह्नित किया गया है, और कम से कम एक पात्र चयनित कैरियर की आवश्यकता रखता है।
minMsgSamples	किसी कैरियर के लिए आवश्यक नमूनों की संख्या। पोर्टल कम से कम एक गैर-रिक्त नमूने की आवश्यकता रखता है और पात्र चयनित कैरियरों में से सबसे अधिक न्यूनतम को पूरा करता है।
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp	आवश्यक सब्सक्राइबर घोषणाएँ। जहाँ आवश्यक हो, संबंधित घोषणा true होनी चाहिए। सक्षम की गई घोषणाओं को उनके कीवर्ड और प्रतिक्रिया-संदेश फ़ील्ड की भी आवश्यकता होती है।
noEmbeddedLink / noEmbeddedPhone	एम्बेडेड लिंक या फ़ोन नंबरों पर प्रतिबंध। यदि कोई पात्र चयनित कैरियर किसी घोषित सुविधा को प्रतिबंधित करता है, तो पोर्टल उसे अस्वीकार कर देता है।

चयनित कैरियरों की आवश्यकताएँ एक साथ लागू करें

कैरियर आवश्यकताएँ भिन्न हो सकती हैं। जब कोई स्पष्ट कैरियर सूची नहीं दी जाती, तो पोर्टल प्रतिक्रिया में मौजूद सभी कैरियर मेटाडेटा पर विचार करता है; एक गैर-रिक्त सूची जाँचों को उन्हीं चयनित ID तक सीमित कर देती है। केवल पहले कैरियर की नमूना संख्या या घोषणाओं का उपयोग न करें। प्रतिक्रिया से कैरियर चुनें, समर्थन और योग्यता की जाँच करें, सबसे अधिक लागू नमूना न्यूनतम को पूरा करें, और उस चयन में आवश्यक ऑप्ट-इन, ऑप्ट-आउट और सहायता घोषणाओं को संतुष्ट करें। पोर्टल वर्तमान प्रतिक्रिया में अनुपस्थित चयनित कैरियर ID को अस्वीकार करता है और ऐसे चयन को भी अस्वीकार करता है जिसमें कोई पात्र कैरियर न हो।

आवश्यकताएँ यह बताती हैं कि क्या प्रदान किया जाना चाहिए; वे यह सिद्ध नहीं करतीं कि ग्राहक की सहमति प्रक्रिया या कैंपेन सामग्री उन आवश्यकताओं को पूरा करती है। सत्य और प्रतिनिधि नमूने तथा घोषणाएँ एकत्र करें। फ़ॉर्म पास कराने के लिए घोषणाओं को स्वचालित रूप से चालू न करें।

नमूने और सब्सक्राइबर प्रतिक्रियाएँ तैयार करें

वर्तमान कैंपेन फ़ॉर्म संदेश नमूनों के लिए sample1 से sample5 तक का उपयोग करता है। यदि उपलब्ध फ़ॉर्म के भीतर आवश्यकताएँ पूरी नहीं की जा सकतीं, तो रुकें और सहायता टीम के साथ चयन का समाधान करें। किसी सक्षम सब्सक्राइबर घोषणा के लिए, उसके संबंधित कीवर्ड और प्रतिक्रिया पाठ प्रदान करें: optinKeywords/optinMessage, optoutKeywords/optoutMessage, और helpKeywords/helpMessage। नमूनों को चुने गए यूज़ केस और वास्तविक ग्राहक संदेश के अनुरूप रखें।

किसी भी पंजीकरण अनुरोध से पहले समीक्षा करें

जब ब्रांड, यूज़ केस या कैरियर चयन बदले, तो आवश्यकताएँ ताज़ा करें। पोर्टल निर्माण से पहले चयनित यूज़ केस, सब-यूज़-केस संख्या, कैरियर पात्रता, नमूनों और घोषणाओं को पुनः सत्यापित करता है। खाता मूल्य-निर्धारण और पंजीकरण शर्तों की समीक्षा अलग से करें। यह GET किसी कैंपेन को पंजीकृत या अनुमोदित नहीं करता, उसे मैसेजिंग कैरियर के साथ साझा नहीं करता और न ही कोई फ़ोन नंबर असाइन करता है। निर्माण और प्रोविज़निंग अलग-अलग संचालन हैं।

विफल आवश्यकता लुकअप को संभालें

यदि अनुरोध विफल हो जाता है, अप्रत्याशित JSON लौटाता है या चयनित यूज़ केस से मेल नहीं खाता, तो फ़ॉर्म को अपूर्ण रखें और त्रुटि का समाधान होने के बाद ग्राहक को पुनः प्रयास करने दें। अनुपलब्ध आवश्यकताओं को किसी रिक्त ऑब्जेक्ट से प्रतिस्थापित न करें और न ही यह मानें कि डेटा की अनुपस्थिति का अर्थ है कि कोई आवश्यकता नहीं है। Retry-After का सम्मान करें और दर सीमाओं तथा उपलब्धता विफलताओं के लिए बैकऑफ़ का उपयोग करें।

अनुरोध

अनुमत स्रोत IP पते से HTTPS पर किसी सक्षम API खाते का उपयोग करें। वर्तमान रूट खाता प्रमाणीकरण नीति का समर्थन करता है, जिसमें Basic प्रमाणीकरण और सक्षम बेयरर API खाते शामिल हैं। प्रदाता क्रेडेंशियल का उपयोग न करें।

URL पाथ में ब्रांड ID और चयनित यूज़-केस मान के साथ GET करें। किसी अनुरोध बॉडी की आवश्यकता नहीं है।

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

पाथ पैरामीटर
नाम	प्रकार	आवश्यक	विवरण
`brand_id`	string	हाँ	आपके प्रमाणीकृत MultiTEL खाते से संबद्ध रजिस्ट्री ब्रांड ID। ब्रांड ID का उपयोग करें, न कि किसी स्थानीय डेटाबेस पंक्ति ID, कैंपेन ID या व्यावसायिक कर संख्या का। इसे एक URL पाथ सेगमेंट के रूप में एन्कोड करें।
`usecase`	string	हाँ	इसी ब्रांड की योग्यता सूची से चयनित मशीन-पठनीय usecase मान। इसके अक्षरों का केस बनाए रखें; अनुवादित प्रदर्शन लेबल न भेजें। इसे एक URL पाथ सेगमेंट के रूप में एन्कोड करें।

प्रतिक्रिया

वर्तमान TCR रूट रजिस्ट्री JSON बॉडी को सीधे लौटाता है और उसकी HTTP स्थिति को बनाए रखता है। यह लीगेसी v3 status/response एनवलप नहीं जोड़ता। संक्षिप्त काल्पनिक उदाहरण कोई लाइव योग्यता परिणाम नहीं है। इसका उपयोग करने से पहले HTTP स्थिति और अपेक्षित JSON आकार की जाँच करें। पोर्टल ऐसे ऑब्जेक्ट की अपेक्षा करता है जिसका usecase चयनित यूज़ केस से मेल खाता हो। कैरियर आवश्यकताएँ mnoMetadata के अंतर्गत हैं, जो कैरियर ID द्वारा कुंजीबद्ध हैं। उदाहरण में दिया गया कैरियर ID और आवश्यकताएँ काल्पनिक हैं। अन्य प्रदाता फ़ील्ड भी लौटाए जा सकते हैं।

उदाहरणात्मक प्रतिक्रिया आकार; लाइव खाता डेटा या वर्तमान कोटेशन नहीं।

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

त्रुटियाँ

401: खाता प्रमाणीकरण विफल हुआ। API क्रेडेंशियल, सक्षम स्थिति और लागू स्रोत-IP प्रतिबंधों की जाँच करें।
404: ब्रांड प्रमाणीकृत खाते से संबद्ध नहीं है, या प्रदाता अनुरोधित ब्रांड या चयन नहीं ढूँढ पाता। प्रदाता अनुरोध से पहले स्थानीय स्वामित्व अस्वीकृति लौटाई जाती है।
अन्य रजिस्ट्री त्रुटियाँ: अपस्ट्रीम HTTP स्थिति और बॉडी बनाए रखी जाती हैं। कोई अमान्य या अनुपलब्ध यूज़ केस सफल रिक्त आवश्यकता सेट नहीं है।
429: खाता या साझा प्रदाता अनुरोध सीमा पूरी हो गई। Retry-After का सम्मान करें।
502/503: ट्रांसपोर्ट, प्रदाता या दर-सीमक उपलब्धता विफलता। फ़ॉर्म को सुरक्षित रखें और बैकऑफ़ के साथ पुनः प्रयास करें।

उपलब्धता और साइड इफ़ेक्ट

समीक्षित GET मौजूदा ब्रांड स्वामित्व की जाँच करता है, रजिस्ट्री से संपर्क करता है और अनुरोध-ऑडिट रिकॉर्ड लिखता है। यह कोई ब्रांड या कैंपेन नहीं बनाता और न ही कोई पंजीकरण शुल्क लेता है।
प्रदाता शुल्क मेटाडेटा MultiTEL ग्राहक खुदरा कोटेशन नहीं है। पोर्टल बाद के पंजीकरण अनुरोध से पहले खाता मूल्य-निर्धारण की समीक्षा अलग से करता है।
योग्यता और आवश्यकताएँ बदल सकती हैं। सबमिशन से पहले चयनित ब्रांड और यूज़ केस के लिए उन्हें ताज़ा करें। एक सफल लुकअप कैंपेन अनुमोदन, नंबर असाइनमेंट या मैसेजिंग शुरू करने की अनुमति नहीं है।