9. 插件部分
9.1 插件文件说明
9.1.1 初始化插件
接口名称:CallCenter.extension.initExtension(cccsUrl)
参数:
| 参数名 | 类型 | 说明 |
| cccsUrl | String | 必选,3CS服务地址(咨询运维人员获取) |
返回值:无
功能:初始化插件服务
说明:无
示例:
- CallCenter.extension.initExtension(‘http://192.168.177.183:8801/cccs’);
注意:
1. 使用插件接口前调用
2. ZLJR-CC-SDK 2.1.1.22_1也支持该接口
9.1.2 签入插件
接口名称:CallCenter.extension.loginExtension(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| username | String | 必选,坐席账号 格式:工号@企业缩写,如1001@ht |
| password | String | 必选,密码 |
| logintype | String | 必选,登录类型 ‘0’手机 ‘1’硬话机 ‘2’软话机(webcall) |
| success | Function | 必选,成功回调,回调参数:JSON数据,插件基础数据对象 |
| error | Function | 可选,失败回调 |
成功回调返回值:
| 参数名 | 类型 | 说明 |
| code | ||
| aid | String | 座席标识符 |
| numberlist | Array | 显号列表 |
| agenttype | Number | 座席签入类型 1短签,2 长签 1短签,2长签 |
| allgroup | Array | 全部技能组 |
| agent2Group | Array | 座席所属技能组 |
| authoritylist | Array | 班长座席权限列表 |
| —info: | Object | 用户详情 |
| —ccsoperator: | Object | CCS用户信息 |
| id | Number | 坐席ID |
| operator_id | String | 工号 |
| name | String | 工号 |
| operator_type | Number | 座席权限 0普通座席,1班长座席 |
| password | String | 密码 |
| operator_type | Number | 坐席权限类型,0 普通坐席,1 班长坐席 |
| is_hide_phone | Number | 是否号码脱敏,0 不脱敏,1 脱敏 |
| --aaacompany | ||
| abbreviate | String | 企业缩写 |
| id | Int | 企业编号 |
功能:签入插件
说明:无
示例:
- CallCenter.extension.loginExtension({
- username:”103@csqy”,
- password:”e10adc3949ba59abbe56e057f20f883e”,
- logintype:0
- },function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
注意:
1. 使用插件接口前调用
2. ZLJR-CC-SDK 2.1.1.22_1也支持该接口
9.1.3 设置aid
接口名称:CallCenter.extension.setAid(aid)
参数:
| 参数名 | 类型 | 说明 |
| aid | String | 必须,坐席签入插件时返回的唯一码 |
返回值:无
功能:设置aid
说明:无
示例:
- CallCenter.extension.loginExtension({
- username:”103@csqy”,
- password:”e10adc3949ba59abbe56e057f20f883e”,
- logintype:0
- },function(json){
- // json为接口数据
- CallCenter.extension.setAid(json.aid);
- },function(){
- // 错误处理
- });
注意:
1. 座席签入插件成功回调时调用
2. ZLJR-CC-SDK 2.1.1.22_1也支持该接口
9.1.4 获取拨打模式
接口名称:CallCenter.extension.getCallModel()
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| agentid | int | 必须,坐席签入插件时返回的唯一码 |
返回值:
| 参数名称 | 类型 | 是否必须 | 说明 |
| code | string | 是 | 返回码 |
| call_type | int | 是 | 呼叫模式 0:非预测 1:预测 -1:无外呼 |
| info | string | 否 | 响应失败的原因 |
| taskid | int | 是 | 任务ID |
| contact_group_id | Int | 是 | 任务关联的联系人组ID |
功能:获取拨打模式
说明:无
示例:
- CallCenter.extension.loginExtension({
- username:”103@csqy”,
- password:”e10adc3949ba59abbe56e057f20f883e”,
- logintype:0
- },function(json){
- // json为接口数据
- CallCenter.extension.setAid(json.aid);
- // 接口示范:获取拨打模式
- CallCenter.extension.getCallModel({
- agentid: json.info.ccsoperator.id
- }, function (json) {
- if (json.code === "0000") {
- if (json.call_type === 1) {
- CallCenter.Transaction.callModel.predict(); // 预测模式
- }
- if (json.call_type === 0) {
- CallCenter.Transaction.callModel.preview(); // 预览模式
- }
- if (json.call_type === -1) {
- // 无活动
- }
- }
- }, function () {
- // 错误处理
- });
- },function(){
- // 错误处理
- });
注意:
1. 座席签入插件成功回调时调用
2. ZLJR-CC-SDK 2.1.1.22_1也支持该接口
9.2 预览插件接口
9.2.1 获取预览任务列表和任务详情
接口名称:CallCenter.preview.getTasks(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| taskName | String | 可选,只有status=34的时候,才可以根据taskName进行模糊查询 |
| status | Number | 必选,status=1 进行中;status=34 已完成(包括已完成和关闭的) |
| pageNo | Number | 可选,当前第几页 |
| pageSize | Number | 可选,每页数据量 |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:
| 参数名 | 类型 | 说明 |
| —list | Array | 任务列表 |
| type | Number | 任务类型:0:自动,1:手动 |
| type2 | Number | 分配类型:0分配到坐席,1公海策略 |
| max_num | Number | 坐席领取最大数量(0-不限量) |
| shownumber_strategy | Number | 显号策略,0坐席自己选,1轮询 |
| showphone_type | Number | 号码展示方式,0逐条分配,1列表展示 |
| notcallnum | Number | 坐席未拨打联系人数量.3 |
| totalcallnum | Number | 任务总联系人数量 |
| answercallnum | Number | 坐席已接通的联系人数量 |
| finishcallnum | Number | 坐席已呼叫的联系人数量 |
| assigned | Number | 任务已分配联系人数量 |
| number_pool | json | 显号列表 |
| status | Number | 任务状态:1进行中,2任务暂停 |
| start_time | TimeStamp | 任务开始时间 |
| end_time | TimeStamp | 任务结束时间 |
| task_name | String | 任务名称 |
功能:获取当前执行预览任务列表
说明:无
注意:无
示例:
- CallCenter.preview.getTasks({
- taskName:’’,
- status: 1,
- pageSize: 10,
- pageNo: 1
- }, function (json) {
- // json为接口数据
- // json.code===”0000” 成功获取数据
- }, function () {
- // 错误处理
- });
9.2.2 获取某个预览外呼任务中的所有联系人信息
接口名称:CallCenter.preview.getContacts(params,success,error)
参数:
| 参数名称 | 参数类型 | 参数含义 |
| — params: | Object | 接口参数 |
| pageNo | Number | 可选,当前第几页,如果不传,默认为第一页 |
| pageSize | Number | 可选,每页数据量,如果不传,默认为每页10条 |
| taskId | Number | 预览外呼任务ID |
| flag | Number | 标识,0-未拨打;1-已拨打 |
返回值:
| 参数名 | 类型 | 说明 |
| id | Number | 联系人ID |
| biz_code | Number | 完成码,初始值为0,1成功,2失败 |
| sys_code | Number | 系统结果,对应CCS话后事件码(cause) |
| cancel_type | Number | 取消拨打标识,初始值为0,取消拨打为1 |
| ptask_id | Number | 预览外呼任务ID |
| agent_id | Number | 坐席ID |
| status | Number | 是否被取出:默认0;取出1; |
| remark | String | 小结备注 |
| f_1 | String | uuid |
| f_2 | String | 号码 |
| f_n | String | 自定义字段(上传名单字段) |
功能:获取某个预览外呼任务中的所有联系人信息
说明:无
注意:无
示例:
- CallCenter.preview.getContacts({
- taskId:12,
- flag: 0,
- pageSize: 10,
- pageNo: 1
- }, function (json) {
- // json为接口数据
- // json.code===”0000” 成功获取数据
- }, function () {
- // 错误处理
- });
9.2.3 获取任务列表
接口名称:CallCenter.preview.getTaskList(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数,可选,不传请传null |
| taskname | String | 可选,任务名称 |
| pageNo | Number | 可选,分页号 |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:
| 序号 | 返回值参数 | 中文名称 | 备注 |
| 1 | code | 返回状态码 | 0000请求成功 |
| 2 | page | 分页信息 | Json对象 |
| pageNo | 当前页数 | ||
| pageCount | 总页数 | ||
| pageSize | 每页数量 | ||
| start | 第几条数据 | ||
| total | 数据总量 | ||
| 3 | list | 任务列表 | JsonArray |
| id | 预览外呼任务ID | ||
| companyid | 企业ID | ||
| task_name | 任务名称 | ||
| type | 任务类型 | 0:自动,1:手动 | |
| template_id | 任务模板表ID | ||
| contact_group_id | 联系人组ID | ||
| total | 用户总数 | ||
| status | 任务状态 | 0:新建任务;1:任务进行中;2:任务暂停;3:任务完成;4:任务关闭 | |
| start_time | 任务开始时间 | ||
| end_time | 任务结束时间 | ||
| max_num | 座席领取最大用户数 | ||
| after_time | 话后时长(秒) | ||
| alter_time_out | 自定义震铃时长 | 单位秒(30秒-120秒之间) | |
| preview_time | 预览时间 | ||
| ordersql | 排序字段 | ||
| orderjson | 排序字段json字符串 | 用于页面反转展示 | |
| business_group_id | 自定义业务结果集ID | ||
| ctime | 创建时间 | ||
| utime | 更新时间 | ||
| type2 | 任务类型 | 0取分配到坐席的号码,1取未分配到坐席的号码 | |
| order_field | 排序字段 | preview_custom_fields表id | |
| priority | 优先级 | 数字越大越靠前 | |
| sortby | 排序方式 | 联系人行排序0升序,1降序 | |
| notcallnum | 未拨打联系人数量 | ||
| number_pool | 任务对应的外显号码 | JsonArray | |
| id | 自增长id | preview_number_pool表 | |
| number | 外显号码 | ||
| resultname | 业务结果集名称 | JsonArray | |
| id | 字增长id | preview_business_results | |
| name | 业务结果名称 | ||
| status | 状态 | 默认为0 | |
| type | 后续动作 | 0继续,1拨打下一个联系人,2企业黑名单,3此任务禁呼 | |
| cause | 挂机原因 | 0-已呼通;1-关机;2-停机;3-暂时无法接通;5-久叫不应;8-用户拒绝;18-空号;99-其他 | |
| type2 | 业务结果分类 | 1呼叫失败,2业务失败,3业务成功 | |
| unassigned | 未分配数量 |
功能:设置aid
说明:无
示例:
- // 不传参数
- CallCenter.preview.getTaskList(null,function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
- // 传参数
- CallCenter.preview.getTaskList({
- taskname:”测试”,
- pageNo:1
- },function(json){
- // json为接口数据
- },function(){
- // 错误处理
- });
注意:座席签入插件成功后调用
9.2.4 获取下一个联系人
接口名称:CallCenter.preview.getNextContact(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| contactgroupid | Number | 必选,联系人组ID,CallCenter.preview.apis.getTaskList接口获取 |
| taskid | Number | 必选,任务id,CallCenter.preview.apis.getTaskList接口获取 |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:
| 参数名 | 类型 | 说明 |
| code | string | 请求返回码:0000:正确;9001:没有taskid;9002:找不到任务;9003:任务状态错误 |
| info | string | 错误说明 |
| notcallnum | number | 坐席未呼叫联系人数量 |
| — contacts | object | 联系人数据 |
| id | number | id |
| f_1 | number | 自定义字段 |
| f_2 | string | 自定义字段 |
| f_3 | number | 座席工号 |
| biz_code | number | 完成代码 初始值为0 此值只来源于页面座席手动操作, 1成功,2失败 |
| sys_code | number | 系统结果 初始值为-2,成功为-1 SS中对应的结果字段 |
| cancel_type | number | 取消拨打标识 初始值为0 取消拨打为1 |
| ptask_id | number | 预览外呼任务ID预留 |
| agent_id | number | 坐席ID |
| status | number | 是否被取出:默认0;取出1;已拨打2;取消拨打用户3 |
| level | number | 用户优先级:默认 0,临时插入优先级最高 1,定时 2 |
| isupdate | number | 是否是更改数据插入的数据,0:默认,1:修改数据不存在插入新数据;2:修改更新数据 |
| remark | string | 小结备注 |
| ctime | number | 添加时间 |
| utime | number | 修改时间 |
| pds_station_no | number | 执行任务站点号 |
| call_round | number | 任务执行轮次 |
功能:设置aid
说明:无
示例:
- CallCenter.preview.getNextContact({
- contactgroupid:64,
- taskid:2
- },function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
注意:获取任务成功后调用
9.2.5 更新拨打结果
接口名称:CallCenter.preview.updateCallResult(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| contactgroupid | Number | 必选,联系人组ID,CallCenter.preview.apis.getTaskList接口获取 |
| id | Number | 必选,联系人ID |
| taskid | String | 必选,任务ID |
| bizcode | Number | 必选,拨打结果。1成功 2失败 |
| syscode | Number | 必选,系统结果,如果挂机时有answer_time则传after事件cause值,否则传5. |
| phone | Number | 必选,拨打号码 |
| callid | String | 必选,通话ID |
| timestamp | String | 必选,时间戳 |
| resultid | Number | 可选,业务结果集id,系统自动生成,CallCenter.preview.getTaskList接口获取 |
| resultname | String | 可选,业务结果集名称,Admin管理员自定义,CallCenter.preview.getTaskList接口获取 |
| phone | String | 电话号码 |
| device | String | 设备 |
| flag | int | 外呼方式:0:手工外呼;1:预览外呼 |
| remark | String | 备注 |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:{"code":"0000","info":"更新成功"}
功能:更新拨打结果
说明:无
示例:
- CallCenter.preview.updateCallResult({
- contactgroupid:12,
- id:2,
- taskid:”120”,
- bizcode:1,
- syscode:0,
- phone:123009998,
- callid:”4276076879298712”,
- timestamp:”1551094273”,
- resultid:1,
- resultName:”xxx”
- },function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
注意:必须在拨打完成当前联系人后调用
9.2.6 获取座席拨打记录
接口名称:CallCenter.preview.getContactLog(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| taskName | String | 可选,任务名称 |
| pageNo | Number | 可选,分页号 |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:
- {
- "page":{
- "pageCount":1,
- "pageNo":1,
- "pageSize":10,
- "start":0,
- "total":2
- },
- "list":[
- {
- "id":33,
- "f_1":"335",
- "f_2":"13152898233",
- "biz_code":2,
- "sys_code":-2,
- "cancel_type":0,
- "ptask_id":217,
- "agent_id":1,
- "status":1,
- "remark":"failed",
- "ctime":1532514344,
- "utime":1532515694,
- "previewContactfiles":[
- {
- "companyid":0,
- "contact_group_id":131,
- "ctime":1497580838,
- "f_enum":4,
- "f_length":32,
- "id":1,
- "name":"uuid",
- "sort":0,
- "type1":1,
- "type2":"STRING",
- "utime":1497580838
- }
- ],
- "calllog":[
- {
- "id":440,
- "pcid":33,
- "sys_code":5,
- "phone":"13152898233",
- "ctime":1532515694,
- "ptask_id":217,
- "agent_id":1,
- "contact_group_id":131,
- "companyid":1,
- "timestamp":1532515684,
- "callid":"23979573960557424"
- }
- ],
- "user":null,
- "guishudi":{
- "area_code":"0359",
- "area_name":"运城",
- "area_type":0,
- "carrier_id":3000,
- "check_status":1,
- "phone_type":0,
- "prefix":"1315289",
- "prefix_id":15160,
- "province":"山西",
- "update_time":{
- "date":20,
- "day":3,
- "hours":18,
- "minutes":50,
- "month":6,
- "nanos":0,
- "seconds":7,
- "time":1469011807000,
- "timezoneOffset":-480,
- "year":116
- }
- },
- "task":{
- "after_time":0,
- "alter_time_out":0,
- "business_group_id":6,
- "companyid":1,
- "contact_group_id":131,
- "ctime":1532514036,
- "end_time":1532534399,
- "id":217,
- "max_num":8,
- "notcallnum":0,
- "number_pool":[],
- "orderjson":"",
- "ordersql":"",
- "preview_time":0,
- "resultname":[
- {"id":1,"name":"成功"},
- {"id":2,"name":"失败"}
- ],
- "start_time":1532480400,
- "status":1,
- "task_name":"www02",
- "template_id":0,
- "total":30,
- "type":0,
- "unassigned":0,
- "utime":1532514387
- }
- }
- ],
- "code":"0000"
- }
| 参数名 | 类型 | 说明 |
| code | string | 请求返回码 |
| page | object | 分页信息 |
| pageCount | number | 总页数 |
| pageNo | number | 页码 |
| pageSize | number | 每页条数 |
| total | number | 总数 |
| list | object | 数据列表 |
| id | number | id |
| f_1 | number | 自定义字段 |
| f_2 | string | 自定义字段 |
| f_3 | string | 自定义字段 |
| f_4 | string | 自定义字段 |
| biz_code | number | 完成代码 初始值为0 此值只来源于页面座席手动操作, 1成功,2失败 |
| sys_code | number | 系统结果 初始值为-2,成功为-1 SS中对应的结果字段 |
| cancel_type | number | 取消拨打标识 初始值为0 取消拨打为1 |
| agent_id | number | 坐席ID |
| ptask_id | number | 预览外呼任务ID预留 |
| status | number | 是否被取出:默认0;取出1;已拨打2;取消拨打用户3 |
| remark | string | 小结备注 |
| ctime | number | 添加时间 |
| utime | number | 修改时间 |
| calllog | object | 拨打号码记录列表 |
| id | number | id |
| pcid | number | 联系人清单id |
| phone | string | 拨打的号码 |
| sys_code | number | 系统结果 |
| ctime | number | 记录创建时间 |
| ptask_id | number | 任务id |
| agent_id | number | 坐席id |
| contact_group_id | number | 联系人组id |
| companyid | number | 联系人组ID |
| timestamp | number | callid创建的时间戳 |
| callid | string | callid |
| previewContactfiles | object | 对应字段列表 |
| companyid | number | 企业id |
| contact_group_id | number | 联系人组ID |
| ctime | number | 创建时间 |
| f_enum | number | 此字段具体含义 1:号码,2:用户唯一标识(即 uuid) 暂时定义 |
| f_length | number | 字段长度 |
| id | number | 无 |
| name | string | 属性名称(展示用) |
| sort | number | 排序,倒序 |
| type1 | number | 是否是必选字段 0:不是,1:是 |
| type2 | string | 属性类型(int,char,varchar等) |
| utime | number | 修改时间 |
| user | object | 客户 |
| guishudi | object | 对应字段列表 |
| area_code | string | 区号 |
| area_name | string | 地区名称 |
| area_type | number | 0:北方,1:南方 |
| carrier_id | number | 运营商id |
| check_status | number | 区号校验标志,0,未校验,1,已校验,2,人工校验,3,区号不存在,4,校验后区号不一致 |
| phone_type | number | 0:手机 1: 固话 |
| prefix | string | 移动号段或座机区号 |
| prefix_id | number | 区号校验标志,0,未校验,1,已校验,2,人工校验,3,区号不存在,4,校验后区号不一致 |
| province | string | 所属省 |
| update_time | object | 对应字段列表 |
| date | number | 时间 |
| day | number | 时间日 |
| hours | number | 时间小时 |
| minutes | number | 时间分钟 |
| month | number | 时间月 |
| nanos | number | 纳秒 |
| seconds | number | 秒 |
| time | number | 时间 |
| timezoneOffset | number | |
| year | number | 时间年 |
| ccsOperator | object | 对应字段列表 |
| after_interval | number | 话后自动空闲间隔时长 |
| bindcode | string | 绑定的电话号码 |
| company_id | number | 企业ID |
| ctime | number | 创建时间 |
| string | 邮箱 | |
| id | number | id |
| immaxconcurrent | number | im最大并发数 |
| is_hide_phone | number | 是否隐藏号码,0否1是 |
| isaudio | number | 语音服务:0:不支持;1:支持 |
| ismemory | number | 技能组内座席开启座席记忆功能 |
| ismessage | number | 即时消息:0:不支持;1:支持 |
| isrecord | number | 是否录音:0:不录音;1:录音 |
| isvideo | number | 视频:0:不支持;1:支持 |
| judge | number | 是否需要服务评价 0 否 1是 |
| maingroupid | number | 座席主要技能组 不能为空 必填项 |
| name | string | 操作员姓名 |
| operator_id | number | 坐席员编号 |
| operator_type | number | 座席类型:0:普通座席;1:班长 |
| outcallflag | number | 外呼标志:0:允许外呼;1:限制长话;2:禁止外呼 |
| password | string | 座席密码 |
| priority | number | 优先级0-10 |
| sendlog | string | 发送日志 |
| showcaller | string | 主叫显示号码 |
| sipid | number | 绑定的SIP ID |
| status | number | 状态:1 开通,0关闭 |
| totalservicetime | number | 总共服务时长 |
| totaltimes | number | 总计服务次数 |
| ttscontent | string | 播放内容 ($ 将替换为工号播放) |
| task | object | 对应字段列表 |
| after_time | number | 话后时长(秒) |
| alter_time_out | number | 自定义震铃时长,单位秒(30秒-120秒之间) |
| companyid | number | 企业ID |
| contact_group_id | number | 联系人组ID |
| ctime | number | 创建时间 |
| end_time | number | 任务结束时间 |
| id | number | id |
| max_num | number | 座席领取最大用户数 |
| notcallnum | number | 坐席未呼叫联系人数量 |
| number_pool | ||
| orderjson | string | 排序字段json字符串,用于页面反转展示 |
| ordersql | string | 排序字段 |
| preview_time | number | 预览时间 |
| start_time | number | 任务开始时间 |
| status | number | 任务状态:0:新建任务;1:任务进行中;2:任务暂停;3:任务完成;4:任务关闭 |
| task_name | string | 任务名称 |
| template_id | number | 任务模板表ID |
| total | number | 用户总数 |
| type | number | 任务类型:0:自动,1:手动 |
| unassigned | ||
| utime | number | 修改时间 |
功能:获取座席拨打记录
说明:无
示例:
- CallCenter.preview.getContactLog({
- taskName:”任务名称”,
- pageNo:1
- },function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
注意:无
9.2.7 获取联系人自定义字段
接口名称:CallCenter.preview.getContactCustomizeFields(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| contactgroupid | Number | 必选,联系人组id |
| pageNo | Number | 可选,分页号 |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:
- {
- "list": [
- {
- "companyid": 1,
- "contact_group_id":0,
- "ctime": 1497580848,
- "f_enum": 1,
- "f_length": 15,
- "id": 2,
- "name": "号码",
- "type1": 1,
- "type2": "PHONE",
- "utime": 1497580848
- }
- ],
- "code": "0000"
- }
| 参数名 | 类型 | 说明 |
| code | string | 返回标示 |
| list | object | 数据列表 |
| companyid | number | 企业id |
| contact_group_id | number | 联系人组表ID |
| ctime | number | 创建时间 |
| f_enum | number | 此字段具体含义 1:号码,2:用户唯一标识(即 uuid) 暂时定义 |
| f_length | number | 字段长度 |
| id | number | 无 |
| name | string | 属性名称(展示用) |
| type1 | number | 是否是必选字段 0:不是,1:是 |
| type2 | string | 属性类型(int,char,varchar等) |
| utime | number | 修改时间 |
功能:获取联系人自定义字段
说明:无
示例:
- CallCenter.preview.getContactCustomizeFields({
- contactgroupid:12,
- pageNo:1
- },function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
注意:无
9.2.8 获取任务详情
接口名称:CallCenter.preview.getTaskInfo(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| taskid | Number | 必选,任务id |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:
- {
- "task":{
- "companyid": 1,
- "contact_group_id": 1,
- "ctime": 1497580979,
- "end_time": 0,
- "id": 1,
- "start_time": 0,
- "status": 1,
- "task_name": "预览外呼测试1",
- "total": 12,
- "utime": 1497583004,
- "unassigned":1000,
- "notcallnum":10
- "numberlist":[
- {"id":1,"number":"11111"},
- {"id":2,"number":"2222"}]
- },
- "code": "0000"
- }
| 参数名 | 类型 | 说明 |
| code | string | 返回信息 |
| page | object | 分页信息 |
| pageCount | number | 总页数 |
| pageNo | number | 页码 |
| pageSize | number | 每页条数 |
| list | object | 数据列表 |
| companyid | number | 企业id |
| contact_group_id | number | 联系人组id |
| ctime | number | 创建时间 |
| end_time | number | 任务结束时间 |
| id | number | 任务id |
| start_time | number | 任务开始时间 |
| status | number | 任务状态:1:任务进行中; |
| task_name | string | 任务名称 |
| total | number | 导入的总记录数 |
| utime | number | 修改时间 |
| unassigned | number | 任务未分配联系人数量 |
| notcallnum | number | 坐席未呼叫联系人数量 |
| numberlist | object | 外显号码列表 |
| id | number | 外显号码id |
| number | string | 外显号码 |
功能:获取任务详情
说明:无
示例:
- CallCenter.preview.getTaskInfo({
- taskid:12
- },function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
注意:无
9.2.9 座席申请额外的预览外呼联系人
接口名称:CallCenter.preview.getAdditionalContacts(params,success,error)
参数:
| 参数名 | 类型 | 说明 |
| — params: | Object | 接口参数 |
| contactgroupid | Number | 必选,联系人组ID |
| taskid | Number | 必选,任务id |
| num | Number | 必选,申请联系人数量 |
| success | Function | 必选,成功回调,回调参数:JSON数据 |
| error | Function | 可选,失败回调 |
返回值:
- {
- "code":"0000",
- "addnum":8,
- "notcallnum ":3,
- "info":"更新成功"
- }
| 参数名 | 类型 | 说明 |
| code | string | 请求返回码 |
| info | string | 错误说明 |
| addnum | number | 成功增加任务数量 |
| notcallnum | number | 坐席未呼叫联系人数量 |
功能:座席申请额外的预览外呼联系人
说明:无
示例:
- CallCenter.preview.getAdditionalContacts({
- contactgroupid:12,
- taskid:1,
- num:5
- },function(json){
- // json为接口数据
- // json.code===”0000” 成功获取数据
- },function(){
- // 错误处理
- });
注意:无