/check/number/basic/o1
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to check if someone is on the blacklist by mobile number.
Request Method
POST
Request URL
- Master Node: https://cloudapi.pakistan-1.accuauth.com/check/number/basic/o1
- Backup Node: https://cloudapi.pakistan.accuauth.com/check/number/basic/o1
Debugging Tool
2.Request Params
2.1 Request Header
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-DF-API-ID | string | Yes | For API credentials，Please visit API Request |
| X-DF-API-SECRET | string | Yes | For API credentials，Please visit API Request |
2.2 Request Body
| Fields | Type | Description | |
|---|---|---|---|
| required | number | string | phone number with country code prefix: 92 |
3.Response Params
| Fields | Type | Description |
|---|---|---|
| request_id | string | Unique id of each request |
| status | string | Response status, OK if request success, other if failed; See Error Codes for details |
| result | object | Check result，See result belowed for details |
Elements in result:
| Fields | Type | Description |
|---|---|---|
| validity | string | If the number is valid, valid: YES or invalid: NO |
| country_code | int | The country code, Pakistan is 92 |
| national_number | string | Local format of number |
| standard_number | string | Standard format of number |
| region_code | string | Region Code |
Response Syntax
{
"status": "OK",
"result": {
"validity": "YES",
"country_code": 92,
"national_number": "81316356360",
"standard_number": "9281316356360",
"region_code": "ID"
},
"request_id": "TID591cb9fb0e284cf296912a4d0ffea889"
}
4.Error Codes
Common error codes of this API:
| Http Status Code | Status field |
Description |
|---|---|---|
400 |
INVALID_ARGUMENT | Request parameter is invalid |
401 |
UNAUTHORIZED | Unauthorized or access is denied |
401 |
KEY_EXPIRED | Your API ID has expired |
403 |
NO_PERMISSION | You are not authorized to use this API |
403 |
OUT_OF_QUOTA | API calls quota exceeded |
403 |
RATE_LIMIT_EXCEEDED | API request frequency exceeds the limit |
404 |
NOT_FOUND | Requested API cannot be found |
500 |
INTERNAL_ERROR | Internal server error |
Comment: Please see the reason field for details when the above 40X error occurred
Response Syntax
{
"status": "INVALID_ARGUMENT",
"reason": "argument 'number': not found",
"request_id": "TID0bb59f6aa6454717b870b16202ccf36f"
}