डेवलपर

POST/tcr/v2/brand/nonBlocking

संदेश ब्रांड पंजीकृत करें

खाता-स्वामित्व वाली व्यावसायिक पहचान पंजीकृत करें, सैंडबॉक्स अनुरोधों को स्पष्ट रखें, और सत्यापन तथा शुल्क का मिलान करें।

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

अपने संदेशों के पीछे का व्यवसाय पंजीकृत करें

संदेश ब्रांड US 10DLC संदेश भेजने वाले व्यवसाय की पहचान करता है। अभियान उपयोग मामला चुनने से पहले ब्रांड पंजीकृत करें। व्यवसाय के कानूनी विवरण और ऐसे संपर्क का उपयोग करें जो आवश्यक सत्यापन पूरा कर सके। लौटाई गई ब्रांड आईडी अपने आप में संदेश भेजने की अनुमति नहीं है।

इस वर्तमान खाता-स्वामित्व वाले रूट का उपयोग HTTPS पर सक्षम API खाते और उसके अनुमत स्रोत IP पते के साथ करें। user_id, username या किसी अन्य ग्राहक का स्वामी पहचानकर्ता सबमिट न करें। MultiTEL प्रमाणीकृत खाते से स्वामित्व दर्ज करता है।

स्पष्ट सैंडबॉक्स अनुरोध से प्रारंभ करें

पोर्टल अपने फ़ॉर्म के mode फ़ील्ड को डिफ़ॉल्ट रूप से सैंडबॉक्स पर सेट करता है; मॉक ब्रांड हेतु सीधे API अनुरोध में JSON बूलियन mock: true स्पष्ट रूप से शामिल करना आवश्यक है। उस फ़्लैग को छोड़ना सैंडबॉक्स की गारंटी नहीं है और इससे बिल योग्य प्रोडक्शन पंजीकरण बन सकता है। पोर्टल का mode फ़ील्ड API के mock फ़ील्ड का विकल्प नहीं है।

नीचे दिए गए फ़ील्ड का उपयोग करके स्थानीय brand.json फ़ाइल तैयार करें। प्लेसहोल्डर को उपयुक्त परीक्षण विवरण और वर्तमान कैटलॉग कोड से बदलें। यह उदाहरण निजी-लाभ व्यवसाय का है; अन्य इकाई प्रकारों की आवश्यकताएँ भिन्न हैं।

{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "Example business",
  "companyName": "Example legal business name",
  "ein": "YOUR_TAX_ID",
  "einIssuingCountry": "US",
  "phone": "+12025550123",
  "street": "123 Example Street",
  "city": "Example City",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "contact@example.invalid",
  "brandRelationship": "BASIC_ACCOUNT",
  "vertical": "CURRENT_VERTICAL_CODE",
  "referenceId": "your-business-reference",
  "mock": true
}

ऊपर दिए गए व्यवसाय, पता, फ़ोन और पहचानकर्ता प्लेसहोल्डर हैं, पंजीकरण-योग्य व्यावसायिक पहचान नहीं। entityType, vertical, country, state, brandRelationship और अन्य एन्यूमरेशन के वर्तमान मानों के लिए देखें संदेश कैटलॉग.

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

व्यवसाय और संपर्क फ़ील्ड

ब्रांड पंजीकरण फ़ील्ड
फ़ील्डक्या प्रदान करें
entityType, displayNameवर्तमान इकाई-प्रकार कोड और पहचानने योग्य ब्रांड नाम। अधिकतम लंबाई क्रमशः 20 और 255 वर्ण है।
country, street, city, state, postalCodeवास्तविक व्यावसायिक पता। दो-अक्षर वाला देश कोड और लागू होने पर वर्तमान US state कोड उपयोग करें। सीमाएँ: street 255, city 100, state 20 और postalCode 10 वर्ण।
email, phoneकार्यशील संपर्क ईमेल, अधिकतम 100 वर्ण तक, और अंतरराष्ट्रीय +देश-कोड प्रारूप में फ़ोन नंबर, अधिकतम 20 वर्ण तक। पूरे पंजीकरण में व्यावसायिक विवरण सुसंगत रखें।
companyName, ein, einIssuingCountryसंगठनों के लिए, कानूनी कंपनी नाम और व्यावसायिक कर पहचानकर्ता प्रदान करें। पहचानकर्ता का जारीकर्ता देश अलग दो-अक्षर वाला फ़ील्ड है। सीमाएँ: companyName 255 और ein 21 वर्ण। एकल स्वामी संगठन की कर पहचान के बजाय व्यक्तिगत-नाम फ़ील्ड उपयोग करता है।
brandRelationship, verticalव्यवसाय से संबंध और उसका उद्योग, वर्तमान कैटलॉग कोड का उपयोग करके। संगठनों के लिए ये आवश्यक हैं; एकल-स्वामी नियम भिन्न हैं। API कोड के लिए अनूदित प्रदर्शन लेबल प्रतिस्थापित न करें।
firstName, lastName, mobilePhoneएकल स्वामी के लिए आवश्यक। नाम फ़ील्ड में प्रत्येक में अधिकतम 100 वर्ण अनुमत हैं। आवश्यक OTP सत्यापन हेतु अंतरराष्ट्रीय प्रारूप में योग्य मोबाइल नंबर प्रदान करें।
stockSymbol, stockExchange, website, businessContactEmailशेयर बाज़ार में सूचीबद्ध कंपनी को अतिरिक्त सत्यापन प्रक्रिया के लिए अपने स्टॉक प्रतीक/एक्सचेंज, website और योग्य व्यावसायिक-संपर्क ईमेल की भी आवश्यकता होती है। सीमाएँ: stockSymbol 10, website 255 और businessContactEmail 255 वर्ण।
altBusinessIdType, altBusinessIdवैकल्पिक अतिरिक्त व्यावसायिक पहचानकर्ता। इसका प्रकार और मान एक साथ दें। वर्तमान प्रकार कैटलॉग उपयोग करें; मान में अधिकतम 50 वर्ण अनुमत हैं।
referenceIdआपका व्यावसायिक संदर्भ, अधिकतम 50 वर्ण तक। वर्तमान इकाई-विशिष्ट आवश्यकताओं के अंतर्गत एकल-स्वामी पंजीकरण हेतु इसे शामिल करें। यह व्यावसायिक मेटाडेटा है, अनुरोध की इडम्पोटेंसी कुंजी नहीं।
website, ipAddress, tagलागू होने पर अतिरिक्त वेबसाइट, मूल-IP मेटाडेटा और टैग मान। ये खाता स्वामित्व स्थापित नहीं करते और न ही पहचान जाँचों का स्थान लेते हैं।
mockJSON बूलियन। केवल इच्छित मॉक वर्कफ़्लो के लिए true उपयोग करें; स्पष्ट रूप से समीक्षित प्रोडक्शन पंजीकरण के लिए false उपयोग करें। JSON बूलियन के विकल्प के रूप में स्ट्रिंग "false" न भेजें।

एकल स्वामी US या कनाडाई पंजीकरणों के लिए समर्थित हैं और अभियान पात्रता से पहले OTP सत्यापन आवश्यक है। शेयर बाज़ार में सूचीबद्ध कंपनियों के लिए व्यावसायिक-संपर्क सत्यापन चरण आवश्यक हो सकता है। GOVERNMENT US-स्थित सरकारी इकाइयों के लिए है; अन्य संगठनों के लिए सही इकाई श्रेणी की पुष्टि करें। इकाई-विशिष्ट आवश्यकताओं के साथ-साथ लौटाई गई सत्यापन त्रुटियों का भी पालन करें।

स्थिर इडम्पोटेंसी कुंजी रखें

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

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

उस अनुरोध का समाधान करते समय brand.json अपरिवर्तित रखें। कैश की गई 500 या 502 त्रुटि पंजीकरण पुनः प्रयास के बजाय मूल त्रुटि पुनः चला सकती है। लौटाए गए brandId, requestId और सहसंबंध हेडर सुरक्षित रखें; भिन्न अनुरोध प्रारंभ करने से पहले मौजूदा ब्रांड की वास्तविक स्थिति जाँचें और किसी भी विसंगति का समाधान करें।

ब्रांड और उसकी स्थिति पढ़ें

यह API v3 status/response लिफ़ाफ़े के बजाय HTTP स्थिति कोड और सीधे JSON बॉडी का उपयोग करता है। सफल पंजीकरण brandId सहित ब्रांड ऑब्जेक्ट लौटाता है। उस पहचानकर्ता को संग्रहीत करें और लौटाई गई सत्यापन या पहचान स्थिति की जाँच करें। अतिरिक्त फ़ील्ड इकाई और पंजीकरण स्थिति पर निर्भर करते हैं।

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

केवल अपने खाते का ब्रांड पढ़ें। 404 का अर्थ हो सकता है कि ब्रांड इस खाते के लिए उपलब्ध नहीं है। आवश्यक सत्यापन पूरा करें, फिर ब्रांड योग्यता के माध्यम से इसके उपलब्ध अभियान उपयोग मामले खोजें। मॉक संसाधनों को प्रोडक्शन भेजने हेतु योग्य न मानें।

प्रोडक्शन शुल्क

वर्तमान कॉन्फ़िगर किए गए ब्रांड पंजीकरण शुल्क
पंजीकरणशुल्क
मानक संगठन$5.00
एकल स्वामी$4.45
मॉक ब्रांडमॉक वर्कफ़्लो में कोई ब्रांड-पंजीकरण डेबिट नहीं

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

मॉक ब्रांड को प्रोडक्शन में बदलना अलग से पुष्ट वर्कफ़्लो है और इससे नई प्रोडक्शन पहचान और शुल्क बन सकता है। यह न मानें कि बाद के अनुरोध पर mock को false में संपादित करने से मौजूदा ब्रांड परिवर्तित हो जाता है।

ब्रांड को डुप्लिकेट किए बिना त्रुटियाँ सँभालें

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