मैसेजिंग कैंपेन को नंबर असाइन करें

कैंपेन को भेजने वाला नंबर असाइन करें

इस ऑपरेशन का उपयोग तब करें जब आपका मैसेजिंग ब्रांड और प्रोडक्शन कैंपेन पंजीकृत हो चुके हों और कैंपेन सक्रिय हो। यह आपके खाते के एक SMS-सक्षम नंबर को कैंपेन से जोड़ता है। यह न तो ब्रांड बनाता है, न कैंपेन बनाता या स्वीकृत करता है, न नंबर खरीदता है, और न ही संदेश भेजता है।

वर्तमान पोर्टल किसी नंबर को कैंपेन असाइन करते समय इसी रूट का उपयोग करता है। सार्वजनिक API एक कैंपेन पहचानकर्ता स्वीकार करता है; यह अलग ब्रांड पहचानकर्ता स्वीकार करने के बजाय खाते के स्वामित्व वाले कैंपेन से ब्रांड निकालता है।

अनुरोध

अपने सक्षम API खाते और उसके अनुमत स्रोत IP पते का उपयोग करके HTTPS पर एक form-encoded POST भेजें। अपने खाते के वास्तविक नंबर और कैंपेन पहचानकर्ताओं का उपयोग करें। इस उदाहरण का नंबर काल्पनिक है।

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=add' \
  --data-urlencode "campaign=$CAMPAIGN_ID" \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

कैंपेन असाइनमेंट पैरामीटर
पैरामीटर	आवश्यक	अर्थ
action	हाँ	असाइन करने के लिए add का उपयोग करें या नंबर का वर्तमान कैंपेन एसोसिएशन हटाने के लिए delete का। केस और आसपास के स्पेस सामान्यीकृत किए जाते हैं।
campaign	add के लिए	campaignId, जो प्रमाणीकृत खाते के स्वामित्व वाले किसी ACTIVE कैंपेन का हो। उसका ब्रांड भी खाते का होना चाहिए। स्पष्ट रूप से sandbox के रूप में चिह्नित कैंपेन को लाइव भेजने वाले नंबरों को असाइन नहीं किया जा सकता। delete के लिए यह पैरामीटर छोड़ दें; हटाने में नंबर के मौजूदा एसोसिएशन का उपयोग होता है।
number	हाँ	स्वामित्व वाला, सक्रिय, निरस्त न किया गया, SMS-सक्षम भेजने वाला नंबर। उत्तर अमेरिकी नंबर के लिए, देश कोड 1 के बाद उसके दस अंक लिखें, बिना प्लस चिह्न के। हैंडलर गैर-अंक वर्ण हटा देता है और प्लस-उपसर्ग वाले तथा दस-अंकीय समकक्षों को भी खोजता है। यह सामान्यीकरण फ़ोन-नंबर की सामान्य वैधता जाँच नहीं है।

यह ऑपरेशन एक नंबर बदलता है। इसमें पेजिनेशन, बैच पैरामीटर या ड्राई-रन विकल्प नहीं है। किसी मौजूदा कैंपेन से केवल नंबर जोड़ने के लिए कैंपेन निर्माण एंडपॉइंट का उपयोग न करें।

वर्तमान एसोसिएशन हटाएँ

स्वामित्व वाले नंबर के साथ action=delete का उपयोग करें। यह उसका भेजने-वाले-कैंपेन एसोसिएशन हटा देता है और उस नंबर के सहेजे गए ब्रांड/कैंपेन फ़ील्ड साफ़ कर देता है। यह कैंपेन या ब्रांड को हटाता नहीं, फ़ोन नंबर को रिलीज़ नहीं करता, नंबर की सेवा रद्द नहीं करता, और न ही कैंपेन की आवर्ती बिलिंग रोकता है।

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=delete' \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

प्रतिक्रिया और सत्यापन

यह काल्पनिक उदाहरण सामान्य API प्रतिक्रिया एनवलप और चयनित परिणाम फ़ील्ड दिखाता है। लौटाया गया नंबर आपके खाते में संग्रहीत प्रारूप को बनाए रखता है। सफल हटाने के बाद brandId और campaignId खाली स्ट्रिंग होते हैं।

{
  "status": {"code": 200, "msg": "Campaign assignment updated."},
  "response": {
    "number": "+12025550123",
    "brandId": "BRAND_FROM_ACCOUNT",
    "campaignId": "CAMPAIGN_FROM_ACCOUNT",
    "providerStatus": 200
  }
}

providerStatus मैसेजिंग पार्टनर का HTTP स्टेटस है। हैंडलर 2xx ट्रांसपोर्ट प्रतिक्रिया स्वीकार करता है और फिर स्थानीय नंबर रिकॉर्ड अपडेट करता है; यह अलग व्यावसायिक-स्तर के स्वीकृति परिणाम के लिए पार्टनर के प्रतिक्रिया बॉडी की व्याख्या नहीं करता। इसलिए सफल प्रतिक्रिया इस बात का प्रमाण नहीं है कि मैसेजिंग पंजीकरण पूरा हो गया है या डिलीवरी सफल होगी। प्रोडक्शन ट्रैफ़िक भेजने से पहले पोर्टल में नंबर की कैंपेन स्थिति की समीक्षा करें।

केवल स्थानीय एसोसिएशन को डिलीवरी स्वीकृति न मानें। कैंपेन और ब्रांड स्वीकृति, नंबर प्रोविज़निंग, खाता अनुमतियाँ, सामग्री नियम और सामान्य मैसेजिंग सीमाएँ अब भी लागू होती हैं।

त्रुटियाँ और आंशिक परिणाम

401: हैंडलर के पास कोई प्रमाणीकृत खाता उपलब्ध नहीं है।
400: action या number गायब/अमान्य है, या किसी add अनुरोध में कैंपेन पहचानकर्ता नहीं है।
404: नंबर स्वामित्व वाला, सक्रिय, निरस्त न किया गया SMS नंबर नहीं है।
409: कैंपेन खाते के लिए अनुपलब्ध है, ACTIVE नहीं है, स्पष्ट रूप से sandbox है, या उसका ब्रांड खाते के लिए अनुपलब्ध है।
503: मैसेजिंग इंटीग्रेशन अनुपलब्ध है। खाता क्रेडेंशियल बदलने या कॉन्फ़िगरेशन मान गढ़ने के बजाय सहायता से संपर्क करें।
502: मैसेजिंग अनुरोध विफल हुआ, समय समाप्त हुआ या गैर-2xx HTTP स्टेटस लौटाया। providerStatus लौटाया जा सकता है। टाइमआउट यह सिद्ध नहीं करता कि पार्टनर ने कोई बदलाव नहीं किया।
500 (partial=true के साथ): मैसेजिंग पार्टनर ने सफल HTTP स्टेटस लौटाया, लेकिन स्थानीय एसोसिएशन की पुष्टि नहीं हो सकी। पुनः प्रयास करने से पहले पोर्टल में नंबर की वास्तविक स्थिति की जाँच करें और किसी भी विसंगति को सुलझाएँ या सहायता से संपर्क करें।

HTTP परिणाम के साथ-साथ API स्टेटस कोड और प्रतिक्रिया बॉडी की भी जाँच करें। टाइमआउट या आंशिक परिणाम पर आँख मूँदकर पुनः प्रयास न करें। इस हैंडलर में अनुरोध-स्तर की idempotency कुंजी, ट्रांज़ैक्शनल रोलबैक या कैंपेन-पंजीकरण पूर्णता जाँच नहीं है। दोहराया गया मेल खाता स्थानीय असाइनमेंट तब भी सफलता लौटा सकता है जब डेटाबेस कोई बदली हुई पंक्ति रिपोर्ट न करे।

दायरा और प्रभाव

यह ऑपरेशन भेजने वाले नंबर की रूटिंग और उसके सहेजे गए कैंपेन/ब्रांड एसोसिएशन को बदलता है। समीक्षित हैंडलर में इसमें कोई प्रत्यक्ष खाता डेबिट, कैंपेन निर्माण, खरीद या संदेश भेजना शामिल नहीं है। यह मूल्य उद्धरण या निःशुल्क सेवा का वादा नहीं है: मौजूदा नंबर, कैंपेन और मैसेजिंग शुल्क आपके खाते की शर्तों के अनुसार जारी रहते हैं।

पोर्टल में, किसी भिन्न कैंपेन में बदलने पर पहले पिछला एसोसिएशन हटाया जाता है और फिर नया जोड़ा जाता है। ये अलग-अलग अनुरोध हैं। यदि दूसरा अनुरोध विफल होता है, तो पहले वाला एसोसिएशन पहले ही हटाया जा चुका हो सकता है। यह न मानें कि दोनों अनुरोध एक साथ रोलबैक होते हैं।