2.2 任务管理
2.2.1 企业坐席任务查询
基本信息
Path： /api/v1/config/openapi/task/gettasklist/v2
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| companyId | integer | 非必须 | 企业id | ||
| operatorId | string | 必须 | 坐席工号 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| code | integer | 必须 | 返回码 | ||
| msg | string | 必须 | 返回说明 | ||
| data | object | 非必须 | 数据 | ||
| ├─ id | integer | 非必须 | 任务id | ||
| ├─ teamName | string | 非必须 | 任务组名称 | ||
| ├─ taskName | string | 非必须 | 任务名称 | ||
| ├─ groupid | integer | 非必须 | 技能组id | ||
| ├─ startTime | integer | 非必须 | 任务开始时间 | ||
| ├─ endTime | integer | 非必须 | 任务结束时间 | ||
| ├─ afterBack | integer | 非必须 | 是否使用话后时长0：不启用 1：启用 | ||
| ├─ afterTime | integer | 非必须 | 话后时长 |
2.2.2 技能组任务查询
基本信息
Path： /api/v1/config/openapi/task/getGroupTaskPage
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| startTime | integer | 非必须 | 最小时间（任务开始时间）。若startTime和endTime都为空，默认为当天的最小时间的00:00:00 | ||
| endTime | integer | 非必须 | 结束时间（任务开始时间）若startTime和endTime都为空，默认为当天的最大时间23:59:59 | ||
| groupName | string | 非必须 | 技能组名称 | ||
| taskId | integer | 非必须 | 任务id | ||
| status | integer | 非必须 | 任务状态（任务状态：0：新建任务；1：任务进行中；2：任务暂停；3：任务完成；4：任务关闭） | ||
| pageNumber | integer | 非必须 | 1 | 页数 | |
| pageSize | integer | 非必须 | 10 | 页大小 | 最大值: 100 最小值: 10 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 提示信息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object | 非必须 | |||
| ├─ result | object [] | 非必须 | item 类型: object | ||
| result├─ companyId | integer | 非必须 | 企业id | ||
| result├─ taskId | integer | 非必须 | 任务id | ||
| result├─ taskName | string | 非必须 | 任务名称 | ||
| result├─ status | integer | 非必须 | 任务状态：0：新建任务；1：任务进行中；2：任务暂停；3：任务完成；4：任务关闭 | ||
| result├─ startTime | integer | 非必须 | 任务开始时间 | ||
| result├─ endTime | integer | 非必须 | 任务结束时间 | ||
| result├─ groupId | integer | 非必须 | 技能组id | ||
| result├─ groupname | string | 非必须 | 技能组名称 | ||
| result├─ contactGroupId | integer | 非必须 | 联系人组id | ||
| result├─ contactGroupName | string | 非必须 | 联系人组名称 | ||
| result├─ roundNow | integer | 非必须 | 当前执行轮次 | ||
| result├─ roundTotal | integer | 非必须 | 总轮次 | ||
| result├─ showcaller | string [] | 非必须 | 外呼显号，数组 | item 类型: string | |
| ├─ | 非必须 | ||||
| result├─ type2 | integer | 非必须 | 外呼名单模式 | ||
| result├─ hangUpId | integer | 非必须 | 挂机策略id | ||
| result├─ hangUpName | string | 非必须 | 挂机策略名称 | ||
| result├─ level | integer | 非必须 | 任务优先级 | ||
| result├─ calltype | integer | 非必须 | 外呼类型:1 预览式外呼,2 预测式外呼 | ||
| result├─ initialHitRate | integer | 非必须 | 初始Hit rate | ||
| result├─ minHitRate | integer | 非必须 | 最小Hit rate | ||
| result├─ cruiseMode | integer | 非必须 | 巡航方式 0:系统自动巡航 , 大于0为专家控制巡航(1：坐席占用率、2：拨打比率、3：单位时间拨打比率，1、2、3是互斥的与其中一个值相关) | ||
| result├─ occupancy | integer | 非必须 | 坐席占用率 cruiseMode=1 | ||
| result├─ callRate | integer | 非必须 | 拨打比率 cruiseMode=2 | ||
| result├─ hitRate | integer | 非必须 | 单位时间拨打比率 cruiseMode=3 | ||
| result├─ initCallRate | integer | 非必须 | 初始拨打比率，轮次切换时将拨打比例设置为初始拨打比率 | ||
| result├─ afterBack | integer | 非必须 | 是否启用话后时长（0：不启用（默认），1：启用） | ||
| result├─ afterTime | integer | 非必须 | 话后时长(秒) | ||
| result├─ alterTimeOut | integer | 非必须 | 自定义震铃时长，单位毫秒（30秒-120秒之间） | ||
| ├─ pageSize | integer | 非必须 | 页大小 | ||
| ├─ total | integer | 非必须 | 总记录数 | ||
| ├─ pageNumber | integer | 非必须 | 页数 | ||
| ├─ pageTotal | integer | 非必须 | 总页数 |
2.2.3 任务状态控制
基本信息
Path： /api/v1/config/openapi/task/controlTask
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| taskId | integer | 必须 | 任务id | ||
| command | integer | 必须 | 任务指令 1 任务开始（继续),暂停的任务可以继续，其他状态不行; 2 任务暂停,进行中的任务可以暂停，其他状态不行； 3 任务切换轮次,进行中的任务可以切换轮次，其他状态不行； 4 任务关闭，所有状态的任务都可以关闭 | 最小值: 1 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 |
2.2.4 查询公司挂机策略
基本信息
Path： /api/v1/config/openapi/starategy/hangup
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | qD9w5lF8i8Dtn62mvxIRpZTKvP5cJBCBaPhpp15PuOfjOSWMIA+LBKSfx36O1dKH | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | |||
| code | integer | 必须 | |||
| data | object [] | 非必须 | item 类型: object | ||
| ├─ id | integer | 非必须 | 策略id | ||
| ├─ companyid | integer | 非必须 | 企业id | ||
| ├─ name | string | 非必须 | 策略名称 | ||
| ├─ content | object [] | 非必须 | 策略详情 | item 类型: object | |
| ├─ cause | integer | 必须 | 挂机原因id 0，1，3，4，5，6，7，8，9 依次循环给出 | ||
| ├─ type | integer | 必须 | 重拨间隔 type=0时生效 | ||
| ├─ count | integer | 必须 | 处理方式0重拨，1跳过 | ||
| ├─ cycle | integer | 必须 | 重拨次数 type=0时生效 | ||
| ├─ name | string | 必须 | 挂机原因描述： 正常(无通话时长)' '关机' '无法接通' '用户忙' '久叫不应' '呼叫限制' '网络忙' '用户忙或拒绝' '呼叫被转移' |
2.2.5 查询任务流程变量参数（转IVR,转BOT）
基本信息
Path： /api/v1/config/openapi/task/getProcessParams
Method： POST
接口描述：
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| type | integer | 必须 | 流程变量类型1:ivr 2:机器人 | ||
| name | string | 必须 | 流程名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | Object[] | 必须 | 任务流程变量参数名称 |
2.2.6 创建任务模板
基本信息
Path： /api/v1/config/openapi/task/createTemplate
Method： POST
接口描述：
参数示例
- {
- "templateName": "TOIVR",
- "type1": 2,
- "abbreviate": "{{abbreviate}}",
- "contactGroupName": "顺利的号码",
- "templateStartTime": "02:00:00",
- "templateEndTime": "23:59:51",
- "recallName": "预测外呼挂机策略",
- "level": 6,
- "autoComplete": 0,
- "taskShowNumber": "1008601",
- "type2": 1,
- "roundCount": 1,
- "calltype": 2,
- "alterTimeOut": 33,
- "groupName": "通用技能组",
- "initialHitRate": 1,
- "minHitRate": 1,
- "afterBack": 1,
- "afterTime": 33,
- "ivrportNum": 1,
- "ivrName": "预测咨询ivr流程",
- "ivrParams": {
- "caller": "name"
- },
- "botName": "录音版机器人",
- "botParams": {
- "name": "number"
- },
- "exePlan": [{"type": 1,"time":"03:00:00"},{"type": 2,"time":"04:22:00"}]
- }
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| templateName | string | 必须 | 模板名称 | ||
| contactGroupName | string | 必须 | 联系人组名称 | ||
| templateStartTime | string | 必须 | 模板任务开始时间（格式HH:mm:ss） | ||
| templateEndTime | string | 必须 | 模板任务结束时间（格式HH:mm:ss） | ||
| level | integer | 非必须 | 优先级（1-99，默认1） | ||
| autoComplete | integer | 非必须 | 任务自动完成 任务是否自动完成（0:否；1:是，默认1） | ||
| recallName | string | 必须 | 挂机策略名称 | ||
| type1 | integer | 必须 | 接通后执行模式（ 2：转IVR；3：转座席组；5:转BOT） | ||
| taskShowNumber | string | 非必须 | 任务外呼显号（支持号码池标识号码） | ||
| type2 | integer | 非必须 | 外呼名单模式（1 按用户外呼 2 按列外呼 默认2） | ||
| roundCount | integer | 非必须 | 拨打轮次（1~5轮，默认1） | ||
| calltype | integer | 非必须 | 外呼类型:（1 预览式外呼,2 预测式外呼。默认2） | ||
| alterTimeOut | integer | 非必须 | 振铃时长（30~120，默认30s） | ||
| groupName | string | 非必须 | 技能组名称 | type1=3必传 | |
| cruiseMode | integer | 非必须 | 巡航方式 （0:系统自动巡航，默认0） | ||
| initialHitRate | integer | 非必须 | 初始最大外呼值（1~7 默认1） | ||
| minHitRate | integer | 非必须 | 外呼上限值（1~7 默认1） | ||
| afterBack | integer | 非必须 | 是否启用话后时长（0：否，1：是 默认0） | ||
| afterTime | integer | 非必须 | 话后时长（单位s，afterBack=1必传，默认30s） | ||
| ivrportNum | integer | 非必须 | IVR通道数（最小为1） | type1=2和5时必传 | |
| ivrName | string | 非必须 | IVR流程名称 | type1=2必传 | |
| ivrParams | map | 非必须 | IVR参数配置 | { "caller": "name"} key为变量名 value为字段名 type1=2 根据ivr流程配置来传参 | |
| botName | string | 非必须 | BOT名称 | type1=5必传 | |
| botParams | map | 非必须 | BOT参数配置 | { "name": "number"} key为变量名 value为字段名 type1=5时根据机器人配置来传参 | |
| exePlan | object [] | 非必须 | 拨打计划（比如9点暂停，10点开始，11点执行下一轮） | ||
| ├─ type | integer | 非必须 | 操作类型 1：开始时间，2;结束时间，3：切换下一轮次 | 使用拨打计划时必须 | |
| ├─ time | String | 非必须 | 计划执行时间（例如："03:00:00"） | 使用拨打计划时必须 | |
| stationGroup | integer | 非必须 | 所属中心【0:A中心，1:B中心】 默认0 仅限双中心模式使用 | sp1补丁后支持 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object | 非必须 | |||
| ├─ templateId | integer | 非必须 | 模板任务id |
2.2.7 创建任务-手动
基本信息
Path： /api/v1/config/openapi/task/create
Method： POST
接口描述：
参数示例
- {
- "type1": 3,
- "abbreviate": "{{abbreviate}}",
- "taskName": "F1445",
- "contactGroupName": "顺利的号码",
- "startTime": 1617772251,
- "endTime": 1617808251,
- "recallName": "预测外呼挂机策略",
- "level": 66,
- "autoComplete": 0,
- "taskShowNumber": "1008601",
- "type2": 1,
- "roundCount": 1,
- "calltype": 2,
- "alterTimeOut": 33,
- "groupName": "通用技能组",
- "initialHitRate": 1,
- "minHitRate": 1,
- "afterBack": 1,
- "afterTime": 33,
- "ivrportNum": 1,
- "ivrName": "预测咨询ivr流程",
- "ivrParams": {
- "caller": "name"
- },
- "botName": "录音版机器人",
- "botParams": {
- "name": "number"
- },
- "exePlan": [{"type": 1,"time":1629518157},{"type": 2,"time":1629518257}]
- }
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| taskName | string | 必须 | 任务名称 | ||
| contactGroupName | string | 必须 | 联系人组名称 | ||
| startTime | integer | 必须 | 任务开始时间（格式秒时间戳） | ||
| endTime | integer | 必须 | 任务结束时间（格式秒时间戳） | ||
| level | integer | 非必须 | 优先级（1-99，默认1） | ||
| autoComplete | integer | 非必须 | 任务自动完成 任务是否自动完成（0:否；1:是，默认1） | ||
| recallName | string | 必须 | 挂机策略名称 | ||
| type1 | integer | 必须 | 接通后执行模式（ 2：转IVR；3：转座席组；5:转BOT，默认3） | ||
| taskShowNumber | string | 非必须 | 任务外呼显号（支持号码池标识号码） | ||
| type2 | integer | 非必须 | 外呼名单模式（1 按用户外呼 2 按列外呼 默认2） | ||
| roundCount | integer | 非必须 | 拨打轮次（1~5轮，默认1） | ||
| calltype | integer | 非必须 | 外呼类型:（1 预览式外呼,2 预测式外呼。默认2） | ||
| alterTimeOut | integer | 非必须 | 振铃时长（30~120，默认30s） | ||
| groupName | string | 非必须 | 技能组名称 | type1=3必传 | |
| cruiseMode | integer | 非必须 | 巡航方式 （0:系统自动巡航，默认0） | ||
| initialHitRate | integer | 非必须 | 初始最大外呼值（1~7 默认1） | ||
| minHitRate | integer | 非必须 | 外呼上限值（1~7 默认1） | ||
| afterBack | integer | 非必须 | 是否启用话后时长（0：否，1：是 默认0） | ||
| afterTime | integer | 非必须 | 话后时长（单位s，afterBack=1必传，默认30s） | ||
| ivrportNum | integer | 非必须 | IVR通道数（最小为1） | type1=2必传 | |
| ivrName | string | 非必须 | IVR流程名称 | type1=2必传 | |
| ivrParams | map | 非必须 | IVR参数配置 | { "caller": "name"} key为变量名 value为字段名 type1=2 时根据ivr配置来传参 | |
| botName | string | 非必须 | BOT名称 | type1=5必传 | |
| botParams | map | 非必须 | BOT参数配置 | { "name": "number"} key为变量名 value为字段名 type1=5 时根据机器人配置来传参 | |
| exePlan | object [] | 非必须 | 拨打计划（比如9点暂停，10点开始，11点执行下一轮） | ||
| ├─ type | integer | 非必须 | 操作类型 1：开始时间，2;结束时间，3：切换下一轮次 | 使用拨打计划时必须 | |
| ├─ time | integer | 非必须 | 计划执行时间（时间戳） | 使用拨打计划时必须 | |
| stationGroup | integer | 非必须 | 所属中心【0:A中心，1:B中心】 默认0 仅限双中心模式使用 | sp1补丁后支持 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object | 非必须 | |||
| ├─ taskId | integer | 非必须 | 任务id |
2.2.8 创建任务-通过模板
基本信息
Path： /api/v1/config/openapi/task/createTaskByTemplate
Method： POST
接口描述：
参数示例
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| templateName | string | 必须 | 模板名称 | ||
| taskName | string | 必须 | 任务名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object | 非必须 | |||
| ├─ taskId | integer | 非必须 | 任务id |
2.2.9 任务监控
基本信息
Path： /api/v1/config/openapi/task/monitorstat
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| taskid | integer | 必须 | 任务id |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object | 非必须 | 返回数据 | ||
| ├─ companyname | string | 非必须 | 企业名称 | ||
| ├─ taskname | string | 非必须 | 任务名称 | ||
| ├─ taskstatus | integer | 非必须 | 任务状态 -1 初始化 2 进行中 3 暂停 4关闭 | ||
| ├─ taskstarttime | string | 非必须 | 任务开始时间（yyyy-MM-dd HH:mm:ss） | ||
| ├─ taskstarttimestamp | integer | 非必须 | 任务开始时间（秒时间戳） | ||
| ├─ taskendtime | string | 非必须 | 任务结束时间（yyyy-MM-dd HH:mm:ss） | ||
| ├─ taskendtimetimestamp | integer | 非必须 | 任务结束时间（秒时间戳） | ||
| ├─ outcallnum | integer | 非必须 | 呼叫总次数 | ||
| ├─ connectrate | string | 非必须 | 接通率 | ||
| ├─ giveuprate | string | 非必须 | 弃线率 | ||
| ├─ contactsuccessnum | integer | 非必须 | 接通量 | ||
| ├─ callednum | integer | 非必须 | 呼叫条目数 | ||
| ├─ finishrate | string | 非必须 | 触达率 | ||
| ├─ finishnum | integer | 非必须 | 触达量 | ||
| ├─ totle | integer | 非必须 | 总条目数 | ||
| ├─ causenum | object | 非必须 | <状态，数量>每种通话结果的数量 |
2.2.10 任务模板搜索
接口描述
展现调用该接口获取企业模板列表
请求说明
| url | /api/v1/config/openapi/task/selectTemplateList |
| 协议 | post |
| 是否需要鉴权 | true 头部token鉴权 |
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3 xt1Pkai9SAsOFjN2z6RpX8cTPr 1/gEFkssjRFY | 是 |
参数说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 | |||||
| １ | companyId | 必选 | Integer | 企业id | ||||||
| 2 | keyword | 非必选 | String | 模板名称查询关键字 | ||||||
| 3 | status | 非必选 | Integer | 模板状态: 0：正常（默认），1：暂停，2：关闭， | ||||||
| 4 | pageNumber | 非必选 | Integer | 页数 默认1 | ||||||
| 5 | pageSize | 非必选 | Integer | 每页数目 默认10 | ||||||
| 举例 | ||||||||||
| { "companyId":154 } | ||||||||||
返回说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
| 1 | msg | 必选 | String | 返回消息 | |
| 2 | code | 必选 | String | 返回结果描述 | |
| 3 | data | 必选 | JSON | 结果数据 | |
| 3.1 | ├─ result | ||||
| 3.1.1 | result├─id | 必选 | integer | 主键 | |
| 3.1.2 | result├─companyid | 必选 | integer | 企业ID | |
| 3.1.3 | result├─templateName | 必选 | String | 任务模板名称 | |
| 3.1.4 | result├─type3 | 必选 | integer | 类型 0：每天（默认），1：每星期（可选多天），2：每月 | |
| 3.1.5 | result├─status | 必选 | integer | 状态 0：正常（默认），1：暂停，2：关闭，-1：删除 | |
| 3.1.6 | result├─type_val | 必选 | String | 星期标记 （可选多天）或月标记（每月的那天） | |
| 3.1.7 | result├─activity_id | 必选 | integer | 任务归属活动的id（c_time:20191012,auth:zxy） | |
| 3.1.8 | result├─contact_group_id | 必选 | integer | 联系人组ID | |
| 3.1.9 | result├─group_name | 必选 | String | 联系人组名称 | |
| 3.1.10 | result├─sourceId | 必选 | integer | 数据源id | |
| 3.1.11 | result├─dataSourceName | 必选 | String | 数据源名称 | |
| 3.1.12 | result├─hangup_id | 必选 | integer | 挂机原因策略名称表ID | |
| 3.1.13 | result├─hangup_name | 必选 | String | 挂机名称 | |
| 3.1.14 | result├─auto_completed | 必选 | integer | 任务是否自动完成【0:是；1:否】 | |
| 3.1.15 | result├─type2 | 必选 | integer | 外呼类型 1 按用户外呼 2 按列外呼 | |
| 3.1.16 | result├─bot_id | 非必选 | integer | 机器人id | |
| 3.1.17 | result├─bot_name | 非必选 | String | 机器人名称 | |
| 3.2 | ├─ pageSize | 必选 | integer | 页大小 | |
| 3.3 | ├─ total | 必选 | integer | 总记录数 | |
| 3.4 | ├─ pageNumber | 必选 | integer | 页数 | |
| 3.5 | ├─ pageTotal | 必选 | integer | 总页数 |
2.2.11 机器人列表搜索
接口描述
展现调用该接口获取关联联系人组的机器人列表
请求说明
| url | /api/v1/config/openapi/task/selectBotList |
| 协议 | post |
| 是否需要鉴权 | true 头部token鉴权 |
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3 xt1Pkai9SAsOFjN2z6RpX8cTPr 1/gEFkssjRFY | 是 |
参数说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 | |||||
| １ | companyId | 必选 | Integer | 企业id | ||||||
| 2 | keyword | 非必选 | String | 模板名称查询关键字 | ||||||
| 3 | contactGroupId | 必选 | Integer | 关联联系人组id | ||||||
| 4 | pageNumber | 非必选 | Integer | 页数 默认1 | ||||||
| 5 | pageSize | 非必选 | Integer | 每页数目 默认10 | ||||||
| 举例 | ||||||||||
| { "companyId":154} | ||||||||||
返回说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
| 1 | msg | 必选 | String | 返回消息 | |
| 2 | code | 必选 | String | 返回结果描述 | |
| 3 | data | 必选 | JSON | 结果数据 | |
| 3.1 | ├─ result | ||||
| 3.1.1 | result├─botName | 必选 | String | 机器人名称 | |
| 3.1.2 | result├─botId | 必选 | integer | 机器人id | |
| 3.1.3 | result├─botParams | 必选 | map | BOT参数配置 {"key":"value"} key为变量名 value为字段名 | |
| 3.2 | ├─ pageSize | 必选 | integer | 页大小 | |
| 3.3 | ├─ total | 必选 | integer | 总记录数 | |
| 3.4 | ├─ pageNumber | 必选 | integer | 页数 | |
| 3.5 | ├─ pageTotal | 必选 | integer | 总页数 |
2.2.12 ivr列表搜索
接口描述
展现调用该接口获取企业创建的IVR列表
请求说明
| url | /api/v1/config/openapi/task/selectIvrList |
| 协议 | post |
| 是否需要鉴权 | true 头部token鉴权 |
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3 xt1Pkai9SAsOFjN2z6RpX8cTPr 1/gEFkssjRFY | 是 |
参数说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 | |||||
| １ | companyId | 必选 | Integer | 企业id | ||||||
| 2 | keyword | 非必选 | String | 模板名称查询关键字 | ||||||
| 3 | pageNumber | 非必选 | Integer | 页数 默认1 | ||||||
| 4 | pageSize | 非必选 | Integer | 每页数目 默认10 | ||||||
| 举例 | ||||||||||
| { "companyId":154} | ||||||||||
返回说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
| 1 | msg | 必选 | String | 返回消息 | |
| 2 | code | 必选 | String | 返回结果描述 | |
| 3 | data | 必选 | JSON | 结果数据 | |
| 3.1 | ├─ result | ||||
| 3.1.1 | result├─id | 必选 | 主键id | ||
| 3.1.2 | result├─flowname | 必选 | Ivr名称 | ||
| 3.1.3 | result├─ivrParams | 必选 | map | IVR参数配置 {"key":"value"} key为变量名 value为字段名 | |
| 3.2 | ├─ pageSize | 必选 | integer | 页大小 | |
| 3.3 | ├─ total | 必选 | integer | 总记录数 | |
| 3.4 | ├─ pageNumber | 必选 | integer | 页数 | |
| 3.5 | ├─ pageTotal | 必选 | integer | 总页数 |
2.2.13 外呼任务详情查询
接口描述
展现调用该接口获取创建任务详情信息(机器人外呼任务)
请求说明
| url | /api/v1/config/openapi/task/selectTaskInfo |
| 协议 | post |
| 是否需要鉴权 | true 头部token鉴权 |
请求参数
Headers外呼任务详情查询接口
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3 xt1Pkai9SAsOFjN2z6RpX8cTPr 1/gEFkssjRFY | 是 |
参数说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 | |||||
| 1 | companyId | 非必选 | Integer | 企业Id | ||||||
| 2 | abbreviate | 必选 | String | 企业缩写 | ||||||
| 3 | taskId | 必选 | Integer | 任务id | ||||||
| 4 | phone | 非必选 | String | 拨打电话号码 | ||||||
| 5 | cause | 非必选 | Integer | 拨打状态 取值详见文档末<挂机原因说明> | ||||||
| 6 | botName | 非必选 | String | 机器人名称 | ||||||
| 7 | startTime | 非必选 | Integer | 操作开始时间 （时间戳 startTime和endTime都有值时生效） | ||||||
| 8 | endTime | 非必选 | Integer | 操作结束时间 （时间戳 startTime和endTime都有值时生效） | ||||||
| 9 | pageNumber | 非必选 | Integer | 页数 默认1 | ||||||
| 10 | pageSize | 非必选 | Integer | 每页数目 默认10 | ||||||
| 举例 | ||||||||||
| { " taskId ":154} | ||||||||||
返回说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
| 1 | msg | 必选 | String | 返回消息 | |
| 2 | code | 必选 | String | 返回结果描述 | |
| 3 | data | 必选 | JSON | 结果数据 | |
| 3.1 | ├─ result | ||||
| 3.1.1 | result├─taskId | 必选 | Integer | 任务id | |
| 3.1.2 | result├─phone | 必选 | String | 号码 | |
| 3.1.3 | result├─causeStr | 必选 | String | 呼叫结果 | |
| 3.1.4 | result├─beginTime | 必选 | Integer | 外呼开始时间 | |
| 3.1.5 | result├─callRound | 必选 | Integer | 当前呼叫轮次 | |
| 3.1.6 | result├─callId | 必选 | String | 通话ID | |
| 3.1.7 | result├─param | 必选 | String | 机器人用到的变量json | |
| 3.1.8 | result├─botDialog | 必选 | String | 对话流（明文,json格式） | |
| 3.1.9 | result├─cause | 非必须 | integer | 取值详见文档末<挂机原因说明> | |
| 3.1.10 | result├─botName | 非必须 | String | 机器人名称 | |
| 3.2 | ├─ pageSize | 必选 | integer | 页大小 | |
| 3.3 | ├─ total | 必选 | integer | 总记录数 | |
| 3.4 | ├─ pageNumber | 必选 | integer | 页数 | |
| 3.5 | ├─ pageTotal | 必选 | integer | 总页数 |
2.2.14 外呼任务列表查询
接口描述
展现调用该接口获取创建任务列表信息
请求说明
| url | /api/v1/config/openapi/task/selectTaskList |
| 协议 | post |
| 是否需要鉴权 | true 头部token鉴权 |
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3 xt1Pkai9SAsOFjN2z6RpX8cTPr 1/gEFkssjRFY | 是 |
参数说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 | |||||
| 1 | companyId | 非必选 | Integer | 企业Id | ||||||
| 2 | abbreviate | 必选 | String | 企业缩写 | ||||||
| 3 | taskId | 非必选 | Integer | 任务id | ||||||
| 4 | status | 非必选 | String | 任务状态：0：新建任务；1：任务进行中；2：任务暂停；3：任务完成；4：任务关闭 | ||||||
| 5 | configId | 非必选 | Integer | 任务挂机原因对应策略 | ||||||
| 6 | startTime | 非必选 | Integer | 操作开始时间 | ||||||
| 7 | endTime | 非必选 | Integer | 操作结束时间 | ||||||
| 8 | pageNumber | 非必选 | Integer | 页数 默认1 | ||||||
| 9 | pageSize | 非必选 | Integer | 每页数目 默认10 | ||||||
| 举例 | ||||||||||
| { " taskId ":154} | ||||||||||
返回说明
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
| 1 | msg | 必选 | String | 返回消息 | |
| 2 | code | 必选 | String | 返回结果描述 | |
| 3 | data | 必选 | JSON | 结果数据 | |
| 3.1 | ├─ result | ||||
| 3.1.1 | result├─id | 必选 | Integer | 任务id | |
| 3.1.2 | result├─taskName | 必选 | String | 任务名称 | |
| 3.1.3 | result├─roundCount | 必选 | String | 轮次（当前PDS呼叫第几轮次） | |
| 3.1.4 | |||||
| 3.1.5 | result├─status | 必选 | Integer | 任务状态：0：新建任务；1：任务进行中；2：任务暂停；3：任务完成；4：任务关闭 | |
| 3.1.6 | result├─name | 必选 | String | 挂机策略名称 | |
| 3.1.7 | result├─startTime | 必选 | String | 任务开始时间 | |
| 3.1.8 | result├─ctime | 必选 | String | 任务创建时间 | |
| 3.2 | ├─ pageSize | 必选 | integer | 页大小 | |
| 3.3 | ├─ total | 必选 | integer | 总记录数 | |
| 3.4 | ├─ pageNumber | 必选 | integer | 页数 | |
| 3.5 | ├─ pageTotal | 必选 | integer | 总页数 |