التوثيق / مرجع الواجهة
تقييم رقم الجوال
تتحقق من رقم هاتف لدولة محددة وتخبرك بمشغّله وهل يبدو حقيقيًا أم مؤقتًا.
نظرة عامة#
تحتاج scoring/phone مدخلين: الرقم phone ودولته countryCode (بصيغة ISO 3166-1 alpha-2 مثل US). يمكن كتابة الرقم بعدة طرق، مع علامة الزائد أو بدونها ومع البادئة الوطنية أو بدونها. تحوي الاستجابة phone بعد التطبيع وisValid وreason عند عدم الصلاحية وcarrier ومؤشر disposable للأرقام المؤقتة أو الافتراضية وblacklisted.
متى تستخدمه#
- للتحقق من الأرقام عند التسجيل قبل إرسال رمز SMS، فتوفّر تكلفة رسائل إلى أرقام لا تستقبلها.
- لتصفية الأرقام المؤقتة والافتراضية المستخدمة في إساءة العروض.
- لتوحيد صيغة الأرقام قبل تخزينها.
قراءة النتيجة#
isValid: falseمعreasonمثل بنية غير صالحة يعني أن الرقم لا يمكن أن يتبع تلك الدولة. اطلب من المستخدم تصحيحه ولا ترسل رمزًا.disposable: trueتدل على رقم مؤقت. اقبله حيث تكون المخاطرة منخفضة فقط، أو اطلب عامل تحقق أقوى.- قد يكون
carrierفارغًا خاصة للأرقام غير الصالحة، وقد يتغير المشغّل عند نقل الأرقام، فاعتبره معلومة إرشادية لا مرجعًا حاسمًا. - مرّر دائمًا الدولة التي اختارها المستخدم لا التي خُمّنت من IP، وإلا قد تُعدّ أرقام صحيحة غير صالحة.
ملاحظات#
- تُحتسب طلبًا واحدًا. وضع الاختبار يُرجع بيانات وهمية مجانًا دون أحداث.
- ليست ضمن الباقة القياسية؛ متاحة في التجربة والمميّزة والدفع حسب الاستخدام. وبدون صلاحية يصلك الخطأ 117 (
feature_not_available). - يمكن لـالقواعد المخصصة في مجموعة الجوال اختبار الرقم والدولة والمشغّل وتعليم الرقم كصالح أو غير صالح. وتُسرد النتيجة في
custom_rules_applied. - يُطلَق حدث
spam_phoneللأرقام المعتبرة وهمية أو مسيئة ويُرسل إلى الويب هوك. - الرقم المفقود أو غير القابل للتحليل يُرجع الخطأ 118 (
invalid_phone_number) والدولة الخاطئة تُرجع 116 (invalid_country_code)، كلاهما مع HTTP 200.
الطلب#
GET
https://gurdx.cretip.com/api/scoring/phone
- صادِق بمعامل key أو بترويسة Authorization: Bearer.
- تُحتسب طلباً واحداً.
- متاحة في: تجربة مجانية المميّزة الدفع حسب الاستخدام
المعاملات#
| الاسم | النوع | الوصف |
|---|---|---|
phone
مطلوب
استعلام |
string |
The phone command is used to specify the phone number you want to validate. Expected values: a phone number Sample value: +12121234567, 0012121234567, 12121234567, or 2121234567
|
countryCode
مطلوب
استعلام |
string |
The ISO 3166-1 alpha-2 format of the country code of the phone number. Learn more Sample value: US
|
تقبل كل خدمة أيضاً format, lang, mode, userID, callback. راجع الخيارات.
أمثلة برمجية#
curl -G "https://gurdx.cretip.com/api/scoring/phone" \
--data-urlencode "key=YOUR_API_KEY" \
--data-urlencode "phone=501234567" \
--data-urlencode "countryCode=SA"
<?php
$response = file_get_contents('https://gurdx.cretip.com/api/scoring/phone?'.http_build_query(['key' => 'YOUR_API_KEY', 'phone' => '501234567', 'countryCode' => 'SA']));
$result = json_decode($response, true);
if ($result['status'] === 'success') {
print_r($result['data']);
} else {
echo $result['code'].': '.$result['description'];
}
const params = new URLSearchParams({"key":"YOUR_API_KEY","phone":"501234567","countryCode":"SA"});
const res = await fetch(`https://gurdx.cretip.com/api/scoring/phone?${params}`);
const result = await res.json();
if (result.status === 'success') {
console.log(result.data);
} else {
console.error(result.code, result.description);
}
import requests
res = requests.get("https://gurdx.cretip.com/api/scoring/phone", params={"key": "YOUR_API_KEY", "phone": "501234567", "countryCode": "SA"})
result = res.json()
if result["status"] == "success":
print(result["data"])
else:
print(result["code"], result["description"])
الاستجابة#
نجاح#
{
"data": {
"carrier": "",
"reason": "Invalid phone number structure.",
"isValid": false,
"blacklisted": false,
"disposable": false,
"phone": "+12121234567",
"countryCode": "US",
"custom_rules_applied": {
"total": 0,
"rules": []
}
},
"status": "success",
"executionTime": 1
}خطأ#
تُسلَّم الأخطاء بحالة HTTP 200 — افحص دائماً حقل status.
{
"status": "error",
"code": 101,
"type": "invalid_key",
"description": "The API Key is missing or invalid."
}حقول الاستجابة#
| الاسم | النوع | الوصف |
|---|---|---|
data.carrier |
string |
Carrier name of the phone number. |
data.reason |
string |
The reason behind considering this phone number as risky. Note: The value of this property will be empty if the isValid is true.
|
data.isValid |
boolean |
A boolean value that you can rely on to determine if the phone number is 100% safe & valid or not. |
data.blacklisted |
boolean |
Indicates if the phone number is blacklisted due to applying custom rules or were found in one of your blacklists. |
data.disposable |
boolean |
A boolean value that indicates if the phone number is a disposable phone number or not. |
data.phone |
string |
The phone number you sent in the request. |
data.countryCode |
string |
The country code you sent in the request. |
data.custom_rules_applied.total |
integer |
The total number of custom rules applied to this request. |
data.custom_rules_applied.rules.id |
string |
The rule ID as shown in the dashboard (e.g: CR104).
|
data.custom_rules_applied.rules.title |
string |
The rule title you set when creating the rule. |
data.custom_rules_applied.rules |
object |
The custom rules applied to this request, learn more. |
data.custom_rules_applied |
object |
The custom rules applied to this request, learn more. |
data.status |
string |
The response status. Expected values: success, or error.
|
data.executionTime |
integer |
Time spent in milliseconds to process the data. |
data |
object |
— |
وجدت خطأ؟ أخبرنا عبر صفحة التواصل. تواصل معنا