NXCC API createAutoCallTask

Create AI Outbound Task and Add Numbers

• URL：https://api2.nxcloud.com/saas/cc/openapi/ai/createandcall
• Method：POST
• Content-Type：application/json
• Authentication Required: Yes

Authentication Mechanism

For authentication rules, please refer to: API Interface Call Agreement

Request Parameters

header Parameters：

Parameter Name	Type	Required	Example Value	Description
accessKey	String	Y	fme2na3kdi3ki	User identity identifier
ts	String	Y	1655710885431	Timestamp of the current request (in milliseconds). The NX server allows a maximum time error of 60 seconds for client requests.
bizType	String	Y	8	Business type, fixed value “8”
action	String	Y	cc	Business operation, fixed value “cc”
sign	String	Y	6e9506557d1f289501d333ee2c365826	API parameter signature, Signature Algorithm

body Parameters：

Parameter Name	Type	Required	Example Value	Description
country	String	Yes	"CN"	Country code
taskName	String	Yes	"Task Name"	Task name
taskDesc	String	No	"Task Description"	Task description
strategyName	String	Yes	"Default Strategy"	Call strategy name, e.g., "one round" (Dial one, redial one), "default" (Default strategy)
dispatchType	Integer	Yes	0	Outbound type: 0: none, 1: ratio outbound, 2: predictive outbound
agentGroupNo	String	Yes	"NXXXXXXXG0000001"	Agent group number
predictCallRate	Double	Yes	1.0	Call rate with two decimal places
ratioCallRate	Double	Yes	1.0	Agent call rate with one decimal place
startCount	Integer	Yes	1	Algorithm start value
callList	Array of CallListItem	Yes	[]	List of user phone numbers
startupType	Integer	No	0	Task startup type: 0: none, 1: manual start, 2: scheduled start, 3: immediate start

CallListItem Parameters

Parameter Name	Type	Required	Example Value	Description
orderID	String	Yes	"FFDD1791E22F4D9DBA967C245C58E544"	Unique ID, default UUID
userPhone	String	Yes	"86156xxxxxxxx"	Phone number
other	String	Yes	"ebd0788c-a592-49a6-a0e8-3205e0492f54"	Customer pass-through field

Request Example

body（application/json）：

{
    "taskDesc": "Description",
    "callList": [
        {
            "userPhone": "85235757581",
            "other": "OTHER",
            "orderID": "ORDER_ID"
        }
    ],
    "country": "HK",
    "dispatchType": 0,
    "predictCallRate": 1.0,
    "agentGroupNo": "NX09445G000025",
    "taskName": "Task Name",
    "strategyName": "Default Strategy",
    "startCount": 1,
    "ratioCallRate": 1.0,
    "startupType": 3
}

Response Parameters

Parameter Name	Type	Description
code	Integer	Result code
data	JsonObject	Response data
msg	String	Result message

Response Example

Success Example

{
  "reqId": "9834904964284198A05BE414383621E8",
  "code": 0,
  "msg": "success",
  "data": null
}

Failure Example

{
    "reqId": "78db27d91ebd46e1e52135e2239b03bc",
    "code": 41000,
    "msg": "Parameter error or empty",
    "data": {}
}

Response Code Description

Code	Message	Solution
0	Request successful
88	Request failed	Please contact technical support to troubleshoot
99	System error	Please contact technical support to troubleshoot
1000~100X	Authentication issues	See the API authentication section for details