डेवलपर

POST/tcr/v2/campaignBuilder

एक 10DLC अभियान पंजीकृत करें

कोई योग्य अभियान सबमिट करें और रजिस्ट्री पंजीकरण को वाहक सक्रियण और प्रेषण तत्परता से अलग करें।

इस पृष्ठ पर
  1. अभियान पंजीकृत करने से पहले ब्रांड की योग्यता जाँचें
  2. सैंडबॉक्स और उत्पादन को अलग रखें
  3. अभियान JSON सबमिट करें
  4. अभियान फ़ील्ड और सशर्त आवश्यकताएँ
  5. उसी इच्छित अनुरोध को सुरक्षित रूप से दोबारा भेजने का प्रयास करें
  6. अभियान आईडी अंतिम प्रेषण सेटअप नहीं है
  7. उत्पादन अभियान शुल्क
  8. सत्यापन और आंशिक विफलताओं को संभालें

अभियान पंजीकृत करने से पहले ब्रांड की योग्यता जाँचें

एक 10DLC अभियान उन संदेशों का वर्णन करता है जिन्हें कोई पंजीकृत व्यवसाय भेजना चाहता है, प्राप्तकर्ता कैसे सहमति देते हैं, और वे सहायता कैसे प्राप्त कर सकते हैं या संदेश बंद कैसे कर सकते हैं। यह API रजिस्ट्री रिकॉर्ड बनाता है; उत्पादन वाहक सक्रियण को पूरा करना एक अलग खाता सेटअप चरण है। निम्न स्रोत से स्वामित्व वाला ब्रांड उपयोग करें: ब्रांड पंजीकरण, फिर इसके लिए लोड करें उपलब्ध उपयोग मामले और चयनित उपयोग मामले की वर्तमान आवश्यकताएँ.

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

सैंडबॉक्स और उत्पादन को अलग रखें

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

उत्पादन अभियान निर्माण बिल योग्य है और किसी फ़ोन नंबर को स्वतः भेजने हेतु तैयार नहीं करता। अभियान वातावरण को उसके ब्रांड के अनुरूप रखें, और लाइव अभियान बनाने से पहले शुल्क और लागू शर्तों की समीक्षा करें।

अभियान JSON सबमिट करें

campaign.json को अपने योग्य मानों के साथ तैयार करें। R000000 का अर्थ है कोई पुनर्विक्रेता नहीं; इसका उपयोग केवल तभी करें जब वही इच्छित कॉन्फ़िगरेशन हो। सामान्य MultiTEL पुनर्विक्रेता कॉन्फ़िगरेशन के लिए, किसी अन्य व्यक्ति के पहचानकर्ता को हार्डकोड करने के बजाय अपने खाते के पुनर्विक्रेता संग्रह या पोर्टल तैयारी प्रवाह से अनुमत MultiTEL LLC पुनर्विक्रेता पहचानकर्ता प्राप्त करें।

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  'https://api.multitel.net/tcr/v2/reseller?companyName=MultiTEL%20LLC&recordsPerPage=500'

निम्नलिखित JSON स्वामित्व वाले मॉक ब्रांड के लिए परीक्षण अभियान को दर्शाता है। अपने परीक्षण हेतु वास्तव में योग्य मानों से ब्रांड, उपयोग मामला, पुनर्विक्रेता और सहमति पाठ को बदलें।

{
  "brandId": "B123ABC",
  "channelId": "10DLC",
  "usecase": "TRIAL",
  "subUsecases": [],
  "resellerId": "R000000",
  "description": "Trial account notices requested by users of the example application.",
  "messageFlow": "Test users explicitly select an unchecked consent box before requesting these trial notices.",
  "sample1": "Example application: your requested account notice is available. Reply STOP to stop notices.",
  "subscriberOptin": true,
  "optinKeywords": "START",
  "optinMessage": "You are subscribed to the example application's requested account notices.",
  "subscriberOptout": true,
  "optoutKeywords": "STOP",
  "optoutMessage": "You will no longer receive the example application's account notices.",
  "subscriberHelp": true,
  "helpKeywords": "HELP",
  "helpMessage": "For help with example account notices, contact support@example.invalid.",
  "embeddedLink": false,
  "embeddedPhone": false,
  "numberPool": false,
  "ageGated": false,
  "directLending": false,
  "termsAndConditions": true,
  "autoRenewal": false,
  "mnoIds": [],
  "referenceId": "your-trial-reference"
}

termsAndConditions को true पर केवल तभी सेट करें जब अधिकृत व्यक्ति ने लागू शर्तों की समीक्षा करके उन्हें स्वीकार कर लिया हो। उदाहरण आपकी ओर से सहमति नहीं है। फ़्लैग हेतु JSON बूलियन उपयोग करें, उद्धृत स्ट्रिंग नहीं।

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @campaign.json \
  'https://api.multitel.net/tcr/v2/campaignBuilder'

अभियान फ़ील्ड और सशर्त आवश्यकताएँ

10DLC अभियान अनुरोध
फ़ील्डक्या प्रदान करें
brandId, channelId, usecaseआपका स्वामित्व वाला ब्रांड, चैनल 10DLC, और कोई योग्य वर्तमान उपयोग-मामला कोड। योग्यता से प्राप्त कोड उपयोग करें, अनुवादित लेबल नहीं।
subUsecasesयोग्य उप-उपयोग-मामला कोडों की एक सरणी। चयनित योग्यता की न्यूनतम और अधिकतम संख्या का पालन करें।
resellerIdकोई अनुमत पुनर्विक्रेता पहचानकर्ता। खाता-स्वामित्व वाला मार्ग स्वामित्व वाले पुनर्विक्रेताओं, इसके कॉन्फ़िगर किए गए साझा पुनर्विक्रेता, या जानबूझकर दिए गए बिना-पुनर्विक्रेता मान को स्वीकार करता है। असंबंधित पुनर्विक्रेता अस्वीकृत कर दिया जाता है।
description, messageFlowवास्तविक उद्देश्य और सहमति कैसे एकत्र की जाती है, इसका वर्णन करें। प्रत्येक में 40–4096 वर्ण होने चाहिए। वास्तविक उपयोगकर्ता कार्रवाई, फ़ॉर्म या प्रक्रिया शामिल करें; ऐसी सहमति न गढ़ें जो आपका एप्लिकेशन एकत्र नहीं करता।
sample1 … sample5प्रतिनिधि संदेश, सामान्यतः प्रत्येक 20–1024 वर्ण। पोर्टल को कम से कम एक आवश्यक है; योग्य नेटवर्क अधिक की आवश्यकता रख सकते हैं। वर्तमान योग्यता द्वारा आवश्यक संख्या प्रदान करें।
subscriberOptin, subscriberOptout, subscriberHelpइन सटीक फ़ील्ड नामों का उपयोग करके समर्थित प्राप्तकर्ता प्रवाह घोषित करें। जब कोई प्रवाह सक्षम हो, तो उसके कीवर्ड और संदेश फ़ील्ड प्रदान करें। नेटवर्क आवश्यकताएँ विशेष प्रवाहों को अनिवार्य बना सकती हैं।
optinKeywords, optoutKeywords, helpKeywordsवास्तविक मान्यता प्राप्त कीवर्ड, अधिकतम 255 वर्ण तक। वे प्राप्त करने वाले एप्लिकेशन के व्यवहार से मेल खाने चाहिए।
optinMessage, optoutMessage, helpMessageसंबंधित संदेश। वर्तमान प्रकाशित फ़ील्ड नियम 20–1024 वर्ण निर्दिष्ट करते हैं। वास्तविक सहायता और ऑप्ट-आउट व्यवहार शामिल करें।
embeddedLink, embeddedPhone, embeddedLinkSampleएम्बेडेड लिंक या फ़ोन नंबरों की सत्यतापूर्वक घोषणा करें। अन्य योग्यता शर्तें पूरी करने वाला नेटवर्क भी उन्हें अस्वीकार कर सकता है। लिंक नमूना अधिकतम 255 वर्ण तक अनुमत है।
mnoIdsयोग्यता से प्राप्त योग्य संख्यात्मक नेटवर्क आईडी की वैकल्पिक सरणी। यह न मानें कि प्रत्येक नेटवर्क चयनित उपयोग मामले का समर्थन करता है।
numberPool, ageGated, directLendingJSON बूलियन के रूप में लागू अभियान विशेषताएँ। उन्हें वास्तविक सेवा के अनुसार चुनें।
privacyPolicyLink, termsAndConditionsLinkलागू होने पर आपकी प्रासंगिक सार्वजनिक नीति और शर्तों के URL, प्रत्येक अधिकतम 2048 वर्ण तक। उन्हें वास्तविक संदेश सेवा का वर्णन करना चाहिए।
termsAndConditionsलागू अभियान शर्तों की स्पष्ट स्वीकृति। पोर्टल को true आवश्यक है और उसका विज़ार्ड वर्तमान व्यक्तिगत पुष्टिकरण भी एकत्र करता है।
autoRenewalअभियान नवीनीकृत होता है या नहीं। डिफ़ॉल्ट true है। नवीनीकरण अक्षम करने से उत्पादन अभियान से पहले से जुड़ी न्यूनतम प्रतिबद्धता समाप्त नहीं होती।
referenceId, tagआपका अभियान संदर्भ, अधिकतम 50 वर्ण तक, और वैकल्पिक टैग। referenceId Idempotency-Key हेडर नहीं है।

प्रकाशित स्कीमा में वर्णनात्मक तालिकाओं में कुछ असंगत बड़े-छोटे अक्षरों का उपयोग है। वर्तमान पोर्टल अनुरोध ऊपर दिखाए अनुसार subscriberOptin और subscriberOptout का उपयोग करता है। वही सटीक अक्षर-स्थिति बनाए रखें। यह मार्गदर्शिका टेनेंट-सामना करने वाले 10DLC वर्कफ़्लो को कवर करती है; यह न मानें कि किसी भिन्न चैनल के आवश्यक फ़ील्ड या सक्रियण चरण समान हैं।

उसी इच्छित अनुरोध को सुरक्षित रूप से दोबारा भेजने का प्रयास करें

इस इच्छित निर्माण हेतु एक Idempotency-Key उपयोग करें। कुंजी बिना रिक्त स्थान के 1–128 मुद्रण योग्य ASCII वर्णों की होती है और स्वामी खाते तक सीमित है। पुनः प्रयास पर HTTP विधि, पथ, क्वेरी स्ट्रिंग और सटीक बॉडी बाइट्स को अपरिवर्तित रखें। पुनः स्वरूपित JSON फ़ाइल विरोध करती है, भले ही उसके मान समतुल्य हों।

प्रगति पर चल रही डुप्लिकेट HTTP 409 के साथ Retry-After लौटा सकती है; पूर्ण अनुरोध अपनी संग्रहीत प्रतिक्रिया को पुनः चला सकते हैं। कैश की गई त्रुटि यह सिद्ध नहीं करती कि रजिस्ट्री ने कुछ नहीं बनाया। नई कुंजी पर विचार करने से पहले campaignId, requestId और कोई भी सहसंबंध हेडर सहेजें, मौजूदा अभियान का निरीक्षण करें और आंशिक विफलता का समाधान करें।

अभियान आईडी अंतिम प्रेषण सेटअप नहीं है

प्रतिक्रिया HTTP स्थिति और प्रत्यक्ष JSON का उपयोग करती है। सफल निर्माण पर, campaignId रखें और उसकी वर्तमान स्थिति पढ़ें:

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

वर्तमान पोर्टल का उत्पादन वर्कफ़्लो अभियान को संदेश वाहक के साथ साझा भी करता है और ब्रांड/अभियान को प्रेषण खाते में लोड करता है। वे इस सार्वजनिक निर्माण कॉल से अलग संचालन हैं। रजिस्ट्री अभियान मौजूद हो सकता है, भले ही बाद का साझाकरण या वाहक-लोडिंग चरण विफल हो जाए।

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

उत्पादन अभियान शुल्क

वर्तमान कॉन्फ़िगर किए गए मासिक अभियान शुल्क
उपयोग मामलामासिक शुल्क
LOW_VOLUME, UCAAS_LOW$1.67
SOLE_PROPRIETOR$2.23
CHARITY$3.34
EMERGENCY$5.56
AGENTS_FRANCHISES$33.34
अन्य कॉन्फ़िगर किए गए फ़ॉलबैक उपयोग मामले$11.12

इन खुदरा राशियों की वर्तमान पोर्टल कॉन्फ़िगरेशन से 24 अक्टूबर 2026 को जाँच की गई थी। उत्पादन सबमिशन से पहले वर्तमान योग्य उपयोग मामला और प्रदर्शित मूल्य की पुष्टि करें। रजिस्ट्री योग्यता प्रतिक्रिया में monthlyFee स्वतः आपका MultiTEL खुदरा मूल्य नहीं है।

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

सत्यापन और आंशिक विफलताओं को संभालें

HTTP status और लौटाया गया JSON पढ़ें। सत्यापन विफलताएँ code/description ऑब्जेक्ट्स की सरणियाँ हो सकती हैं; स्थानीय विफलताएँ इसके बजाय message, status और, कुछ प्रसंस्करण त्रुटियों हेतु, requestId सहित ऑब्जेक्ट हो सकती हैं।

अभियान विफलताएँ
HTTP परिणामअगली कार्रवाई
400विशिष्ट फ़ील्ड या आइडेम्पोटेंसी कुंजी को सुधारें। वर्तमान योग्यता, आवश्यक नमूना संख्या और प्राप्तकर्ता-प्रवाह आवश्यकताओं को पुनः पढ़ें।
401, 403 या 404API क्रेडेंशियल और अनुमत स्रोत IP जाँचें, फिर ब्रांड/पुनर्विक्रेता स्वामित्व और अनुमतियाँ देखें। किसी अन्य खाते के पहचानकर्ताओं का उपयोग न करें।
402उसी इच्छित निर्माण को पुनः प्रयास करने से पहले उत्पादन निधि और क्रय अनुमति की समीक्षा करें।
409उसी कुंजी का उपयोग करके बदले गए अनुरोध से प्रगति पर चल रहे पुनः प्रदर्शन को अलग करें। समाधान करते समय मौजूदा अभियान और अनुरोध विवरण बनाए रखें।
429 या सीमक अनुपलब्धउपस्थित होने पर Retry-After का पालन करें और मूल कुंजी व सटीक अनुरोध बनाए रखें।
500 या 502निर्माण पहले ही हो चुका हो सकता है। कोई भी campaignId और requestId सहेजें, मौजूदा अभियान जाँचें, और डुप्लिकेट बनाने के बजाय उसके सक्रियण को पुनः आरंभ करें या उसका समाधान करें।