WhatsApp API phoneList

Query Phone Number List for Integrators (Integrators Only)

Query the phone number list for a customer application through the API.

• URL: https://api2.nxcloud.com/api/wa/integrator/embedded/register/phoneList
• Method: POST
• Content-Type: application/json
• Requires authentication: Yes

Authentication Mechanism

Please refer to the following address for authentication rules: API Interface Call Convention

Request Parameters

Header parameters:

Parameter Name	Type	Required	Example Value	Description
accessKey	String	Yes	fmexxx3ki	User identity identifier
ts	String	Yes	1655710885431	Current timestamp of the request in milliseconds. The maximum allowable time difference between the server and the user is 60 seconds.
bizType	String	Yes	2	WhatsApp business type, fixed value "2"
action	String	Yes	phoneList	WhatsApp business operation, fixed value "phoneList"
sign	String	Yes	6e95xxx826	API input parameter signature, signature algorithm

Body parameters:

Parameter Name	Type	Required	Example Value	Description
appkey	String	Yes	KI9xxew9	App key of the NiuXin Cloud WhatsApp application

Request Example

Body (application/json) parameters:

{
    "appkey": "jh42xxxd434"
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Result code
data	JsonObject	Request result
message	String	Description of the request result

• data object parameters:

Parameter Name	Type	Description
display_phone_number	string	Registered WhatsApp phone number
quality_rating	string	Quality rating of the number. Enum values: GREEN: High quality; YELLOW: Medium quality; RED: Low quality; UNKNOW: Quality unknown
verified_name	string	Display name of the number
name_status	string	Name approval status. Enum values: APPROVED: Name not yet approved; NONE: No certificate available; AVAILABLE_WITHOUT_REVIEW: Certificate available for download without review; DECLINED: Name not yet approved, certificate cannot be downloaded; EXPIRED: Certificate expired, cannot be downloaded; PENDING_REVIEW: Name request is under review, certificate cannot be downloaded
register_status	integer	Connection status. 1: Creation failed (local client); 2: Registration of local client failed; 3: Creation in progress (local client); 4: Creation successful (local client); 5: Registration of local client successful
status	string	Number status. Enum values: PENDING, DELETED, MIGRATED, BANNED, RESTRICTED, RATE_LIMITED, FLAGGED, CONNECTED, DISCONNECTED, UNKNOWN, UNVERIFIED
current_limit	string	Merchant-initiated conversation 24-hour limit level. Enum values: TIER_1K: 1,000 customers/24 hours; TIER_10K: 10,000 customers/24 hours; TIER_100K: 100,000 customers/24 hours; TIER_50: 50 customers/24 hours; TIER_250: 250 customers/24 hours; TIER_UNLIMITED: Not applicable
code_verification_status	string	Number verification status. Enum values: NOT_VERIFIED: Not verified; VERIFIED: Verified

Response Example

Success Example

{
  "code": 0,
  "data": [
    {
      "display_phone_number": "+86 xxx 24",
      "quality_rating": "GREEN",
      "name_status": "APPROVED",
      "verified_name": "GLORY JACK",
      "code_verification_status": "VERIFIED",
      "current_limit": "",
      "register_status": 1,
      "status": "CONNECTED"
    },
    {
      "display_phone_number": "+1 xxx99",
      "quality_rating": "GREEN",
      "name_status": "APPROVED",
      "verified_name": "Glory HK",
      "code_verification_status": "NOT_VERIFIED",
      "current_limit": "",
      "register_status": 1,
      "status": "CONNECTED"
    }
  ],
  "message": "Request successful"
}

Failure Example

{
    "code": -1,
    "message": "Request failed",
    "data": null
}

Response Code Explanation

Code	Message	Solution
0	Request successful
-1	Request failed	Please contact technical personnel to troubleshoot the issue
1000~100X	Authentication issue	Refer to the API authentication section for details
9000	Parameter exception	Missing parameters, please check the required parameters
9001	System business error	Please contact technical personnel to troubleshoot the issue
9007	Non-integrator request	Please confirm if it is an integrator request
9008	APPKEY does not exist	Please confirm if the APPKEY is correct
9010	Inconsistency between the authentication mechanism and the customer information corresponding to APPKEY	Please confirm if the APPKEY is correct