GenderAPI v2 के साथ अंतरराष्ट्रीय या राष्ट्रीय फ़ोन नंबरों को सत्यापित और प्रारूपित करें। आवश्यक देश संदर्भ, JSON फ़ील्ड और एक-क्रेडिट शुल्क देखें।
फ़ोन नंबर सत्यापित करें और प्रारूपित करें
POST /phone/validate में number और वैकल्पिक country फ़ील्ड भेजें। अंतरराष्ट्रीय फ़ोन नंबर + से शुरू होना चाहिए। राष्ट्रीय प्रारूप के नंबर के साथ बड़े अंग्रेज़ी अक्षरों में ISO देश कोड देना ज़रूरी है। रिस्पॉन्स के data में valid, possible, e164, country और country_calling_code मिलते हैं; साथ में साझा meta ऑब्जेक्ट होता है। यह नंबर की संरचना जाँचता है, ग्राहक के अस्तित्व की पुष्टि नहीं करता। हर पूरी हुई जाँच की लागत 1 क्रेडिट है, भले ही नंबर अमान्य हो। नीचे दिया गया उदाहरण अमान्य नंबर का रिस्पॉन्स दिखाता है और अनुरोध के उदाहरण से स्वतंत्र है।
JSON फ़ील्ड
प्रकार
नियम
number
string
आवश्यक, 3-32 अक्षर। ASCII अंक, रिक्त स्थान, कोष्ठक और हाइफ़न, एक वैकल्पिक अग्रणी + के साथ। एक्सटेंशन और वर्णमाला वर्ण स्वीकार नहीं किए जाते हैं.
country
string
अपरकेस ISO 3166-1 अल्फा-2 कोड। राष्ट्रीय फ़ोन नंबर के लिए आवश्यक. वैकल्पिक जब number मान + से शुरू होता है। जब इसकी आवश्यकता न हो तो इस फ़ील्ड को छोड़ दें।
प्रत्येक पूर्वानुमान अनुरोध एक नया बिल योग्य ऑपरेशन है, जिसमें पुनर्प्रयास भी शामिल है। ये उदाहरण स्वचालित रूप से पुनः प्रयास नहीं करते हैं. दूसरा अनुरोध भेजने से पहले बिलिंग स्थिति जांचें।
चलाने से पहले: पहुंच और त्रुटि प्रबंधन
इन उदाहरणों को अपने सर्वर पर चलाएँ। प्रक्रिया परिवेश में 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+; अंतर्निर्मित फ़ेच. 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 चलाएँ। रनटाइम दस्तावेज़ीकरण
PHP 8+ cURL एक्सटेंशन के साथ. 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 चलाएँ। रनटाइम दस्तावेज़ीकरण
बिलिंग से पहले विकृत इनपुट को HTTP 422 के साथ अस्वीकार कर दिया जाता है। यदि अनुरोध प्रारूप सही है लेकिन फ़ोन नंबर को पार्स नहीं किया जा सकता है, तो ऑपरेशन valid: false और null फ़ॉर्मेटिंग फ़ील्ड के साथ HTTP 200 लौटा सकता है। इस पूर्ण सत्यापन की लागत 1 क्रेडिट है। एक संख्या जिसे पार्स किया जा सकता है लेकिन अमान्य है, उसमें अभी भी e164 मान हो सकता है। valid की जाँच करें; केवल स्वरूपित संख्या ही वैधता का प्रमाण नहीं है।
data के अंदर फ़ील्ड
अर्थ
valid
क्या संख्या क्रमांकन-योजना सत्यापन नियमों से मेल खाती है।
possible
क्या संख्या की संख्या योजना के लिए प्रशंसनीय लंबाई है; वैध से कमजोर.
e164
पार्सिंग सफल होने पर अंतर्राष्ट्रीय स्वरूपित संख्या, अन्यथा null।
country
अनुपलब्ध होने पर संख्या, या null से प्राप्त क्षेत्र; यह ग्राहक का पता नहीं लगाता है.
country_calling_code
संख्यात्मक अंतर्राष्ट्रीय कॉलिंग कोड, या अनुपलब्ध होने पर null।
प्रमाणीकरण और पुनः प्रयास
बियरर प्रमाणीकरण और सामग्री-प्रकार: एप्लिकेशन/जेसन का उपयोग करके अपनी मौजूदा एपीआई कुंजी भेजें। उदाहरण परिवेश से GENDERAPI_API_KEY पढ़ते हैं। country फ़ील्ड राष्ट्रीय फ़ोन नंबरों के लिए आवश्यक है और जब number मान + से शुरू होता है तो वैकल्पिक होता है।