मुख्य सामग्री पर जाएं
POST
curl

अपने ब्रांड का नाम SMS में रखें

आपके एप्लिकेशन का SMS सेंडर नाम, जिसे Business Console में सेट किया जाता है, SMS कोड के साथ बिना अतिरिक्त शुल्क के जाता है:
123456 आपका Acme Bank के लिए सत्यापन कोड है
किसी एक कोड पर अलग नाम दिखाने के लिए options.sms_sender_name पास करें (1 से 30 अक्षर: केवल अक्षर, अंक, स्पेस और ’ & - ! की अनुमति है, और यह केवल अंक नहीं हो सकता):
इन नियमों से बाहर का नाम 400 लौटाता है और कोई कोड नहीं भेजा जाता। WhatsApp कोड एक निश्चित संदेश का उपयोग करते हैं और उन पर ब्रांड का नाम नहीं होता। अपने व्यवसाय के नाम से भेजने के लिए Business Console में अपना WhatsApp Business नंबर जोड़ें। देखें अपने नंबर से WhatsApp कोड भेजें। देखें ब्रांडेड सत्यापन संदेश कि किसी कोड पर कौन सा नाम जाता है और नए नामों की दैनिक सीमा क्या है।

प्रदाता की सेवा में रुकावट संभालें

यदि फ़ोन प्रदाता अस्थायी रूप से उपलब्ध नहीं है, तो यह endpoint 502 और एक स्थिर, मशीन-पठनीय कोड लौटाता है:
इस प्रतिक्रिया को पुनः प्रयास योग्य मानें। छोटा बैकऑफ़ लगाएँ और उपयोगकर्ता को अस्थायी सेवा का संदेश दिखाएँ, न कि उससे किसी वैध फ़ोन नंबर या कोड को बदलने के लिए कहें।

प्राधिकरण

x-api-key
string
header
आवश्यक

आपकी एप्लिकेशन की API कुंजी, Business Console में Developers -> API keys से। प्राथमिक कुंजी के पास पूर्ण एक्सेस होता है। एक नामित कुंजी को स्कोप किया जा सकता है: प्रति संसाधन none, read या write, कुछ वर्कफ़्लो या स्वीकृत सत्रों तक सीमित, IP पतों की सूची तक सीमित, और समाप्ति तिथि तक सीमित। 401 का अर्थ है कि कुंजी गलत है, निरस्त कर दी गई है या उसकी समय-सीमा समाप्त हो गई है; 403 का अर्थ है कि कोई कुंजी नहीं भेजी गई थी, कुंजी के पास इस संसाधन या कार्रवाई का एक्सेस नहीं है, या अनुरोध उसकी IP सूची से बाहर के पते से आया था; सत्र रूट पर 404 का अर्थ है कि सत्र कुंजी के वर्कफ़्लो या स्थितियों से बाहर है। मीडिया एक्सेस के बिना एक कुंजी को छवि, वीडियो और PDF URL null के रूप में प्राप्त होते हैं, और सत्र write के बिना एक कुंजी को सत्र लिंक और token null के रूप में प्राप्त होते हैं। देखें https://docs.didit.me/console/api-keys।

बॉडी

application/json
phone_number
string
आवश्यक

E.164 प्रारूप में प्राप्तकर्ता का फ़ोन नंबर — शुरुआती + और देश कोड (उदा., +14155552671)। नंबरों को मान्य और E.164 में सामान्यीकृत किया जाता है; पार्स न होने योग्य या अमान्य नंबर phone_number फ़ील्ड त्रुटि के साथ 400 लौटाते हैं।

Maximum string length: 20
उदाहरण:

"+14155552671"

options
object

OTP डिलीवरी विकल्प। सभी फ़ील्ड वैकल्पिक हैं।

signals
object

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

vendor_data
string

वैकल्पिक कॉलर-नियंत्रित पहचानकर्ता (आपकी आंतरिक उपयोगकर्ता id, एक ईमेल, एक UUID, आदि) जो सत्र में सुरक्षित रहता है और भेजने के रिस्पॉन्स, मिलान जांच रिस्पॉन्स, webhook और Business Console में वापस लौटाया जाता है। Didit के request_id को अपने उपयोगकर्ता रिकॉर्ड के साथ सहसंबंधित करने के लिए इसका उपयोग करें।

metadata
object | null

वैकल्पिक फ़्री-फ़ॉर्म JSON ऑब्जेक्ट जो सत्र पर बना रहता है और सेंड रिस्पॉन्स, मिलान जांच रिस्पॉन्स, webhooks और Business Console में वापस प्रदर्शित होता है।

प्रतिक्रिया

भेजने की पुष्टि की गई। status की जांच करें: Success और Retry का अर्थ है कि एक कोड रास्ते में है; Blocked का अर्थ है कि धोखाधड़ी-रोधी लेयर ने अस्वीकार कर दिया और सत्यापन पहले ही Declined के रूप में अंतिम रूप ले चुका है। request_id संग्रहीत सत्र आईडी है (Retry पर वही आईडी)।

request_id
string<uuid>

सत्यापन का सत्र id। Retry भेजने पर मूल भेजने के समान request_id लौटता है। यह id Business Console में दिखाई देता है, एक फ़ाइनलाइज़ किए गए POST /v3/phone/check/ द्वारा फिर से लौटाया जाता है, और इसे GET /v3/session/{sessionId}/decision/ पर पास किया जा सकता है।

status
enum<string>

Success — OTP एक नए सत्यापन पर भेजा गया। Retry — पिछले प्रेषण द्वारा बनाए गए लंबित सत्यापन के लिए OTP पुनः भेजा गया। Blocked — धोखाधड़ी-रोधी परत ने भेजने से मना कर दिया; सत्यापन तुरंत Declined के रूप में फ़ाइनलाइज़ कर दिया जाता है और कुछ भी बिल नहीं किया जाता है।

उपलब्ध विकल्प:
Success,
Retry,
Blocked
reason
string | null

कोई संदेश भेजना Blocked क्यों था (उदा., repeated_attempts, suspicious, spam)। Success और Retry पर null।

vendor_data
string | null

सत्र पर संग्रहीत vendor_data का इको (पहली बार भेजे गए डेटा से)।

metadata
object | null

सत्र पर संग्रहीत metadata का इको (पहली बार भेजे गए डेटा से)।

अंतिम संशोधन 7 नवंबर 2026