AI Agent ‐ Append Contacts to an Existing Task

Append Contacts to an Existing Task

Append additional contact phone numbers to an existing outbound task.

---

API Information

• URL: https://api-hk.nxlink.ai/openapi/aiagent/call/append
• Method: POST
• Content-Type: application/json
• Authentication Required: Yes

---

🌐 Service Endpoints

NXLink is deployed across multiple global regions. Please select the appropriate endpoint based on your business location.

Code	Region	NXLink Website	API Gateway
APAC	Hong Kong	https://app.nxlink.ai	https://api-hk.nxlink.ai
AMER	Americas	https://chl-nxlink.nxcloud.com	https://chl-api.nxlink.ai
APAC (IDN)	Indonesia	https://idn.nxlink.ai	https://api-idn.nxlink.ai

---

Request Parameters

Header Parameters

Parameter	Type	Required	Example	Description
accessKey	String	Yes	AK-6230339248928541113-2133	User access key
ts	String	Yes	1655710885431	Request timestamp in milliseconds. Maximum allowed time drift is 60 seconds
bizType	String	Yes	100	Business type, fixed value
action	String	Yes	nxai	Business action, fixed value
sign	String	Yes	6e9506557d1f289501d333ee2c365826	API request signature (see common authentication rules) , Signature Algorithm

---

Body Parameters

Parameter	Type	Required	Example	Description
taskId	String	Yes	"52145b00-abc9-4a87-94c2-ed1e1e42ec1c"	Task ID
countryCode	String	No	"86"	Country calling code
list	Array	Yes		List of contacts to append

---

Contact Object (list Element)

Parameter	Type	Required	Example	Description
contactId	String	Yes	"52145b00-abc9-4a87-94c2-ed1e1e42x4rfvmh"	Contact ID (globally unique)
name	String	Yes	"Jones"	Contact name
phoneNumber	String	Yes	"86130XXXX"	Phone number
params	Array	No		Custom variables

---

Variable Object (params Element)

Parameter	Type	Required	Example	Description
name	String	Yes	"key1"	Variable name (must match an existing variable in the workflow)
value	Object	No	"value1"	Variable value

---

Request Example

{
  "taskId": "52145b00-abc9-4a87-94c2-ed1e1e42ec1c",
  "countryCode": "86",
  "list": [
    {
      "contactId": "52145b00-abc9-4a87-94c2-ed1e1e42xki093",
      "name": "name1",
      "phoneNumber": "86130XXXXX",
      "params": [
        {
          "name": "key1",
          "value": "value1"
        }
      ]
    }
  ]
}

Response Parameters

Parameter	Type	Description
code	Integer	Result code
message	String	Result message
traceId	String	Trace ID for request tracking
data	Object	Response payload

---

Data Object

Parameter	Type	Description
errList	Array	Error list containing records that failed to be imported
successCount	Integer	Number of records successfully imported
totalCount	Integer	Total number of processed records

---

Error List Item (errList Element)

Parameter	Type	Description
phoneNumber	String	Phone number that failed to be imported
reason	String	Failure reason

---

Response Examples

Success Example

{
  "code": 0,
  "message": null,
  "traceId": null,
  "data": {
    "errList": [
      {
        "userName": "lucy",
        "userPhone": "1312895-xxx",
        "errMsg": "Illegal phone number format:1312895-xxx"
      }
    ],
    "successCount": 1,
    "totalCount": 2
  }
}

Failure Example

{
  "code": 20000,
  "message": "Duplicate contactIds are not allowed: 52145b00-abc9-4a87-94c2-ed1e1e42xki0931",
  "traceId": "dbdd93a9-cb7c-4c0d-8f98-01755b1883b6"
}

Error Codes

Code	Description
1001	Authentication failed (missing public parameters)
1002	Authentication failed (parameter error)
1003	Authentication failed (invalid signature)
1004	Authentication failed (timestamp expired)
1005	Authentication failed (insufficient authority)
20000	Business Error