WebCti接口批量外呼部分开发版文档

本文档由工具直接从代码扫描生成，是代码最新变动后的快照文档，仅供开发人员参考，正式文档请阅读更新后的MVB2000 V5接口文档。

文档生成时间: 2025年05月07日 08:39:56。

1 根据id删除外呼日志

文件路径: webservice2/outcall/delobcalllog.php

接口地址: /webservice2/outcall/delobcalllog.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

1.1 功能描述

根据id删除外呼日志。

1.2 请求参数

参数名	类型	必填	说明
taskid	string	是	任务id
id	string	否	日志id（支持逗号分隔的多个值）
dialid	string	否	号码id

1.3 响应示例


{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

1.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

2 获取批量外呼名单表

文件路径: webservice2/outcall/getobdiallist.php

接口地址: /webservice2/outcall/getobdiallist.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

2.1 功能描述

获取批量外呼名单表。

2.2 请求参数

参数名	类型	必填	说明
id	string	否	名单id
taskid	string	是	任务id
dialnumber	string	否	外拨号码
createtime1	string	否	名单创建时间1(如:2015-01-01或2015-01-01 01:22:25)
createtime2	string	否	名单创建时间2(如:2015-01-01或2015-01-01 01:22:25)
dialedtime1	string	否	拨号开始时间1(如:2015-01-01或2015-01-01 01:22:25)
dialedtime2	string	否	拨号结束时间2(如:2015-01-01或2015-01-01 01:22:25)
answertime1	string	否	应答开始时间1(如:2015-01-01或2015-01-01 01:22:25)
answertime2	string	否	应答结束时间2 (如:2015-01-01或2015-01-01 01:22:25)
endtime1	string	否	通话结束时间1(如:2015-01-01或2015-01-01 01:22:25)
endtime2	string	否	通话结束时间2(如:2015-01-01或2015-01-01 01:22:25)
status	string	否	状态（支持逗号分隔的多个值）
remark	string	否	备注
caller	string	否	坐席号码
responsekey	string	否	客户按键（支持逗号分隔的多个值）
duration	string	否	通话时长（枚举类型 up/down/空），默认等于
second	string	否	通话时长阈值（根据duration比较）
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认id
sens	string	否	排序方法(asc/desc),默认desc

2.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": 1,
    "data": [
        {
            "id": "19",
            "taskid": "18",
            "createtime": "2024-07-29 14:54:47",
            "dialnumber": "10086",
            "extrefid": "",
            "campaignid": "0",
            "dialedtime": "2024-07-29 16:56:04",
            "answertime": "2024-07-29 16:56:04",
            "endtime": "2024-07-29 16:56:04",
            "duration": "0",
            "uniqueid": "1722243363.9",
            "responsekey": "-1",
            "responsetime": "1-01-01 00:00:00",
            "ttstext1": null,
            "ttstext2": null,
            "agentinput": "",
            "retrytimes": "1",
            "lastruntime": "2024-07-29 16:56:02",
            "cause": "16",
            "disposition": "ANSWER",
            "message": "",
            "status": "S",
            "lastrange": "",
            "communicateret": "",
            "monitorfile": "",
            "callerid": "",
            "caller": "",
            "remark": "由任务直接添加，备注：10086"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

2.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

3 删除特殊坐席

文件路径: webservice2/outcall/delspecialagent.php

接口地址: /webservice2/outcall/delspecialagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

3.1 功能描述

删除特殊坐席。

3.2 请求参数

参数名	类型	必填	说明
groupid	string	是	分组id
agent	string	是	坐席

3.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

3.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

4 增加特殊坐席

文件路径: webservice2/outcall/addspecialagent.php

接口地址: /webservice2/outcall/addspecialagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

4.1 功能描述

增加特殊坐席。

4.2 请求参数

参数名	类型	必填	说明
groupid	integer	是	分组id
agent	string	是	坐席
agentname	string	是	坐席名称
agentpassword	string	是	登录密码

4.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "分组测试已经存在！",
    "data": []
}

4.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

5 重置外呼名单状态

文件路径: webservice2/outcall/setobdialliststatus.php

接口地址: /webservice2/outcall/setobdialliststatus.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

5.1 功能描述

重置外呼名单状态。

5.2 请求参数

参数名	类型	必填	说明
taskid	string	是	任务id
id	string	否	id

5.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

5.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

6 根据id删除外呼任务

文件路径: webservice2/outcall/delobtask.php

接口地址: /webservice2/outcall/delobtask.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

6.1 功能描述

根据id删除外呼任务。

6.2 请求参数

参数名	类型	必填	说明
id	string	否	ID

6.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

6.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

7 修改特殊坐席分组信息

文件路径: webservice2/outcall/setagentgroup.php

接口地址: /webservice2/outcall/setagentgroup.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

7.1 功能描述

修改特殊坐席分组信息。传入"empty_string"表示空串，传入"empty_string"表示null。

7.2 请求参数

参数名	类型	必填	说明
id	integer	是	ID
groupname	string	是	分组名称
grouplist	string	否	呼叫组
ackcall	string	否	按键接听电话（枚举类型，yes/no），默认否
autologoff	string	否	超时登出时间(秒)
wrapuptime	string	否	事后处理时间(秒)
musiconhold	string	否	保持音乐
asexten	string	否	允许被叫（枚举类型，yes/no），默认no

7.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "分组测试已经存在！",
    "data": []
}

7.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

8 统计坐席外拨情况

文件路径: webservice2/outcall/getagentreport.php

接口地址: /webservice2/outcall/getagentreport.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

8.1 功能描述

统计坐席外拨情况。

8.2 请求参数

参数名	类型	必填	说明
id	string	是	任务ID
sort	string	否	排序字段，默认num
sens	string	否	排序方法(asc/desc),默认desc

8.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "taskid": "18",
            "agent": 601,
            "num": 2
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

8.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-10	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

9 增加外呼名单（数据包方式）

文件路径: webservice2/outcall/addobdiallists.php

接口地址: /webservice2/outcall/addobdiallists.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

9.1 功能描述

通过json数据包方式增加外呼名单。

9.2 请求参数

参数名	类型	必填	说明
taskid	string	是	任务id
data	string	是	json数据包

9.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

9.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

10 删除特殊坐席分组

文件路径: webservice2/outcall/delagentgroup.php

接口地址: /webservice2/outcall/delagentgroup.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

10.1 功能描述

删除特殊坐席分组，同时删除特殊坐席。

10.2 请求参数

参数名	类型	必填	说明
id	string	是	分组id

10.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

10.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

11 修改外呼任务信息

文件路径: webservice2/outcall/setobtask.php

接口地址: /webservice2/outcall/setobtask.php?webkey=xxxxxxxx&json=4

版本: 1.0.3 最后更新: 2024-11-26

11.1 功能描述

修改外呼任务信息，修改状态使用@see setobtaskstatus接口，此接不能修改状态。任务状态为R/C/B时不允许修改数据。传入"empty_string"表示空串，传入"empty_string"表示null。

11.2 请求参数

参数名	类型	必填	说明
id	string	是	任务id
name	string	是	任务名称
begindate	date	否	任务开始日期(yyyy-mm-dd)
enddate	date	否	任务结束时间(yyyy-mm-dd)
amrange	string	否	上午时段(24小时制,如8:10-12:30)
pmrange	string	否	下午时段(24小时制,如18:10-22:30)
monthlist	string	否	月列表(1,2,,3,4,...12)
timelist	string	否	循环时间列表(10:10,12:10,15:20...)
weeklist	string	否	周列表(0,1,2,3,4,5,,6)
daylist	string	否	日列表(1,2,3,...31)
runtype	integer	否	运行方式（枚举类型：0/1）（默认0）
actiontype	string	是	任务类型（枚举类型：1/2/3/4/5/6/7/8/9,循环任务仅支持1/2/5/6）
maxcalls	integer	否	并发数（默认0）
maxretries	integer	否	重试次数（默认0）
timeout	integer	否	振铃时长（默认0）
queuecallrate	float	否	队列呼叫比率（默认1.00）
outtrunk	string	否	指定中继
earlymedia	string	否	是否允许前向语音(Y/N，默认N)
needqs	string	否	是否质检(Y/N，默认N)
neednotify	string	否	需要继续提示(Y/N，默认Y)
needinput	string	否	需要输入结果(Y/N，默认N)
agentvoice	string	否	播放给坐席的语音
voicefile1	string	否	语音文件1(语音通知,自动调查回访)
voicefile2	string	否	感谢语音文件2(自动调查回访)
validkey	string	否	有效按键(如0-1-2-3)
inputtimeout	integer	否	调查回访等待输入时间（默认5）
inputerrorcount	integer	否	调查回访允许输入错误次数（默认3）
inputtimeoutcount	integer	否	调查回访允许输入超时次数（默认1）
callerid	string	否	主叫号码
account	string	否	计费账号
application	string	否	应用名称
appdata	string	否	应用数据
variable	string	否	变量
context	string	否	入口
exten	string	否	号码
priority	string	否	序号
agentno	string	否	坐席号码
agentchannel	string	否	坐席接口
createbyapp	string	否	模块名称
creater	string	否	创建人

11.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": "22",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

11.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-08	畅信达	新建
1.0.1	2022-05-06	畅信达	数字参数设为空时，不做数字验证
1.0.2	2022-05-07	畅信达	不传值不更新，传空值则更新为默认值
1.0.3	2024-11-26	畅信达	信创改造，去掉默认值代码，增加使用空串和空值标志更新字段的值，不传入字段则不处理。

12 增加外呼名单

文件路径: webservice2/outcall/addobdiallist.php

接口地址: /webservice2/outcall/addobdiallist.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

12.1 功能描述

增加外呼名单。

12.2 请求参数

参数名	类型	必填	说明
taskid	string	是	任务id
dialnumber	string	是	外拨号码
extrefid	string	否	外拨关联数据id
campaignid	string	否	投诉单id
ttstext1	string	否	TTS转换语音内容
ttstext2	string	否	感谢语TTS转换语音内容
caller	string	否	坐席号码
remark	string	否	备注

12.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

12.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

13 获取批量外呼日志表

文件路径: webservice2/outcall/getobcalllog.php

接口地址: /webservice2/outcall/getobcalllog.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

13.1 功能描述

获取批量外呼日志表。

13.2 请求参数

参数名	类型	必填	说明
dialid	string	否	号码id
taskid	string	否	任务id
phoneno	string	否	外拨号码
answertime1	string	否	接通时间1(如:2015-01-01或2015-01-01 01:22:25)
answertime2	string	否	接通时间2(如:2015-01-01或2015-01-01 01:22:25)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认id
sens	string	否	排序方法(asc/desc),默认desc

13.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": 0,
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

13.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

14 统计外拨任务

文件路径: webservice2/outcall/gettaskreport.php

接口地址: /webservice2/outcall/gettaskreport.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

14.1 功能描述

统计外拨任务。

14.2 请求参数

参数名	类型	必填	说明
id	string	否	任务id
name	string	否	任务名称
status	string	否	任务状态
actiontype	string	否	外拨类型
begindate1	string	否	任务开始日期1
begindate2	string	否	任务开始日期2
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认id
sens	string	否	排序方法(asc/desc),默认desc

14.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": 1,
    "data": [
        {
            "id": "26",
            "name": "测试",
            "begindate": "2024-01-01",
            "enddate": "2025-01-01",
            "actiontype": "1",
            "runtype": "1",
            "status": "N",
            "total": "2",
            "failcount": "0",
            "succcount": "1",
            "succrate": 50,
            "finishrate": 50
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

14.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

15 删除外呼任务特殊坐席与队列关系

文件路径: webservice2/outcall/delobagent.php

接口地址: /webservice2/outcall/delobagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

15.1 功能描述

删除外呼任务特殊坐席与队列关系。

15.2 请求参数

参数名	类型	必填	说明
id	string	否	ID
queue	string	是	队列号码（数值）
agent	string	否	坐席号码（支持逗号分隔的多个值）

15.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

15.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

16 增加外呼任务特殊坐席

文件路径: webservice2/outcall/addobagent.php

接口地址: /webservice2/outcall/addobagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

16.1 功能描述

增加外呼任务特殊坐席，可用于外呼转入队列的任务。

16.2 请求参数

参数名	类型	必填	说明
queue	string	是	队列号码（数值）
agent	string	是	坐席号码（数值）
penalty	string	否	优先级（数值，越大优先级越低，默认0）

16.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

16.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

17 增加外呼任务

文件路径: webservice2/outcall/addobtask.php

接口地址: /webservice2/outcall/addobtask.php?webkey=xxxxxxxx&json=4

版本: 1.0.3 最后更新: 2024-11-26

17.1 功能描述

增加外呼任务。

17.2 请求参数

参数名	类型	必填	说明
name	string	是	任务名称
begindate	date	否	任务开始日期(yyyy-mm-dd)
enddate	date	否	任务结束时间(yyyy-mm-dd)
amrange	string	否	上午时段(24小时制,如8:10-12:30)
pmrange	string	否	下午时段(24小时制,如18:10-22:30)
monthlist	string	否	月列表(1,2,,3,4,...12)
timelist	string	否	循环时间列表(10:10,12:10,15:20...)
weeklist	string	否	周列表(0,1,2,3,4,5,,6)
daylist	string	否	日列表(1,2,3,...31)
runtype	integer	否	运行方式（枚举类型：0/1）（默认0）
actiontype	string	是	任务类型（枚举类型：1/2/3/4/5/6/7/8/9,循环任务仅支持1/2/5/6）
maxcalls	integer	否	并发数（默认0）
maxretries	integer	否	重试次数（默认0）
timeout	integer	否	振铃时长（默认0）
queuecallrate	float	否	队列呼叫比率（默认1.00）
outtrunk	string	否	指定中继
earlymedia	string	否	是否允许前向语音(Y/N，默认N)
needqs	string	否	是否质检(Y/N，默认N)
neednotify	string	否	需要继续提示(Y/N，默认Y)
needinput	string	否	需要输入结果(Y/N，默认N)
agentvoice	string	否	播放给坐席的语音
voicefile1	string	否	语音文件1(语音通知,自动调查回访)
voicefile2	string	否	感谢语音文件2(自动调查回访)
validkey	string	否	有效按键(如0-1-2-3)
inputtimeout	integer	否	调查回访等待输入时间（默认5）
inputerrorcount	integer	否	调查回访允许输入错误次数（默认3）
inputtimeoutcount	integer	否	调查回访允许输入超时次数（默认1）
callerid	string	否	主叫号码
account	string	否	计费账号
application	string	否	应用名称
appdata	string	否	应用数据
variable	string	否	变量
context	string	否	入口
exten	string	否	号码
priority	string	否	序号
agentno	string	否	坐席号码
agentchannel	string	否	坐席接口
createbyapp	string	否	模块名称
creater	string	否	创建人

17.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": "22",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

17.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-08	畅信达	新建
1.0.1	2022-05-06	畅信达	根据不通类型验证必填项
1.0.2	2022-05-07	畅信达	不传值或传空值写入默认值
1.0.3	2024-11-26	畅信达	信创改造。

18 根据id删除外呼名单

文件路径: webservice2/outcall/delobdiallist.php

接口地址: /webservice2/outcall/delobdiallist.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

18.1 功能描述

根据id删除外呼名单。

18.2 请求参数

参数名	类型	必填	说明
taskid	string	是	任务id
id	string	否	名单id（支持逗号分隔的多个值）

18.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

18.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

19 获取批量外呼参数表

文件路径: webservice2/outcall/getobparams.php

接口地址: /webservice2/outcall/getobparams.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

19.1 功能描述

获取批量外呼参数表。

19.2 请求参数

参数名	类型	必填	说明
keyname	string	否	参数名
keydesc	string	否	参数描述
sort	string	否	排序字段，默认keyname
sens	string	否	排序方法(asc/desc),默认asc

19.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "keyname": "touservoice",
            "keyvalue": "custom\/transfer",
            "keydesc": "导入语音(坐席接通前播放给客户)"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

19.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

20 获取批量外呼任务表

文件路径: webservice2/outcall/getobtasks.php

接口地址: /webservice2/outcall/getobtasks.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

20.1 功能描述

获取批量外呼任务表。

20.2 请求参数

参数名	类型	必填	说明
id	string	否	任务id
name	string	否	任务名称
status	string	否	任务状态
actiontype	string	否	外拨类型
begindate	string	否	任务开始日期
enddate	string	否	任务结束日期
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认id
sens	string	否	排序方法(asc/desc),默认desc

20.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": 3,
    "data": [
        {
            "id": "20",
            "name": "测试",
            "begindate": null,
            "enddate": null,
            "amrange": "",
            "pmrange": "",
            "monthlist": "",
            "timelist": "",
            "weeklist": "",
            "daylist": "",
            "runtype": "0",
            "actiontype": "1",
            "maxcalls": "0",
            "maxretries": "0",
            "timeout": "0",
            "queuecallrate": "1",
            "outtrunk": "",
            "earlymedia": "N",
            "needqs": "N",
            "neednotify": "N",
            "needinput": "N",
            "agentvoice": "",
            "voicefile1": "hello",
            "voicefile2": "",
            "validkey": "",
            "inputtimeout": "5",
            "inputerrorcount": "3",
            "inputtimeoutcount": "1",
            "callerid": "",
            "account": "",
            "application": "",
            "appdata": "",
            "variable": "",
            "context": "",
            "exten": "",
            "priority": "",
            "agentno": "",
            "agentchannel": "",
            "createbyapp": "",
            "creater": "",
            "createtime": "2024-11-26 08:43:03",
            "begintime": null,
            "status": "N",
            "lastrange": "",
            "curdialid": "0",
            "lastruntime": null,
            "finishtime": null
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

20.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

21 统计外拨按键

文件路径: webservice2/outcall/getpresskeyreport.php

接口地址: /webservice2/outcall/getpresskeyreport.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

21.1 功能描述

统计外拨按键。

21.2 请求参数

参数名	类型	必填	说明
id	string	是	任务ID
sort	string	否	排序字段，默认responsekey
sens	string	否	排序方法(asc/desc),默认desc

21.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "taskid": "18",
            "responsekey": "2",
            "num": "1"
        },
        {
            "taskid": "18",
            "responsekey": "1",
            "num": "1"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

21.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-10	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

22 增加特殊坐席分组

文件路径: webservice2/outcall/addagentgroup.php

接口地址: /webservice2/outcall/addagentgroup.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

22.1 功能描述

增加特殊坐席分组。

22.2 请求参数

参数名	类型	必填	说明
groupname	string	是	分组名称
grouplist	string	否	呼叫组
ackcall	string	否	按键接听电话（枚举类型，yes/no），默认否
autologoff	string	否	超时登出时间(秒)
wrapuptime	string	否	事后处理时间(秒)
musiconhold	string	否	保持音乐
asexten	string	否	允许被叫（枚举类型，yes/no），默认no

22.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "分组测试已经存在！",
    "data": []
}

22.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

23 修改参数值和描述

文件路径: webservice2/outcall/setobparams.php

接口地址: /webservice2/outcall/setobparams.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

23.1 功能描述

修改参数值和描述。传入"empty_string"表示空串，传入"empty_string"表示null。

23.2 请求参数

参数名	类型	必填	说明
keyname	string	是	参数名
keyvalue	string	是	参数值
keydesc	string	否	参数描述

23.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

23.4 修订历史

版本	日期	作者	说明
1.0.0	2016-09-30	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

24 查看外呼任务特殊坐席与队列关系表

文件路径: webservice2/outcall/getobagent.php

接口地址: /webservice2/outcall/getobagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

24.1 功能描述

查看外呼任务特殊坐席与队列关系表。

24.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码（数值）
agent	string	否	坐席号码（数值）
penalty	string	否	优先级（数值，越大优先级越低，默认0）
sort	string	否	排序字段，默认id
sens	string	否	排序方法(asc/desc),默认desc

24.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "id": "1",
            "queue": "90",
            "agentid": "601",
            "penalty": "0",
            "logstatus": "0",
            "logintime": null,
            "logouttime": null,
            "extraid": ""
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

24.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

25 修改外呼名单信息

文件路径: webservice2/outcall/setobdiallist.php

接口地址: /webservice2/outcall/setobdiallist.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

25.1 功能描述

修改外呼名单信息。传入"empty_string"表示空串，传入"empty_string"表示null。

25.2 请求参数

参数名	类型	必填	说明
id	string	是	id
taskid	string	是	任务id
dialnumber	string	是	外拨号码
extrefid	string	否	外拨关联数据id
campaignid	string	否	投诉单id
ttstext1	string	否	TTS转换语音内容
ttstext2	string	否	感谢语TTS转换语音内容
caller	string	否	坐席号码
status	string	否	状态（枚举类型：N/R/D/S/F）
remark	string	否	备注

25.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "ID为199的数据不存在！",
    "data": []
}

25.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

26 修改特殊坐席信息

文件路径: webservice2/outcall/setspecialagent.php

接口地址: /webservice2/outcall/setspecialagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

26.1 功能描述

修改特殊坐席信息。传入"empty_string"表示空串，传入"empty_string"表示null。

26.2 请求参数

参数名	类型	必填	说明
groupid	string	是	分组id
agent	string	是	参数值
agentname	string	是	名称
agentpassword	string	否	密码

26.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

26.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

27 获取特殊坐席列表

文件路径: webservice2/outcall/getspecialagent.php

接口地址: /webservice2/outcall/getspecialagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

27.1 功能描述

获取特殊坐席列表，成功时message字段返回可用分页的总记录数，失败时返回错误信息。

27.2 请求参数

参数名	类型	必填	说明
groupid	integer	否	分组id
agent	string	否	坐席
agentname	string	否	坐席名称
queue	string	否	所属队列
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认agentid
sens	string	否	排序方法(asc/desc),默认asc

27.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "groupid": "25",
            "agentid": "688",
            "agentpassword": "111",
            "agentname": "test",
            "id": null,
            "queue": null,
            "penalty": null,
            "logstatus": null,
            "logintime": null,
            "logouttime": null
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "分组测试已经存在！",
    "data": []
}

27.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

28 获取特殊坐席分组列表

文件路径: webservice2/outcall/getagentgroup.php

接口地址: /webservice2/outcall/getagentgroup.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

28.1 功能描述

获取特殊坐席分组列表。

28.2 请求参数

参数名	类型	必填	说明
groupname	string	是	分组名称
sort	string	否	排序字段，默认id
sens	string	否	排序方法(asc/desc),默认desc

28.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "id": "6",
            "groupname": "测试",
            "grouplist": "",
            "ackcall": "",
            "autologoff": "0",
            "wrapuptime": "15000",
            "musiconhold": "",
            "asexten": "yes"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

28.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

29 统计通话时长

文件路径: webservice2/outcall/gettimereport.php

接口地址: /webservice2/outcall/gettimereport.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

29.1 功能描述

统计通话时长。

29.2 请求参数

参数名	类型	必填	说明
id	string	是	任务id
second	integer	否	有效通话时长（秒），默认10

29.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "taskid": "26",
            "up": "1",
            "down": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

29.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。

30 修改外呼任务状态

文件路径: webservice2/outcall/setobtaskstatus.php

接口地址: /webservice2/outcall/setobtaskstatus.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

30.1 功能描述

修改外呼任务状态。

30.2 请求参数

参数名	类型	必填	说明
id	integer	是	任务id
status	string	是	状态（N/B/S/P/C/R/F ）

30.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

30.4 修订历史

版本	日期	作者	说明
1.0.0	2016-09-30	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。

31 修改外呼任务特殊坐席

文件路径: webservice2/outcall/setobagent.php

接口地址: /webservice2/outcall/setobagent.php?webkey=xxxxxxxx&json=4

版本: 1.0.1 最后更新: 2024-11-26

31.1 功能描述

修改外呼任务特殊坐席。传入"empty_string"表示空串，传入"empty_string"表示null。

31.2 请求参数

参数名	类型	必填	说明
id	integer	是	ID
queue	string	否	队列号码（数值）
agent	string	否	坐席号码（数值）
penalty	string	否	优先级（数值，越大优先级越低，默认0）

31.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "",
    "data": []
}

31.4 修订历史

版本	日期	作者	说明
1.0.0	2016-10-14	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-26	畅信达	信创改造。