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

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

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

इंटेलिजेंस ऐड-ऑन

नंबर पर फ़ोन इंटेलिजेंस भी चलाने के लिए enable_enrichment को true पर सेट करें। इससे जोखिम स्कोर, लाइन प्रकार, यह कि नंबर हाल में पोर्ट हुआ था या नहीं, और ट्रस्ट इंडेक्स मिलते हैं। यह ऐड-ऑन सूची मूल्य पर प्रति अनुरोध $0.05 के हिसाब से बिल होता है, और यह जाँच की कीमत के ऊपर जुड़ता है। जब आपका बैलेंस इसे कवर नहीं कर पाता, तो अनुरोध 403 लौटाता है। चार फ़ील्ड तय करते हैं कि संकेत क्या करें। इनमें से हर एक का मान NO_ACTION (डिफ़ॉल्ट) या DECLINE होता है, और हर एक केवल तभी लागू होता है जब enable_enrichment का मान true हो। NO_ACTION होने पर भी संकेत phone.phone_intelligence में लौटाया जाता है, ताकि आप अपना नियम खुद लागू कर सकें।

प्राधिकरण

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
आवश्यक

वही फ़ोन नंबर जो संबंधित POST /v3/phone/send/ कॉल में उपयोग किया गया था, E.164 प्रारूप में। यह चेक को सेंड से लिंक करता है।

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

"+14155552671"

code
string
आवश्यक

अंतिम उपयोगकर्ता को प्राप्त OTP। 4–8 संख्यात्मक अंक होने चाहिए — कोई अन्य मान प्रयास की खपत किए बिना 400 लौटाता है। एक सही प्रारूप वाला लेकिन गलत कोड status: "Failed" के साथ 200 लौटाता है और 3 प्रयासों में से एक की खपत करता है।

Required string length: 4 - 8
Pattern: ^[0-9]{4,8}$
उदाहरण:

"123456"

duplicated_phone_number_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

आपके एप्लिकेशन के किसी भिन्न उपयोगकर्ता (भिन्न vendor_data) द्वारा समान नंबर का पहले ही उपयोग किए जाने पर क्या कार्रवाई की जाए। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION जोखिम को phone.warnings में रिकॉर्ड करता है और phone.matches को भरता है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
disposable_number_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब कैरियर लुकअप नंबर को एक अस्थायी/बर्नर लाइन के रूप में फ़्लैग करता है (phone.is_disposable) तो क्या कार्रवाई करें। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION जोखिम को phone.warnings में रिकॉर्ड करता है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
voip_number_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब कैरियर लुकअप वर्चुअल लाइन प्रकार — voip, isp, या vpn रिपोर्ट करता है (phone.is_virtual) तो क्या कार्रवाई करें। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION जोखिम को phone.warnings में रिकॉर्ड करता है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
enable_enrichment
boolean
डिफ़ॉल्ट:false

जब true होता है, तो नंबर पर फ़ोन इंटेलिजेंस भी चलाएं: एक जोखिम स्कोर, लाइन का प्रकार, क्या इसे हाल ही में पोर्ट किया गया था और एक ट्रस्ट इंडेक्स। इस endpoint की अपनी कीमत के अतिरिक्त प्रति अनुरोध एक phone_intelligence_api यूनिट ($0.05 सूची मूल्य पर) के रूप में बिल किया जाता है। जब आपका बैलेंस इसे कवर नहीं कर पाता है, तो अनुरोध 403 लौटाता है।

उदाहरण:

false

phone_intelligence_score_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब फ़ोन इंटेलिजेंस जोखिम स्कोर थ्रेशोल्ड से अधिक हो, तब की जाने वाली कार्रवाई। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION अस्वीकार किए बिना सिग्नल रिकॉर्ड करता है। केवल तभी प्रभावी होता है जब enable_enrichment का मान true हो।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
phone_type_risk_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब नंबर एक उच्च-जोखिम वाली लाइन का प्रकार हो, तब की जाने वाली कार्रवाई। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION अस्वीकार किए बिना सिग्नल रिकॉर्ड करता है। केवल तभी प्रभावी होता है जब enable_enrichment का मान true हो।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
recent_port_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब नंबर हाल ही में किसी अन्य कैरियर में पोर्ट किया गया हो, तब की जाने वाली कार्रवाई। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION अस्वीकार किए बिना सिग्नल रिकॉर्ड करता है। केवल तभी प्रभावी होता है जब enable_enrichment का मान true हो।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
low_phone_trust_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब फ़ोन इंटेलिजेंस ट्रस्ट इंडेक्स थ्रेशोल्ड पर या उससे कम हो, तब की जाने वाली कार्रवाई। DECLINE अंतिम status को Declined में बदल देता है; NO_ACTION अस्वीकार किए बिना सिग्नल रिकॉर्ड करता है। केवल तभी प्रभावी होता है जब enable_enrichment का मान true हो।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE
enable_social
boolean
डिफ़ॉल्ट:false

true होने पर, नंबर के सोशल फ़ुटप्रिंट की भी खोज करें - मैसेजिंग, सोशल, ई-कॉमर्स और व्यावसायिक प्लेटफ़ॉर्म जिन पर यह पंजीकृत है। इस endpoint की अपनी कीमत के अतिरिक्त प्रति अनुरोध एक phone_social इकाई के रूप में बिल किया जाता है।

उदाहरण:

true

phone_no_social_presence_action
enum<string>
डिफ़ॉल्ट:NO_ACTION

जब सोशल फ़ुटप्रिंट जाँच में यह पाया जाता है कि नंबर इसके दायरे में आने वाले किसी भी प्लेटफ़ॉर्म पर पंजीकृत नहीं है, तब की जाने वाली कार्रवाई। इस endpoint पर केवल NO_ACTION और DECLINE स्वीकार किए जाते हैं; REVIEW इसी नाम की वर्कफ़्लो कॉन्फ़िगरेशन कुंजी पर उपलब्ध है।

उपलब्ध विकल्प:
NO_ACTION,
DECLINE

प्रतिक्रिया

जांच पूरी हुई — गलत कोड और छूटे हुए सत्यापन भी 200 लौटाते हैं; HTTP कोड नहीं, status का निरीक्षण करें। phone केवल अंतिम परिणामों (Approved/Declined) पर पॉप्युलेट होता है, Failed पर null, और Expired or Not Found पर अनुपस्थित होता है।

request_id
string<uuid>

Approved/Declined पर: मिलान किए गए सत्यापन की सत्र id — POST /v3/phone/send/ द्वारा लौटाए गए request_id के समान। Failed और Expired or Not Found पर: एक यादृच्छिक वन-ऑफ़ UUID जिसे बाद में देखा नहीं जा सकता।

status
enum<string>

Approved — सही कोड, अस्वीकृति का कोई जोखिम नहीं। Declined — अंतिम: अस्वीकृति का कोई जोखिम मेल खा गया या प्रयास सीमा (3) समाप्त हो गई। Failed — गलत कोड, प्रयास शेष हैं। Expired or Not Found — पिछले 5 मिनट में इस नंबर के लिए कोई लंबित सत्यापन नहीं।

उपलब्ध विकल्प:
Approved,
Declined,
Failed,
Expired or Not Found
message
string

गलत कोड के बाद शेष प्रयासों की संख्या सहित परिणाम का मानव-पठनीय स्पष्टीकरण।

phone
object | null

पूर्ण फ़ोन रिपोर्ट। केवल अंतिम परिणामों (Approved/Declined) पर मौजूद (शून्येतर); Failed पर null और Expired or Not Found पर अनुपस्थित।

vendor_data
string | null

मिलान किए गए सत्यापन के सत्र का vendor_data। Expired or Not Found पर null।

metadata
object | null

मेल खाने वाले सत्यापन के सत्र का metadata। Expired or Not Found पर null।

created_at
string<date-time>

इस जांच के रिस्पॉन्स का टाइमस्टैम्प।

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