Integrator Create Customer Application

Initiate the service to create a customer application through the API (for integrators only)

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

Authentication Mechanism

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	createApp	WhatsApp business operation, fixed value "createApp"
sign	String	Yes	6e9506557d1f289501d333ee2c365826	API input parameter signature, signature algorithm

Body parameters:

Parameter Name	Type	Required	Example Value	Description
app_name	String	Yes	Whatsapp	Application name
webhook	String	Yes	https://***/api/webhook/whatsApp	Webhook address

Request Example

Body (application/json) parameters:

{
    "app_name": "Whatsapp",
    "webhook ": "https://***/api/webhook/whatsApp"
}

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
app_id	Integer	App ID
app_name	String	Application name
app_key	String	App key

Response Example

Successful Example

{
    "code": 0,
    "data": {
        "app_id": 1000,
        "app_name": "Whatsapp",
        "app_key": "KI92cew9"
    },
    "message": "Request successful"
}

Failed Example

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

Response Code Explanation

code	message	Solution
0	Request successful
-1	Request failed	Please contact technical support 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 support to troubleshoot the issue.
9007	Non-integrator request	Please confirm if it is an integrator request.
9009	Maximum of 1000 customer applications reached	Maximum of 1000 customer applications can be created.