Callbot API taskList - nxtele/http-api-document GitHub Wiki

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

列出任务信息及任务统计信息

Body 请求参数

{
  "productID": "callbot",
  "page": 1,
  "size": 100,
  "queryConditions": {
    "taskStatus": [
      1
    ],
    "taskName": [
      "string"
    ],
    "sceneID": "string",
    "userTaskID": [
      "string"
    ],
    "startTs": 0,
    "endTs": 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	是	产品id，定值"callbot"
» page	body	integer	是	页码
» size	body	integer	是	页面大小
» queryConditions	body	object	是
»» taskStatus	body	[integer]	否	任务状态
»» taskName	body	[string]	否	任务名称
»» sceneID	body	string	否	话术模板id
»» userTaskID	body	[string]	否	调用方任务id
»» startTs	body	integer	否	任务创建起止戳
»» endTs	body	integer	否	任务创建结束时间戳

枚举值

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

返回示例

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "taskData": [
    {
      "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
      },
      "taskSetting": {
        "taskCreateSetting": {
          "strategyName": "默认策略",
          "startupType": "[",
          "startupAt": 0,
          "zoneSecond": 0,
          "dialAtWeekDay": "string",
          "dialAtUpHour": "string",
          "dialAtDownHour": "string",
          "maxCall": 0,
          "taskName": "string",
          "taskCallbackUrl": "string",
          "manualCallSetting": {}
        },
        "funcFlag": {
          "taskKeep": false,
          "roundRedial": false,
          "wholeTTS": false,
          "smsEnable": false,
          "smsFuncFlag": [
            null
          ],
          "phoneEncrypt": true
        }
      }
    }
  ],
  "totalCount": 0
}

返回结果

状态码	状态码含义	说明	数据模型
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
» taskData	[object]	true	none
»» userTaskID	string	true	none	调用方任务id
»» taskID	string	true	none	被调用方任务id
»» sceneID	string	true	none	话术模板id
»» taskStatus	integer	true	none	任务状态
»» createTs	integer	true	none	任务创建时间戳
»» taskStat	object	true	none	任务统计参数
»»» answerOrderCount	integer	true	none	接通订单数
»»» finishOrderCount	integer	true	none	完成订单数
»»» totalOrderCount	integer	true	none	总订单数
»»» finishRate	number(float)	true	none	任务完成率，保留二位小数，计算方式完成订单数/总订单数
»»» totalAnswerCall	integer	true	none	总接听电话次数
»»» totalCall	integer	true	none	电话已呼叫总次数
»»» answerRate	number(float)	true	none	电话接听率，保留二位小数，总接听电话次数/电话已呼叫总次数
»» taskSetting	object	true	none	任务设置参数
»»» taskCreateSetting	object	true	none	任务参数设置
»»»» strategyName	string	true	none	策略名称;请登录aibot平台->话术管理->话术(找到对应话术,点击话术名称或点击编辑)->点击拨打策略(右上角) 查看策略名称;该字段默认可以使用(默认策略);如需设置其他拨打策略，请到aibot平台设置新的策略名
»»»» startupType	integer	true	none	启动策略
»»»» startupAt	integer	true	none	当startupType=2时候，任务启动的时间戳
»»»» zoneSecond	integer	true	none	任务工作时区，为一个相对于零时的秒数的偏移值，比如东八区则其值为8 * 3600=28800,西八区其值为-8 * 3600=-28800
»»»» dialAtWeekDay	string	true	none	针对任务任务工作时间范围，多个用英文逗号分割，取值范围为[1,7]，1:星期一,...6:星期六,7:星期天
»»»» dialAtUpHour	string	true	none	多个使用英文逗号分割，针对任务工作时间范围，取值范围为[0,23]，0: [00:00 ~ 00:30]可拨打，1:[01:00 ~ 01:30]可拨,...23:[23:00 ~ 23:30]可以拨打
»»»» dialAtDownHour	string	true	none	多个使用英文逗号分割，针对任务工作时间范围，取值范围为[0,23]，0: [00:30 ~ 01:00]可拨打，1:[01:30 ~ 02:00]可拨,...23:[23:30 ~ 24:00]可以拨打
»»»» maxCall	integer	true	none	机器人数量
»»»» taskName	string	true	none	任务名称
»»»» taskCallbackUrl	string	true	none	任务状态变动回调地址
»»»» manualCallSetting	object	false	none	转人工相关设置
»»»»» agentGroup	string	true	none	坐席组Id
»»»»» dispatchType	integer	true	none	外呼类型，0:none，1:比例式外呼，3:预测试外呼2.0
»»»»» ratioCallRate	number	true	none	坐席呼叫倍率（比例外呼填这个值）
»»»»» predictCallRate	number	true	none	预测试呼叫倍率（预测试外呼填这个值）
»»» funcFlag	object	true	none	任务功能标识
»»»» taskKeep	boolean	true	none	开启后，即使任务中没有通话订单，任务也不会自动结束
»»»» roundRedial	boolean	true	none	轮内自动重拨，开启后，一轮内未接听的通话将自动重拨一次
»»»» wholeTTS	boolean	true	none	开启后，将还有变量的句子当作整句进行tts合成，含有变量时，必须开启
»»»» smsEnable	boolean	true	none	true为开启，开启后，任务通话订单结束后，将根据意向发送设置的短信（需提前开通短信服务，设置appKey）
»»»» smsFuncFlag	[object]	true	none	smsEnable为true后使用，需填入相关字段作为短信发送条件, intentID请不要重复, 否则将根据数组顺序覆盖
»»»»» smsID	string	true	none	发送的短信模板id，可通过短信模板，查找需要发送的短信模板（短信模板发送前请联系客服进行短信文案测试，进行送达率测试）
»»»»» intentID	[string]	true	none	通话订单通话结束后，将根据设置的意向id进行短信发送
»»»»» intentName	[string]	true	none	通话订单通话结束后，将根据设置的意向名称进行短信发送（效果与设置intentId相同）
»»»» phoneEncrypt	boolean	true	none	开启后，在后台显示的号码会被显示为加密号码
» totalCount	integer	true	none	任务总数

枚举值

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