Callbot API taskCallback

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 任务回调(aibot->customer)

POST /api/v3/taskCallback

Body 请求参数

{
  "callbackType": 1,
  "userTaskID": "string",
  "taskID": "string",
  "sceneID": "string",
  "taskStatus": 1,
  "createTs": 0,
  "taskStat": {
    "answerOrderCount": 0,
    "finishOrderCount": 0,
    "totalOrderCount": 0,
    "finishRate": 0,
    "totalAnswerCall": 0,
    "totalCall": 0,
    "answerRate": 0
  }
}

请求参数

名称	位置	类型	必选	说明
requestID	header	string	是	请求唯一id
uuid	header	string	是	uuid,由被调用方给出
createTs	header	string	是	请求时间戳,(秒级)
sign	header	string	是	签名,使用的签名算法可在后台->开发者 查看
body	body	object	否
» callbackType	body	integer	是	回调类型
» userTaskID	body	string	是	调用方任务id
» taskID	body	string	是	被调用方任务id
» sceneID	body	string	是	话术模板id
» taskStatus	body	integer	是	任务状态
» createTs	body	integer	是	任务创建时间戳
» taskStat	body	object	是
»» answerOrderCount	body	integer	是	接通订单数
»» finishOrderCount	body	integer	是	完成订单数
»» totalOrderCount	body	integer	是	总订单数
»» finishRate	body	number(float)	是	任务完成率，保留二位小数，计算方式 完成订单数/总订单数
»» totalAnswerCall	body	integer	是	总接听电话次数
»» totalCall	body	integer	是	电话已呼叫总次数
»» answerRate	body	number(float)	是	电话接听率，保留二位小数，总接听电话次数/电话已呼叫总次数

枚举值

属性	值	说明
» callbackType	1	任务回调
» callbackType	2	订单回调
» callbackType	3	通话回调
taskStatus	1	任务待启动
taskStatus	2	任务进行中
taskStatus	3	任务已完成
taskStatus	4	任务已完结（失败）
taskStatus	5	任务已暂停

返回示例

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string"
}

返回结果

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

返回数据结构

状态码 200

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