Callbot API stopOrder

callbot-api

v1.0.0

Base URLs:

• Production Environment: https://nxbot.nxcloud.com

aibot External API v3.0/Order Operations

Authentication Method

For authentication, please refer to the document https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization

POST Stop Order Call

POST /callcentre/api/v3/stopOrder

Stopping an order call is irreversible

Stop the order call.

Body Request Parameters

{
  "productID": "callbot",
  "userTaskID": "string",
  "orderIDs": [
    "string"
  ],
  "delCall": 0
}

Request Parameters

Name	Location	Type	Required	Description
requestID	header	string	Yes	Unique request ID
uuid	header	string	Yes	UUID provided by the callee
createTs	header	string	Yes	Request timestamp (in seconds)
sign	header	string	Yes	Signature
algorithm	header	string	No	Signature algorithm: MD5 or SHA256, default to MD5 if left blank
body	body	object	No	None
» productID	body	string	Yes	Constant value: "callbot"
» userTaskID	body	string	Yes	Task ID of the requester (generated and ensured unique by the caller), recommended to use UUID
» orderIDs	body	[string]	Yes	Order ID list
» delCall	body	integer	No	Whether to delete undialed data, 0: none, 1: delete (use with caution)

Response Example

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "totalCount": 0,
  "successCount": 0,
  "errList": [
    {
      "orderID": "string",
      "errMsg": "string"
    }
  ]
}

Response Results

Status Code	Status Code Meaning	Description	Data Model
200	OK	Success	Inline

Response header

Name	Type	Required	Description
requestID	string	Yes	Consistent with the request header
uuid	string	Yes	Consistent with the request header
createTs	string	Yes	Second level timestamp at response time
sign	string	Yes	The generation method is the same as the sign generation algorithm in the request header
algorithm	string	No	Consistent with the request header, signature algorithm: MD5 or SHA256, default to MD5 if not filled in

Response Data Structure

Status Code 200

Name	Type	Required	Constraints	Description
» retCode	integer	true	none	Response Code, 0 for success, others for failure
» retMsg	string	true	none	Response Message
» responseID	string	true	none	Random unique ID used for request tracking, should be provided for issue tracking
» totalCount	integer	true	none	Total Count
» successCount	integer	true	none	Success Count
» errList	[object]	true	none	Error List
»» orderID	string	true	none	Failed Order ID
»» errMsg	string	true	none	Failure Reason