/check/whatsapp_advanced
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to check whether the phone number have registered WhatsApp (Advanced version).
Request Method
POST
Request URL
https://cloudapi.peru.accuauth.com/check/whatsapp_advanced
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 | Peru phone number without country code |
| optional | callback | string | Not supported yet |
3.Response Params
| Fields | Type | Description |
|---|---|---|
| request_id | string | Unique id of each request |
| status | string | Response status, OK if request success, PENDING if checking is in progress, other if failed; See Error Codes for details |
| result | object | Check result，See result belowed for details |
Elements in result:
| Fields | Type | Description |
|---|---|---|
| number | string | The phone number |
| string | Registered or not, yes or no |
|
| status_update | string | Status updated date, such as 20231212 |
| signature | string | User signature |
| business_user | string | yes or no |
| avatar | string | yes or no |
Response Syntax
{
"status": "OK",
"result": {
"number": "+5275293XXXX",
"whatsapp": "yes",
"status_update": "20231212",
"signature": "Hello world",
"business_user": "no",
"avatar": "yes"
},
"request_id": "TID591cb9fb0e284cf296912a4d0ffea889"
}
4.Error Codes
Common error codes of this API:
| Http Status Code | Status field |
Description |
|---|---|---|
400 |
PENDING | Operation in progress |
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"
}