AI Agent Task ‐ Delete Contacts - nxtele/nxcloud-doc-en GitHub Wiki

Delete Contacts from a Task

Remove existing contacts (orders) from an outbound task.

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

🌐 Service Endpoints

NXLink is deployed across multiple global regions. Choose the endpoint that matches your business location. Website domains and API gateway domains differ by region.

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 Value Description
accessKey String Yes AK-6230339248928541113-2133 User identity key
ts String Yes 1655710885431 Request timestamp in milliseconds. Maximum allowed time drift is 60 seconds
bizType String Yes 100 Business type, fixed value: 100
action String Yes nxai Business action, fixed value: nxai
sign String Yes 6e9506557d1f289501d333ee2c365826 API request signature (see common authentication rules), Signature Algorithm

Body Parameters

Parameter Type Required Example Description
taskId String No "52145b00-abc9-4a87-94c2-ed1e1e42ec1c" Task ID, which is the internal system task ID. At least one of taskId or userTaskId is required. If both are provided, userTaskId takes priority
userTaskId String No "EXT-TASK-202603250001" Caller-defined task ID. Recommended as the preferred identifier. At least one of taskId or userTaskId is required
contactId String Yes "52145b00-abc9-4a87-94c2-56hu4rfo" Contact ID

Note: Only contacts in the Pending / Not Started state can be deleted.

If both taskId and userTaskId are provided, userTaskId is used first to locate the task.


Request Example

{
  "userTaskId": "EXT-TASK-202603250001",
  "contactId": "52145b00-abc9-4a87-94c2-ed1e1e42ec1c"
}

Response Parameters

Parameter Type Description
code Integer Result code
message String Result message
traceId String Trace ID for request tracking
data Array Response payload, returns an array of UUIDs

Data Element

Parameter Type Description
callId Integer Call ID

Response Example

Success Response

{
  "code": 0,
  "message": "success",
  "traceId": "e84a7ee05c7248029828e59ddf725d75",
  "data": null
}

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