WhatsApp API getCode - nxtele/http-api-document-en GitHub Wiki
Get Verification Code for Integrators
Initiate the process of getting a verification code through the API. (For Integrators Only)
- URL:
https://api2.nxcloud.com/api/wa/integrator/embedded/register/getCode
- 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 |
fme2na3kdi3ki |
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 |
getCode |
WhatsApp business operation, fixed value "getCode" |
| sign |
String |
Yes |
6e9506557d1f289501d333ee2c365826 |
API input parameter signature, signature algorithm |
Body parameters:
| Parameter Name |
Type |
Required |
Example Value |
Description |
| phone_number |
String |
Yes |
185xxx99 |
Phone number |
| method |
String |
Yes |
sms |
Enumeration values: sms, voice |
Request Example
Body (application/json) parameters:
{
"phone_number": "185xxx99",
"method": "sms"
}
Response Parameters
| Parameter Name |
Type |
Description |
| code |
Integer |
Result code |
| data |
JsonObject |
Request result |
| message |
String |
Description of the request result |
Response Example
Success Example
{
"code": 0,
"data": {},
"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 |