डेवलपर API संदर्भ दस्तावेज़
सरल HTTP GET रिक्वेस्ट से प्रोग्रामेटिक रूप से टेस्ट फोन नंबर बैच जनरेट करें।
API एंडपॉइंट
निम्न URL पर HTTP GET रिक्वेस्ट भेजें:
GEThttps://phone-number.loveyouall.qzz.io/api/generate
ऑनलाइन टेस्ट (Try It)
नीचे पैरामीटर भरें और असली API को सीधे कॉल करके JSON रिस्पॉन्स देखें।
Query पैरामीटर
| पैरामीटर | टाइप | आवश्यक | विवरण |
|---|---|---|---|
country | string | नहीं | देश कोड। "US", "CN", "CA", "GB", "AU", "DE", "FR", "JP", "KR", "IN", "SG", "ES", "IT", "BR", "MX", "RU", "NL" सपोर्टेड। डिफ़ॉल्ट "US"। |
region | string | नहीं | क्षेत्र/राज्य/ऑपरेटर नाम (जैसे "California", "Ontario", "China Mobile")। केस-इंसेंसिटिव। |
city | string | नहीं | शहर का नाम या 3/2-अंकीय विशेष प्रीफ़िक्स (जैसे "Los Angeles", "138")। केस-इंसेंसिटिव। region निर्दिष्ट होना आवश्यक। |
quantity | integer | नहीं | जनरेट किए जाने वाले नंबरों की संख्या। रेंज: 1–1000 (1000 से अधिक ट्रंकेट होगा)। डिफ़ॉल्ट: 10। |
customPrefix | string | नहीं | कस्टम प्रीफ़िक्स अंक (केवल 0-9 डिजिट)। वैकल्पिक। |
safetyMode | string | नहीं | सुरक्षा मोड। "realistic" (रियलिस्टिक नियम) और "safe" (आधिकारिक रिज़र्व फ़िक्शन टेस्ट नंबर, जैसे 555-XXXX) सपोर्टेड। डिफ़ॉल्ट "realistic"। |
uniqueOnly | boolean | नहीं | केवल यूनिक नंबर जनरेट करना है या नहीं। "true" या "false" सपोर्टेड। डिफ़ॉल्ट "true"। |
कोड इंटीग्रेशन उदाहरण
जनरेटर API इंटीग्रेट करने के लिए अपनी पसंदीदा भाषा या टूल चुनें:
curl -X GET "https://phone-number.loveyouall.qzz.io/api/generate?country=US&quantity=5&safetyMode=safe&uniqueOnly=true"रिस्पॉन्स फॉर्मेट
फोन नंबर रिकॉर्ड ऑब्जेक्ट्स की JSON ऐरे लौटाता है। हर ऑब्जेक्ट में लोकलाइज़्ड फ़ील्ड्स, डिस्प्ले फॉर्मेट और स्टैंडर्ड E.164 स्ट्रिंग होती है।
[
{
"id": "c852d129-4112-4981-8ddb",
"country": "US",
"region": "California",
"regionCode": "CA",
"city": "Los Angeles",
"areaCode": "213",
"display": "+1 (213) 932-8419",
"e164": "+12139328419"
}
]रिस्पॉन्स फ़ील्ड विवरण
| फ़ील्ड | टाइप | विवरण |
|---|---|---|
id | string | रिकॉर्ड का यूनिक UUID v4 आइडेंटिफ़ायर। |
country | string | दो-अक्षर देश कोड (जैसे US, CN)। |
region | string | राज्य / प्रांत / ऑपरेटर नाम, जैसे California या China Mobile। |
regionCode | string | मौजूद होने पर राज्य/प्रांत का दो-अक्षर कोड, जैसे CA (कैलिफ़ोर्निया)। |
areaCode | string | एरिया कोड या नंबर प्रीफ़िक्स, जैसे 213, 138। |
city | string | शहर का नाम या नंबर ब्लॉक, जैसे Los Angeles, 138। |
display | string | मानव-पठनीय फॉर्मेटेड नंबर, जैसे +1 (213) 555-1234। |
e164 | string | स्टैंडर्ड E.164 फॉर्मेट, जैसे +12135551234। |
एरर कोड
API स्टैंडर्ड HTTP स्टेटस कोड का उपयोग करता है और विफलता पर हमेशा "error" फ़ील्ड वाला JSON रिस्पॉन्स लौटाता है।
| स्टेटस कोड | ट्रिगर स्थिति | रिस्पॉन्स बॉडी |
|---|---|---|
400 | असमर्थित देश कोड | {"error":"Unsupported country code: XX"} |
400 | चुने गए देश में ऐसा राज्य/प्रांत या शहर मौजूद नहीं | {"error":"Unknown region ... for country US"} |
400 | customPrefix में नॉन-डिजिट कैरेक्टर हैं | {"error":"customPrefix must contain digits only"} |
400 | region निर्दिष्ट किए बिना city पास किया गया | {"error":"city requires region"} |
500 | जनरेशन के दौरान आंतरिक एरर | {"error":"Internal Server Error"} |
उपयोग सीमाएं
- मुफ़्त और बिना ऑथेंटिकेशन, API की ज़रूरत नहीं
- प्रति रिक्वेस्ट अधिकतम 1000 नंबर (अधिक ट्रंकेट होगा)
- डिफ़ॉल्ट: country=US, quantity=10, safetyMode=realistic, uniqueOnly=true
- safetyMode=safe आधिकारिक रिज़र्व फ़िक्शन टेस्ट नंबर (जैसे 555-XXXX) का उपयोग करता है, जो असली यूज़र से नहीं जुड़ते