callbot-api

v1.0.0

Base URLs:

• 正式环境: https://nxbot.nxcloud.com

aibot外部接口v3.0/任务操作

鉴权方式

鉴权请查看文档https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization

POST 操作任务状态

POST /callcentre/api/v3/mgrTaskStatus

修改任务状态 如开启、暂停或完结任务

请求示例

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

header:

名称	类型	必选	说明
requestID	string	是	请求唯一id
uuid	string	是	uuid,由被调用方给出
createTs	string	是	请求时间戳,(秒级)
sign	string	是	签名
algorithm	string	否	签名的算法：MD5或者SHA256，不填默认用MD5

请求体

名称	类型	必选	说明
productID	string	是	产品id，定值"callbot"
userTaskID	string	是	任务id，请求方的任务id(调用方生成并且保证唯一)，建议使用uuid
taskOperate	integer	是	任务操作参数
delCall	integer	否	是否删除未拨打的数据，0:none，1:删除(谨慎使用)

枚举值

属性	值	说明
» taskOperate	1	启动
» taskOperate	2	暂停
» taskOperate	3	完结

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	Inline

响应的header

名称	类型	必选	说明
requestID	string	是	与请求头一致
uuid	string	是	与请求头一致
createTs	string	是	响应时的秒级时间戳
sign	string	是	生成方法与请求头sign生成算法一样
algorithm	string	否	与请求头一致，签名的算法：MD5或者SHA256，不填默认用MD5

返回数据结构

状态码 200

名称	类型	必选	约束	说明
retCode	integer	true	none	响应码，0为成功，其余为失败
retMsg	string	true	none	响应消息
responseID	string	true	none	响应id，随机唯一id，用于请求追踪，定位问题时需要提供该次请求的responseID
taskID	string	true	none	任务id
taskStatus	integer	true	none	任务状态

枚举值

属性	值	说明
taskStatus	1	任务待启动
taskStatus	2	任务进行中
taskStatus	3	任务已完成
taskStatus	4	任务已完结（失败）
taskStatus	5	任务已暂停