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/stopOrder

停止订单操作不可逆

停止订单呼叫

Body 请求参数

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

请求参数

名称	位置	类型	必选	说明
requestID	header	string	是	请求唯一id
uuid	header	string	是	uuid,由被调用方给出
createTs	header	string	是	请求时间戳,(秒级)
sign	header	string	是	签名
algorithm	header	string	否	签名的算法：MD5或者SHA256，不填默认用MD5
body	body	object	否
» productID	body	string	是	定值"callbot"
» userTaskID	body	string	是	请求方的任务id(调用方生成并且保证唯一)，建议使用uuid
» orderIDs	body	[string]	是	订单id列表
» delCall	body	integer	否	是否删除未拨打的数据，0:none，1:删除(谨慎使用)

返回示例

200 Response

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

返回结果

状态码	状态码含义	说明	数据模型
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，用于请求追踪，定位问题时需要提供该次请求的responseID
» totalCount	integer	true	none	总数
» successCount	integer	true	none	成功数
» errList	[object]	true	none	错误列表
»» orderID	string	true	none	暂停失败订单号
»» errMsg	string	true	none	失败原因