Callbot API createTaskAndCall

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

创建任务并添加订单

返回响应码枚举值

返回响应码	错误原因
0	成功
1	通用错误
2	参数丢失
3	参数格式错误
4	参数值错误
4001	参数内容容量错误(数组元素过多)
5	服务器维护
5001	服务器内部错误
6	签名不正确
6001	签名错误丢失
6001	签名错误丢失
6002	账号不存在
6003	用户没有权限
7	系统正忙

Body 请求参数

{
  "productID": "callbot",
  "userTaskID": "string",
  "sceneID": "string",
  "taskCreateSetting": {
    "strategyName": "默认策略",
    "startupType": 1,
    "startupAt": 0,
    "zoneSecond": 0,
    "maxRingTime": 0,
    "routeID": "",
    "dialAtWeekDay": "string",
    "dialAtUpHour": "string",
    "dialAtDownHour": "string",
    "maxCall": 0,
    "taskName": "string",
    "taskCallbackUrl": "string",
    "manualCallSetting": {
      "agentGroup": "string",
      "dispatchType": 0,
      "ratioCallRate": 0,
      "predictCallRate": 0
    }
  },
  "funcFlag": {
    "taskKeep": false,
    "roundRedial": false,
    "wholeTTS": false,
    "smsEnable": false,
    "smsFuncFlag": [
      {
        "smsID": "string",
        "intentID": [
          "string"
        ],
        "intentName": [
          "string"
        ]
      }
    ],
    "phoneEncrypt": true
  },
  "callInfoList": {
    "orderCallbackUrl": "string",
    "callCallbackUrl": "string",
    "callList": [
      {
        "orderID": "string",
        "userPhone": "string",
        "other": "string",
        "userName": "string",
        "customerName": "string",
        "params": [
          {
            "name": null,
            "value": null
          }
        ]
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	说明
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"
» userTaskID	body	string	是	请求方的任务id(调用方生成并且保证唯一)，建议使用uuid
» sceneID	body	string	是	话术模板id，登录后台 话术管理->选择对应模板名称 即可查看
» taskCreateSetting	body	object	是	任务参数设置
»» strategyName	body	string	是	策略名称;请登录aibot平台->话术管理->话术(找到对应话术,点击话术名称或点击编辑)->点击拨打策略(右上角) 查看策略名称;该字段默认可以使用(默认策略);如需设置其他拨打策略，请到aibot平台设置新的策略名
»» startupType	body	integer	是	启动策略
»» startupAt	body	integer	是	当startupType=2时候，任务启动的时间戳
»» zoneSecond	body	integer	是	任务工作时区，为一个相对于零时的秒数的偏移值，比如东八区则其值为8 * 3600=28800,西八区其值为-8 * 3600=-28800
»» dialAtWeekDay	body	string	是	针对任务任务工作时间范围，多个用英文逗号分割，取值范围为[1,7]，1:星期一,...6:星期六,7:星期天
»» dialAtUpHour	body	string	是	拨打小时（上半小时），多个使用英文逗号分割，针对任务工作时间范围，取值范围为[0,23]，0: [00:00 ~ 00:30]可拨打，1:[01:00 ~ 01:30]可拨,...23:[23:00 ~ 23:30]可以拨打
»» dialAtDownHour	body	string	是	拨打小时（下半小时），多个使用英文逗号分割，针对任务工作时间范围，取值范围为[0,23]，0: [00:30 ~ 01:00]可拨打，1:[01:30 ~ 02:00]可拨,...23:[23:30 ~ 24:00]可以拨打
»» maxRingTime	body	integer	是	最大响铃时长/秒
»» routeID	body	string	是	路由ID
»» maxCall	body	integer	是	机器人数量
»» taskName	body	string	是	任务名称
»» taskCallbackUrl	body	string	是	任务状态变动回调地址
»» manualCallSetting	body	object	否	转人工相关设置，AICC模板才使用
»»» agentGroup	body	string	是	坐席组Id
»»» dispatchType	body	integer	是	外呼类型，0:none，1:比例式外呼，3:预测试外呼2.0
»»» ratioCallRate	body	number	是	坐席呼叫倍率（比例外呼填这个值）
»»» predictCallRate	body	number	是	预测试呼叫倍率（预测试外呼填这个值）
» funcFlag	body	object	是	任务功能标识
»» taskKeep	body	boolean	是	任务保持（永久任务保活），开启后，即使任务中没有通话订单，任务也不会自动结束
»» roundRedial	body	boolean	是	轮内自动重拨，开启后，一轮内未接听的通话将自动重拨一次
»» wholeTTS	body	boolean	是	开启后，将还有变量的句子当作整句进行tts合成，含有变量时，必须开启
»» smsEnable	body	boolean	是	短信发送功能开关，true为开启，开启后，任务通话订单结束后，将根据意向发送设置的短信（需提前开通短信服务，设置appKey）
»» smsFuncFlag	body	[object]	是	短信发送功能，smsEnable为true后使用，需填入相关字段作为短信发送条件, intentID请不要重复, 否则将根据数组顺序覆盖
»»» smsID	body	string	是	发送的短信模板id，可通过短信模板，查找需要发送的短信模板（短信模板发送前请联系客服进行短信文案测试，进行送达率测试）
»»» intentID	body	[string]	是	意向id，通话订单 通话结束后，将根据设置的意向id进行短信发送
»»» intentName	body	[string]	是	意向名，通话订单 通话结束后，将根据设置的意向名称进行短信发送 （效果与设置intentId相同）
»» phoneEncrypt	body	boolean	是	号码加密功能，开启后，在后台显示的号码会被显示为加密号码
» callInfoList	body	object	是
»» orderCallbackUrl	body	string	是	通话订单回调地址
»» callCallbackUrl	body	string	是	通话回调地址
»» callList	body	[object]	是	通话订单列表，一个号码即为一个订单，一个订单会进行一轮或多轮通话
»»» orderID	body	string	是	通话订单id，调用方生成，并保证全局唯一，建议使用uuid
»»» userPhone	body	string	是	用户订单号码，带有用户手机区号，不带符号，如 86156xxxxxxxx
»»» other	body	string	是	透传字段
»»» userName	body	string	是	用户名称
»»» customerName	body	string	是	客户名称
»»» params	body	[object]	是	变量列表，如话术模板中含有变量，则需填入所有变量，可通过话术管理->变量设置 查询模板名，并按照变量类型规定，输入对应的字符串值
»»»» name	body	string	是	变量名
»»»» value	body	string	是	变量值

枚举值

属性	值	说明
»» startupType	1	手动启动
»» startupType	2	定时启动
»» startupType	3	立即启动

返回示例

200 Response

{
  "retCode": 0,
  "retMsg": "string",
  "responseID": "string",
  "taskID": "string",
  "totalCount": 0,
  "successCount": 0,
  "errList": [
    {
      "phone": "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，随机唯一id，用于请求追踪，定位问题时需要提供该次请求的responseID
» taskID	string	true	none	任务id
» totalCount	integer	true	none	导入总数
» successCount	integer	true	none	导入成功数
» errList	[object]	false	none	错误列表
»» phone	string	true	none	导入失败手机号
»» errMsg	string	true	none	导入失败原因