Create Customer Application for Integrators

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

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

Request Parameters

Header Parameters:

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

Body Parameters:

Parameter Name	Type	Required	Example	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	Request result description

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 you are an integrator
9009	Maximum of 1000 customer applications reached	Maximum of 1000 customer applications can be created