GenderAPI.io V2 से अंतरराष्ट्रीय या राष्ट्रीय फ़ोन नंबरों का सत्यापन और फ़ॉर्मेटिंग करें। ज़रूरी देश का संदर्भ, JSON फ़ील्ड और 1 क्रेडिट का शुल्क देखें।
फ़ोन नंबर का सत्यापन और फ़ॉर्मेटिंग
पैरामीटर
प्रकार
ज़रूरी
डिफ़ॉल्ट
विवरण
पैरामीटरnumber
प्रकारstring
ज़रूरीहाँ
डिफ़ॉल्ट—
विवरणज़रूरी, 3–32 अक्षर। ASCII अंक, स्पेस, कोष्ठक और हाइफ़न, शुरुआत में वैकल्पिक + के साथ। एक्सटेंशन और अक्षर स्वीकार नहीं होते।
पैरामीटरcountry
प्रकारstring
ज़रूरीशर्त के साथ
डिफ़ॉल्ट—
विवरणबड़े अक्षरों में ISO 3166-1 alpha-2 कोड। राष्ट्रीय नंबर के लिए ज़रूरी; number के + से शुरू होने पर वैकल्पिक। इस्तेमाल न हो तो छोड़ दें।
POST /phone/validate में number और वैकल्पिक country स्वीकार होते हैं। + से शुरू होने वाला अंतरराष्ट्रीय नंबर इस्तेमाल करें, या राष्ट्रीय नंबर के लिए बड़े अक्षरों में ISO देश कोड दें। रिस्पॉन्स के data में valid, possible, e164, country और country_calling_code होते हैं, साथ में वही meta एनवेलप। यह नंबर का ढाँचा जाँचता है, यह नहीं कि सब्सक्राइबर मौजूद है। पूरे हुए सत्यापन पर 1 क्रेडिट लगता है, अमान्य परिणाम पर भी। नीचे दिया गया काल्पनिक रिस्पॉन्स अनुरोध के उदाहरण से अलग एक अमान्य नंबर दिखाता है।
अनुमान का हर अनुरोध, दोबारा प्रयास सहित, शुल्क वाली नई प्रक्रिया है। ये उदाहरण अपने-आप दोबारा प्रयास नहीं करते। दूसरा अनुरोध भेजने से पहले बिलिंग स्टेटस देखें।
चलाने से पहले: एक्सेस और त्रुटियों को संभालना
ये उदाहरण अपने सर्वर पर चलाएँ। प्रोसेस एनवायरनमेंट में GENDERAPI_API_KEY को अपनी मौजूदा API कुंजी पर सेट करें। पक्का करें कि meta.access.mode का मान api_key है: पहचानी न गई कुंजी IP ट्रायल पर जा सकती है।
HTTP 4xx और 5xx वाले JSON रिस्पॉन्स में त्रुटि की बॉडी बनी रहती है और प्रोग्राम शून्य से अलग एग्ज़िट स्टेटस लौटाता है। दोबारा प्रयास से पहले code, action और meta.usage.billing_status देखें।
// Server-side Node.js. Save as example.mjs.const apiKey = process.env.GENDERAPI_API_KEY;if (!apiKey) throw new Error("Set GENDERAPI_API_KEY");const body = { "number": "+905321234567"};const response = await fetch("https://api.genderapi.io/api/v2/phone/validate", { method: "POST", headers: { Authorization: `Bearer ${apiKey}`, "Content-Type": "application/json", }, body: JSON.stringify(body), signal: AbortSignal.timeout(30_000), redirect: "error",});const raw = await response.text();if (!(response.headers.get("content-type") ?? "").includes("json")) { throw new Error(`HTTP ${response.status}: expected JSON; request ID ${response.headers.get("x-request-id")}`);}const result = JSON.parse(raw); // Also accepts application/problem+json.if (!response.ok) { console.error(`HTTP ${response.status}`, result); process.exitCode = 1; // A retry is a new operation; inspect billing first.} else { console.log(JSON.stringify(result, null, 2)); // For batches, inspect every item: HTTP 200 may contain item errors.}
Node.js 22+; बिल्ट-इन fetch। example.mjs के रूप में सेव करें और node example.mjs चलाएँ। रनटाइम दस्तावेज़ीकरण
Python
import jsonimport osimport sysimport urllib.errorimport urllib.requestapi_key = os.environ.get("GENDERAPI_API_KEY")if not api_key: raise RuntimeError("Set GENDERAPI_API_KEY")body = json.loads("{\"number\":\"+905321234567\"}")class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return Nonerequest = urllib.request.Request( "https://api.genderapi.io/api/v2/phone/validate", method="POST", data=json.dumps(body).encode("utf-8"), headers={ "Authorization": "Bearer " + api_key, "Content-Type": "application/json", },)opener = urllib.request.build_opener(NoRedirect())try: response = opener.open(request, timeout=30)except urllib.error.HTTPError as error: response = error # Keep the Problem Details body on non-2xx responses.with response: status = response.status raw = response.read().decode("utf-8") if "json" not in response.headers.get("Content-Type", ""): raise RuntimeError(f"HTTP {status}: expected a JSON response") result = json.loads(raw)print(json.dumps(result, indent=2), file=sys.stderr if status >= 300 else sys.stdout)if not 200 <= status < 300: sys.exit(1) # Inspect code, action and billing before retrying.# For batches, inspect every item even when HTTP status is 200.
Python 3.10+; स्टैंडर्ड लाइब्रेरी। example.py के रूप में सेव करें और python3 example.py चलाएँ। रनटाइम दस्तावेज़ीकरण
cURL एक्सटेंशन के साथ PHP 8+। example.php के रूप में सेव करें और php example.php चलाएँ। रनटाइम दस्तावेज़ीकरण
Java
import java.net.URI;import java.net.http.HttpClient;import java.net.http.HttpRequest;import java.net.http.HttpResponse;import java.nio.charset.StandardCharsets;import java.time.Duration;public class GenderApiExample { private static String requiredEnv(String name) { String value = System.getenv(name); if (value == null || value.isBlank()) throw new IllegalStateException("Set " + name); return value; } public static void main(String[] args) throws Exception { String apiKey = requiredEnv("GENDERAPI_API_KEY"); String body = "{\"number\":\"+905321234567\"}"; HttpClient client = HttpClient.newBuilder() .connectTimeout(Duration.ofSeconds(10)) .followRedirects(HttpClient.Redirect.NEVER) .build(); HttpRequest request = HttpRequest.newBuilder(URI.create("https://api.genderapi.io/api/v2/phone/validate")) .timeout(Duration.ofSeconds(30)) .header("Authorization", "Bearer " + apiKey) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8)) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8)); if (!response.headers().firstValue("content-type").orElse("").contains("json")) { throw new IllegalStateException("HTTP " + response.statusCode() + ": expected JSON"); } // JSON text; parse with your application's JSON library when integrating. if (response.statusCode() < 200 || response.statusCode() >= 300) { System.err.println(response.body()); // Includes Problem Details. System.exit(1); } System.out.println(response.body()); // For batches, inspect each item's data or error, including on HTTP 200. }}
Java 17+; स्टैंडर्ड HTTP क्लाइंट। GenderApiExample.java के रूप में सेव करें और java GenderApiExample.java चलाएँ। रनटाइम दस्तावेज़ीकरण
C# / .NET
using System;using System.Net.Http;using System.Net.Http.Headers;using System.Text;using System.Text.Json;string RequiredEnv(string name) => !string.IsNullOrWhiteSpace(Environment.GetEnvironmentVariable(name)) ? Environment.GetEnvironmentVariable(name)! : throw new InvalidOperationException($"Set {name}");var apiKey = RequiredEnv("GENDERAPI_API_KEY");using var handler = new HttpClientHandler { AllowAutoRedirect = false };using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(30) };using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.genderapi.io/api/v2/phone/validate");request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", apiKey);request.Content = new StringContent("{\"number\":\"+905321234567\"}", Encoding.UTF8, "application/json");using var response = await client.SendAsync(request);var raw = await response.Content.ReadAsStringAsync();if (!(response.Content.Headers.ContentType?.MediaType?.Contains("json") ?? false)) throw new InvalidOperationException($"HTTP {(int)response.StatusCode}: expected JSON");using var result = JsonDocument.Parse(raw);if (!response.IsSuccessStatusCode){ Console.Error.WriteLine(result.RootElement); // Preserve Problem Details. Environment.ExitCode = 1;}else{ Console.WriteLine(result.RootElement); // For batches, inspect every item even on HTTP 200.}
.NET 8+ कंसोल ऐप्लिकेशन। कंसोल प्रोजेक्ट में Program.cs के रूप में इस्तेमाल करें, फिर dotnet run चलाएँ। रनटाइम दस्तावेज़ीकरण
Go
package mainimport ( "encoding/json" "fmt" "io" "net/http" "os" "strings" "time")func requiredEnv(name string) string { value := os.Getenv(name) if value == "" { panic("Set " + name) } return value}func run() error { apiKey := requiredEnv("GENDERAPI_API_KEY") body := "{\"number\":\"+905321234567\"}" request, err := http.NewRequest("POST", "https://api.genderapi.io/api/v2/phone/validate", strings.NewReader(body)) if err != nil { return err } request.Header.Set("Authorization", "Bearer " + apiKey) request.Header.Set("Content-Type", "application/json") client := &http.Client{ Timeout: 30 * time.Second, CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse }, } response, err := client.Do(request) if err != nil { return err } defer response.Body.Close() raw, err := io.ReadAll(response.Body) if err != nil { return err } if !strings.Contains(response.Header.Get("Content-Type"), "json") || !json.Valid(raw) { return fmt.Errorf("HTTP %d: expected a JSON response", response.StatusCode) } if response.StatusCode < 200 || response.StatusCode >= 300 { return fmt.Errorf("HTTP %d: %s", response.StatusCode, raw) } fmt.Println(string(raw)) // For batches, inspect every item even on HTTP 200. return nil}func main() { if err := run(); err != nil { fmt.Fprintln(os.Stderr, err) // Keep Problem Details for error handling. os.Exit(1) }}
Go 1.22+; स्टैंडर्ड लाइब्रेरी। main.go के रूप में सेव करें और go run main.go चलाएँ। रनटाइम दस्तावेज़ीकरण
422 रिस्पॉन्स गलत फ़ॉर्मेट वाले इनपुट को बिलिंग से पहले अस्वीकार करता है। सही फ़ॉर्मेट वाला अनुरोध, जिसका नंबर पार्स नहीं हो पाता, HTTP 200, valid: false और null फ़ॉर्मेटिंग फ़ील्ड के साथ पूरा हो सकता है; ऐसे पूरे हुए सत्यापन पर 1 क्रेडिट लगता है। पार्स हो सकने वाले लेकिन अमान्य नंबर में भी e164 मान हो सकता है। फ़ॉर्मेट किए गए आउटपुट को वैधता का प्रमाण मानने के बजाय valid जाँचें।
फ़ील्ड
प्रकार
Nullable
उदाहरण
विवरण
फ़ील्डdata.valid
प्रकारboolean
Nullableनहीं
उदाहरणfalse
विवरणनंबर, नंबरिंग प्लान के सत्यापन नियमों से मेल खाता है या नहीं।
फ़ील्डdata.possible
प्रकारboolean
Nullableनहीं
उदाहरणfalse
विवरणनंबर की लंबाई उसके नंबरिंग प्लान के हिसाब से संभव है या नहीं; valid से कमज़ोर जाँच।
फ़ील्डdata.e164
प्रकारstring
Nullableहाँ
उदाहरणnull
विवरणपार्सिंग सफल होने पर अंतरराष्ट्रीय फ़ॉर्मेट वाला नंबर, नहीं तो null।
फ़ील्डdata.country
प्रकारstring
Nullableहाँ
उदाहरणnull
विवरणनंबर से निकाला गया क्षेत्र, या उपलब्ध न होने पर null; इससे सब्सक्राइबर का स्थान पता नहीं चलता।
फ़ील्डdata.country_calling_code
प्रकारinteger
Nullableहाँ
उदाहरणnull
विवरणअंतरराष्ट्रीय कॉलिंग कोड (अंकों में), या उपलब्ध न होने पर null।
एक्सेस, बिलिंग और अनुरोध का मेटाडेटा
फ़ील्ड
प्रकार
Nullable
उदाहरण
विवरण
फ़ील्डmeta.request_id
प्रकारstring
Nullableनहीं
उदाहरण"550e8400-e29b-41d4-a716-446655440000"
विवरणइस HTTP प्रयास का यूनिक पहचानकर्ता; X-Request-ID में भी भेजा जाता है।
फ़ील्डmeta.duration_ms
प्रकारinteger
Nullableनहीं
उदाहरण42
विवरणमिलीसेकंड में अनुरोध प्रोसेस होने का समय।
फ़ील्डmeta.access.mode
प्रकारstring
Nullableनहीं
उदाहरण"api_key"
विवरणapi_key, ip_trial या unauthenticated। पेड अकाउंट इस्तेमाल करते समय api_key की पुष्टि करें।
फ़ील्डmeta.access.reason
प्रकारstring
Nullableहाँ
उदाहरणnull
विवरणIP ट्रायल पर जाने का कारण: api_key_missing, api_key_invalid या api_key_not_found; बाकी मामलों में null।
फ़ील्डmeta.usage.charged_credits
प्रकारinteger
Nullableहाँ
उदाहरण1
विवरणकुल कटे हुए क्रेडिट। शुल्क लगने से पहले या पूरे रिफ़ंड की पुष्टि के बाद शून्य; बिलिंग की पुष्टि न होने पर null।
फ़ील्डmeta.usage.remaining_credits
प्रकारinteger
Nullableहाँ
उदाहरण99
विवरणप्रक्रिया पूरी होने के समय का बैलेंस। नेगेटिव हो सकता है; उपलब्ध न होने या बिलिंग की पुष्टि न होने पर null।
फ़ील्डmeta.usage.billing_status
प्रकारstring
Nullableनहीं
उदाहरण"confirmed"
विवरणnot_charged, confirmed या unconfirmed। विफल अनुमान का दोबारा प्रयास करने से पहले इसे जाँचें।
फ़ील्डmeta.usage.resets_at
प्रकारstring
Nullableहाँ
उदाहरण"2026-09-27T12:00:00.000Z"
विवरणUTC में IP ट्रायल रीसेट होने का समय (ISO 8601); API कुंजी वाले अकाउंट के लिए या पता न होने पर null।
फ़ील्डmeta.usage.limit
प्रकारinteger
Nullableहाँ
उदाहरण10
विवरणIP ट्रायल की सीमा; API कुंजी वाले अकाउंट के लिए null।
फ़ील्डmeta.usage.period_seconds
प्रकारinteger
Nullableहाँ
उदाहरण86400
विवरणसेकंड में IP ट्रायल की अवधि; API कुंजी वाले अकाउंट के लिए null।
प्रमाणीकरण और दोबारा प्रयास
अपनी मौजूदा Bearer API कुंजी और Content-Type: application/json भेजें। कोड उदाहरण एनवायरनमेंट से GENDERAPI_API_KEY पढ़ते हैं। राष्ट्रीय नंबरों के लिए country ज़रूरी है; number के + से शुरू होने पर यह फ़ील्ड वैकल्पिक है।