सहायक दस्तावेज़ संलग्न करें

टेम्पलेट पर आधारित सहायक दस्तावेज़ संलग्न करें

इस स्रोत से टेम्पलेट लें: get_supporting_document_templates। साथ ही ऐसी पहचान का उपयोग करें जो पहले से आपके खाते के स्वामित्व में हो। उसकी फ़ाइलें अपलोड करने के लिए create_encrypt_files का उपयोग करें और इसमें यह फ़ील्ड दें: supporting_template_id। सामान्य पहचान या पते के प्रमाण के लिए किए गए अपलोड एक अलग श्रेणी में आते हैं और उनकी जगह इस्तेमाल नहीं किए जा सकते।

सहायक दस्तावेज़ बनाएँ

सक्षम MultiTEL API खाते और उसके लिए अनुमत आईपी पते का उपयोग करें। उदाहरणों में परिवेश चरों से लिए गए HTTP Basic क्रेडेंशियल का उपयोग किया गया है; अपने खाते के प्रकार के अनुसार प्रमाणीकरण के नियमों का पालन करें। अनुरोध HTTPS के माध्यम से भेजें। HTTP प्रतिक्रिया के साथ-साथ JSON में इस मान की भी जाँच करें: status.code; अनुप्रयोग की त्रुटियाँ HTTP 200 के साथ भी आ सकती हैं। नीचे दिए गए उदाहरण काल्पनिक हैं।

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --data @supporting-request.json \
  https://api.multitel.net/v3/create_supporting_document

{
  "identity_id": "33333333333333333333333333333333",
  "template_id": "55555555555555555555555555555555",
  "encrypted_file_ids": [
    "66666666666666666666666666666666"
  ]
}

ऐसा फ़ॉर्म डेटा भी स्वीकार किया जाता है जिसमें बार-बार encrypted_file_ids[] फ़ील्ड दिए गए हों। संलग्न करने वाले इस एंडपॉइंट पर फ़ाइल के बाइट न भेजें।

बनाया गया सहायक दस्तावेज़

{
  "status": {
    "code": 200,
    "msg": "Supporting document created successfully."
  },
  "response": {
    "id": "77777777777777777777777777777777",
    "template_id": "55555555555555555555555555555555",
    "identity_id": "33333333333333333333333333333333",
    "template_name": "Example supporting template"
  }
}

यह सहायक दस्तावेज़ बनाए जाने की पुष्टि करता है, नियामकीय स्वीकृति या नंबर सक्रिय होने की नहीं। अपस्ट्रीम संसाधन में प्रयुक्त ‘स्थायी’ शब्द ग्राहक के लिए भंडारण अवधि या हटाने की नीति की कोई गारंटी नहीं है।

त्रुटियाँ और पुनः प्रयास

API कोड 500 का अर्थ है कि आवश्यक इनपुट नहीं दिए गए हैं, दूरसंचार सेवा प्रदाता की ओर से त्रुटियाँ हुई हैं या उसकी प्रतिक्रिया अमान्य है। कोड 404 का अर्थ है कि पहचान खाते से जुड़ी नहीं है, टेम्पलेट अमान्य है, अपलोड मौजूद नहीं हैं, उनकी वैधता समाप्त हो चुकी है या वे गलत श्रेणी में हैं, अथवा उपयोग योग्य फ़ाइलों का समूह खाली है। यह मान जाँचें: status.msg; केवल HTTP 200 पर्याप्त नहीं है।

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