Callbot API mgrTaskStatus

callbot-api

v1.0.0

Base URLs:

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

aibot External API v3.0/Task Operation

Authentication Method

Please refer to the documentation at https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization

POST Operation Task Status

POST /callcentre/api/v3/mgrTaskStatus

Modify task status, such as starting, pausing, or completing a task.

Request Example

{
  "productID": "callbot",
  "userTaskID": "string",
  "taskOperate": 1,
  "delCall": 0
}

header:

Name	Type	Required	Description
requestID	string	Yes	Unique request ID
uuid	string	Yes	UUID provided by the callee
createTs	string	Yes	Request timestamp (in seconds)
sign	string	Yes	Signature
algorithm	string	No	Signature algorithm: MD5 or SHA256, default to MD5 if left blank

Request Body

Name	Type	Required	Description
productID	string	Yes	Constant value "callbot"
userTaskID	string	Yes	Task ID of the requester (generated and guaranteed to be unique by the caller), it is recommended to use UUID
taskOperate	integer	Yes
delCall	integer	No	Whether to delete undialed data, 0: none, 1: delete (use with caution)

Enumerated Values

Property	Value	Description
» taskOperate	1	Start
» taskOperate	2	Pause
» taskOperate	3	Complete

Response Example

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "taskID": "string",
  "taskStatus": 1
}

Response Result

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	0 indicates success, others indicate failure
retMsg	string	true	none	Response message
responseID	string	true	none	Random unique ID used for request tracking, it needs to be provided when locating problems related to the request
taskID	string	true	none	Actual task ID returned by the callee
taskStatus	integer	true	none	Task status

Enumerated Values

Property	Value	Description
taskStatus	1	Task is pending
taskStatus	2	Task is in progress
taskStatus	3	Task is completed
taskStatus	4	Task is finished (failed)
taskStatus	5	Task is paused