WebCti接口开发版文档

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

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

1 删除呼出白名单列表

文件路径: webservice2/deleteroutewhitelist.php

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

版本: 1.0.1 最后更新: 2024-10-23

1.1 功能描述

根据电话号码删除呼出白名单列表

1.2 请求参数

参数名	类型	必填	说明
extension	string	是	电话号码

1.3 响应示例


{
    "errcode": 0,
    "message": "删除呼出白名单号码 10010 成功！",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9007,
    "message": "呼出白名单号码 10010 不存在",
    "data": []
}

1.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新增接口
1.0.1	2024-10-23	畅信达	信创改造

2 根据呼叫编号标记呼损记录

文件路径: webservice2/setbadcall.php

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

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

2.1 功能描述

根据呼叫编号标记呼损记录。

2.2 请求参数

参数名	类型	必填	说明
uniqueid	string	是	呼叫编号
processflag	string	否	处理标志(数字，新记录默认0)
processmark	string	否	备注，采用base64编码(编码前需要utf-8字符集)，如：5bey57uP5Zue5ouo6IGU57O7
processapp	string	否	应用程序名,如R3

2.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

2.4 修订历史

版本	日期	作者	说明
1.0.0	2015-06-25	畅信达	新建
1.0.1	2024-11-21	畅信达	信创改造

3 座席示忙或示闲

文件路径: webservice2/ctiqueuepause.php

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

版本: 1.0.1 最后更新: 2024-10-24

3.1 功能描述

此操作设置座席示忙或示闲状态，其中示忙可以是1-99之间的状态

3.2 请求参数

参数名	类型	必填	说明
interface	string	是	坐席拨号接口(如:SIP/601)
paused	int	是	状态(0-99)
queue	string	否	队列号码
reason	string	否	原因（支持中文）

3.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "座席示忙操作成功: Interface paused successfully",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1291,
    "message": "座席示忙操作失败: Interface not found",
    "data": []
}

3.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-24	畅信达	信创改造，增加原因参数，队列号非必填

4 发送SIP短信

文件路径: webservice2/ctisendtext.php

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

版本: 1.0.1 最后更新: 2024-10-29

4.1 功能描述

向SIP终端发送文字信息。

4.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道(如SIP/601-0000005d)
message	string	是	信息（文字使用UTF8编码）
contenttype	string	否	MIME类型
actionid	string	否	事务ID

4.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI发送SIP短信指令成功：Success",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1331,
    "message": "执行CTI发送SIP短信指令失败(phpcti-10.1.0.2-20241029083032)：No such channel",
    "data": []
}

4.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

5 批量获取号码归属区号

文件路径: webservice2/getareas.php

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

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

5.1 功能描述

批量获取号码归属区号。

5.2 请求参数

参数名	类型	必填	说明
phoneno	string	是	电话号码（逗号分隔的手机号码或带区号的固定电话）

5.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "获取区号成功！",
    "data": [
        {
            "area": "0532",
            "city": "青岛",
            "province": "山东",
            "type": "中国电信",
            "phone": "19953219999"
        },
        {
            "area": "0532",
            "city": "青岛市",
            "province": "山东",
            "TYPE": "固话",
            "phone": "053282754888"
        }
    ]
}


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

5.4 修订历史

版本	日期	作者	说明
1.0.0	2016-06-15	畅信达	新建
1.0.1	2024-11-04	畅信达	信创改造

6 整理语音留言

文件路径: webservice2/movemsg.php

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

版本: 1.0.2 最后更新: 2024-11-22

6.1 功能描述

整理语音留言，在目录之间移动留言。

6.2 请求参数

参数名	类型	必填	说明
msgbox	string	是	语音信箱号码(如601)
msgdir	string	是	留言目录(枚举类型：INBOX/Old/Urgent/Work/Friends/Family/Cust1/Cust2/Cust3/Cust4/Deleted)
msgfile	string	是	留言文件名称（msg_id），来自@see getmsglist.php 结果集，如：1730267105-00000000
dstdir	string	是	目标目录(枚举类型：INBOX/Old/Urgent/Work/Friends/Family/Cust1/Cust2/Cust3/Cust4/Deleted)，参考msgdir
context	string	否	语音信箱入口(默认default)

6.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "INBOX\/1730267105-00000000 移动到 Old.",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9002,
    "message": "缺少参数 \"dstdir\".",
    "data": []
}

6.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新建
1.0.1	2022-01-11	畅信达	改为从数据库处理留言增加context参数
1.0.2	2024-11-22	畅信达	信创改造

7 触发队列的状态事件

文件路径: webservice2/ctiqueuestatus.php

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

版本: 1.0.0 最后更新: 2024-10-25

7.1 功能描述

此操作检查一个或全部队列的指定或全部状态，触发QueueParams/QueueMember/QueueEntry事件，以事件的方式向CTI客户端返回数据，只有当前CTI连接可以收到事件。

7.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码
member	string	否	指定成员
data	string	否	请求的数据类型（枚举类型），默认返回3种类型数据，建议指定数据类型。

7.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "触发队列的状态事件成功: Queue status will follow",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1462,
    "message": "触发队列的状态事件失败: ",
    "data": []
}

7.4 修订历史

版本	日期	作者	说明
1.0.0	2024-10-24	畅信达	信创改造，新建

8 根据文件名下载或检查通话录音文件

文件路径: webservice2/getmonitor.php

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

版本: 1.0.2 最后更新: 2024-11-13

8.1 功能描述

下载或检查通话录音文件，支持输出mp3格式。

8.2 请求参数

参数名	类型	必填	说明
filename	string	是	录音文件名(话单中登记的文件名，如：2024/10/31/queue_603_601_20241031-154814_1730360894.4.WAV)
mp3	string	否	提供转mp3格式功能（枚举类型）,默认否
checkonly	string	否	仅检查录音文件名是否存在（枚举类型）,默认否，开启时返回结构数据，否则返回二进制流

8.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9003,
    "message": "文件不存在！",
    "data": []
}

8.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2015-03-19	提供转mp3格式功能	* @revision 1.0.2 2024-11-13 畅信达信创改造

9 查询短信收件箱记录数

文件路径: webservice2/getrecvsmscount.php

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

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

9.1 功能描述

查询短信收件箱记录数，用于分页。

9.2 请求参数

参数名	类型	必填	说明
insert_dates	string	否	记录写入日期开始(如:2015-01-01或2015-01-01 01:22:25)
insert_datee	string	否	记录写入日期结束(如:2015-01-01或2015-01-01 01:22:25)
received_dates	string	否	接收日期开始(如:2015-01-01或2015-01-01 01:22:25)
received_datee	string	否	接收日期结束(如:2015-01-01或2015-01-01 01:22:25)
number	string	否	手机号码
id	string	否	ID
idcmp	string	否	ID比较方法(e/g/l 等于/大于/小于)
dst	string	否	目标号码
text	string	否	内容（模糊匹配）
processed	string	否	处理状态(预留字段)
app_id	string	否	应用ID(预留字段)
app_user	string	否	应用用户名(预留字段)
app_flag	string	否	应用标志(预留字段)

9.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

9.4 修订历史

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

10 调用第三方语义理解系统

文件路径: webservice2/getnlpresult.php

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

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

10.1 功能描述

调用第三方语义理解系统。需要在平台管理页面配置理解引擎

10.2 请求参数

参数名	类型	必填	说明
callerid	string	是	用户编号
robotid	string	是	机器人名称
content	string	是	理解内容
paramsmem	string	否	交互参数，不同NLP服务商接口返回数据不同，调用者无需处理，同一对话下次调用原样返回即可
clearsession	string	否	清除sessionID，重置多轮对话（枚举类型）,默认否

10.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 4001,
    "message": "Robot not exist",
    "data": []
}

10.4 修订历史

版本	日期	作者	说明
1.0.0	2023-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-13	畅信达	信创改造

11 获取座席助手交互记录

文件路径: webservice2/getccsalist.php

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

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

11.1 功能描述

此操作可根据呼叫编号获取座席助手交互记录。

11.2 请求参数

参数名	类型	必填	说明
uniqueid	string	是	呼叫编号（逗号分隔）

11.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

11.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-01	畅信达	信创改造

12 查询语音卡通道列表

文件路径: webservice2/getzapchannel.php

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

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

12.1 功能描述

查询语音卡通道列表。

12.2 请求参数

参数名	类型	必填	说明
channel	string	否	语音卡通道

12.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

12.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-11-22	畅信达	信创改造

13 删除呼入黑名单（旧版）

文件路径: webservice2/ctidelblacklist.php

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

版本: 1.0.1 最后更新: 2024-10-25

13.1 功能描述

此接口实现了根据电话号码删除呼入黑名单的功能。

13.2 请求参数

参数名	类型	必填	说明
extension	string	是	电话号码

13.3 响应示例


xxxxxxxxxx
{
    "errcode": 1061,
    "message": "号码 10010 不存在",
    "data": []
}

13.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-25	畅信达	信创改造

14 查询呼出白名单列表

文件路径: webservice2/getroutewhitelist.php

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

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

14.1 功能描述

查询呼出白名单列表。

14.2 请求参数

参数名	类型	必填	说明
extension	string	否	被叫号码
isvalid	string	否	是否有效（枚举类型0/1）
sort	string	否	排序字段(默认id)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认：0)
rows	string	否	记录数

14.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "id": "27",
            "extension": "99999999",
            "reason": "测试",
            "isvalid": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

14.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新建
1.0.1	2024-11-21	畅信达	信创改造

15 设置或取消通道静音

文件路径: webservice2/ctimuteaudio.php

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

版本: 1.0.1 最后更新: 2024-10-27

15.1 功能描述

设置或取消通道静音。

15.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
direction	string	否	音频流方向（枚举类型）,默认all
state	string	否	开关（枚举类型）,默认on

15.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI静音指令成功：",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1201,
    "message": "执行CTI静音指令失败(phpcti-10.1.0.2-20241028095324)：No such channel",
    "data": []
}

15.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

16 设置语音留言处理状态

文件路径: webservice2/setmsg.php

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

版本: 1.0.2 最后更新: 2024-11-22

16.1 功能描述

设置语音留言处理状态。

16.2 请求参数

参数名	类型	必填	说明
msgbox	string	是	语音信箱号码(如601)
msgdir	string	是	留言目录(枚举类型：INBOX/Old/Urgent/Work/Friends/Family/Cust1/Cust2/Cust3/Cust4/Deleted)
msgfile	string	是	留言文件名称（msg_id），来自@see getmsglist.php 结果集，如：1730267105-00000000
alreadyread	string	是	是否已读(枚举类型：0/1)
context	string	否	语音信箱入口(默认default)
remark	string	否	备注

16.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "INBOX\/1730267105-00000000 已更新！",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1472,
    "message": "指定数据不存在，无法更新 Old\/1730267105-000000001.",
    "data": []
}

16.4 修订历史

版本	日期	作者	说明
1.0.0	2022-06-25	畅信达	新建
1.0.1	2024-11-22	畅信达	信创改造

17 拆除指定活动通道

文件路径: webservice2/ctihangup.php

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

版本: 1.0.1 最后更新: 2024-10-27

17.1 功能描述

此操作可拆除指定活动通道如（SIP/601-0000012a），也支持正则表达式（如：/^SIP/601-.*$/），可拆除匹配的全部通道。

17.2 请求参数

参数名	类型	必填	说明
channel	string	是	确切的活动通道名称，或者使用正则表达式进行设置。
cause	int	否	拆线原因（整数值）

17.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI拆线指令成功：Channel Hungup",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1191,
    "message": "执行CTI拆线指令失败(phpcti-10.1.0.2-20241028090655)：No such channel",
    "data": []
}

17.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

18 通过CTI踢出会议桥成员

文件路径: webservice2/cticonfbridgekick.php

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

版本: 1.0.0 最后更新: 2025-03-03

18.1 功能描述

通过CTI踢出会议桥成员。

18.2 请求参数

参数名	类型	必填	说明
conference	string	是	会议桥名称
channel	string	否	活动通道，支持按前缀匹配。

18.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通过CTI踢出会议桥成员成功：All participants kicked",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1202,
    "message": "执行通过CTI踢出会议桥成员失败(phpcti-10.1.0.2-20250303075014)：No active conferences.",
    "data": []
}

18.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

19 取消禁止呼入（免打扰）功能

文件路径: webservice2/ctisetdndoff.php

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

版本: 1.0.1 最后更新: 2024-10-29

19.1 功能描述

取消指定分机的禁止呼入（免打扰）功能。

19.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码

19.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "取消禁止呼入（免打扰）成功！",
    "data": [
        {
            "status": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

19.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

20 查询会议数据

文件路径: webservice2/getmeetme.php

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

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

20.1 功能描述

查询会议数据。

20.2 请求参数

参数名	类型	必填	说明
meetme	string	否	会议室号码

20.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-13 17:16:52",
            "callerid": "602",
            "calleridname": "预设",
            "channel": "SIP\/602-00000047",
            "uniqueid": "1731489409.124",
            "linkedid": "1731489409.124",
            "meetme": "20",
            "usernum": "1",
            "muted": "0",
            "talkrequest": "0",
            "talking": "0",
            "duration": "3",
            "leave": "0"
        }
    ]
}


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

20.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-13	畅信达	信创改造

21 查询短信发件箱列表

文件路径: webservice2/getsendsms.php

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

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

21.1 功能描述

查询短信发件箱列表，成功时message字段返回总记录数（可用于分页），失败时返回描述。注意: 只支持短信通道发送方式。

21.2 请求参数

参数名	类型	必填	说明
insert_dates	string	否	记录写入日期开始(如:2015-01-01或2015-01-01 01:22:25)
insert_datee	string	否	记录写入日期结束(如:2015-01-01或2015-01-01 01:22:25)
processed_dates	string	否	处理日期开始(如:2015-01-01或2015-01-01 01:22:25)
processed_datee	string	否	处理日期结束(如:2015-01-01或2015-01-01 01:22:25)
number	string	否	手机号码
id	string	否	ID
idcmp	string	否	ID比较方法(e/g/l 等于/大于/小于)
text	string	否	内容（模糊匹配）
processed	string	否	处理状态(枚举类型0/1/2/-1)
app_id	string	否	应用ID(预留字段)
app_user	string	否	应用用户名(预留字段)
app_flag	string	否	应用标志(预留字段)
sort	string	否	排序字段(默认id)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认：0)
rows	string	否	记录数

21.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

21.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-21	畅信达	信创改造，成功时message字段返回总记录数（可用于分页），失败时返回描述。

22 绑定设备与工号

文件路径: webservice2/ctibinddevice.php

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

版本: 1.0.2 最后更新: 2024-10-23

22.1 功能描述

此操作将建立申请工号和申请设备的绑定关系，必要条件：工号当前没有绑定固定类型设备设备类型是临时操作逻辑： reset为0并且申请工号和申请设备已经建立绑定关系，则直接返回成功。如果申请工号和申请设备没有建立绑定关系或reset为1时按下面逻辑处理：申请工号从队列下线申请设备从队列下线申请工号已经绑定的设备会被从队列下线并与其工号分离；申请设备已经绑定的工号被从队列下线并与其设备号分离；申请工号关系分离申请设备关系分离建立申请工号和申请设备的绑定关系

22.2 请求参数

参数名	类型	必填	说明
extension	string	是	工号
device	string	是	设备号码
reset	int	否	强制重置（已绑定状态是否强制分离和下线(默认0)）

22.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "工号 610 绑定到设备 609 成功。",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1041,
    "message": " 工号 610 不存在。",
    "data": []
}

22.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2015-06-09	畅信达	绑定时分离工号现有关系
1.0.2	2024-10-23	畅信达	信创改造，增加了reset参数，控制已经绑定时是否重新绑定并下线

23 获取分机列表

文件路径: webservice2/getallextensions.php

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

版本: 1.0.1 最后更新: 2024-10-31

23.1 功能描述

获取分机列表，包含分机号、设备号、设备状态等信息，设备状态有1秒缓存。

23.2 请求参数

参数名	类型	必填	说明
exten	string	否	分机号码（仅为向前兼容）
extension	string	否	分机号码（优先使用）

23.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "extension": "601",
            "cnname": "预设",
            "enname": "New",
            "device": "601",
            "channel": "SIP\/601",
            "context": "ext-local",
            "status": "0",
            "statusint": "999"
        }
    ]
}


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

23.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-10-31	畅信达	信创改造，将多数据库关联查询分离

24 电话驻留

文件路径: webservice2/ctipark.php

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

版本: 1.0.1 最后更新: 2024-10-27

24.1 功能描述

设置电话驻留，驻留发起者挂机，向对方播放保持音乐。

24.2 请求参数

参数名	类型	必填	说明
channel	string	是	待驻留的活动通道
timeoutchannel	string	是	超时返回的活动通道或拨号接口，驻留超时后如果此通道在通话中，在提醒此通道，否则根据此通道的前缀部分进行回拨。
srcchannel	string	否	请使用timeoutchannel，仅为向前兼容而设。
announcechannel	string	是	通告通道，电话被驻留时要通知的活动通道，此通道必须是处于桥接状态的通道。
timeout	int	否	指定驻留超时秒数，默认300
parkinglot	string	否	驻留位置（系统配置的驻留范围内空闲的位置），默认有系统自动选择。

24.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI电话驻留指令成功：Park successful",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1251,
    "message": "执行CTI电话驻留指令失败(phpcti-10.1.0.2-20241029070731)：Channel does not exist: SIP\/601-00000050",
    "data": []
}

24.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

25 查询坐席活动记录

文件路径: webservice2/getagentactivity.php

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

版本: 1.0.1 最后更新: 2024-10-31

25.1 功能描述

根据条件查询坐席活动记录，查询成功时返回结果的message属性为总记录数，可用于分页。失败时message属性为失败描述。

25.2 请求参数

参数名	类型	必填	说明
datefrom	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
dateto	string	是	结束日期时间(如:2015-01-02或2015-01-02 10:22:25)
queue	string	否	队列号码(如: 90)
agent	string	否	坐席接口(如: SIP/) 向右模糊匹配
agentname	string	否	坐席工号(如: 601)
event	string	否	事件名称(added/removed/unpaused/paused)
sort	string	否	排序字段(默认agent)
sens	string	否	排序方式（asc/desc）(默认desc)
offset	int	否	偏移量
rows	int	否	结果集大小

25.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "36",
    "data": [
        {
            "createtime": "2024-10-24 17:23:01",
            "agent": "SIP\/609",
            "agentname": "610",
            "queue": "91",
            "channel": "",
            "uniqueid": "",
            "logintime": null,
            "event": "unpaused",
            "actionid": "1729761781",
            "actionseconds": "0",
            "conseconds": "0",
            "unpauseseconds": "0",
            "pauseseconds": "0",
            "pausetype": "0",
            "reason": ""
        },
        {
            "createtime": "2024-10-24 17:23:01",
            "agent": "SIP\/609",
            "agentname": "610",
            "queue": "91",
            "channel": "",
            "uniqueid": "",
            "logintime": "2024-10-24 17:23:01",
            "event": "added",
            "actionid": "1729761781",
            "actionseconds": "0",
            "conseconds": "0",
            "unpauseseconds": "0",
            "pauseseconds": "0",
            "pausetype": "0",
            "reason": ""
        }
    ]
}


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

25.4 修订历史

版本	日期	作者	说明
1.0.0	2023-12-31	畅信达	新建
1.0.1	2024-10-31	畅信达	信创改造

26 通话中等待身份验证结果

文件路径: webservice2/ctiwaitcalldata.php

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

版本: 1.0.1 最后更新: 2024-10-30

26.1 功能描述

坐席与客户通话中，要求客户进行身份验证,坐席等待验证结果数据，验证过程中，坐席处于静默或音乐状态。原理: 坐席或其他应用发起指令(快捷键定义)调用平台某一语音程序(AGI,如会员验证), 提示客户输入账户密码等信息，该语音程序对信息进行验证，并验证结果写入事先约定的通道变量CALLDATA_STATE等，此接口在给定的时间(timeout)内等待 CALLDATA_STATE变量发生变化(>0)，获取数据返回。语音程序(AGI)退出前应设置的通道变量: CALLDATA_STATE 必须调用状态 0=未处理 1=完成 2-输入不完整 3-已挂机 CALLDATA_AUTH 必须由使用者在语音程序中设定,代表认证是否通过( 0-未处理 1-通过 2-失败) CALLDATA_ID 按需 ID，由使用者在语音程序中设定 CALLDATA_ACCOUNT 按需 ACCOUNT，由使用者在语音程序中设定 CALLDATA_TIMESTAMP 按需时间戳，由使用者在语音程序中设定 CALLDATA_DATA1-4 按需预定义的变量自定义1-4 按需自定义的变量注意：此接口与ctiwaitauth.php功能类似，区别在于不自动触发通话中的语音流程程序，触发需要单独调用接口实现。

26.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道（如SIP/601-0000006e）
timeout	int	否	等待结果时间（秒），默认：120。0秒为不等待立即返回
cdvar1	string	否	要获取的自定义通道变量名称1
cdvar2	string	否	要获取的自定义通道变量名称2
cdvar3	string	否	要获取的自定义通道变量名称3
cdvar4	string	否	要获取的自定义通道变量名称4

26.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通话中等待身份验证结果指令成功",
    "data": [
        {
            "CALLDATA_STATE": 1,
            "CALLDATA_ID": "VIPID0001",
            "CALLDATA_ACCOUNT": "37020001",
            "CALLDATA_AUTH": 1,
            "CALLDATA_TIMESTAMP": 1730259986,
            "CALLDATA_DATA1": "模拟数据1",
            "CALLDATA_DATA2": "模拟数据2",
            "CALLDATA_DATA3": "模拟数据3",
            "CALLDATA_DATA4": "模拟数据4"
        }
    ]
}


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

26.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-30	畅信达	信创改造

27 从队列撤回排队者

文件路径: webservice2/ctiqueuecallerwithdraw.php

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

版本: 1.0.1 最后更新: 2024-10-24

27.1 功能描述

此操作将从队列撤回排队者，撤回后设置通道变量 QUEUESTATUS=WITHDRAW， QUEUE_WITHDRAW_INFO=传入的撤回原因。被撤回后的呼叫将自动进入队列失败选项。

27.2 请求参数

参数名	类型	必填	说明
queue	string	是	队列号码
caller	string	是	来电者活动通道（如SIP/603-0000000e）
withdrawinfo	string	否	撤回原因

27.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "从队列撤回排队者成功: Withdraw requested successfully",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1291,
    "message": "从队列撤回排队者失败: Unable to request withdraw from queue: No such caller",
    "data": []
}

27.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-24	畅信达	信创改造

28 查询坐席当前通话

文件路径: webservice2/getagentcalls.php

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

版本: 1.0.1 最后更新: 2024-10-31

28.1 功能描述

查询坐席当前通话，数据量很少，不需要分页。

28.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码(如: 90)
agentname	string	否	坐席工号(如: 601)

28.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-10-31 15:48:15",
            "queue": "90",
            "queuestart": "1730360894",
            "channel": "SIP\/601-00000003",
            "uniqueid": "1730360894.5",
            "callingchannel": "SIP\/603-00000002",
            "callinguniqueid": "1730360894.4",
            "agent": "SIP\/601",
            "agentname": "601",
            "callerid": "603",
            "calleridname": "Q1",
            "callstate": "Connect",
            "context": "from-internal",
            "extension": "90",
            "priority": "31",
            "connecttime": "2024-10-31 15:48:16",
            "commpletetime": null,
            "holdtime": "2",
            "ringtime": "2",
            "talktime": "0",
            "service": "1",
            "reason": ""
        }
    ]
}


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

28.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-10-31	畅信达	信创改造

29 查询短信发件箱记录数

文件路径: webservice2/getsendsmscount.php

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

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

29.1 功能描述

查询短信发件箱记录数，用于分页。

29.2 请求参数

参数名	类型	必填	说明
insert_dates	string	否	记录写入日期开始(如:2015-01-01或2015-01-01 01:22:25)
insert_datee	string	否	记录写入日期结束(如:2015-01-01或2015-01-01 01:22:25)
processed_dates	string	否	处理日期开始(如:2015-01-01或2015-01-01 01:22:25)
processed_datee	string	否	处理日期结束(如:2015-01-01或2015-01-01 01:22:25)
number	string	否	手机号码
id	string	否	ID
idcmp	string	否	ID比较方法(e/g/l 等于/大于/小于)
text	string	否	内容（模糊匹配）
processed	string	否	处理状态(枚举类型0/1/2/-1)
app_id	string	否	应用ID(预留字段)
app_user	string	否	应用用户名(预留字段)
app_flag	string	否	应用标志(预留字段)

29.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

29.4 修订历史

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

30 查询CTI事件列表

文件路径: webservice2/getevents.php

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

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

30.1 功能描述

从状态机数据库查询CTI事件列表，最多返回满足条件的5条记录

30.2 请求参数

参数名	类型	必填	说明
event	string	是	事件名称
id	string	否	事件ID（大于等于此ID）

30.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "id": "9197",
            "timestamp": "2024-11-04 17:11:00",
            "event": "ExtensionStatus",
            "content": "Event: ExtensionStatus\nPrivilege: call,all\nTimestamp: 1730711460\nExten: 601\nContext: ext-local\nHint: SIP\/601\nStatus: 8\nStatusText: Ringing\n"
        },
        {
            "id": "9190",
            "timestamp": "2024-11-04 17:11:00",
            "event": "ExtensionStatus",
            "content": "Event: ExtensionStatus\nPrivilege: call,all\nTimestamp: 1730711460\nExten: 603\nContext: ext-local\nHint: SIP\/603\nStatus: 1\nStatusText: InUse\n"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

30.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

31 通过CTI取消询问转接

文件路径: webservice2/cticancelatxfer.php

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

版本: 1.0.0 最后更新: 2025-03-03

31.1 功能描述

通过CTI取消询问转接。

31.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道。

31.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通过CTI取消询问转接成功",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1201,
    "message": "执行通过CTI取消询问转接失败",
    "data": []
}

31.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

32 设置队列成员的ringinuse值

文件路径: webservice2/ctiqueuememberringinuse.php

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

版本: 1.0.0 最后更新: 2024-10-24

32.1 功能描述

此操作设置队列成员的ringinuse值，开启设置后队列会将来电分配给正在通话的座席。

32.2 请求参数

参数名	类型	必填	说明
interface	string	是	座席接口(如SIP/601)
queue	string	否	队列号码
ringinuse	string	否	是否启用振铃正在通话座席（枚举类型）,默认有效

32.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "设置队列成员的ringinuse值成功: Interface ringinuse set successfully",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1291,
    "message": "设置队列成员的ringinuse值失败: 'RingInUse' parameter must be a truth value (yes\/no, on\/off, 0\/1, etc)",
    "data": []
}

32.4 修订历史

版本	日期	作者	说明
1.0.0	2024-10-24	畅信达	信创改造，新增接口

33 查询来电弹屏数据

文件路径: webservice2/getpopupscreen.php

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

版本: 1.0.2 最后更新: 2024-11-14

33.1 功能描述

查询来电弹屏数据。

33.2 请求参数

参数名	类型	必填	说明
channel	string	否	设备拨号接口（如: SIP/601）
withdetail	string	否	需通道详细信息(枚举类型) ,传入channel参数时有效，开启时消耗资源较多，默认否。

33.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "channel": "SIP\/602-00000068",
            "uniqueid": "1731573219.193",
            "callerid": "603",
            "miscdata": "SIP\/603-00000067",
            "miscuniqueid": "1731573219.192",
            "direct": "IN",
            "state": "Ringing",
            "dialstring": "602",
            "queuenum": "",
            "did": "",
            "agentno": "",
            "holdtime": "0",
            "ivridhist": "",
            "ivrhist": "",
            "calldata": "",
            "calleridname": "",
            "dstchannel": "SIP\/603-00000067",
            "dstuniqueid": "1731573219.192",
            "monitorfile": "",
            "dialednum": ""
        }
    ]
}


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

33.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-09-28	畅信达	增加缓存功能
1.0.2	2024-11-14	畅信达	信创改造

34 直接转接(盲转)

文件路径: webservice2/ctiredirect.php

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

版本: 1.0.2 最后更新: 2024-10-27

34.1 功能描述

此操作可将1个或2个活动通话通道转接到各自的目的号码。常用转接示例: 1.转IVR时 $context=ivrID(见平台语音导航配置) $exten=s $priority=1 2.转队列时 $context=ext-queues $exten=队列号 $priority=1 3.转电子传真 $context=ext-fax $exten=s $priority=1 4.转客户应用 $context=custom-客户应用名称 $exten=s $priority=1 4.转电话号码 $context=from-internal(或其它拨号授权) $exten=号码 $priority=1

34.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
exten	string	是	号码(通常是目标号码或s)
context	string	是	入口(通常是from-internal或应用入口)
priority	string	是	序号(通常是1)
extrachannel	string	否	第二活动通道
extracontext	string	否	第二入口
extraexten	string	否	第二号码
extrapriority	string	否	第二序号

34.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "盲转成功： Redirect successful",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1231,
    "message": "盲转失败： Channel does not exist: SIP\/603-00000001",
    "data": []
}

34.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-01-07	畅信达	根据V5cti接口修改Redirect参数
1.0.2	2024-10-27	畅信达	信创改造

35 增加呼出白名单列表

文件路径: webservice2/addroutewhitelist.php

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

版本: 1.0.1 最后更新: 2024-10-23

35.1 功能描述

将电话号码增加到呼出白名单。 *

35.2 请求参数

参数名	类型	必填	说明
extension	string	是	电话号码
reason	string	否	原因
isvalid	string	否	是否有效（枚举类型）,默认有效

35.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "添加 10010 到呼出白名单成功.",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9008,
    "message": "号码 10010 已经存在",
    "data": []
}

35.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新增接口
1.0.1	2024-10-23	畅信达	信创改造

36 获取座席通话情况统计

文件路径: webservice2/report/getusercallsum.php

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

版本: 1.0.1 最后更新: 2024-12-06

36.1 功能描述

获取座席通话情况统计，支持分页。

36.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
agentno	string	否	分机号
direct	string	否	呼叫方向(枚举类型:IN/OUT/INOUT/INNER)
history	string	否	查询历史数据库记录(枚举类型: 0/1)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认agentno
sens	string	否	排序方法(asc/desc),默认desc

36.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "agentno": "610",
            "callsum": "1",
            "totaltalktime": "13"
        },
        {
            "agentno": "602",
            "callsum": "6",
            "totaltalktime": "46"
        }
    ]
}

36.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-06	畅信达	信创改造。

37 获取指定队列明细

文件路径: webservice2/report/getqueuecallrptdetail.php

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

版本: 1.0.1 最后更新: 2024-12-04

37.1 功能描述

获取指定队列明细。

37.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
history	string	否	查询历史数据库记录(枚举类型: 0/1)
queueno	string	否	队列号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认eventtime
sens	string	否	排序方法(asc/desc),默认desc

37.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": 86,
    "data": [
        {
            "eventtime": "2024-12-02 17:57:46",
            "queuename": "90",
            "caller": "603",
            "dialstatus": "ENTERQUEUE",
            "uniqueid": "1733133466.39"
        },
        {
            "eventtime": "2024-12-02 16:17:02",
            "queuename": "90",
            "caller": "603",
            "dialstatus": "ENTERQUEUE",
            "uniqueid": "1733127422.36"
        }
    ]
}

37.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-05	畅信达	信创改造。

38 查询通话话单记录列表（简化版）

文件路径: webservice2/report/getcdrsimple.php

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

版本: 1.0.1 最后更新: 2024-12-04

38.1 功能描述

查询通话话单记录列表（简化版）。成功时message字段返回总记录数（可用于分页），失败时返回描述。注意：设置onlymonitor有效时，需要比对录音文件是否存在，因此查询效率较低，同时message字段返回的总记录数也会忽略onlymonitor条件，因此使用message字段作为分页总记录数时，不要使用onlymonitor查询条件。

38.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
caller	string	否	主叫号码
callee	string	否	被叫号码
agentno	string	否	坐席工号（如果传了坐席工号，则按照被叫号码为坐席工号精确查询，并且主叫号码模糊查询，或者主叫号码为坐席工号并且精确查询，被叫号码模糊匹配来进行查询，）
number	string	否	电话号码串（逗号分隔，匹配主叫和被叫号码）
disposition	string	否	呼叫状态（枚举类型: ANSWERED/FAILED/NO ANSWER/BUSY）
direct	string	否	呼叫方向(枚举类型:IN/OUT/INOUT/INNER)
lastdialstatus	string	否	二次拨号结果(枚举类型: 0/1/2)
onlymonitor	string	否	只需要有录音记录(枚举类型0/1),效率较低，默认0
history	string	否	查询历史数据库记录(枚举类型: 0/1)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认calldate
sens	string	否	排序方法(asc/desc),默认desc

38.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "6",
    "data": [
        {
            "newcalldate": "6",
            "yeardate": "2024",
            "timesum": "147",
            "callscount": "25",
            "avgtime": "6"
        },
        {
            "newcalldate": "7",
            "yeardate": "2024",
            "timesum": "16051",
            "callscount": "580",
            "avgtime": "28"
        }
    ]
}

38.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

39 获取队列话务量比较记录

文件路径: webservice2/report/getqueuecallcmp.php

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

版本: 1.0.1 最后更新: 2024-12-04

39.1 功能描述

获取队列话务量比较记录。

39.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
history	string	否	查询历史数据库记录(枚举类型: 0/1)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认calldatehour
sens	string	否	排序方法(asc/desc),默认desc

39.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "queuename": "90",
            "totalcalls": "86",
            "answeredcalls": "25",
            "callerexit": "68",
            "calltimeout": "0",
            "othexit": "0",
            "maxholdtime": "27",
            "talktime": "243",
            "callerhangups": "16",
            "agenthangups": "7",
            "agenttrans": "2",
            "ansrate": "29.07",
            "avgtalktime": "10",
            "avgholdtime": "3",
            "avgringtime": "1"
        }
    ]
}

39.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

40 获取区域年话务量报表

文件路径: webservice2/report/getareayearreport.php

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

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

40.1 功能描述

获取区域年话务量报表

40.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
areacode	string	否	区号(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

40.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024",
            "pbxid": 1,
            "areacode": "0532",
            "incomingcalls": 3,
            "incominganswered": 1,
            "incomingbillsecs": 5,
            "incomingavgbillsecs": 5,
            "incomingmaxbillsecs": 5,
            "incomingrate": 33.33,
            "incomingqueues": 0,
            "incomingivrs": 0,
            "incomingextensions": 1
        }
    ]
}


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

40.4 修订历史

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

41 获取坐席日话务量报表

文件路径: webservice2/report/getagentdayreport.php

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

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

41.1 功能描述

获取坐席日话务量报表

41.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
agentno	string	否	坐席号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

41.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024-12-02",
            "agentno": "601",
            "pbxid": 0,
            "incomingcalls": 9,
            "incallanswered": 9,
            "outboundcalls": 0,
            "outcallanswered": 0,
            "transfercalls": 1,
            "agenthangup": 2,
            "callerhangup": 6,
            "pickupcalls": 0,
            "outboundbillsecs": 0,
            "incomingbillsecs": 93,
            "ringsecs": 10,
            "holdsecs": 11,
            "maxoutboundbillsec": 0,
            "maxincomingbillsec": 49,
            "onlineduration": 0,
            "logintimes": 0,
            "pauseduration": 0,
            "unpauseduration": 0,
            "pausetimes": 0,
            "wrappedsecs": 0,
            "othworksecs": 0,
            "ringnoanswer": 0,
            "qmcounts": 2,
            "qmscore": 2,
            "musicholdsecs": 9,
            "musicholdcounts": 2,
            "maxmusicholdsec": 7,
            "incominganswerrate": 100,
            "outboundansweredrate": 0,
            "outboundavg": 0,
            "incomingavg": 10,
            "ringavg": 1,
            "holdavg": 1,
            "occupancyrate": 0,
            "musicholdavg": 5,
            "qmresult": 100
        }
    ]
}


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

41.4 修订历史

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

42 获取平台年话务量报表

文件路径: webservice2/report/getplatformyearreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

42.1 功能描述

获取平台年话务量报表

42.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

42.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "4",
    "data": [
        {
            "rptdate": "2024",
            "pbxid": 1,
            "incomingcalls": 1,
            "incominganswered": 0,
            "incomingbillsecs": 0,
            "incomingavgbillsecs": 0,
            "incomingmaxbillsecs": 0,
            "incomingrate": 0,
            "incomingivrs": 0,
            "incomingextensions": 0,
            "incomingqueues": 0,
            "outboundcalls": 0,
            "outboundanswered": 0,
            "outboundrate": 0,
            "outboundnationalcalls": 0,
            "outboundnationalanswered": 0,
            "outboundnationalbillsecs": 0,
            "outboundnationalavgbillsecs": 0,
            "outboundinternationalcalls": 0,
            "outboundinternationalanswered": 0,
            "outboundinternationalbillsecs": 0,
            "outboundinternationalavgbillsecs": 0,
            "outboundbillsecs": 0,
            "outboundavgbillsecs": 0,
            "outboundmaxbillsecs": 0,
            "internalcalls": 3,
            "internalanswered": 3,
            "internalbillsecs": 27,
            "internalavgbillsecs": 9,
            "internalmaxbillsecs": 10
        }
    ]
}

42.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

43 获取队列年话务量报表

文件路径: webservice2/report/getqueueyearreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

43.1 功能描述

获取队列年话务量报表

43.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
queue	string	否	队列号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

43.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024",
            "queue": "90",
            "pbxid": 0,
            "queuecalls": 86,
            "agentcalls": 70,
            "agentanswered": 25,
            "noanswerdcalls": 45,
            "timeoutcalls": 0,
            "abandancalls": 68,
            "otherbadcalls": 0,
            "answeredin5": 22,
            "answeredin10": 1,
            "answeredin15": 0,
            "answeredin20": 0,
            "answeredin30": 0,
            "answeredinup30": 0,
            "answeredholdtime": 68,
            "abandanholdtime": 974,
            "maxholdtime": 27,
            "qmcounts": 5,
            "qmscore": 5,
            "billsecs": 243,
            "queuerate": 29.07,
            "agentrate": 35.71,
            "avgbillsecs": 10,
            "avgansweredholdtime": 3,
            "avgabandanholdtime": 1432.35,
            "qmresult": 100
        }
    ]
}

43.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

44 维护MVB2000平台基本信息

文件路径: webservice2/report/pbxconfig.php

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

版本: 1.0.1 最后更新: 2024-12-06

44.1 功能描述

维护MVB2000平台基本信息。

44.2 请求参数

参数名	类型	必填	说明
item	string	是	动作(枚举类型:add/delete/update/find)
pbxid	string	否	平台ID
pbxname	string	否	平台名称
remark	string	否	备注

44.3 响应示例


xxxxxxxxxx
{
    "errcode": 9009,
    "message": "无效的动作 test。",
    "data": []
}

44.4 修订历史

版本	日期	作者	说明
1.0.0	2016-08-08	畅信达	新建
1.0.1	2024-12-06	畅信达	信创改造，取消base64输入

45 获取平台周话务量报表

文件路径: webservice2/report/getplatformweekreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

45.1 功能描述

获取平台周话务量报表

45.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

45.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "4",
    "data": [
        {
            "rptdate": "2024-12-01",
            "pbxid": 1,
            "incomingcalls": 1,
            "incominganswered": 0,
            "incomingbillsecs": 0,
            "incomingavgbillsecs": 0,
            "incomingmaxbillsecs": 0,
            "incomingrate": 0,
            "incomingivrs": 0,
            "incomingextensions": 0,
            "incomingqueues": 0,
            "outboundcalls": 0,
            "outboundanswered": 0,
            "outboundrate": 0,
            "outboundnationalcalls": 0,
            "outboundnationalanswered": 0,
            "outboundnationalbillsecs": 0,
            "outboundnationalavgbillsecs": 0,
            "outboundinternationalcalls": 0,
            "outboundinternationalanswered": 0,
            "outboundinternationalbillsecs": 0,
            "outboundinternationalavgbillsecs": 0,
            "outboundbillsecs": 0,
            "outboundavgbillsecs": 0,
            "outboundmaxbillsecs": 0,
            "internalcalls": 3,
            "internalanswered": 3,
            "internalbillsecs": 27,
            "internalavgbillsecs": 9,
            "internalmaxbillsecs": 10
        }
    ]
}

45.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

46 获取坐席月话务量报表

文件路径: webservice2/report/getagentmonthreport.php

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

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

46.1 功能描述

获取坐席月话务量报表

46.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
agentno	string	否	坐席号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

46.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "12",
    "data": [
        {
            "rptdate": "2024-12",
            "agentno": "601",
            "pbxid": 0,
            "incomingcalls": 9,
            "incallanswered": 9,
            "outboundcalls": 0,
            "outcallanswered": 0,
            "transfercalls": 1,
            "agenthangup": 2,
            "callerhangup": 6,
            "pickupcalls": 0,
            "outboundbillsecs": 0,
            "incomingbillsecs": 93,
            "ringsecs": 10,
            "holdsecs": 11,
            "maxoutboundbillsec": 0,
            "maxincomingbillsec": 49,
            "onlineduration": 0,
            "logintimes": 0,
            "pauseduration": 0,
            "unpauseduration": 0,
            "pausetimes": 0,
            "wrappedsecs": 0,
            "othworksecs": 0,
            "ringnoanswer": 0,
            "qmcounts": 2,
            "qmscore": 2,
            "musicholdsecs": 9,
            "musicholdcounts": 2,
            "maxmusicholdsec": 7,
            "incominganswerrate": 100,
            "outboundansweredrate": 0,
            "outboundavg": 0,
            "incomingavg": 10,
            "ringavg": 1,
            "holdavg": 1,
            "occupancyrate": 0,
            "musicholdavg": 5,
            "qmresult": 100
        }
    ]
}


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

46.4 修订历史

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

47 获取坐席代接的明细

文件路径: webservice2/report/getagentpickuprptdetail.php

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

版本: 1.0.1 最后更新: 2024-12-04

47.1 功能描述

获取坐席代接的明细。

47.2 请求参数

参数名	类型	必填	说明
agentno	string	是	坐席号码
calldate1	string	是	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期(如:2015-01-01或2015-01-01 01:22:25)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认createtime
sens	string	否	排序方法(asc/desc),默认asc

47.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "total": 1,
    "data": [
        {
            "createtime": "2024-10-29 15:48:38",
            "caller": "601",
            "callee": "602",
            "pickup": "602",
            "billsecs": "8"
        }
    ]
}


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

47.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

48 呼损记录报表

文件路径: webservice2/report/getbadcallreport.php

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

版本: 1.0.1 最后更新: 2024-12-04

48.1 功能描述

呼损记录报表，可生成按日、月、队列、处理标志统计的报表。

48.2 请求参数

参数名	类型	必填	说明
createtime1	string	否	记录时间起始(如:2015-01-01或2015-01-01 01:22:25)
createtime2	string	否	记录时间结束(如:2015-01-01或2015-01-01 01:22:25)
processtime1	string	否	处置时间开始(如:2015-01-01或2015-01-01 01:22:25)
processtime2	string	否	处置时间结束(如:2015-01-01或2015-01-01 01:22:25)
reporttype	string	否	统计项目(枚举类型：d/m/q/p 日/月/队列/处理标志)
queue	string	否	队列号码
processflag	string	否	处置标记
processapp	string	否	处置应用
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认item
sens	string	否	排序方法(asc/desc),默认desc

48.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "item": "2024-11",
            "callcount": "3",
            "waittime_sum": "17",
            "waittime_avg": "6",
            "times_sum": "3",
            "times_avg": "1"
        }
    ]
}

48.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

49 获取坐席年话务量报表

文件路径: webservice2/report/getagentyearreport.php

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

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

49.1 功能描述

获取坐席年话务量报表

49.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始月份(如:2015-01)
rptdate2	string	否	开始月份(如:2015-01)
agentno	string	否	坐席号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

49.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024",
            "agentno": "601",
            "pbxid": 0,
            "incomingcalls": 67,
            "incallanswered": 24,
            "outboundcalls": 54,
            "outcallanswered": 29,
            "transfercalls": 2,
            "agenthangup": 6,
            "callerhangup": 16,
            "pickupcalls": 1,
            "outboundbillsecs": 300,
            "incomingbillsecs": 228,
            "ringsecs": 34,
            "holdsecs": 61,
            "maxoutboundbillsec": 38,
            "maxincomingbillsec": 49,
            "onlineduration": 0,
            "logintimes": 0,
            "pauseduration": 51,
            "unpauseduration": 0,
            "pausetimes": 1,
            "wrappedsecs": 0,
            "othworksecs": 0,
            "ringnoanswer": 43,
            "qmcounts": 5,
            "qmscore": 5,
            "musicholdsecs": 15,
            "musicholdcounts": 5,
            "maxmusicholdsec": 7,
            "incominganswerrate": 35.82,
            "outboundansweredrate": 53.7,
            "outboundavg": 10,
            "incomingavg": 10,
            "ringavg": 1,
            "holdavg": 3,
            "occupancyrate": 0,
            "musicholdavg": 3,
            "qmresult": 100
        }
    ]
}


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

49.4 修订历史

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

50 获取通话月流量

文件路径: webservice2/report/getcallmonth.php

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

版本: 1.0.1 最后更新: 2024-12-04

50.1 功能描述

获取通话月流量。

50.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
disposition	string	否	呼叫状态（枚举类型: ANSWERED/FAILED/NO ANSWER/BUSY）
lastdialstatus	string	否	二次拨号结果(枚举类型: 0/1/2)，查询效率较低
history	string	否	查询历史数据库记录(枚举类型: 0/1)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认newcalldate
sens	string	否	排序方法(asc/desc),默认desc

50.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "6",
    "data": [
        {
            "newcalldate": "6",
            "yeardate": "2024",
            "timesum": "147",
            "callscount": "25",
            "avgtime": "6"
        },
        {
            "newcalldate": "7",
            "yeardate": "2024",
            "timesum": "16051",
            "callscount": "580",
            "avgtime": "28"
        }
    ]
}

50.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

51 获取坐席示忙示闲明细

文件路径: webservice2/report/getagentpauserptdetail.php

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

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

51.1 功能描述

获取坐席示忙示闲明细，获取坐席示忙次数、示闲时长、示忙时长的明细示忙动作值范围： 0 示闲小于60 普通示忙大于等于60 并小于90 其它工作示忙等于99 事后处理示忙

51.2 请求参数

参数名	类型	必填	说明
agentno	string	是	坐席号码
calldate1	string	是	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期(如:2015-01-01或2015-01-01 01:22:25)
flag	string	否	查询类型（枚举类型： pauseduration/unpauseduration/pausetimes/wrappedsecs/othworksecs）
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认eventtime
sens	string	否	排序方法(asc/desc),默认asc

51.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "33",
    "total": 33,
    "data": [
        {
            "eventtime": "2024-12-04 09:59:50",
            "agentno": "603",
            "queuename": "91",
            "dialstatus": "UNPAUSE",
            "actiontime": "33",
            "actiontype": "1"
        },
        {
            "eventtime": "2024-12-04 09:59:17",
            "agentno": "603",
            "queuename": "91",
            "dialstatus": "PAUSE",
            "actiontime": "3110",
            "actiontype": "1"
        }
    ]
}


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

51.4 修订历史

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

52 获取坐席在线明细报表

文件路径: webservice2/report/getagentonlinerptdetail.php

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

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

52.1 功能描述

获取坐席在线明细报表，获取坐席上线次数、在线时长的明细。

52.2 请求参数

参数名	类型	必填	说明
agentno	string	是	坐席号码
calldate1	string	是	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期(如:2015-01-01或2015-01-01 01:22:25)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认eventtime
sens	string	否	排序方法(asc/desc),默认asc

52.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "31",
    "total": 31,
    "data": [
        {
            "eventtime": "2024-12-04 09:07:27",
            "agentno": "603",
            "queuename": "91",
            "dialstatus": "LOGIN",
            "onlinetime": ""
        },
        {
            "eventtime": "2024-11-25 14:13:58",
            "agentno": "603",
            "queuename": "91",
            "dialstatus": "LOGOFF",
            "onlinetime": "592"
        }
    ]
}


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

52.4 修订历史

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

53 获取队列日话务量报表

文件路径: webservice2/report/getqueuedayreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

53.1 功能描述

获取队列日话务量报表

53.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
queue	string	否	队列号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

53.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024-12-02",
            "queue": "90",
            "pbxid": 0,
            "queuecalls": 9,
            "agentcalls": 9,
            "agentanswered": 9,
            "noanswerdcalls": 0,
            "timeoutcalls": 0,
            "abandancalls": 0,
            "otherbadcalls": 0,
            "answeredin5": 9,
            "answeredin10": 0,
            "answeredin15": 0,
            "answeredin20": 0,
            "answeredin30": 0,
            "answeredinup30": 0,
            "answeredholdtime": 11,
            "abandanholdtime": 0,
            "maxholdtime": 2,
            "qmcounts": 2,
            "qmscore": 2,
            "billsecs": 93,
            "queuerate": 100,
            "agentrate": 100,
            "avgbillsecs": 10,
            "avgansweredholdtime": 1,
            "avgabandanholdtime": 0,
            "qmresult": 100
        }
    ]
}

53.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

54 增删改查待统计坐席列表

文件路径: webservice2/report/agentlistconfig.php

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

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

54.1 功能描述

增删改查待统计坐席列表，查询座席配置列表时message字段返回总记录数（可用于分页），失败时返回描述。参数值传入"empty_string"表示空串，传入"empty_string"表示null

54.2 请求参数

参数名	类型	必填	说明
item	string	是	增删改查动作（枚举类型：add/delete/update/find/count）
pbxid	string	是	MVB2000平台编号（见全局设置-->基础参数-->节点编号）(item等于add/delete/update必须)
agentno	string	是	坐席号码(item等于add/delete/update必须)
agentname	string	否	坐席名称
remark	string	否	备注
offset	string	否	分页偏移量（item等于find有效）
rows	string	否	每页行数（item等于find有效）
sort	string	否	排序字段，默认agentno（item等于find有效）
sens	string	否	排序方法(asc/desc),默认asc（item等于find有效）

54.3 响应示例


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

54.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。agentname和remark取消base64编码，直接传值。

55 获取区域月话务量报表

文件路径: webservice2/report/getareamonthreport.php

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

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

55.1 功能描述

获取区域月话务量报表

55.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
areacode	string	否	区号(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

55.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024-12",
            "pbxid": 1,
            "areacode": "0532",
            "incomingcalls": 3,
            "incominganswered": 1,
            "incomingbillsecs": 5,
            "incomingavgbillsecs": 5,
            "incomingmaxbillsecs": 5,
            "incomingrate": 33.33,
            "incomingqueues": 0,
            "incomingivrs": 0,
            "incomingextensions": 1
        }
    ]
}


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

55.4 修订历史

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

56 获取平台日话务量报表

文件路径: webservice2/report/getplatformdayreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

56.1 功能描述

获取平台日话务量报表

56.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

56.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "4",
    "data": [
        {
            "rptdate": "2024-12-02",
            "pbxid": 1,
            "incomingcalls": 1,
            "incominganswered": 0,
            "incomingbillsecs": 0,
            "incomingavgbillsecs": 0,
            "incomingmaxbillsecs": 0,
            "incomingrate": 0,
            "incomingivrs": 0,
            "incomingextensions": 0,
            "incomingqueues": 0,
            "outboundcalls": 0,
            "outboundanswered": 0,
            "outboundrate": 0,
            "outboundnationalcalls": 0,
            "outboundnationalanswered": 0,
            "outboundnationalbillsecs": 0,
            "outboundnationalavgbillsecs": 0,
            "outboundinternationalcalls": 0,
            "outboundinternationalanswered": 0,
            "outboundinternationalbillsecs": 0,
            "outboundinternationalavgbillsecs": 0,
            "outboundbillsecs": 0,
            "outboundavgbillsecs": 0,
            "outboundmaxbillsecs": 0,
            "internalcalls": 3,
            "internalanswered": 3,
            "internalbillsecs": 27,
            "internalavgbillsecs": 9,
            "internalmaxbillsecs": 10
        }
    ]
}

56.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

57 获取平台小时话务量报表

文件路径: webservice2/report/getplatformhourreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

57.1 功能描述

获取平台小时话务量报表

57.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
rpthour1	string	否	开始小时(如:1)
rpthour2	string	否	结束小时(如:18)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

57.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "4",
    "data": [
        {
            "rptdate": "2024-12-02",
            "pbxid": 1,
            "rpthour": 14,
            "incomingcalls": 1,
            "incominganswered": 0,
            "incomingbillsecs": 0,
            "incomingavgbillsecs": 0,
            "incomingmaxbillsecs": 0,
            "incomingrate": 0,
            "incomingivrs": 0,
            "incomingextensions": 0,
            "incomingqueues": 0,
            "outboundcalls": 0,
            "outboundanswered": 0,
            "outboundrate": 0,
            "outboundnationalcalls": 0,
            "outboundnationalanswered": 0,
            "outboundnationalbillsecs": 0,
            "outboundnationalavgbillsecs": 0,
            "outboundinternationalcalls": 0,
            "outboundinternationalanswered": 0,
            "outboundinternationalbillsecs": 0,
            "outboundinternationalavgbillsecs": 0,
            "outboundbillsecs": 0,
            "outboundavgbillsecs": 0,
            "outboundmaxbillsecs": 0,
            "internalcalls": 3,
            "internalanswered": 3,
            "internalbillsecs": 27,
            "internalavgbillsecs": 9,
            "internalmaxbillsecs": 10
        }
    ]
}

57.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

58 获取队列指定项目明细

文件路径: webservice2/report/getqueuerptdetail.php

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

版本: 1.0.1 最后更新: 2024-12-06

58.1 功能描述

获取队列指定项目明细，支持分页。

58.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
queueno	string	是	队列号
flag	string	否	查询类型(枚举类型：agentcalls/agentanswered/noanswerdcalls/ringcanceldcalls/ringnoanswercalls/agentdumpcalls/answeredin5/answeredin10/answeredin15/answeredin20/answeredin30/answeredholdtime/abandancalls/abandancalls/timeoutcalls/otherbadcalls/billsecs)
history	string	否	查询历史数据库记录(枚举类型: 0/1)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认eventtime
sens	string	否	排序方法(asc/desc),默认desc

58.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": 28,
    "data": [
        {
            "eventtime": "2024-12-02 17:57:56",
            "agentno": "601",
            "queuename": "90",
            "dialstatus": "BLINDTRANSFER",
            "uniqueid": "1733133466.39",
            "caller": "603",
            "billsecs": "9"
        }
    ]
}

58.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-06	畅信达	信创改造。

59 获取区域日话务量报表

文件路径: webservice2/report/getareadayreport.php

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

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

59.1 功能描述

获取区域日话务量报表

59.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
areacode	string	否	区号(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

59.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024-12-02",
            "pbxid": 1,
            "areacode": "0532",
            "incomingcalls": 3,
            "incominganswered": 1,
            "incomingbillsecs": 5,
            "incomingavgbillsecs": 5,
            "incomingmaxbillsecs": 5,
            "incomingrate": 33.33,
            "incomingqueues": 0,
            "incomingivrs": 0,
            "incomingextensions": 1
        }
    ]
}


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

59.4 修订历史

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

60 获取通话日流量

文件路径: webservice2/report/getcallday.php

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

版本: 1.0.1 最后更新: 2024-12-04

60.1 功能描述

获取通话日流量。

60.2 请求参数

参数名	类型	必填	说明
calldate	string	是	呼叫日期或日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldatehour	string	否	小时，按照具体的小时进行统计
disposition	string	否	呼叫状态（枚举类型: ANSWERED/FAILED/NO ANSWER/BUSY）
lastdialstatus	string	否	二次拨号结果(枚举类型: 0/1/2)
history	string	否	查询历史数据库记录(枚举类型: 0/1)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认calldatehour
sens	string	否	排序方法(asc/desc),默认desc

60.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "4",
    "data": [
        {
            "calldatehour": "14",
            "timesum": "27",
            "callscount": "4",
            "avgtime": "7"
        },
        {
            "calldatehour": "15",
            "timesum": "27",
            "callscount": "5",
            "avgtime": "5"
        }
    ]
}

60.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

61 获取平台月话务量报表

文件路径: webservice2/report/getplatformmonthreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

61.1 功能描述

获取平台月话务量报表

61.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

61.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "4",
    "data": [
        {
            "rptdate": "2024-12",
            "pbxid": 1,
            "incomingcalls": 1,
            "incominganswered": 0,
            "incomingbillsecs": 0,
            "incomingavgbillsecs": 0,
            "incomingmaxbillsecs": 0,
            "incomingrate": 0,
            "incomingivrs": 0,
            "incomingextensions": 0,
            "incomingqueues": 0,
            "outboundcalls": 0,
            "outboundanswered": 0,
            "outboundrate": 0,
            "outboundnationalcalls": 0,
            "outboundnationalanswered": 0,
            "outboundnationalbillsecs": 0,
            "outboundnationalavgbillsecs": 0,
            "outboundinternationalcalls": 0,
            "outboundinternationalanswered": 0,
            "outboundinternationalbillsecs": 0,
            "outboundinternationalavgbillsecs": 0,
            "outboundbillsecs": 0,
            "outboundavgbillsecs": 0,
            "outboundmaxbillsecs": 0,
            "internalcalls": 3,
            "internalanswered": 3,
            "internalbillsecs": 27,
            "internalavgbillsecs": 9,
            "internalmaxbillsecs": 10
        }
    ]
}

61.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

62 维护报表运行信息

文件路径: webservice2/report/rptcontrol.php

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

版本: 1.0.1 最后更新: 2024-12-06

62.1 功能描述

维护报表运行信息。

62.2 请求参数

参数名	类型	必填	说明
item	string	是	动作(枚举类型:add/delete/update/find)
pbxid	string	否	平台ID
rpttype	string	否	报表类型（枚举类型：platform/agent/queue/area）
rptname	string	否	报表名称
begindate	string	否	开始处理日期
enddate	string	否	截止处理日期(空表示当前日期)
enabled	string	否	是否允许(枚举类型：0/1)

62.3 响应示例


xxxxxxxxxx
{
    "errcode": 9007,
    "message": "平台ID 1，队列号 95 的记录已经存在.",
    "data": []
}

62.4 修订历史

版本	日期	作者	说明
1.0.0	2016-08-08	畅信达	新建
1.0.1	2024-12-06	畅信达	信创改造，取消base64输入

63 获取坐席呼入话务明细

文件路径: webservice2/report/getagentcallrptdetail.php

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

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

63.1 功能描述

获取坐席呼入话务明细，获取坐席呼入量，呼入接通量，呼入接通时长（与呼入接通量相同），坐席拆线，用户拆线，振铃时长，排队时长，振铃放弃数，转接的明细

63.2 请求参数

参数名	类型	必填	说明
agentno	string	是	坐席号码
calldate1	string	是	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期(如:2015-01-01或2015-01-01 01:22:25)
flag	string	否	查询类型（枚举类型： incomingcalls/incallanswered/agenthangup/callerhangup/transfercalls/ringsecs/holdsecs/ringnoanswer/incomingbillsecs）
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认eventtime
sens	string	否	排序方法(asc/desc),默认asc

63.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "17",
    "total": 17,
    "data": [
        {
            "eventtime": "2024-07-19 14:00:34",
            "agentno": "601",
            "queuename": "90",
            "dialstatus": "COMPLETECALLER",
            "uniqueid": "1721368823.175",
            "caller": "603",
            "billsecs": "9"
        }
    ]
}


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

63.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-11-26	畅信达	信创改造。agentname和remark取消base64编码，直接传值。

64 获取队列周话务量报表

文件路径: webservice2/report/getqueueweekreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

64.1 功能描述

获取队列周话务量报表

64.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
queue	string	否	队列号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

64.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024-12-01",
            "queue": "90",
            "pbxid": 0,
            "queuecalls": 9,
            "agentcalls": 9,
            "agentanswered": 9,
            "noanswerdcalls": 0,
            "timeoutcalls": 0,
            "abandancalls": 0,
            "otherbadcalls": 0,
            "answeredin5": 9,
            "answeredin10": 0,
            "answeredin15": 0,
            "answeredin20": 0,
            "answeredin30": 0,
            "answeredinup30": 0,
            "answeredholdtime": 11,
            "abandanholdtime": 0,
            "maxholdtime": 2,
            "qmcounts": 2,
            "qmscore": 2,
            "billsecs": 93,
            "queuerate": 100,
            "agentrate": 100,
            "avgbillsecs": 10,
            "avgansweredholdtime": 1,
            "avgabandanholdtime": 0,
            "qmresult": 100
        }
    ]
}

64.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

65 查询队列记录总数

文件路径: webservice2/report/getqueuecallcount.php

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

版本: 1.0.1 最后更新: 2024-12-04

65.1 功能描述

查询队列记录总数。

65.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
history	string	否	查询历史数据库记录(枚举类型: 0/1)
queuename	string	否	队列号
queueevent	string	否	状态

65.3 响应示例


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

65.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

66 获取坐席质检的明细

文件路径: webservice2/report/getagentqmrrptdetail.php

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

版本: 1.0.1 最后更新: 2024-12-04

66.1 功能描述

获取坐席质检的明细。

66.2 请求参数

参数名	类型	必填	说明
agentno	string	是	坐席号码
calldate1	string	是	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期(如:2015-01-01或2015-01-01 01:22:25)
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认calltime
sens	string	否	排序方法(asc/desc),默认desc

66.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "9",
    "total": 9,
    "data": [
        {
            "queuename": "90",
            "caller": "603",
            "agentno": "601",
            "calltime": "2024-12-02 16:17:07",
            "selkey": "2",
            "uniqueid": "1733127422.36",
            "score": "1"
        },
        {
            "queuename": "90",
            "caller": "603",
            "agentno": "601",
            "calltime": "2024-12-02 14:02:42",
            "selkey": "2",
            "uniqueid": "1733119350.8",
            "score": "1"
        }
    ]
}

66.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

67 维护质检按键分值

文件路径: webservice2/report/qmrconfig.php

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

版本: 1.0.1 最后更新: 2024-12-06

67.1 功能描述

维护质检按键分值。

67.2 请求参数

参数名	类型	必填	说明
item	string	是	动作(枚举类型:update/find)
inputkey	string	是	按键
score	string	否	分值
remark	string	否	备注

67.3 响应示例


xxxxxxxxxx
{
    "errcode": 9009,
    "message": "无效的动作 test。",
    "data": []
}

67.4 修订历史

版本	日期	作者	说明
1.0.0	2016-08-08	畅信达	新建
1.0.1	2024-12-06	畅信达	信创改造，取消base64输入

68 查询通话话单记录数（简化版）

文件路径: webservice2/report/getcdrcountsimple.php

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

版本: 1.0.1 最后更新: 2024-12-04

68.1 功能描述

查询通话话单记录数（简化版）。

68.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
caller	string	否	主叫号码
callee	string	否	被叫号码
agentno	string	否	坐席工号（如果传了坐席工号，则按照被叫号码为坐席工号精确查询，并且主叫号码模糊查询，或者主叫号码为坐席工号并且精确查询，被叫号码模糊匹配来进行查询，）
number	string	否	电话号码串（逗号分隔，匹配主叫和被叫号码）
disposition	string	否	呼叫状态（枚举类型: ANSWERED/FAILED/NO ANSWER/BUSY）
direct	string	否	呼叫方向(枚举类型:IN/OUT/INOUT/INNER)
lastdialstatus	string	否	二次拨号结果(枚举类型: 0/1/2)
history	string	否	查询历史数据库记录(枚举类型: 0/1)

68.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "6",
    "data": [
        {
            "newcalldate": "6",
            "yeardate": "2024",
            "timesum": "147",
            "callscount": "25",
            "avgtime": "6"
        },
        {
            "newcalldate": "7",
            "yeardate": "2024",
            "timesum": "16051",
            "callscount": "580",
            "avgtime": "28"
        }
    ]
}

68.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。

69 获取区域周话务量报表

文件路径: webservice2/report/getareaweekreport.php

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

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

69.1 功能描述

获取区域周话务量报表

69.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
areacode	string	否	区号(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

69.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024-12-01",
            "pbxid": 1,
            "areacode": "0532",
            "incomingcalls": 3,
            "incominganswered": 1,
            "incomingbillsecs": 5,
            "incomingavgbillsecs": 5,
            "incomingmaxbillsecs": 5,
            "incomingrate": 33.33,
            "incomingqueues": 0,
            "incomingivrs": 0,
            "incomingextensions": 1
        }
    ]
}


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

69.4 修订历史

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

70 获取坐席周话务量报表

文件路径: webservice2/report/getagentweekreport.php

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

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

70.1 功能描述

获取坐席周话务量报表

70.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
agentno	string	否	坐席号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

70.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "49",
    "data": [
        {
            "rptdate": "2024-08-04",
            "agentno": "601",
            "pbxid": 0,
            "incomingcalls": 36,
            "incallanswered": 6,
            "outboundcalls": 11,
            "outcallanswered": 0,
            "transfercalls": 0,
            "agenthangup": 3,
            "callerhangup": 3,
            "pickupcalls": 0,
            "outboundbillsecs": 0,
            "incomingbillsecs": 34,
            "ringsecs": 8,
            "holdsecs": 11,
            "maxoutboundbillsec": 0,
            "maxincomingbillsec": 19,
            "onlineduration": 0,
            "logintimes": 0,
            "pauseduration": 0,
            "unpauseduration": 0,
            "pausetimes": 0,
            "wrappedsecs": 0,
            "othworksecs": 0,
            "ringnoanswer": 30,
            "qmcounts": 2,
            "qmscore": 2,
            "musicholdsecs": 0,
            "musicholdcounts": 0,
            "maxmusicholdsec": 0,
            "incominganswerrate": 16.67,
            "outboundansweredrate": 0,
            "outboundavg": 0,
            "incomingavg": 6,
            "ringavg": 1,
            "holdavg": 2,
            "occupancyrate": 0,
            "musicholdavg": 0,
            "qmresult": 100
        }
    ]
}


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

70.4 修订历史

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

71 获取队列小时话务量报表

文件路径: webservice2/report/getqueuehourreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

71.1 功能描述

获取坐席日话务量报表

71.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
rpthour1	string	否	开始小时(如:1)
rpthour2	string	否	结束小时(如:18)
queue	string	否	队列号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

71.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "4",
    "data": [
        {
            "rptdate": "2024-12-02",
            "queue": "90",
            "rpthour": 14,
            "pbxid": 0,
            "queuecalls": 1,
            "agentcalls": 1,
            "agentanswered": 1,
            "noanswerdcalls": 0,
            "timeoutcalls": 0,
            "abandancalls": 0,
            "otherbadcalls": 0,
            "answeredin5": 1,
            "answeredin10": 0,
            "answeredin15": 0,
            "answeredin20": 0,
            "answeredin30": 0,
            "answeredinup30": 0,
            "answeredholdtime": 1,
            "abandanholdtime": 0,
            "maxholdtime": 1,
            "qmcounts": 1,
            "qmscore": 1,
            "billsecs": 9,
            "queuerate": 100,
            "agentrate": 100,
            "avgbillsecs": 9,
            "avgansweredholdtime": 1,
            "avgabandanholdtime": 0,
            "qmresult": 100
        }
    ]
}

71.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

72 获取队列月话务量报表

文件路径: webservice2/report/getqueuemonthreport.php

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

版本: 1.0.1 最后更新: 2024-12-03

72.1 功能描述

获取队列月话务量报表

72.2 请求参数

参数名	类型	必填	说明
rptdate1	string	是	开始日期(如:2015-01-01)
rptdate2	string	否	结束日期(如:2015-01-01)
queue	string	否	队列号码(逗号分隔输入多个值)
pbxid	string	否	平台编号
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认rptdate
sens	string	否	排序方法(asc/desc),默认asc

72.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "rptdate": "2024-12",
            "queue": "90",
            "pbxid": 0,
            "queuecalls": 9,
            "agentcalls": 9,
            "agentanswered": 9,
            "noanswerdcalls": 0,
            "timeoutcalls": 0,
            "abandancalls": 0,
            "otherbadcalls": 0,
            "answeredin5": 9,
            "answeredin10": 0,
            "answeredin15": 0,
            "answeredin20": 0,
            "answeredin30": 0,
            "answeredinup30": 0,
            "answeredholdtime": 11,
            "abandanholdtime": 0,
            "maxholdtime": 2,
            "qmcounts": 2,
            "qmscore": 2,
            "billsecs": 93,
            "queuerate": 100,
            "agentrate": 100,
            "avgbillsecs": 10,
            "avgansweredholdtime": 1,
            "avgabandanholdtime": 0,
            "qmresult": 100
        }
    ]
}

72.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-03	畅信达	信创改造。

73 维护参与统计队列

文件路径: webservice2/report/queuelistconfig.php

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

版本: 1.0.1 最后更新: 2024-12-06

73.1 功能描述

维护参与统计队列。

73.2 请求参数

参数名	类型	必填	说明
item	string	是	动作(枚举类型:add/delete/update/find)
pbxid	string	否	平台ID
queueno	string	否	队列号码
queuename	string	否	队列名称
remark	string	否	备注

73.3 响应示例


xxxxxxxxxx
{
    "errcode": 9007,
    "message": "平台ID 1，队列号 95 的记录已经存在.",
    "data": []
}

73.4 修订历史

版本	日期	作者	说明
1.0.0	2016-08-08	畅信达	新建
1.0.1	2024-12-06	畅信达	信创改造，取消base64输入

74 获取队列记录明细

文件路径: webservice2/report/getqueuecalldetail.php

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

版本: 1.0.1 最后更新: 2024-12-04

74.1 功能描述

获取队列记录明细，成功时message字段返回总记录数（可用于分页），失败时返回描述。

74.2 请求参数

参数名	类型	必填	说明
calldate1	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期时间(如:2015-01-01或2015-01-01 01:22:25)
history	string	否	查询历史数据库记录(枚举类型: 0/1)
queuename	string	否	队列号，多个可用逗号分隔
queueevent	string	否	状态，多个可用逗号分隔
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认eventtime
sens	string	否	排序方法(asc/desc),默认desc

74.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "366",
    "data": [
        {
            "eventtime": "2024-07-02 16:40:47",
            "callid": "1719909644.82",
            "queuename": "90",
            "queuestart": "1719909647",
            "agent": "NONE",
            "agentno": "NONE",
            "event": "ENTERQUEUE",
            "arg1": "",
            "arg2": "603",
            "arg3": "1",
            "arg4": ""
        }
    ]
}

74.4 修订历史

版本	日期	作者	说明
1.0.0	2016-07-29	畅信达	新建
1.0.1	2024-12-04	畅信达	信创改造。
1.0.2	2025-04-15	畅信达	队列和事件支持逗号分隔的多个值

75 获取坐席呼出话务明细

文件路径: webservice2/report/getagentcdrrptdetail.php

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

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

75.1 功能描述

获取坐席呼出话务明细，获取坐席呼出、呼出接通量、呼出时长（返回接通与呼出接通量相同）的明细

75.2 请求参数

参数名	类型	必填	说明
agentno	string	是	坐席号码
calldate1	string	是	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	是	结束日期(如:2015-01-01或2015-01-01 01:22:25)
flag	string	否	查询类型（枚举类型： outboundcalls/outcallanswered/outboundbillsecs）
offset	string	否	分页偏移量
rows	string	否	每页行数
sort	string	否	排序字段，默认calldate
sens	string	否	排序方法(asc/desc),默认asc

75.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "54",
    "total": 54,
    "data": [
        {
            "calldate": "2024-08-05 10:44:25",
            "areacode": "0532",
            "caller": "601",
            "callee": "10086",
            "dnid": "10086",
            "duration": "3",
            "billsec": "0",
            "uniqueid": "1722825865.18",
            "direct": "OUT",
            "disposition": "NO ANSWER",
            "dialstatus": "CANCEL",
            "userfield": "DIALSTATUS:CANCEL^"
        }
    ]
}


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

75.4 修订历史

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

76 查询活动通道

文件路径: webservice2/getchannel.php

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

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

76.1 功能描述

从状态机数据库查询当前活动通话通道。

76.2 请求参数

参数名	类型	必填	说明
channel	string	否	活动通道（向右模糊匹配）
refchannel	string	否	关联活动通道（向右模糊匹配，或者关系）

76.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-04 16:21:10",
            "channel": "SIP\/601-0000002a",
            "readformat": "alaw",
            "writeformat": "",
            "rawreadformat": "alaw",
            "rawwriteformat": "",
            "state": "Up",
            "statecode": "6",
            "callerid": "601",
            "calleridname": "预设",
            "uniqueid": "1730708470.76",
            "callingpres": "",
            "cause": "0",
            "causetxt": "",
            "musichold": "",
            "hold": "0",
            "application": "",
            "appdata": "",
            "lastevent": "Newstate",
            "refchannel": "SIP\/603-00000029",
            "refuniqueid": "1730708470.75",
            "refcallerid": "603",
            "refcalleridname": "预设",
            "refcallingpres": "",
            "hanguptime": null,
            "from_status": "0",
            "clearflag": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

76.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2017-11-24	畅信达	增加clearflag查询条件
1.0.2	2024-11-04	畅信达	信创改造

77 重置队列统计信息

文件路径: webservice2/ctiqueuereset.php

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

版本: 1.0.0 最后更新: 2024-10-24

77.1 功能描述

此操作重置队列统计信息，常用于座席交接班重新开始统计队列摘要。

77.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码

77.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "重置队列统计信息成功: Queue stats reset successfully",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1462,
    "message": "重置队列统计信息失败: ",
    "data": []
}

77.4 修订历史

版本	日期	作者	说明
1.0.0	2024-10-24	畅信达	信创改造

78 删除呼出黑名单列表

文件路径: webservice2/deleterouteblacklist.php

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

版本: 1.0.1 最后更新: 2024-10-23

78.1 功能描述

根据电话号码删除呼出黑名单列表

78.2 请求参数

参数名	类型	必填	说明
extension	string	是	电话号码

78.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "删除呼出黑名单号码 10010 成功！",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9007,
    "message": "呼出黑名单号码 10010 不存在",
    "data": []
}

78.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新增接口
1.0.1	2024-10-23	畅信达	信创改造

79 查询语音文件内容

文件路径: webservice2/getrecordingstext.php

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

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

79.1 功能描述

查询语音文件内容，支持查询逗号分隔的多个文件。

79.2 请求参数

参数名	类型	必填	说明
voiceid	string	是	语音编号，支持逗号分隔的多个值

79.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "voiceid": "mvb2000info",
            "description": "  此平台是我公司自主研发的具有划时代意义的融合通信系统。该系统采用了最新的IP内核一体化设计，具备大容量的电话呼入\/呼出处理与管理能力、实现传统大型商用PBX的全部功能，同时还提供了传统PBX所不具备的IVR自动应答、ACD话务分配、话务排队、通话录音、CTI计算机电话集成、视频通话、电子传真、电话会议、语音信箱、通话统计分析等高端系统功能。\r\n  平台采用高度集成的一体化语音交换设计，从系统运行的稳定性、可扩充性以及造价方面对比传统的计算机语音板卡方案、交换机方案，都有着巨大的优势。平台设计具备良好的技术前瞻性，在运营商IMS语音接入、SIP语音呼叫、远程管理等方面已全面支持IPv6协议。\r\n  平台内置丰富的二次开发接口，满足客户方业务系统的系统集成要求，实现强大的增值功能。平台支持国际标准的MRCP接口，可扩展智能语音导航、智能机器人客服等智能化应用。"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

79.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-21	畅信达	信创改造

80 查询传真收件箱记录数

文件路径: webservice2/getfaxrecvlogcount.php

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

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

80.1 功能描述

查询传真收件箱记录数,用于分页。

80.2 请求参数

参数名	类型	必填	说明
rcvtime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
rcvtime2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
callerid	string	否	主叫号码
did	string	否	原被叫
appflag1	string	否	应用标记1
appflag2	string	否	应用标记2
faxuser	string	否	分机用户
result	string	否	结果（枚举类型SUCCESS/FAILED）
dirmark	string	否	目录分类（枚举类型new/archive/trash）
alreadyread	string	否	是否已读（枚举类型0/1），默认0

80.3 响应示例


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


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

80.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-06	畅信达	信创改造

81 查询质检记录总数

文件路径: webservice2/getqmrcount.php

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

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

81.1 功能描述

查询质检记录总数。

81.2 请求参数

参数名	类型	必填	说明
calltime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calltime2	string	否	结束时间(如:2015-01-01或2015-01-01 01:22:25)
uniqueid	string	否	呼叫编号
phonenumber	string	是	号码
queuenum	string	否	队列号
agentno	string	否	坐席工号
selkey	string	否	按键(-1表示挂机)

81.3 响应示例


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


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

81.4 修订历史

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

82 查询智能客服机器人列表

文件路径: webservice2/getnlprobotlist.php

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

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

82.1 功能描述

查询智能客服机器人列表。

82.2 请求参数

参数名	类型	必填	说明

82.3 响应示例


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


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

82.4 修订历史

版本	日期	作者	说明
1.0.0	2023-07-28	畅信达	新建
1.0.1	2024-11-14	畅信达	信创改造

83 按条件获取呼入黑名单

文件路径: webservice2/getblacklist.php

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

版本: 1.0.3 最后更新: 2024-10-27

83.1 功能描述

此操作可将通过指定搜索条件获取呼入黑名单结果集。

83.2 请求参数

参数名	类型	必填	说明
phone	string	否	电话号码
precise	string	否	是否模糊匹配号码（枚举类型），默认是
name	string	否	名称
isvalid	string	否	是否有效（枚举类型）
sens	string	否	排序字段,默认id
sort	string	否	排序方法（枚举类型），默认降序
offset	int	否	分页-记录偏移量比如：1000 表示从1000行开始返回
rows	int	否	分页-返回行数比如： 100 表示返回100行

83.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "total": 1,
    "data": [
        {
            "id": "49",
            "blacklistname": "test",
            "extension": "10010",
            "reason": null,
            "isvalid": "1"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

83.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-07-16	畅信达	可根据 isvalid 查询
1.0.2	2024-07-19	畅信达	添加precise参数指定号码精确查找
1.0.3	2024-10-27	畅信达	信创改造
1.0.4	2025-04-08	畅信达	修复模糊查询参数错误

84 查询队列成员列表

文件路径: webservice2/getqueuemember.php

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

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

84.1 功能描述

查询队列日志记录列表，成功时message字段返回总记录数（可用于分页），失败时返回描述。

84.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码
agentname	string	否	坐席工号

84.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-15 16:27:10",
            "queue": "90",
            "agent": "SIP\/601",
            "agentname": "601",
            "agentship": "static",
            "penalty": "0",
            "ringinuse": "0",
            "wrapuptime": "0",
            "callstaken": "0",
            "lastcall": null,
            "status": "1",
            "paused": "0",
            "reason": "",
            "pausedtime": null
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

84.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-21	畅信达	信创改造

85 查询分机禁止呼入（免打扰）设置

文件路径: webservice2/ctigetdnd.php

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

版本: 1.0.1 最后更新: 2024-10-27

85.1 功能描述

此操作可查询分机禁止呼入（免打扰）设置

85.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码

85.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

85.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

86 下载传真文件

文件路径: webservice2/getfax.php

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

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

86.1 功能描述

根据传真文件名称下载传真。

86.2 请求参数

参数名	类型	必填	说明
filename	string	是	传真文件名称(不含路径，如1606198761.32.tif)

86.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "device": "601",
            "interface": "SIP\/601",
            "context": "from-internal",
            "devicetype": "fixed"
        }
    ]
}


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

86.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

87 坐席下线

文件路径: webservice2/ctiqueueremove.php

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

版本: 1.0.1 最后更新: 2024-10-24

87.1 功能描述

此操作将座席移出指定队列

87.2 请求参数

参数名	类型	必填	说明
queue	string	是	队列号码
interface	string	是	坐席拨号接口(如:SIP/601)

87.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "座席下线成功: Removed interface from queue",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1291,
    "message": "座席下线失败: Unable to remove interface: Not there",
    "data": []
}

87.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-24	畅信达	信创改造

88 查询用户号码列表

文件路径: webservice2/getusers.php

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

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

88.1 功能描述

查询用户号码列表。

88.2 请求参数

参数名	类型	必填	说明
user	string	否	用户号码

88.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "userno": "601",
            "username": "预设",
            "cnname": "预设",
            "voicemail": "default",
            "ringtimer": "0",
            "recording": null,
            "outboundcid": "",
            "directdid": "",
            "musichold": "default"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

88.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新建
1.0.1	2024-11-21	畅信达	信创改造

89 通过CTI取消锁定会议桥

文件路径: webservice2/cticonfbridgeunlock.php

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

版本: 1.0.0 最后更新: 2025-03-03

89.1 功能描述

通过CTI取消锁定会议桥。

89.2 请求参数

参数名	类型	必填	说明
conference	string	是	会议桥

89.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通过CTI取消锁定会议桥成功：Conference unlocked",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1201,
    "message": "执行通过CTI取消锁定会议桥失败",
    "data": []
}

89.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

90 查询队列日志记录列表

文件路径: webservice2/getqueueloglist.php

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

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

90.1 功能描述

查询队列日志记录列表，成功时message字段返回总记录数（可用于分页），失败时返回描述。

90.2 请求参数

参数名	类型	必填	说明
eventtime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
eventtime2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
event	string	否	事件名称
uniqueid	string	否	呼叫编号
queuename	string	否	队列名称
agent	string	否	座席拨号接口（向右模糊匹配）
agentno	string	否	工号
history	string	否	查询历史数据库记录(枚举类型0/1)，默认0
sort	string	否	排序字段(默认：eventtime)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认0)
rows	string	否	记录数

90.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "315",
    "data": [
        {
            "eventtime": "2024-11-15 10:35:07",
            "callid": "1731638100.211",
            "queuename": "91",
            "queuestart": "1731638100",
            "agent": "NONE",
            "agentno": "NONE",
            "event": "ABANDON",
            "arg1": "1",
            "arg2": "1",
            "arg3": "7",
            "arg4": "",
            "arg5": ""
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

90.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-15	畅信达	信创改造，去掉了结果集中多余的result节点。

91 查询传真收件箱

文件路径: webservice2/getfaxrecvlog.php

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

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

91.1 功能描述

从状态机数据库查询传真收件箱。成功时message字段返回总记录数（可用于分页），失败时返回描述。

91.2 请求参数

参数名	类型	必填	说明
rcvtime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
rcvtime2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
callerid	string	否	主叫号码
did	string	否	原被叫
appflag1	string	否	应用标记1
appflag2	string	否	应用标记2
faxuser	string	否	分机用户
result	string	否	结果（枚举类型SUCCESS/FAILED）
dirmark	string	否	目录分类（枚举类型new/archive/trash）
alreadyread	string	否	是否已读（枚举类型0/1），默认0
sort	string	否	排序字段（默认createtime）
sens	string	否	排序方式（desc/asc 默认desc）
offset	string	否	偏移量（默认0）
rows	string	否	记录数

91.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "id": "20",
            "createtime": "2024-11-06 15:16:29",
            "channel": "SIP\/v5168-00000037",
            "exten": "s",
            "uniqueid": "1730877332.97",
            "callerid": "4000820188",
            "destnumber": "",
            "remotestationid": "ipxchina",
            "localstationid": "PBXV5",
            "pagestransferred": "4",
            "resolution": "8031x7700",
            "transferrate": "14400",
            "duration": "57",
            "mode": "audio",
            "result": "成功",
            "resultstr": "OK",
            "error": "",
            "faxuser": "601",
            "filename": "\/var\/spool\/asterisk\/fax\/inbox\/1730877332.97.tif",
            "alreadyread": "1",
            "dirmark": "new",
            "trashtime": null,
            "appflag1": null,
            "appflag2": null,
            "remark": null
        }
    ]
}


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

91.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-06	畅信达	信创改造

92 查询CTI接口发起的异步呼叫结果

文件路径: webservice2/getasyncdialresponse.php

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

版本: 1.0.1 最后更新: 2024-10-29

92.1 功能描述

通过接口查询ctioriginate.php接口发起的异步拨号结果。调用originate方法，使用异步拨号方式时，系统会生成结果记录，在originate方法中可以指定呼叫编号和事务ID，然后使用这些参数查询拨号结果。

92.2 请求参数

参数名	类型	必填	说明
actionid	string	是	事务ID（拨号时传入的actionid参数）
channel	string	是	通道（拨号时传入的channel参数）(模糊左匹配)
response	string	否	拨号响应（枚举类型Success/Failure）
exten	string	否	被叫号码（拨号时传入的exten参数）
uniqueid	string	否	呼叫编号（拨号时传入的channelid参数）
reason	int	否	拨号失败原因（枚举类型0/1/3/4/5/8）
calleridnum	string	否	主叫号码（拨号时传入的callerid参数的号码部分）

92.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "createtime": "2024-10-29 11:37:52",
            "channel": "SIP\/602",
            "response": "Failure",
            "actionid": "phpcti-10.1.0.2-20241029033750",
            "exten": "601",
            "context": "from-internal",
            "uniqueid": "sys2024102911400001",
            "application": "",
            "data": "",
            "reason": "5",
            "calleridnum": "602",
            "calleridname": "<unknown>"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = 9ca3d73a-5777-4222-8afe-bf9f932f3649, Database Error code: 42S02\/0, Please search webcti.log by infoid for details.",
    "data": []
}

92.4 修订历史

版本	日期	作者	说明
1.0.0	2023/12/28	畅信达	新建
1.0.1	2024-10-29	畅信达	信创改造

93 按代码执行快捷键

文件路径: webservice2/ctifeaturecode.php

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

版本: 1.0.1 最后更新: 2024-10-27

93.1 功能描述

此操作可在电话终端通话期间触发快捷键，在主被叫通道发起语音流程。通常用于通话过程中获取来电者的输入、密码验证或者座席向来电者播放语音信息。

93.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
code	string	是	快捷键代码(对应管理界面的【快捷按键】)

93.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "通过编码执行快捷键成功: Feature code successfully queued",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1071,
    "message": "通过编码执行快捷键失败: Channel specified does not exist",
    "data": []
}

93.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

94 取语音信箱留言数量

文件路径: webservice2/ctimailboxcount.php

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

版本: 1.0.1 最后更新: 2024-10-27

94.1 功能描述

此操取指定语音信箱新留言和旧留言的数量。

94.2 请求参数

参数名	类型	必填	说明
mailbox	string	是	语音信箱号码

94.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI取语音信箱留言数量指令成功：Mailbox Message Count",
    "data": [
        {
            "mailbox": "601",
            "oldmessages": "0",
            "newmessages": "1"
        }
    ]
}


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

94.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

95 修改排队者优先级

文件路径: webservice2/ctiqueuecallerpriority.php

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

版本: 1.0.1 最后更新: 2024-10-24

95.1 功能描述

此操作修改排队者优先级，用于排队位置，使重要客户优先得到服务

95.2 请求参数

参数名	类型	必填	说明
queue	string	是	队列号码
caller	string	是	来电者活动通道（如SIP/603-0000000e）
priority	string	是	优先级（值越大优先级越高，排队位置越靠前支持负数）

95.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "修改排队者优先级成功: Priority change for caller on queue",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1291,
    "message": "修改排队者优先级失败: Unable to change priority caller on queue: No such caller",
    "data": []
}

95.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-24	畅信达	信创改造

96 查询全部驻留列表

文件路径: webservice2/getparkedcall.php

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

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

96.1 功能描述

查询全部驻留列表。结果集字段state(GiveUp/UnParked/TimeOut 放弃/取出/超时)

96.2 请求参数

参数名	类型	必填	说明

96.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-14 15:38:09",
            "exten": "701",
            "channel": "SIP\/601-0000005f",
            "uniqueid": "1731569879.178",
            "srcchannel": "SIP\/603-0000005e",
            "timeout": "120",
            "duration": "0",
            "callerid": "601",
            "calleridname": "预设",
            "state": "Parked",
            "parkedtime": "2024-11-14 15:38:07",
            "giveuptime": null,
            "timeouttime": null,
            "unparkedtime": null
        }
    ]
}


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

96.4 修订历史

版本	日期	作者	说明
1.0.0	2023-07-28	畅信达	新建
1.0.1	2024-11-14	畅信达	信创改造

97 通过CTI静音会议桥成员

文件路径: webservice2/cticonfbridgemute.php

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

版本: 1.0.0 最后更新: 2025-03-03

97.1 功能描述

通过CTI静音会议桥成员。

97.2 请求参数

参数名	类型	必填	说明
conference	string	是	会议桥
channel	string	否	活动通道，支持按前缀匹配。

97.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通过CTI静音会议桥成员成功：User muted",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1201,
    "message": "执行通过CTI静音会议桥成员失败",
    "data": []
}

97.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

98 获取呼损记录数

文件路径: webservice2/getbadcallcount.php

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

版本: 1.0.1 最后更新: 2024-10-31

98.1 功能描述

根据条件查询呼损记录总数，用于分页。

98.2 请求参数

参数名	类型	必填	说明
createtime1	string	否	记录时间起始(如:2015-01-01或2015-01-01 01:22:25)
createtime2	string	否	记录时间结束(如:2015-01-02或2015-01-02 10:22:25)
processtime1	string	否	处置时间起始(如:2015-01-02或2015-01-02 10:22:25)
processtime2	string	否	处置时间结束(如:2015-01-02或2015-01-02 10:22:25)
processflag	string	否	处理标志
processapp	string	否	应用程序名,如R3
callerid	string	否	主叫号码
queue	string	否	队列号码
uniqueid	string	否	呼叫编号

98.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "result": 2
        }
    ]
}


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

98.4 修订历史

版本	日期	作者	说明
1.0.0	2015-06-25	畅信达	新建
1.0.1	2024-10-31	畅信达	信创改造

99 从状态机数据库查询设备状态

文件路径: webservice2/getextensionstatus.php

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

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

99.1 功能描述

从状态机数据库查询设备状态。

99.2 请求参数

参数名	类型	必填	说明
exten	string	否	设备号

99.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-01 14:53:41",
            "exten": "601",
            "channel": "SIP\/601",
            "hint": "SIP\/601",
            "context": "ext-local",
            "status": "0",
            "statustext": "Idle",
            "ts": "2024-11-04 17:11:58.317674",
            "statustime": "2024-11-04 17:11:58"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

99.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造
1.0.2	2025-01-27	畅信达	支持逗号分隔的多个分机

100 记录亿联话机动作

文件路径: webservice2/setphoneaction.php

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

版本: 1.0.2 最后更新: 2024-11-22

100.1 功能描述

记录亿联话机动作（仅供系统内部使用）。

100.2 请求参数

参数名	类型	必填	说明
device	string	是	设备号
action	string	是	动作

100.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "INBOX\/1730267105-00000000 已更新！",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 0,
    "message": "设备 610 没有绑定用户号！",
    "data": []
}

100.4 修订历史

版本	日期	作者	说明
1.0.0	2022-06-25	畅信达	新建
1.0.1	2024-11-22	畅信达	信创改造

101 查询磁盘空间列表

文件路径: webservice2/getdiskinfo.php

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

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

101.1 功能描述

从状态机数据库查询磁盘空间列表。

101.2 请求参数

参数名	类型	必填	说明

101.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "3",
    "data": [
        {
            "createtime": "2024-11-04 16:58:45",
            "filesystem": "\/dev\/mapper\/klas-root",
            "type": "xfs",
            "size": "245G",
            "used": "54G",
            "avail": "192G",
            "usedper": "22%",
            "mountedon": "\/"
        },
        {
            "createtime": "2024-11-04 16:58:45",
            "filesystem": "\/dev\/sda1",
            "type": "xfs",
            "size": "1014M",
            "used": "290M",
            "avail": "725M",
            "usedper": "29%",
            "mountedon": "\/boot"
        },
        {
            "createtime": "2024-11-04 16:58:45",
            "filesystem": "\/dev\/mapper\/klas-backup",
            "type": "xfs",
            "size": "50G",
            "used": "390M",
            "avail": "50G",
            "usedper": "1%",
            "mountedon": "\/backup"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

101.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

102 通过数据库查询会议桥列表

文件路径: webservice2/getconfbridgelistrooms.php

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

版本: 1.0.0 最后更新: 2025-03-03

102.1 功能描述

通过数据库查询会议桥列表。 *

102.2 请求参数

参数名	类型	必填	说明
conference	string	否	会议桥名称。
starttime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
starttime2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
accountcode	string	否	计费账号。
initiator	string	否	发起者号码。
isactive	string	否	是否活动(1/0)。
history	string	否	是否查询历史数据(1/0)。
sort	string	否	排序字段（默认starttime）
sens	string	否	排序方式（desc/asc 默认desc）
offset	string	否	偏移量（默认0）
rows	string	否	记录数

102.3 响应示例


xxxxxxxxxx
{
    "errcode": 1472,
    "message": "通过数据库查询会议桥列表失败",
    "data": []
}

102.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

103 获取短信发件箱统计信息

文件路径: webservice2/getsendsmsstat.php

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

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

103.1 功能描述

获取短信发件箱统计信息。

103.2 请求参数

参数名	类型	必填	说明
insert_dates	string	否	记录写入日期开始(如:2015-01-01或2015-01-01 01:22:25)
insert_datee	string	否	记录写入日期结束(如:2015-01-01或2015-01-01 01:22:25)
processed_dates	string	否	处理日期开始(如:2015-01-01或2015-01-01 01:22:25)
processed_datee	string	否	处理日期结束(如:2015-01-01或2015-01-01 01:22:25)
text	string	否	内容（模糊匹配）
processed	string	否	处理状态(预留字段)
app_id	string	否	应用ID(预留字段)
app_user	string	否	应用用户名(预留字段)
app_flag	string	否	应用标志(预留字段)

103.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "rows": "0",
            "maxid": null,
            "minid": null,
            "maxdate": null,
            "mindate": null,
            "maxprocdate": null,
            "minprocdate": null
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

103.4 修订历史

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

104 查询语音导航按键记录总数

文件路径: webservice2/getivrlogcount.php

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

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

104.1 功能描述

查询语音导航按键记录总数。

104.2 请求参数

参数名	类型	必填	说明
ivrdate1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
ivrdate2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
ivrname	string	否	语音导航名称
uniqueid	string	否	呼叫编号
channel	string	否	活动通道
obdialid	string	否	批量外呼ID
obtaskid	string	否	批量外呼任务ID
callerid	string	否	主叫号码
funcname	string	否	按键功能

104.3 响应示例


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


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

104.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-13	畅信达	信创改造

105 根据指定uniqueueid下载录音文件

文件路径: webservice2/getmonitorbyuid.php

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

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

105.1 功能描述

根据指定uniqueueid下载录音文件，支持输出mp3格式。

105.2 请求参数

参数名	类型	必填	说明
uniqueid	string	是	呼叫编号
direct	string	否	呼叫方向
recno	string	否	录音文件编号(1个uniqueid对应多个录音文件时),默认 0
history	string	否	查询历史数据库记录（枚举类型）,默认否
mp3	string	否	提供转mp3格式功能（枚举类型）,默认否

105.3 响应示例


xxxxxxxxxx
{
    "errcode": 9003,
    "message": "文件不存在！",
    "data": []
}

105.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2015-03-19	畅信达	提供转mp3格式功能，增加条件 history 查询历史库数据(0-否 1-是)
1.0.2	2018-12-05	畅信达	增加条件direct 按照主被叫查询录音文件
1.0.3	2024-11-14	畅信达	信创改造

106 查询中继列表

文件路径: webservice2/gettrunklist.php

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

版本: 1.0.2 最后更新: 2024-11-21

106.1 功能描述

查询中继列表。

106.2 请求参数

参数名	类型	必填	说明
withdialid	string	否	是否返回拨号接口（枚举类型0/1）

106.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "trunk": "OUT_1",
            "dialid": "DAHDI\/g0",
            "channelid": "g0",
            "description": "默认"
        },
        {
            "trunk": "OUT_2",
            "dialid": "SIP\/v5168",
            "channelid": "v5168",
            "description": "test"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

106.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新建
1.0.1	2023-12-05	畅信达	增加dialid返回字段的控制开关
1.0.2	2024-11-21	畅信达	信创改造

107 添加或修改呼入黑名单（旧版）

文件路径: webservice2/ctiaddblacklist.php

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

版本: 1.0.1 最后更新: 2024-10-23

107.1 功能描述

此接口实现了将电话号码加入呼入黑名单和根据电话号码修改呼入黑名单的功能。

107.2 请求参数

参数名	类型	必填	说明
name	string	是	黑名单名称(需UTF8编码)
extension	string	是	电话号码
reason	string	否	加入原因
isvalid	string	否	是否有效（枚举类型）

107.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "添加 号码 10010 到 test 成功。",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9008,
    "message": "号码 10010 已经存在。",
    "data": []
}

107.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-23	畅信达	信创改造

108 通过数据库查询会议桥成员列表

文件路径: webservice2/getconfbridgelist.php

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

版本: 1.0.0 最后更新: 2025-03-03

108.1 功能描述

通过数据库查询会议桥成员列表。

108.2 请求参数

参数名	类型	必填	说明
bridgeuniqueid	string	是	会议桥ID。
history	string	否	是否查询历史数据(1/0)。

108.3 响应示例


xxxxxxxxxx
{
    "errcode": "9000",
    "message": "infoid = 6dc8cd3b-ab5c-4e8a-b04e-c7929152f6b6",
    "data": "[]}"
}

108.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

109 查询全部拨号权限列表

文件路径: webservice2/getdevicerules.php

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

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

109.1 功能描述

查询全部拨号权限列表。

109.2 请求参数

参数名	类型	必填	说明

109.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "rulename": "全部权限",
            "context": "from-internal"
        },
        {
            "rulename": "内线电话",
            "context": "from-internal-2"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

109.4 修订历史

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

110 根据id删除外呼日志

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

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

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

110.1 功能描述

根据id删除外呼日志。

110.2 请求参数

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

110.3 响应示例


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


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

110.4 修订历史

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

111 获取批量外呼名单表

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

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

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

111.1 功能描述

获取批量外呼名单表。

111.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

111.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": []
}

111.4 修订历史

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

112 删除特殊坐席

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

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

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

112.1 功能描述

删除特殊坐席。

112.2 请求参数

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

112.3 响应示例


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


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

112.4 修订历史

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

113 增加特殊坐席

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

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

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

113.1 功能描述

增加特殊坐席。

113.2 请求参数

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

113.3 响应示例


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


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

113.4 修订历史

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

114 重置外呼名单状态

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

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

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

114.1 功能描述

重置外呼名单状态。

114.2 请求参数

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

114.3 响应示例


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


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

114.4 修订历史

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

115 根据id删除外呼任务

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

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

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

115.1 功能描述

根据id删除外呼任务。

115.2 请求参数

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

115.3 响应示例


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


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

115.4 修订历史

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

116 修改特殊坐席分组信息

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

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

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

116.1 功能描述

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

116.2 请求参数

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

116.3 响应示例


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


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

116.4 修订历史

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

117 统计坐席外拨情况

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

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

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

117.1 功能描述

统计坐席外拨情况。

117.2 请求参数

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

117.3 响应示例


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


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

117.4 修订历史

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

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

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

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

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

118.1 功能描述

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

118.2 请求参数

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

118.3 响应示例


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


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

118.4 修订历史

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

119 删除特殊坐席分组

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

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

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

119.1 功能描述

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

119.2 请求参数

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

119.3 响应示例


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


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

119.4 修订历史

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

120 修改外呼任务信息

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

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

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

120.1 功能描述

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

120.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	否	创建人

120.3 响应示例


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


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

120.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	畅信达	信创改造，去掉默认值代码，增加使用空串和空值标志更新字段的值，不传入字段则不处理。

121 增加外呼名单

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

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

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

121.1 功能描述

增加外呼名单。

121.2 请求参数

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

121.3 响应示例


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


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

121.4 修订历史

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

122 获取批量外呼日志表

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

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

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

122.1 功能描述

获取批量外呼日志表。

122.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

122.3 响应示例


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


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

122.4 修订历史

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

123 统计外拨任务

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

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

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

123.1 功能描述

统计外拨任务。

123.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

123.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": []
}

123.4 修订历史

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

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

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

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

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

124.1 功能描述

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

124.2 请求参数

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

124.3 响应示例


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


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

124.4 修订历史

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

125 增加外呼任务特殊坐席

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

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

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

125.1 功能描述

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

125.2 请求参数

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

125.3 响应示例


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


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

125.4 修订历史

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

126 增加外呼任务

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

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

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

126.1 功能描述

增加外呼任务。

126.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	否	创建人

126.3 响应示例


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


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

126.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	畅信达	信创改造。

127 根据id删除外呼名单

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

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

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

127.1 功能描述

根据id删除外呼名单。

127.2 请求参数

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

127.3 响应示例


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


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

127.4 修订历史

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

128 获取批量外呼参数表

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

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

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

128.1 功能描述

获取批量外呼参数表。

128.2 请求参数

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

128.3 响应示例


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


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

128.4 修订历史

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

129 获取批量外呼任务表

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

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

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

129.1 功能描述

获取批量外呼任务表。

129.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

129.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": []
}

129.4 修订历史

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

130 统计外拨按键

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

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

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

130.1 功能描述

统计外拨按键。

130.2 请求参数

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

130.3 响应示例


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


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

130.4 修订历史

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

131 增加特殊坐席分组

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

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

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

131.1 功能描述

增加特殊坐席分组。

131.2 请求参数

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

131.3 响应示例


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


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

131.4 修订历史

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

132 修改参数值和描述

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

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

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

132.1 功能描述

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

132.2 请求参数

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

132.3 响应示例


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


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

132.4 修订历史

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

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

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

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

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

133.1 功能描述

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

133.2 请求参数

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

133.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": []
}

133.4 修订历史

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

134 修改外呼名单信息

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

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

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

134.1 功能描述

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

134.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	否	备注

134.3 响应示例


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


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

134.4 修订历史

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

135 修改特殊坐席信息

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

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

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

135.1 功能描述

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

135.2 请求参数

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

135.3 响应示例


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


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

135.4 修订历史

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

136 获取特殊坐席列表

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

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

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

136.1 功能描述

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

136.2 请求参数

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

136.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": []
}

136.4 修订历史

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

137 获取特殊坐席分组列表

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

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

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

137.1 功能描述

获取特殊坐席分组列表。

137.2 请求参数

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

137.3 响应示例


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


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

137.4 修订历史

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

138 统计通话时长

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

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

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

138.1 功能描述

统计通话时长。

138.2 请求参数

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

138.3 响应示例


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


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

138.4 修订历史

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

139 修改外呼任务状态

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

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

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

139.1 功能描述

修改外呼任务状态。

139.2 请求参数

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

139.3 响应示例


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


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

139.4 修订历史

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

140 修改外呼任务特殊坐席

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

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

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

140.1 功能描述

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

140.2 请求参数

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

140.3 响应示例


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


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

140.4 修订历史

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

141 查询队列信息

文件路径: webservice2/getqueue.php

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

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

141.1 功能描述

查询队列信息。

141.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码

141.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-14 17:19:00",
            "queue": "90",
            "max": "0",
            "calls": "0",
            "holdtime": "0",
            "completed": "0",
            "abandoned": "0",
            "serviceLevel": "0",
            "servicelevelperf": "0.0",
            "weight": "0"
        }
    ]
}


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

141.4 修订历史

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

142 查询终端列表

文件路径: webservice2/getpeers.php

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

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

142.1 功能描述

查询终端列表。

142.2 请求参数

参数名	类型	必填	说明
peername	string	否	终端名称

142.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-14 15:55:01",
            "channeltype": "SIP",
            "objectname": "601",
            "description": "预设",
            "chanobjectType": "peer",
            "ipaddress": "",
            "ipport": null,
            "dynamic": "yes",
            "videosupport": "yes",
            "textsupport": "no",
            "acl": "yes",
            "trunk": "no",
            "encryption": "no",
            "netstatus": "Unmonitored",
            "inboundreg": "Unmonitored",
            "outboundreg": null
        }
    ]
}


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

142.4 修订历史

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

143 查询WebRTC设备配置

文件路径: webservice2/getwebrtcdevices.php

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

版本: 1.0.2 最后更新: 2024-11-22

143.1 功能描述

查询WebRTC设备配置，设备号与密码加密返回，忽略空密码的设备。

143.2 请求参数

参数名	类型	必填	说明
deviceno	string	否	设备号码（支持逗号分隔的多个设备）
webctionly	string	否	是否仅返回webcti设备（枚举类型0/1）

143.3 响应示例


xxxxxxxxxx
{
    "errcode": "0",
    "message": "1",
    "data": "[   {",
    "connection": "{",
    "sip_server": "192.168.0.168",
    "wss_uri": "wss:",
    "port": "5060",
    "maxexpiry": "3600",
    "minexpiry": "60",
    "defaultexpiry": "120",
    "devices": "[      {",
    "deviceno": "f4ba7e8e09d910bdc471a5598e80bed9",
    "secret": "6e6af64c860fc718142473792174d4b6",
    "description": "WebRTC"
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

143.4 修订历史

版本	日期	作者	说明
1.0.0	2024-06-19	畅信达	新建
1.0.1	2024-06-27	畅信达	补充设备端口号和描述，补充全局sip端口和注册时长，仅返回webcti设备
1.0.2	2024-11-22	畅信达	信创改造

144 删除语音留言

文件路径: webservice2/deletemsg.php

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

版本: 1.0.2 最后更新: 2024-10-30

144.1 功能描述

删除指定用户语音信箱中的留言文件。

144.2 请求参数

参数名	类型	必填	说明
msgbox	string	是	语音信箱号码(如601)
msgdir	string	是	留言目录(枚举类型INBOX/Old/Work/Family/Friends)
msgfile	string	是	留言文件(如msg0000.WAV)
context	string	否	语音信箱入口(默认default)

144.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "删除语音留言 INBOX\/1721638197-00000002 成功！",
    "data": []
}


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

144.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2022-01-11	畅信达	改为从数据库删除留言增加 $context 参数
1.0.2	2024-10-30	畅信达	信创改造

145 获取指定设备信息

文件路径: webservice2/ctigetdevice.php

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

版本: 1.0.1 最后更新: 2024-10-27

145.1 功能描述

此操作可获取指定设备的类型、绑定用户号码、描述、拨号权限、拨号接口

145.2 请求参数

参数名	类型	必填	说明
device	string	是	设备号码

145.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "type": "fixed",
            "user": "601",
            "cnname": "预设",
            "context": "from-internal",
            "dial": "SIP\/601"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1141,
    "message": " 设备 6016 不存在！",
    "data": []
}

145.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

146 拨号并执行TTS语音通知调查流程(需要单独开通TTS服务软件)

文件路径: webservice2/ctioriginatetts.php

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

版本: 1.0.2 最后更新: 2024-10-27

146.1 功能描述

通过接口发起呼叫接通语音流程，将tts文本写入临时文件，然后将文件名写入通道变量，由语音流程读取进行合成播报处理。可以实现语音通知、按键获取、友情提示等功能。用户按键以后，您可以： 1、通过设置回调URL，在web服务端接收tts_call_id: TTS_CALL_ID通道变量的值原样返回、 uniqueid:呼叫编号（调用时传入或系统生成）、channel:活动通道、inputkeys:用户按键。 2、可以通过TTS_EXIT_GOTO通道变量指定一个包含用户按键的语音流程（比如IVR），根据按键自动分流呼叫。

同步和异步，同步拨号方式时接口等待被叫通道接听或超时、失败后才返回，并返回失败原因，异步拨号方式时只要呼叫指令发出就立刻返回，调用者需要通过查询进展的接口（getasyncdialresponse）获得拨号结果。
注意事项: 1、tts呼叫应使用context/exten/priority指定语音流程入口，默认custom-ttsplay/s/1 2、使用此接口时，应设置正确的callerid,MVB_CALLER、MVB_CALLEE、MVB_DIRECT变量,以确保话单生成正确。如: callerid=114 如果channel是内部终端时，设置被叫为来显号码，确保弹屏正确 callerid=8275XXXX XXXX代表具体数字，如果channel是客户电话时，设置运营商允许的号码作为来显号码 MVB_CALLER=8001|MVB_CALLEE=114|MVB_DIRECT=out 3、操作失败时，如返回结果中有Reason字段，其含义见@see ctioriginate.php
使用方法: 1、将这些通道变量设置到variable参数，可以控制语音流程行为: TTS_INPUTKEYLENGTH 允许按键长度(需要客户输入时必须设置此变量) TTS_PLAYCOUNT 循环播放次数 TTS_REPLAYKEY 重听按键 TTS_EXIT_GOTO 结束后跳转目标(context名称,比如: ivr-2) TTS_CALLBACK_URL 回调url，用于通知调用方结果: post方式提交 'tts_call_id', 'uniqueid' , 'channel' , 'inputkeys' TTS_CALL_ID 在url回调时原样返回调用方 TTS_TEXT_CHARTSET 输入文本的字符集，一般都是 utf-8 2、建立或选择一个控制语音流程客户应用（V5平台已经内置ttsplay，可直接使用），以下脚本仅供参考： [custom-myttsplay] ;TTS播放调用接口 exten => s,1,NoOp(TTS_FILE=${TTS_FILE}) ;播放完毕后,需要获取按键的位数 exten => s,n,EXECIF($["${TTS_INPUTKEYLENGTH}"=""]?Set(TTS_INPUTKEYLENGTH=0)) ;再次播放的选择按键,与TTS_INPUTKEYLENGTH设置的位数相同 exten => s,n,EXECIF($["${TTS_REPLAYKEY}"=""]?Set(TTS_REPLAYKEY=*)) ;默认播放重复几次 exten => s,n,EXECIF($["${TTS_PLAYCOUNT}"=""]?Set(TTS_PLAYCOUNT=1)) ;调用TTS转换和播放接口 exten => s,n,EXECIF($["${TTS_FILE}"!=""]?AGI(ttsplayerfile.agi,base64):AGI(ttsplayer.agi,base64)) ;用户输入的按键存放在变量TTS_INPUTKEY中 exten => s,n,Noop(${TTS_INPUTKEY}) exten => s,n,Macro(hangupcall) exten => h,1,Macro(hangupcall) 3、接口调用参数参考： context=custom-ttsplay 或 context=custom-myttsplay exten=s priority=1 variable=MVB_CALLER=8001|MVB_CALLEE=114|MVB_DIRECT=out|TTS_PLAYCOUNT=3|TTS_INPUTKEYLENGTH=1|TTS_CALLBACK_URL=http://ip/recieve_key timeout=45000 callerid=8275XXXX ttstext=utf8字符集的文字或语音文件用base64编码后用urlencode处理

146.2 请求参数

参数名	类型	必填	说明
channel	string	是	先呼叫的拨号接口(如SIP/601, SIP/gateway/114, Local/114@from-internal)，可以用于异步拨号时查询结果。
ttstext	string	是	TTS文字(base64编码,utf-8字符集,支持::分隔的2段语音)
exten	string	否	号码，默认s
context	string	否	拨号入口/拨号权限，默认custom-ttsplay
priority	string	否	流程序号(如1)，默认1
timeout	string	否	等待被叫channel接听的时间(单位毫秒),默认30000
callerid	string	否	显示的主叫号码，有效格式："名称" <号码>或者直接填号码，channel通过中继出局时必须设置合规号码，号码部分可以用于异步拨号时查询结果。
variable	string	否	通道变量(如MVB_CALLER=8001
account	string	否	计费账号
channelid	string	否	指定通道呼叫编号（UniqueId），长度不超过32个字符，系统会自动分配呼叫编号（通常是时间戳，如：1730167616.78），用户指定时要确保使用唯一的有意义的编号（如sys2024102911400001），此编号也可以用于异步拨号时查询结果。
otherchannelid	string	否	指定第二个通道呼叫编号（UniqueId）
earlymedia	string	否	是否强制在早期媒体上调用桥接功能（枚举类型0/1），默认否
codecs	string	否	指定语音编码，多个编码英文逗号分隔
actionid	string	否	事务ID，可用于异步拨号时查询拨号结果，允许字母数字下划线等字符，应尽量采用唯一的有意义的字符串作为ID。如phpcti-10.1.0.2-20241029023404
async	int	否	异步呼叫（枚举类型0/1），默认：否（同步）。设置异步时命令发送完立刻返回, 设置同步时等待channel接听才返回

146.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI拨号指令成功：Originate successfully queued",
    "data": []
}


xxxxxxxxxx
{
    "errcode": "1232",
    "message": "Originate failed",
    "data": "[   {",
    "reason": "5\"}"
}

146.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-03-31	畅信达	默认字符集设置为UTF-8，增加播放语音文件、回调url、跳转入口等功能
1.0.2	2024-10-27	畅信达	信创改造

147 从云端获取节假日

文件路径: webservice2/getholidaycloud.php

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

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

147.1 功能描述

从云端获取节假日

147.2 请求参数

参数名	类型	必填	说明
year	string	是	年份（如2024）

147.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "year": 2024,
            "description": "2024年法定节假日",
            "holidays": [
                {
                    "name": "元旦",
                    "range": "2023-12-30:2024-01-01",
                    "exclude": ""
                },
                {
                    "name": "春节",
                    "range": "2024-02-10:2024-02-17",
                    "exclude": "2024-02-04,2024-02-18"
                },
                {
                    "name": "清明节",
                    "range": "2024-04-04:2024-04-06",
                    "exclude": "2024-04-07"
                },
                {
                    "name": "劳动节",
                    "range": "2024-05-01:2024-05-05",
                    "exclude": "2024-04-28,2024-05-11"
                },
                {
                    "name": "端午节",
                    "range": "2024-06-08:2024-06-10",
                    "exclude": ""
                },
                {
                    "name": "中秋节",
                    "range": "2024-09-15:2024-09-17",
                    "exclude": "2024-09-14"
                },
                {
                    "name": "国庆节",
                    "range": "2024-10-01:2024-10-07",
                    "exclude": "2024-09-29,2024-10-12"
                }
            ],
            "成功": true,
            "message": "成功",
            "pbxServiceVersion": "1.0.0",
            "timestamp": 1730883881
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 5001,
    "message": "云端不存在2025年度的节假日数据(pbxServiceVersion: 1.0.0)",
    "data": []
}

147.4 修订历史

版本	日期	作者	说明
1.0.0	2024-08-08	畅信达	新建
1.0.1	2024-11-06	畅信达	信创改造

148 添加或修改呼入黑名单

文件路径: webservice2/addblacklist.php

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

版本: 1.0.3 最后更新: 2024-10-23

148.1 功能描述

此接口实现了将电话号码加入呼入黑名单和根据黑名单ID修改呼入黑名单的功能。这个接口与addblacklist.php接口类似，只是参数不同，请根据需要选择。

148.2 请求参数

参数名	类型	必填	说明
id	string	否	黑名单ID，传入ID为修改，否则为新建
name	string	否	黑名单名称(需UTF8编码)，不传入id时必填
extension	string	是	电话号码
reason	string	否	加入黑名单原因
isvalid	string	否	是否有效（枚举类型）,新建默认有效

148.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "添加 号码 10010 到 test 成功。",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9008,
    "message": "号码 10010 已经存在。",
    "data": []
}

148.4 修订历史

版本	日期	作者	说明
1.0.0	2016-09-06	畅信达	统一响应码和响应消息
1.0.2	2024-07-16	畅信达	可指定isvalid
1.0.3	2024-10-23	畅信达	信创改造

149 通过短信网关/接口发送短信

文件路径: webservice2/sendsms.php

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

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

149.1 功能描述

通过短信网关/接口发送短信。

149.2 请求参数

参数名	类型	必填	说明
number	string	是	手机号码（逗号分隔支持多个号码）
text	string	是	发送内容(UTF8字符集,使用base64编码)
reqdate	string	否	预约日期(如:2015-01-01)
starttime	string	否	预约开始时间(如:10:18:18)
endtime	string	否	预约结束时间如:18:18:18)
gwid	string	否	指定短信网关ID，仅使用短信网关时有效
params	string	否	参数，格式由短信网关决定，如果填写，则替换短信网关配置的参数。
app_id	string	否	应用ID(预留字段)
app_user	string	否	应用用户名(预留字段)
app_flag	string	否	应用标志(预留字段)

149.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9002,
    "message": "缺少参数 \"number\".",
    "data": []
}

149.4 修订历史

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

150 获取全部呼叫中心资源状态和弹屏数据

文件路径: webservice2/getallstatus.php

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

版本: 1.0.3 最后更新: 2025-04-07

150.1 功能描述

获取呼叫中心资源状态，包括坐席、队列、当前通话、弹屏数据、设备状态、会议、驻留等。此接口涵盖数据量比较大，调用时占用资源较多，适合第三方后台定时轮询，实现CTI数据对接，一般不应该用于座席端直接调用此接口。

150.2 请求参数

参数名	类型	必填	说明
devices	string	否	设备列表（逗号分隔）
users	string	否	用户列表（逗号分隔）
queues	string	否	队列列表（逗号分隔）
version	int	否	请求的数据版本（大于0通话记录返回号码归属地）

150.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "requesttime": "2024-11-01 05:20:50",
            "devices": [
                {
                    "device": "601",
                    "interface": "SIP\/601",
                    "devicetype": "fixed",
                    "context": "from-internal",
                    "user": "601",
                    "popupcalls": [],
                    "calls": [],
                    "status": 0
                },
                {
                    "device": "602",
                    "interface": "SIP\/602",
                    "devicetype": "fixed",
                    "context": "from-internal",
                    "user": "602",
                    "popupcalls": [
                        {
                            "channel": "SIP\/602-00000007",
                            "uniqueid": "1730438448.11",
                            "callerid": "603",
                            "refchannel": "SIP\/603-00000006",
                            "refuniqueid": "1730438448.10",
                            "direct": "IN",
                            "dialstring": null,
                            "queue": "",
                            "did": "",
                            "agentno": "",
                            "holdtime": "0",
                            "ivridhist": "",
                            "ivrhist": "",
                            "calldata": "",
                            "state": "Ringing",
                            "isdefault": "0"
                        }
                    ],
                    "calls": [
                        {
                            "createtime": "2024-11-01 13:20:48",
                            "channel": "SIP\/602-00000007",
                            "refchannel": "SIP\/603-00000006",
                            "callstate": "Dialing",
                            "callerid": "602",
                            "refcallerid": "603",
                            "channelstate": "Ringing",
                            "refchannelstate": "Ring",
                            "uniqueid": "1730438448.11",
                            "refuniqueid": "1730438448.10",
                            "dialtime": "2024-11-01 13:20:48",
                            "linktime": null,
                            "direct": "IN"
                        }
                    ],
                    "status": 8
                }
            ],
            "users": [
                {
                    "user": "601",
                    "device": ""
                },
                {
                    "user": "602",
                    "device": ""
                }
            ],
            "queues": [
                {
                    "queue": "90",
                    "members": [
                        {
                            "createtime": "2024-10-31 15:52:52",
                            "interface": "SIP\/601",
                            "agentno": "601",
                            "agenttype": "static",
                            "penalty": "0",
                            "callstaken": "2",
                            "lastcall": "2024-10-31 15:52:52",
                            "status": "1",
                            "paused": "0"
                        },
                        {
                            "createtime": "2024-11-01 13:20:48",
                            "interface": "SIP\/602",
                            "agentno": "602",
                            "agenttype": "static",
                            "penalty": "1",
                            "callstaken": "0",
                            "lastcall": null,
                            "status": "6",
                            "paused": "0"
                        }
                    ],
                    "waitingcalls": [],
                    "badcalls": 0
                },
                {
                    "queue": "91",
                    "members": [],
                    "waitingcalls": [],
                    "badcalls": 1
                }
            ],
            "conferences": [],
            "parks": [],
            "responsetime": "2024-11-01 05:20:50"
        }
    ]
}


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

150.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2022-09-28	畅信达	增加缓存功能
1.0.2	2024-10-31	畅信达	信创改造
1.0.3	2025-04-07	畅信达	修复get_ctival相关bug

151 查询紧急呼叫列表

文件路径: webservice2/geturgentcalls.php

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

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

151.1 功能描述

查询紧急呼叫列表，成功时message字段返回总记录数（可用于分页），失败时返回描述。

151.2 请求参数

参数名	类型	必填	说明
id	string	否	ID
calldates	string	否	日期时间开始(如:2015-01-01或2015-01-01 01:22:25)
calldatee	string	否	日期时间结束(如:2015-01-01或2015-01-01 01:22:25)
dnid	string	否	被叫号码
flag	string	否	数值型应用标志(预留字段)
appflag	string	否	字符型应用标志(预留字段)
sort	string	否	排序字段(默认id)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认：0)
rows	string	否	记录数

151.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "id": "1",
            "calldate": "2024-11-21 17:30:07",
            "calleridnum": "602",
            "channel": "SIP\/602-000000c2",
            "uniqueid": "1732181405.510",
            "dnid": "s",
            "flag": "0",
            "appflag": "",
            "remark": ""
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

151.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新建
1.0.1	2024-11-21	畅信达	信创改造

152 查询系统录音模块上传的语音文件列表

文件路径: webservice2/getrecordings.php

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

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

152.1 功能描述

查询系统录音模块上传的语音文件列表。

152.2 请求参数

参数名	类型	必填	说明

152.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "id": "55",
            "filename": "custom\/mvb2000info",
            "description": "  此平台是我公司自主研发的具有划时代意义的融合通信系统。该系统采用了最新的IP内核一体化设计，具备大容量的电话呼入\/呼出处理与管理能力、实现传统大型商用PBX的全部功能，同时还提供了传统PBX所不具备的IVR自动应答、ACD话务分配、话务排队、通话录音、CTI计算机电话集成、视频通话、电子传真、电话会议、语音信箱、通话统计分析等高端系统功能。\r\n  平台采用高度集成的一体化语音交换设计，从系统运行的稳定性、可扩充性以及造价方面对比传统的计算机语音板卡方案、交换机方案，都有着巨大的优势。平台设计具备良好的技术前瞻性，在运营商IMS语音接入、SIP语音呼叫、远程管理等方面已全面支持IPv6协议。\r\n  平台内置丰富的二次开发接口，满足客户方业务系统的系统集成要求，实现强大的增值功能。平台支持国际标准的MRCP接口，可扩展智能语音导航、智能机器人客服等智能化应用。"
        },
        {
            "id": "58",
            "filename": "custom\/pls-stay-on-line",
            "description": "请不要挂机"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

152.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-21	畅信达	信创改造

153 根据指定uniqueueid获取录音文件列表

文件路径: webservice2/getmonitornums.php

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

版本: 1.0.2 最后更新: 2024-11-14

153.1 功能描述

根据指定uniqueueid获取录音文件列表，当一个呼叫编号对应多个录音文件时，可以根据返回的文件编号选择下载需要的录音。@see getmonitorbyuid.php

153.2 请求参数

参数名	类型	必填	说明
uniqueid	string	是	呼叫编号
history	string	否	查询历史数据库记录（枚举类型）,默认否

153.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "fileid": 0,
            "filename": "2024\/10\/31\/queue_603_601_20241031-155245_1730361165.7.WAV"
        }
    ]
}


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

153.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2015-03-19	畅信达	增加条件 history 查询历史库数据(0-否 1-是)
1.0.2	2024-11-14	畅信达	信创改造

154 拨号

文件路径: webservice2/ctioriginate.php

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

版本: 1.0.2 最后更新: 2024-10-27

154.1 功能描述

通过接口发起2个目的端的呼叫，并将之接通。目的可以是内线和外线电话号码、语音导航、队列、自定义入口等。拨号动作分同步和异步，同步拨号方式时接口等待被叫通道接听或超时、失败后才返回，并返回失败原因，异步拨号方式时只要呼叫指令发出就立刻返回，调用者需要通过查询进展的接口（getasyncdialresponse）获得拨号结果。使用注意事项: 1、application和data配合使用, exten、context、priority配合使用,以上2种配合 2者选1，不能同时使用，设置了application和data就不能设置exten、context、priority,反之亦然。 2、使用此接口时，应设置正确的callerid、MVB_CALLER、MVB_CALLEE、MVB_DIRECT变量,以确保话单生成正确。如: callerid=114。如果channel是内部终端时，设置被叫为来显号码，确保弹屏正确，如callerid=8275XXXX XXXX代表具体数字，如果channel是客户电话时，应设置运营商允许的号码作为来显号码。其他变量示例：MVB_CALLER=8001|MVB_CALLEE=114|MVB_DIRECT=out 3、使用异步呼叫时，可以调用getasyncdialresponse.php接口传入exten、channelid、channel、callerid、actionid、响应等查询拨号结果。

同步方式返回的拨号失败原因: 0 失败 1 已挂机 HANGUP 3 振铃但无应答 RINGING 4 已摘机 ANSWER 5 正忙 BUSY 8 阻塞 CONGESTION

154.2 请求参数

参数名	类型	必填	说明
channel	string	是	先呼叫的拨号接口(如SIP/601, SIP/gateway/114, Local/114@from-internal)，可以用于异步拨号时查询结果。
exten	string	否	号码，此号码可以用于异步拨号时查询结果。
context	string	否	拨号入口/拨号权限，设置exten时必须
priority	string	否	流程序号(如1)，设置exten时必须
application	string	否	应用名称(如Playback)
data	string	否	传递给应用的数据(如2000
timeout	string	否	等待被叫channel接听的时间(单位毫秒),默认30000
callerid	string	否	显示的主叫号码，有效格式："名称" <号码>或者直接填号码，channel通过中继出局时必须设置合规号码，号码部分可以用于异步拨号时查询结果。
variable	string	否	通道变量(如MVB_CALLER=8001
account	string	否	计费账号
channelid	string	否	指定通道呼叫编号（UniqueId），长度不超过32个字符，系统会自动分配呼叫编号（通常是时间戳，如：1730167616.78），用户指定时要确保使用唯一的有意义的编号（如sys2024102911400001），此编号也可以用于异步拨号时查询结果。
otherchannelid	string	否	指定第二个通道呼叫编号（UniqueId）
earlymedia	string	否	是否强制在早期媒体上调用桥接功能（枚举类型0/1），默认否
codecs	string	否	指定语音编码，多个编码英文逗号分隔
actionid	string	否	事务ID，可用于异步拨号时查询拨号结果，允许字母数字下划线等字符，应尽量采用唯一的有意义的字符串作为ID。如phpcti-10.1.0.2-20241029023404
async	int	否	异步呼叫（枚举类型0/1），默认：否（同步）。设置异步时命令发送完立刻返回, 设置同步时等待channel接听才返回

154.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI拨号指令成功：Originate successfully queued",
    "data": []
}


xxxxxxxxxx
{
    "errcode": "1232",
    "message": "Originate failed",
    "data": "[   {",
    "reason": "5\"}"
}

154.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2023-12-26	畅信达	增加 ActionID，Earlymedia，ChannelId，OtherChannelId，Codecs参数
1.0.2	2024-10-27	畅信达	信创改造

155 取消禁止呼出功能

文件路径: webservice2/ctisetcndoff.php

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

版本: 1.0.1 最后更新: 2024-10-29

155.1 功能描述

取消指定分机的禁止呼出功能。

155.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码

155.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "取消禁止呼出成功！",
    "data": [
        {
            "status": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

155.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

156 查询保持音乐列表

文件路径: webservice2/getholdmusic.php

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

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

156.1 功能描述

查询保持音乐类别列表。

156.2 请求参数

参数名	类型	必填	说明

156.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "name": "agent"
        },
        {
            "name": "classic"
        },
        {
            "name": "custom"
        },
        {
            "name": "default"
        },
        {
            "name": "fashion"
        },
        {
            "name": "misc"
        }
    ]
}


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

156.4 修订历史

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

157 标注短信收件箱

文件路径: webservice2/setrecvsms.php

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

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

157.1 功能描述

标注短信收件箱，第三方程序可以标注预留字段,写入扩展信息。

157.2 请求参数

参数名	类型	必填	说明
id	string	是	ID
processed	string	否	处理状态（整数，默认0）
app_id	string	否	应用ID
app_user	string	否	应用用户
app_flag	string	否	应用标志

157.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "更新失败，指定数据不存在！",
    "data": []
}

157.4 修订历史

版本	日期	作者	说明
1.0.0	2015-06-25	畅信达	新建
1.0.1	2024-11-22	畅信达	信创改造

158 查询内存使用状况

文件路径: webservice2/getmemload.php

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

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

158.1 功能描述

查询内存使用状况。

158.2 请求参数

参数名	类型	必填	说明

158.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-13 17:21:56",
            "infotype": "memload",
            "memtotal": "2978164",
            "memfree": "152252",
            "buffers": "1265484",
            "cached": "4",
            "swapcached": "1416284",
            "active": "40216",
            "inactive": "1132100",
            "hightotal": "1218752",
            "highfree": "729368",
            "lowtotal": "405828",
            "lowfree": "402732",
            "swaptotal": "812924",
            "swapfree": "11304",
            "dirty": "11304",
            "writeback": "4161532",
            "mapped": "3883516",
            "slab": "0",
            "commitlimit": "0",
            "committed_as": "916740",
            "pagetables": "138236",
            "vmalloctotal": "191060",
            "vmallocused": "183076",
            "vmallocchunk": "294096",
            "hugepages_total": "183076",
            "hugepages_free": "111020",
            "hugepagesize": "12300",
            "kernelapp": 1560424
        }
    ]
}


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

158.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-13	畅信达	信创改造

159 激活呼叫转移功能

文件路径: webservice2/ctisetcfon.php

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

版本: 1.0.1 最后更新: 2024-10-29

159.1 功能描述

激活指定分机的全部或指定呼叫转移功能。

159.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码
destination	string	是	目标号码
cftype	string	否	转移类型（枚举类型CF/CFB/CFU/ALL）,默认ALL

159.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "激活呼叫转移成功！",
    "data": [
        {
            "CF": "602",
            "CFB": "602",
            "CFU": "602"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

159.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

160 查询语音导航按键记录

文件路径: webservice2/getivrlog.php

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

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

160.1 功能描述

查询语音导航按键记录。成功时message字段返回总记录数（可用于分页），失败时返回描述。

160.2 请求参数

参数名	类型	必填	说明
ivrdate1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
ivrdate2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
ivrname	string	否	语音导航名称
uniqueid	string	否	呼叫编号
channel	string	否	活动通道
obdialid	string	否	批量外呼ID
obtaskid	string	否	批量外呼任务ID
callerid	string	否	主叫号码
funcname	string	否	按键功能
sort	string	否	排序字段（默认ivrdate）
sens	string	否	排序方式（desc/asc 默认desc）
offset	string	否	偏移量（默认0）
rows	string	否	记录数

160.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "ivrdate": "2024-11-13 10:00:36",
            "ivrcontext": "ivr-2",
            "ivrname": "欢迎菜单",
            "funcname": "ivr-2",
            "channel": "SIP\/602-00000045",
            "uniqueid": "1731463234.121",
            "keyinput": "1",
            "callerid": "602",
            "dnid": "s",
            "obtaskid": "0",
            "obdialid": "0"
        }
    ]
}


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

160.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-06	畅信达	信创改造

161 激活呼叫保持（播放等待音乐）

文件路径: webservice2/ctihold.php

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

版本: 1.0.1 最后更新: 2024-10-27

161.1 功能描述

此操激活指定活动通道的呼叫保持状态，保持期间向通话双方播放指定类别的音乐。

161.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
musicclass	string	否	保持音乐名称

161.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI激活保持指令成功：MusicOnHold Started.",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1201,
    "message": "执行CTI激活保持指令失败(phpcti-10.1.0.2-20241028091707)：No such channel",
    "data": []
}

161.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

162 获取活动通道指定通道变量的值

文件路径: webservice2/ctigetvar.php

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

版本: 1.0.1 最后更新: 2024-10-27

162.1 功能描述

此操作可获取活动通道指定通道变量的值。

162.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道（如SIP/601-00000018）
variable	string	是	变量名称（如SIPCALLID）

162.3 响应示例


xxxxxxxxxx
{
    "errcode": "0",
    "message": "成功",
    "data": "[{\"result\": \"6d8e19f5135b82607d8dc9016d305bbe}"
}


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

162.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

163 删除呼入黑名单

文件路径: webservice2/delblacklist.php

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

版本: 1.0.1 最后更新: 2024-10-23

163.1 功能描述

根据指定的黑名单ID删除呼入黑名单。

163.2 请求参数

参数名	类型	必填	说明
id	string	是	黑名单ID

163.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "ID为 36 的黑名单删除成功！",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9007,
    "message": "黑名单ID 36 不存在",
    "data": []
}

163.4 修订历史

版本	日期	作者	说明
1.0.0	2016-09-06	畅信达	统一响应码和响应消息,统一建立CTI连接
1.0.1	2024-10-23	畅信达	信创改造

164 通过CTI取消静音会议桥成员

文件路径: webservice2/cticonfbridgeunmute.php

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

版本: 1.0.0 最后更新: 2025-03-03

164.1 功能描述

通过CTI取消静音会议桥成员。

164.2 请求参数

参数名	类型	必填	说明
conference	string	是	会议桥
channel	string	否	活动通道，支持按前缀匹配。

164.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通过CTI取消静音会议桥成员成功：User unmuted",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1201,
    "message": "执行通过CTI取消静音会议桥成员失败",
    "data": []
}

164.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

165 根据条件查询队列活动日志

文件路径: webservice2/getqueuelog.php

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

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

165.1 功能描述

根据条件查询队列活动日志，成功时message字段返回总记录数（可用于分页），失败时返回描述。传入event时，只返回满足条件的数据中每个呼叫最新一次发生该事件的记录。

165.2 请求参数

参数名	类型	必填	说明
eventtime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
eventtime2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
queue	string	否	队列号码
uniqueid	string	否	呼叫编号（查多个编号用逗号分隔）
event	string	否	队列事件
sort	string	否	排序字段(默认：callid desc, eventtime desc)，传入event时，固定使用callid desc排序。
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认0)
rows	string	否	记录数

165.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": 13,
    "data": [
        {
            "eventtime": "2024-07-02 16:40:49",
            "callid": "1719909644.82",
            "queuename": "90",
            "queuestart": "1719909647",
            "agent": "SIP\/601",
            "agentno": "601",
            "event": "CONNECT",
            "arg1": "2",
            "arg2": "603",
            "arg3": "2",
            "arg4": "",
            "arg5": ""
        }
    ]
}


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

165.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-14	畅信达	信创改造，增加了一些输入参数

166 查询拨号进展

文件路径: webservice2/getdialprogress.php

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

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

166.1 功能描述

从状态机数据库查询拨号进展，可以获取从拨号到接通的相关数据，包括原被叫、IVR历史、接听座席等。

166.2 请求参数

参数名	类型	必填	说明
channel	string	否	活动通道（向右模糊匹配）
device	string	否	关联通道(向右模糊匹配)
uniqueid	string	否	呼叫编号
dstuniqueid	string	否	关联呼叫编号

166.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-04 16:53:13",
            "begintimestamp": "2024-11-04 16:53:13.822413",
            "endtimestamp": "",
            "channel": "SIP\/603-0000002b",
            "channelstate": "4",
            "channelstatedesc": "Ring",
            "uniqueid": "1730710393.78",
            "callerid": "603",
            "calleridname": "预设",
            "connectedlinenum": "601",
            "connectedlinename": "预设",
            "dstchannel": "SIP\/601-0000002c",
            "dstchannelstate": "5",
            "dstchannelstatedesc": "Ringing",
            "dstuniqueid": "1730710393.79",
            "dstconnectedlinenum": "603",
            "dstconnectedlinename": "预设",
            "outbound": "No",
            "dialstatus": "RINGING",
            "dialstring": "601",
            "queuenum": "",
            "dnid": "",
            "agentno": "",
            "holdtime": "0",
            "ivridhist": "",
            "ivrhist": "",
            "calldata": "",
            "hanguptime": null
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

166.4 修订历史

版本	日期	作者	说明
1.0.0	2023-12-28	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

167 查询通话话单

文件路径: webservice2/getcdr.php

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

版本: 1.0.2 最后更新: 2024-11-04

167.1 功能描述

查询通话话单，成功时message字段返回总记录数（可用于分页），失败时返回描述。注意：设置onlymonitor有效时，需要比对录音文件是否存在，因此查询效率较低，同时message字段返回的总记录数也会忽略onlymonitor条件，因此使用message字段作为分页总记录数时，不要使用onlymonitor查询条件。

167.2 请求参数

参数名	类型	必填	说明
calldate1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
caller	string	否	主叫号码
callee	string	否	被叫号码
disposition	string	否	呼叫状态
accountcode	string	否	计费号码
channel	string	否	主叫活动通道
dstchannel	string	否	被叫活动通道
uniqueid	string	否	呼叫编号（支持逗号分隔的多个编号）
dnid	string	否	原被叫号码
direct	string	否	呼叫方向(枚举类型ALL/IN/OUT/INNER)，默认ALL
firstdialstatus	string	否	首次拨号结果(枚举类型0/1/2),优先于disposition参数,，默认0
lastdialstatus	string	否	最后拨号结果(枚举类型0/1/2),效率较低，默认0
onlymonitor	string	否	只需要有录音记录(枚举类型0/1),效率较低，默认0
history	string	否	查询历史数据库记录(枚举类型0/1)，默认0
sort	string	否	排序字段(默认calldate)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认0)
rows	string	否	记录数

167.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1283",
    "data": [
        {
            "pbxid": "1",
            "calldate": "2024-06-12 11:17:12",
            "sequence": "0",
            "clid": "\"自动拨号\" <2000>",
            "areacode": "",
            "location": "",
            "src": "2000",
            "dst": "s",
            "dcontext": "iv2-2",
            "channel": "SIP\/601-00000000",
            "dstchannel": "",
            "lastapp": "AppDial2",
            "lastdata": "(Outgoing Line)",
            "duration": "1",
            "billsec": "0",
            "disposition": "ANSWERED",
            "amaflags": "3",
            "accountcode": "601",
            "peeraccount": "",
            "uniqueid": "1718162232.0",
            "sipcallid": null,
            "linkedid": "1718162232.0",
            "userfield": "",
            "answertime": "2024-06-12 11:17:14",
            "endtime": "2024-06-12 11:17:14",
            "caller": "2000",
            "callee": "",
            "dnid": "",
            "rdnis": "",
            "ani": "",
            "monitor": "",
            "direct": "",
            "transfer": "",
            "trunk": "",
            "dialstatus": "",
            "hangupcause": "0",
            "codec": "",
            "peerip": "",
            "outbound_cnum": null,
            "outbound_cnam": null,
            "hasmonitorfile": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

167.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2020-01-01	畅信达	增加条件首次拨号状态firstdialstatus(0-全部(默认) 1-未通 2-接通)，查询历史库数据history(0-否 1-是)，
1.0.2	2024-11-04	畅信达	信创改造，成功时message字段返回总记录数（可用于分页），失败时返回描述。

168 座席上线

文件路径: webservice2/ctiqueueadd.php

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

版本: 1.0.1 最后更新: 2024-10-24

168.1 功能描述

此操作将座席加入指定队列，并设置优先级（服务惩罚值）

168.2 请求参数

参数名	类型	必填	说明
queue	string	是	队列号码
interface	string	是	坐席拨号接口(如:SIP/601)
penalty	int	否	服务惩罚值（从0开始的整数，值越大优先级越低）
membername	string	否	坐席别名
paused	string	否	坐席示忙状态（0-99）
wrapuptime	string	否	坐席事后处理时长（秒）
stateinterface	string	否	坐席状态监控接口

168.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "座席上线成功: Added interface to queue",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1291,
    "message": "座席上线失败: Unable to add interface: Already there",
    "data": []
}

168.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-24	畅信达	信创改造，增加了4个参数

169 查询当前使用的理解引擎名称

文件路径: webservice2/getnlpinfo.php

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

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

169.1 功能描述

查询当前使用的理解引擎名称。

169.2 请求参数

参数名	类型	必填	说明

169.3 响应示例


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


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

169.4 修订历史

版本	日期	作者	说明
1.0.0	2023-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-13	畅信达	信创改造

170 查询通话话单记录数

文件路径: webservice2/getcdrcount.php

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

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

170.1 功能描述

查询通话话单记录数，用于分页。

170.2 请求参数

参数名	类型	必填	说明
calldate1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calldate2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
caller	string	否	主叫号码
callee	string	否	被叫号码
disposition	string	否	呼叫状态
accountcode	string	否	计费号码
channel	string	否	主叫活动通道
dstchannel	string	否	被叫活动通道
uniqueid	string	否	呼叫编号（支持逗号分隔的多个编号）
dnid	string	否	原被叫号码
direct	string	否	呼叫方向(枚举类型ALL/IN/OUT/INNER)，默认ALL
firstdialstatus	string	否	首次拨号结果(枚举类型0/1/2),优先于disposition参数,，默认0
lastdialstatus	string	否	最后拨号结果(枚举类型0/1/2),效率较低，默认0
history	string	否	查询历史数据库记录(枚举类型0/1)，默认0

170.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

170.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

171 SIP话机控制（需话机支持）

文件路径: webservice2/ctisipnotify.php

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

版本: 1.0.1 最后更新: 2024-10-30

171.1 功能描述

向指定的SIP话机发送NOTIFY消息，实现某些控制功能。业务系统通常可以使用此接口控制话机摘机、挂机、调整音量、设置取消DND等。此功能需要话机终端支持，不同的终端action也不一样。有效的action动作定义在sip_notify.conf配置文件中，使用时请向技术服务工程师咨询。

171.2 请求参数

参数名	类型	必填	说明
action	string	是	动作（如offhook-yealink）
device	string	是	设备号码（如601）

171.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI发送SIP话机控制指令成功：Command output follows",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1468,
    "message": "执行CTI发送SIP话机控制指令失败(phpcti-10.1.0.2-20241030014459)：Command output follows",
    "data": []
}

171.4 修订历史

版本	日期	作者	说明
1.0.0	2024-06-18	畅信达	新建
1.0.1	2024-10-30	畅信达	信创改造

172 取消呼叫保持（停止播放等待音乐）

文件路径: webservice2/ctiunhold.php

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

版本: 1.0.1 最后更新: 2024-10-27

172.1 功能描述

此操取消指定活动通道的呼叫保持状态，停止向通话双方播放音乐。

172.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道

172.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI取消保持指令成功：MusicOnHold Stopped.",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1431,
    "message": "执行CTI取消保持指令失败(phpcti-10.1.0.2-20241028092449)：No such channel",
    "data": []
}

172.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

173 批量获取活动通道指定通道变量的值

文件路径: webservice2/ctigetvars.php

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

版本: 1.0.1 最后更新: 2024-10-27

173.1 功能描述

此操作可批量获取活动通道指定通道变量的值，最多一次可获取10个变量的值。

173.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道（如SIP/601-00000018）
variable0	string	是	变量名称1（如SIPCALLID）
variable1	string	否	变量名称2（如DIALEDPEERNUMBER）
variable2	string	否	变量名称3（如MVB_DNID）
variable3	string	否	变量名称4（如MVB_ANI）
variable4	string	否	变量名称5（如MVB_FROMEXTEN）
variable5	string	否	变量名称6
variable6	string	否	变量名称7
variable7	string	否	变量名称8
variable8	string	否	变量名称9
variable9	string	否	变量名称10

173.3 响应示例


xxxxxxxxxx
{
    "errcode": "0",
    "message": "成功",
    "data": "[   {",
    "SIPCALLID": "688cc3371e4beb8018f03a1c375a4252}"
}


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

173.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

174 设置及紧急呼叫标记

文件路径: webservice2/seturgentcall.php

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

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

174.1 功能描述

设置及紧急呼叫标记。

174.2 请求参数

参数名	类型	必填	说明
id	int	是	ID
flag	int	是	数字应用标志
appflag	string	是	字符应用标志
remark	string	否	备注(utf-8编码)

174.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "更新失败，指定数据不存在！",
    "data": []
}

174.4 修订历史

版本	日期	作者	说明
1.0.0	2015-04-09	畅信达	新建
1.0.1	2024-11-22	畅信达	信创改造

175 根据分机号获取绑定关系以及设备信息

文件路径: webservice2/getextinterface.php

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

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

175.1 功能描述

根据分机号获取绑定关系以及设备信息。结果集字段devicetype=adhoc/fixed表示临时/固定关系。

175.2 请求参数

参数名	类型	必填	说明
device	string	否	设备号

175.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "device": "601",
            "interface": "SIP\/601",
            "context": "from-internal",
            "devicetype": "fixed"
        }
    ]
}


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

175.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

176 查询呼出黑名单列表

文件路径: webservice2/getrouteblacklist.php

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

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

176.1 功能描述

查询呼出黑名单列表。

176.2 请求参数

参数名	类型	必填	说明
extension	string	否	被叫号码
isvalid	string	否	是否有效（枚举类型0/1）
sort	string	否	排序字段(默认id)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认：0)
rows	string	否	记录数

176.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "id": "27",
            "extension": "99999999",
            "reason": "测试黑名单",
            "isvalid": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

176.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新建
1.0.1	2024-11-21	畅信达	信创改造

177 批量设置活动通道指定通道变量的值

文件路径: webservice2/ctisetvars.php

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

版本: 1.0.1 最后更新: 2024-10-27

177.1 功能描述

此操作可批量设置活动通道指定通道变量的值。

177.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道（如SIP/601-00000018）
variable0	string	是	变量名称1（如SIPCALLID）
variable1	string	否	变量名称2（如DIALEDPEERNUMBER）
variable2	string	否	变量名称3（如MVB_DNID）
variable3	string	否	变量名称4（如MVB_ANI）
variable4	string	否	变量名称5（如MVB_FROMEXTEN）
variable5	string	否	变量名称6
variable6	string	否	变量名称7
variable7	string	否	变量名称8
variable8	string	否	变量名称9
variable9	string	否	变量名称10
value0	string	否	变量1的值
value1	string	否	变量2的值
value2	string	否	变量3的值
value3	string	否	变量4的值
value4	string	否	变量5的值
value5	string	否	变量6的值
value6	string	否	变量7的值
value7	string	否	变量8的值
value8	string	否	变量9的值
value9	string	否	变量10的值

177.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI批量设置活动通道指定通道变量指令成功",
    "data": [
        {
            "CALLDATA_STATE": "1",
            "CALLDATA_ID": "VIPID0001",
            "CALLDATA_ACCOUNT": "37020001",
            "CALLDATA_AUTH": "1",
            "CALLDATA_TIMESTAMP": "20241030112201",
            "CALLDATA_DATA1": "模拟数据1",
            "CALLDATA_DATA2": "模拟数据2",
            "CALLDATA_DATA3": "模拟数据3",
            "CALLDATA_DATA4": "模拟数据4"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1411,
    "message": "执行CTI批量设置活动通道指定通道变量指令失败(phpcti-10.1.0.2-20241030011024)：No such channel",
    "data": []
}

177.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

178 查询通信录

文件路径: webservice2/getaddressbook.php

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

版本: 1.0.1 最后更新: 2024-10-30

178.1 功能描述

根据条件查询通信录。

178.2 请求参数

参数名	类型	必填	说明
departmentname	string	否	部门名称
extension	string	否	分机号
needtel	int	否	需要电话非空(0/1)
needmobilephone	int	否	需要手机号非空(0/1)
needemail	int	否	需要邮件非空(0/1)
needfax	int	否	需要传真开启(0/1)
needvoicemail	int	否	需要留言开启(0/1)

178.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "Extension": "601",
            "Name": "预设",
            "Mobilephone": "",
            "PhoneNumber": "",
            "Email": "",
            "FaxEnabled": "yes",
            "Voicemail": "default",
            "Description": "",
            "DepartmentName": "新建部门1"
        }
    ]
}


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

178.4 修订历史

版本	日期	作者	说明
1.0.0	2023-12-31	畅信达	新建
1.0.1	2024-10-30	畅信达	信创改造

179 发送DTMF按键音

文件路径: webservice2/ctisenddtmf.php

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

版本: 1.0.1 最后更新: 2024-10-27

179.1 功能描述

向活动通道发送DTMF按键音。

179.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
digits	string	是	有效的DTMF按键字符(0-9*#abcdABCD),如a001.
timeout	int	否	DTMF按键音之间的间隔（毫秒），默认200
duration	int	否	控制按键音的长度（毫秒），默认200

179.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI发送DTMF按键音指令成功：SendDTMF successfully",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1331,
    "message": "执行CTI发送DTMF按键音失败(phpcti-10.1.0.2-20241029081035)：Channel specified does not exist",
    "data": []
}

179.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

180 查询分机呼叫转移设置

文件路径: webservice2/ctigetcf.php

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

版本: 1.0.1 最后更新: 2024-10-27

180.1 功能描述

此操作可查询分机呼叫转移（无条件、遇忙、不可用）设置

180.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码

180.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

180.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

181 电话代接/抢接

文件路径: webservice2/ctipickup.php

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

版本: 1.0.1 最后更新: 2024-10-29

181.1 功能描述

电话代接/抢接，先拨通指定通道，改通道摘机后再接通指定的正在振铃的目标分机。注意事项: 1、设置正确的callerid参数和通道变量MVB_CALLER、MVB_CALLEE、MVB_DIRECT变量，以确保话单生成正确。如: callerid=7001
MVB_CALLER=8001|MVB_CALLEE=114|MVB_DIRECT=out 2、代接来自队列的电话需要传入拨号接口，否则无法代接成功。 3、操作失败时，如返回结果中有Reason字段，其含义见@see ctioriginate.php

181.2 请求参数

参数名	类型	必填	说明
channel	string	是	代接者拨号接口,如 SIP/7001
pickupexten	string	是	正在振铃的分机号码或拨号接口(如：SIP/7601)，代接来自队列的电话需要传入拨号接口
callerid	string	是	显示给代接者的主叫号码
timeout	string	否	等待代接者摘机的时间（毫秒），默认30000
variable	string	否	通道变量(如MVB_CALLER=8001
account	string	否	计费账号，通常用于后期数据查询统计
async	int	否	异步呼叫（枚举类型0/1），默认：否（同步）。设置异步时命令发送完立刻返回, 设置同步时等待channel接听才返回

181.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI代接指令成功：Originate successfully queued",
    "data": []
}


xxxxxxxxxx
{
    "errcode": "1232",
    "message": "Originate failed",
    "data": "[   {",
    "reason": "5\"}"
}

181.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

182 获取呼损记录

文件路径: webservice2/getbadcalllist.php

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

版本: 1.0.1 最后更新: 2024-10-31

182.1 功能描述

根据条件查询呼损记录，查询成功时返回结果的message属性为总记录数，可用于分页。失败时message属性为失败描述。

182.2 请求参数

参数名	类型	必填	说明
createtime1	string	否	记录时间起始(如:2015-01-01或2015-01-01 01:22:25)
createtime2	string	否	记录时间结束(如:2015-01-02或2015-01-02 10:22:25)
processtime1	string	否	处置时间起始(如:2015-01-02或2015-01-02 10:22:25)
processtime2	string	否	处置时间结束(如:2015-01-02或2015-01-02 10:22:25)
processflag	string	否	处理标志
processapp	string	否	应用程序名,如R3
callerid	string	否	主叫号码
queue	string	否	队列号码
uniqueid	string	否	呼叫编号
sort	string	否	排序字段(默认calltime)
sens	string	否	排序方式（asc/desc）(默认desc)
offset	int	否	偏移量（默认0）
rows	int	否	结果集大小（默认允许的最大值）

182.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "createtime": "2024-11-01 13:52:12",
            "calltime": "2024-11-01 13:52:02",
            "queue": "91",
            "channel": "SIP\/603-0000000b",
            "queuestart": "1730440322",
            "uniqueid": "1730440322.19",
            "callerid": "603",
            "waittime": "10",
            "times": "1",
            "lastexitreason": "ABANDON",
            "processapp": "",
            "processtime": null,
            "processflag": "0",
            "processmark": ""
        }
    ]
}


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

182.4 修订历史

版本	日期	作者	说明
1.0.0	2023-12-31	畅信达	新建
1.0.1	2024-07-22	畅信达	添加查询条件callerid
1.0.1	2024-10-31	畅信达	信创改造

183 设置活动通道指定通道变量的值

文件路径: webservice2/ctisetvar.php

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

版本: 1.0.1 最后更新: 2024-10-27

183.1 功能描述

此操作可设置活动通道指定通道变量的值。

183.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道（如SIP/601-00000018）
variable	string	是	变量名称
value	string	否	变量值

183.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI获取通道变量指令成功：Variable Set",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1401,
    "message": "执行CTI设置通道变量指令失败(phpcti-10.1.0.2-20241029093735)：No such channel",
    "data": []
}

183.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

184 增加呼出黑名单列表

文件路径: webservice2/addrouteblacklist.php

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

版本: 1.0.1 最后更新: 2024-10-22

184.1 功能描述

将电话号码增加到呼出黑名单。

184.2 请求参数

参数名	类型	必填	说明
extension	string	是	电话号码
reason	string	否	加入黑名单原因
isvalid	string	否	是否有效（枚举类型）,默认有效

184.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "添加 10010 到呼出黑名单成功.",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9008,
    "message": "号码 10010 已经存在",
    "data": []
}

184.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-25	畅信达	新增接口
1.0.1	2024-10-22	畅信达	信创改造

185 取消呼叫转移功能

文件路径: webservice2/ctisetcfoff.php

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

版本: 1.0.1 最后更新: 2024-10-29

185.1 功能描述

取消指定分机的全部或指定呼叫转移功能。

185.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码
cftype	string	否	转移类型（枚举类型CF/CFB/CFU/ALL）,默认ALL

185.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "取消呼叫转移成功！",
    "data": [
        {
            "CF": "",
            "CFB": "",
            "CFU": ""
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

185.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

186 查询语音留言文件数量

文件路径: webservice2/getmsgcount.php

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

版本: 1.0.2 最后更新: 2024-11-13

186.1 功能描述

查询语音导航按键记录总数。

186.2 请求参数

参数名	类型	必填	说明
begindatetime	string	否	开始时间(如:2015-01-01 01:22:25)
enddatetime	string	否	结束时间(如:2015-01-01 01:22:25)
context	string	否	语音信箱入口(默认default)
msgbox	string	是	语音信箱号码(如601)
msgdir	string	是	留言目录(枚举类型：INBOX/Old/Urgent/Work/Friends/Family/Cust1/Cust2/Cust3/Cust4/Deleted)
query	string	否	搜索内容
alreadyread	string	否	是否已读（枚举类型）

186.3 响应示例


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


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

186.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-01-11	畅信达	改为从数据库查询，增加begindatetime/enddatetime/context/alreadyread参数
1.0.2	2024-11-13	畅信达	信创改造

187 获取PBX运行状态

文件路径: webservice2/ctipbxstatus.php

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

版本: 1.0.1 最后更新: 2024-10-29

187.1 功能描述

此操作可获取PBX运行状态。

187.2 请求参数

参数名	类型	必填	说明

187.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI获取PBX运行状态指令成功：",
    "data": [
        {
            "startupdate": "2024-10-25",
            "startuptime": "14:58:38",
            "reloaddate": "2024-10-28",
            "reloadtime": "11:24:34",
            "currentchannels": "0",
            "currentcalls": "0",
            "maxcalls": "50"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1271,
    "message": "执行CTI获取PBX运行状态指令失败",
    "data": []
}

187.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

188 取语音信箱状态

文件路径: webservice2/ctimailboxstatus.php

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

版本: 1.0.1 最后更新: 2024-10-27

188.1 功能描述

此操取指定语音信箱状态。

188.2 请求参数

参数名	类型	必填	说明
mailbox	string	是	语音信箱号码

188.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI取语音信箱留言状态指令成功：Mailbox Status",
    "data": [
        {
            "mailbox": "601",
            "waiting": "1"
        }
    ]
}


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

188.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

189 获取短信收件箱统计信息

文件路径: webservice2/getrecvsmsstat.php

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

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

189.1 功能描述

获取短信收件箱统计信息。

189.2 请求参数

参数名	类型	必填	说明
insert_dates	string	否	记录写入日期开始(如:2015-01-01或2015-01-01 01:22:25)
insert_datee	string	否	记录写入日期结束(如:2015-01-01或2015-01-01 01:22:25)
dst	string	否	目标号码
text	string	否	内容（模糊匹配）
processed	string	否	处理状态(预留字段)
app_id	string	否	应用ID(预留字段)
app_user	string	否	应用用户名(预留字段)
app_flag	string	否	应用标志(预留字段)

189.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "rows": "0",
            "maxid": null,
            "minid": null,
            "maxdate": null,
            "mindate": null
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

189.4 修订历史

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

190 删除接口上传的自定义语音文件

文件路径: webservice2/deleterecordings.php

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

版本: 1.0.1 最后更新: 2024-10-30

190.1 功能描述

根据数字编号、显示名称、文件ID三个参数之一删除指定的自定义语音文件，至少需要提供一个参数。如果提供了多于1个的参数，则按照优先顺序(digitname/displayname/id)取第一个参数使用。注意：只能删除接口@see putrecordings.php 上传的文件(webcti_前缀开头)。

190.2 请求参数

参数名	类型	必填	说明
digitname	string	否	系统录音文件数字编号（调用putrecordings.php接口时会返回此字段）
displayname	string	否	系统录音文件显示名称（调用putrecordings.php接口时会返回此字段）
id	string	否	系统录音文件ID

190.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "删除自定义语音文件成功！",
    "data": []
}


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

190.4 修订历史

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

191 触发队列摘要事件

文件路径: webservice2/ctiqueuesummary.php

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

版本: 1.0.0 最后更新: 2024-10-25

191.1 功能描述

此操作触发队列摘要事件，只有当前CTI连接可以收到事件。

191.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码

191.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "触发队列摘要事件成功: Queue summary will follow",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1051,
    "message": "触发队列摘要事件失败: ",
    "data": []
}

191.4 修订历史

版本	日期	作者	说明
1.0.0	2024-10-24	畅信达	信创改造，新建

192 下载通话语音留言文件

文件路径: webservice2/getmsg.php

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

版本: 1.0.2 最后更新: 2024-11-14

192.1 功能描述

下载通话语音留言文件。

192.2 请求参数

参数名	类型	必填	说明
msgbox	string	是	语音信箱号码(如601)
msgdir	string	是	留言目录(枚举类型：INBOX/Old/Urgent/Work/Friends/Family/Cust1/Cust2/Cust3/Cust4/Deleted)
msgfile	string	是	留言文件名称，来自@see getmsglist.php结果集
context	string	否	语音信箱入口(默认default)
mp3	string	否	提供转mp3格式功能（枚举类型）,默认否

192.3 响应示例


xxxxxxxxxx
{
    "errcode": 9003,
    "message": "文件 \"1730267105-00000000\" 不存在！",
    "data": []
}

192.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-01-11	畅信达	改为从数据库查询增加$context 参数
1.0.2	2024-11-14	畅信达	信创改造

193 查询当前正在进行的通话(含坐席)

文件路径: webservice2/getcalls.php

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

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

193.1 功能描述

此操作可将通过指定搜索条件查询当前正在进行的通话(含坐席)。查询成功时返回结果的message属性为总记录数，可用于分页。失败时message属性为失败描述。

193.2 请求参数

参数名	类型	必填	说明
srcchannel	string	否	主叫活动通道(以此开头模糊匹配,如:SIP/7001)
dstchannel	string	否	被叫活动通道(以此开头模糊匹配,如:SIP/7001)
srccallerid	string	否	主叫号码
dstcallerid	string	否	被叫号码

193.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-01 18:00:41",
            "bridgeuniqueid": "8afef51b-00c2-4fdd-b196-10e635811851",
            "srcchannel": "SIP\/603-00000023",
            "dstchannel": "SIP\/601-00000024",
            "callstate": "Link",
            "srccallerid": "603",
            "srccalleridname": "预设",
            "dstcallerid": "601",
            "dstcalleridname": "预设",
            "srcchannelstate": "Up",
            "dstchannelstate": "Up",
            "srcuniqueid": "1730455240.66",
            "dstuniqueid": "1730455241.67",
            "dialtime": "2024-11-01 18:00:41",
            "linktime": "2024-11-01 18:00:42",
            "unlinktime": null,
            "dialstatus": "ANSWER",
            "from_status": "0",
            "clearflag": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

193.4 修订历史

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

194 下载spool目录下指定文件

文件路径: webservice2/getspoolfile.php

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

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

194.1 功能描述

下载spool目录下指定文件。

194.2 请求参数

参数名	类型	必填	说明
location	string	是	spool下的子目录
filename	string	是	文件名（相对路径）
delete	string	否	是否只删除(枚举类型，1/0)

194.3 响应示例


xxxxxxxxxx
{
    "errcode": 9002,
    "message": "缺少参数 \"location\".",
    "data": []
}

194.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-21	畅信达	信创改造

195 查询CPU负载和交换平台并发占用情况

文件路径: webservice2/getcpuload.php

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

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

195.1 功能描述

从状态机数据库查询CPU负载和交换平台并发占用情况。

195.2 请求参数

参数名	类型	必填	说明

195.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-04 16:28:32",
            "infotype": "cpuload",
            "user": "2.71",
            "system": "4.41",
            "nice": "0",
            "idle": "92.88",
            "startuptime": "2024-10-30 13:44:33",
            "reloadtime": "2024-10-30 13:44:33",
            "currentchannels": "0",
            "currentcalls": "0",
            "allowmaxcalls": "50",
            "processedcalls": "27"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

195.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

196 查询所有终端设备列表

文件路径: webservice2/getdevices.php

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

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

196.1 功能描述

从配置数据库查询所有终端设备列表。

196.2 请求参数

参数名	类型	必填	说明
device	string	否	设备号

196.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "deviceno": "601",
            "tech": "sip",
            "channel": "SIP\/601",
            "devicetype": "fixed",
            "user": "601",
            "cndescription": "预设",
            "context": "from-internal",
            "spyeegroup": ",1",
            "spyergroup": ",1",
            "spectrunk": ""
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

196.4 修订历史

版本	日期	作者	说明
1.0.0	2022-11-22	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-04	畅信达	信创改造

197 获取队列与坐席状态统计信息

文件路径: webservice2/getqueuegeneral.php

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

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

197.1 功能描述

获取队列与坐席状态统计信息。结果集字段: queue 队列号码 membercount 坐席数 waitings 排队数 usable 示闲并且设备可用 unusable 示忙或设备状态不正常 inuse 正在通话或振铃 usableidle 示闲并且设备可用并空闲 pause 示忙数 unpause 示闲数 invalid 设备状态不正常

197.2 请求参数

参数名	类型	必填	说明
queuenos	string	否	队列号码(多个队列用逗号或分号分隔)

197.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "queue": "90",
            "membercount": 2,
            "waitings": 0,
            "usable": 2,
            "unusable": 0,
            "inuse": 0,
            "usableidle": 2,
            "invalid": 0,
            "pause": 0,
            "unpause": 2
        }
    ]
}


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

197.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-11-14	畅信达	信创改造

198 按名称执行快捷键

文件路径: webservice2/ctifeaturename.php

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

版本: 1.0.1 最后更新: 2024-10-27

198.1 功能描述

此操作可在电话终端通话期间触发指定名称对应的快捷键，在主被叫通道发起语音流程。通常用于通话过程中获取来电者的输入、密码验证或者座席向来电者播放语音信息。

198.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
name	string	是	快捷键名称(对应管理界面的【唯一标识】)

198.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "通过名称执行快捷键成功：Feature name successfully queued",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1071,
    "message": "通过名称执行快捷键失败: Feature's name specified does not exist",
    "data": []
}

198.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

199 获取呼叫活动记录

文件路径: webservice2/getcallactivitylist.php

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

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

199.1 功能描述

此操作可将通过指定搜索条件获取呼叫活动记录，按照发生的时间倒序返回，通常用于大屏显示和呼叫中心活动监控场景。

199.2 请求参数

参数名	类型	必填	说明
starttime	string	否	记录时间起始
endtime	string	否	记录时间结束
offset	int	否	偏移量（默认0）
rows	int	否	结果集大小（默认允许的最大值）

199.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "9",
    "data": [
        {
            "createtime": "2024-11-01 17:43:26",
            "ts": "1730454206.028690",
            "seq": "77",
            "channel": "SIP\/603-00000022",
            "uniqueid": "1730454204.64",
            "callerid": "603",
            "connectedlinenum": "91",
            "actiontype": "Cdr",
            "activity": "生成话单 - 主叫：603， 被叫：91，通话时长： 1秒，拆线原因： 0，录音： "
        },
        {
            "createtime": "2024-11-01 17:43:26",
            "ts": "1730454206.028626",
            "seq": "76",
            "channel": "SIP\/603-00000022",
            "uniqueid": "1730454204.64",
            "callerid": "603",
            "connectedlinenum": "<unknown>",
            "actiontype": "Hangup",
            "activity": "请求拆线\/拆线 - 603 通话结束拆线，代码：16，说明：Normal Clearing。"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

199.4 修订历史

版本	日期	作者	说明
1.0.0	2023-11-28	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-01	畅信达	信创改造

200 查询质检/满意度调查记录

文件路径: webservice2/getqmr.php

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

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

200.1 功能描述

查询质检/满意度调查记录，成功时message字段返回总记录数（可用于分页），失败时返回描述。

200.2 请求参数

参数名	类型	必填	说明
calltime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
calltime2	string	否	结束时间(如:2015-01-01或2015-01-01 01:22:25)
uniqueid	string	否	呼叫编号
phonenumber	string	是	号码
queuenum	string	否	队列号
agentno	string	否	坐席工号
selkey	string	否	按键(-1表示挂机)
sort	string	否	排序字段(默认：calltime)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认0)
rows	string	否	记录数

200.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "7",
    "data": [
        {
            "id": "1",
            "uniqueid": "1719909644.82",
            "name": "90",
            "phonenumber": "603",
            "agentno": "601",
            "calltime": "2024-07-02 16:40:55",
            "selkey": "1",
            "ownerapp": "QUEUE"
        }
    ]
}


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

200.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-01-11	畅信达	改为从数据库查询，增加begindatetime/enddatetime/context/alreadyread参数
1.0.2	2024-11-13	畅信达	信创改造

201 获取坐席示忙原因列表

文件路径: webservice2/getpausetype.php

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

版本: 1.0.2 最后更新: 2024-11-14

201.1 功能描述

获取坐席示忙原因列表。

201.2 请求参数

参数名	类型	必填	说明
onlycustom	string	否	只获取可自定义的原因（枚举类型）,默认否

201.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "7",
    "data": [
        {
            "pausetype": "1",
            "description": "示忙"
        },
        {
            "pausetype": "2",
            "description": "就餐"
        },
        {
            "pausetype": "3",
            "description": "小休"
        },
        {
            "pausetype": "4",
            "description": "邮件"
        },
        {
            "pausetype": "5",
            "description": "培训"
        },
        {
            "pausetype": "60",
            "description": "其它工作"
        },
        {
            "pausetype": "99",
            "description": "事后处理"
        }
    ]
}


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

201.4 修订历史

版本	日期	作者	说明
1.0.0	2023-07-28	畅信达	新建
1.0.1	2022-04-13	畅信达	增加参数onlycustom，用于R3的请假模式和示忙模式
1.0.2	2024-11-14	畅信达	信创改造

202 查询短信收件箱列表

文件路径: webservice2/getrecvsms.php

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

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

202.1 功能描述

查询短信收件箱列表，成功时message字段返回总记录数（可用于分页），失败时返回描述。注意: 只支持短信通道接收方式。

202.2 请求参数

参数名	类型	必填	说明
insert_dates	string	否	记录写入日期开始(如:2015-01-01或2015-01-01 01:22:25)
insert_datee	string	否	记录写入日期结束(如:2015-01-01或2015-01-01 01:22:25)
received_dates	string	否	接收日期开始(如:2015-01-01或2015-01-01 01:22:25)
received_datee	string	否	接收日期结束(如:2015-01-01或2015-01-01 01:22:25)
number	string	否	手机号码
id	string	否	ID
idcmp	string	否	ID比较方法(e/g/l 等于/大于/小于)
dst	string	否	目标号码
text	string	否	内容（模糊匹配）
processed	string	否	处理状态(预留字段)
app_id	string	否	应用ID(预留字段)
app_user	string	否	应用用户名(预留字段)
app_flag	string	否	应用标志(预留字段)
sort	string	否	排序字段(默认id)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认：0)
rows	string	否	记录数

202.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

202.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-21	畅信达	信创改造，成功时message字段返回总记录数（可用于分页），失败时返回描述。

203 查询平台语音导航列表

文件路径: webservice2/getivrlist.php

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

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

203.1 功能描述

查询平台语音导航列表。

203.2 请求参数

参数名	类型	必填	说明

203.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "3",
    "data": [
        {
            "id": "2",
            "ivrname": "欢迎菜单"
        },
        {
            "id": "31",
            "ivrname": "产品介绍"
        },
        {
            "id": "54",
            "ivrname": "直拨分机"
        }
    ]
}


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

203.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-11-06	畅信达	信创改造、补充按键信息

204 查询平台时间

文件路径: webservice2/ctigetdatetime.php

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

版本: 1.0.1 最后更新: 2024-10-27

204.1 功能描述

此操作可查询平台时间，返回一组日期时间数据

204.2 请求参数

参数名	类型	必填	说明

204.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "mvb_datetime": "2024-10-28 07:46:00",
            "mvb_date": "2024-10-28",
            "mvb_time": "07:46:00",
            "mvb_timestamp": 1730101560,
            "mvb_year": "2024",
            "mvb_month": "10",
            "mvb_month_day": "28",
            "mvb_year_day": "301",
            "mvb_week": "1",
            "mvb_hour": "7",
            "mvb_minute": 46,
            "mvb_second": 0
        }
    ]
}


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

204.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

205 激活禁止呼出功能

文件路径: webservice2/ctisetcndon.php

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

版本: 1.0.1 最后更新: 2024-10-29

205.1 功能描述

激活指定分机的禁止功能。

205.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码

205.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "激活禁止呼出成功！",
    "data": [
        {
            "status": "1"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

205.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

206 删除短信发件箱记录

文件路径: webservice2/delsendsms.php

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

版本: 1.0.1 最后更新: 2024-10-30

206.1 功能描述

根据ID删除短信发件箱记录。

206.2 请求参数

参数名	类型	必填	说明
id	string	是	短息编号

206.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "操作成功，删除 1 条短信发件箱记录！",
    "data": []
}


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

206.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-10-30	畅信达	信创改造

207 查询坐席活动记录总数

文件路径: webservice2/getagentactivitycount.php

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

版本: 1.0.1 最后更新: 2024-10-30

207.1 功能描述

根据条件查询坐席活动记录总数，用于分页。

207.2 请求参数

参数名	类型	必填	说明
datefrom	string	是	开始日期时间(如:2015-01-01或2015-01-01 01:22:25)
dateto	string	是	结束日期时间(如:2015-01-02或2015-01-02 10:22:25)
queue	string	否	队列号码(如: 90)
agent	string	否	坐席接口(如: SIP/) 向右模糊匹配
agentname	string	否	坐席工号(如: 601)
event	string	否	事件名称(added/removed/unpaused/paused)

207.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "36",
    "data": [
        {
            "result": 36
        }
    ]
}


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

207.4 修订历史

版本	日期	作者	说明
1.0.0	2023-12-31	畅信达	新建
1.0.1	2024-10-30	畅信达	信创改造

208 获取号码归属区号

文件路径: webservice2/getarea.php

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

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

208.1 功能描述

根据电话号码获取归属区号，结果缓存30秒。

208.2 请求参数

参数名	类型	必填	说明
phoneno	string	是	电话号码（手机号码或带区号的固定电话）

208.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "获取区号成功！",
    "data": [
        {
            "area": "0532",
            "city": "青岛",
            "province": "山东",
            "type": "中国电信"
        }
    ]
}


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

208.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-11-04	畅信达	信创改造

209 查询语音留言文件列表

文件路径: webservice2/getmsglist.php

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

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

209.1 功能描述

查询语音留言文件列表，成功时message字段返回总记录数（可用于分页），失败时返回描述。结果集字段: msgdir 留言分类目录如: INBOX msgfile 留言文件名称如: msg0000.WAV msgbox 信箱号码如: 7601 msgcontext 入口名称如: from-internal msgmacrocontext 宏名称如: macro-vm msgreason 留言产生原因如: DIRECTDIAL msgchan 主叫活动通道如: SIP/7001-09ef51a0 msgcallerid 主叫名称和号码如: "新建" <7601> msgdatetime 日期时间如: 2015-01-05 11:38:54 msgduration 时长(秒) 如: 7 alreadyread 已读标记如：1 remark 备注如：咨询业务

209.2 请求参数

参数名	类型	必填	说明
begindatetime	string	否	开始时间(如:2015-01-01 01:22:25)
enddatetime	string	否	结束时间(如:2015-01-01 01:22:25)
context	string	否	语音信箱入口(默认default)
msgbox	string	是	语音信箱号码(如601)
msgdir	string	是	留言目录(枚举类型：INBOX/Old/Urgent/Work/Friends/Family/Cust1/Cust2/Cust3/Cust4/Deleted)
query	string	否	搜索内容
alreadyread	string	否	是否已读（枚举类型）
withextend	string	否	是否返回扩展数据（枚举类型）,在V4接口标准基础上增加alreadyread和remark字段
sort	string	否	排序字段(msgdatetime/msgfile/msgdir/msgcontext/msgmacrocontext/msgbox/msgcallerid/msgduration，默认：msgdatetime)
sens	string	否	排序方式(desc/asc 默认desc)
offset	string	否	偏移量(默认0)
rows	string	否	记录数

209.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": 1,
    "data": [
        {
            "msgfile": "1730267105-00000000.wav",
            "msgdir": "INBOX",
            "msgcontext": "macro-vm",
            "msgmacrocontext": "from-internal",
            "msgbox": "601",
            "msgreason": "",
            "msgcallerid": "602",
            "msgchan": "",
            "msgdatetime": "2024-10-30 13:45:13",
            "msgduration": "6",
            "alreadyread": "1",
            "remark": "咨询，已处理"
        }
    ]
}


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

209.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-01-11	畅信达	改为从数据库查询，增加begindatetime/enddatetime/context/alreadyread参数
1.0.2	2024-11-13	畅信达	信创改造

210 执行指定的控制台命令

文件路径: webservice2/cticommand.php

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

版本: 1.0.1 最后更新: 2024-10-25

210.1 功能描述

此操作将执行指定的控制台命令，结果数据会以事件返回当前cti客户端，命令发送完毕就会返回成功，通常不会出现执行失败的情况。

210.2 请求参数

参数名	类型	必填	说明
command	string	是	cti命令

210.3 响应示例


xxxxxxxxxx
{
    "errcode": 1051,
    "message": "调用CTI命令失败。",
    "data": []
}

210.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-25	畅信达	信创改造

211 下载系统录音模块上传的语音文件

文件路径: webservice2/getrecord.php

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

版本: 1.0.2 最后更新: 2024-11-21

211.1 功能描述

下载系统录音模块上传的语音文件。

211.2 请求参数

参数名	类型	必填	说明
filename	string	是	语音文件名（不含路径和扩展名）
mp3	string	否	是否转MP3(枚举类型0/1)，默认：0

211.3 响应示例


xxxxxxxxxx
{
    "errcode": 9003,
    "message": "文件 \"a.wav\" 不存在！",
    "data": []
}

211.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2015-03-19	畅信达	提供转mp3格式功能
1.0.2	2024-11-21	畅信达	信创改造

212 标注传真收件箱

文件路径: webservice2/setfaxrecvlog.php

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

版本: 1.0.2 最后更新: 2024-11-22

212.1 功能描述

标注传真收件箱，第三方程序可以标注预留字段,写入扩展信息。

212.2 请求参数

参数名	类型	必填	说明
id	string	是	ID
appflag1	string	否	应用标志1
appflag2	string	否	应用标志2
remark	string	否	备注，采用base64编码(编码前需要utf-8字符集)，如：5bey57uP5Zue5ouo6IGU57O7

212.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

212.4 修订历史

版本	日期	作者	说明
1.0.0	2015-06-25	畅信达	新建
1.0.1	2022-03-31	畅信达	操作表改为mvbsts_rxfax
1.0.2	2024-11-21	畅信达	信创改造

213 删除短信收件箱记录

文件路径: webservice2/delrecvsms.php

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

版本: 1.0.1 最后更新: 2024-10-30

213.1 功能描述

根据ID删除短信收件箱记录。

213.2 请求参数

参数名	类型	必填	说明
id	string	是	短息编号

213.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "操作成功，删除 1 条短信收件箱记录！",
    "data": []
}


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

213.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建
1.0.1	2024-10-30	畅信达	信创改造

214 分离设备与工号

文件路径: webservice2/ctisplitdevice.php

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

版本: 1.0.1 最后更新: 2024-10-24

214.1 功能描述

此操作将分离申请工号和申请设备的绑定关系，必要条件：工号当前没有绑定固定类型设备设备类型是临时操作逻辑：申请工号从队列下线申请设备从队列下线申请工号关系分离申请设备关系分离

214.2 请求参数

参数名	类型	必填	说明
extension	string	是	工号
device	string	是	设备号码

214.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "工号 610 与设备 609 分离成功。",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1041,
    "message": " 工号 610 不存在。",
    "data": []
}

214.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-24	畅信达	信创改造

215 获取活动通道详细信息

文件路径: webservice2/ctigetchanneldetail.php

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

版本: 1.0.1 最后更新: 2024-10-27

215.1 功能描述

此操作可获取活动通道详细信息，通过type参数可以控制返回数据所在的通道， datachannel属性之后的数据受type参数影响，可以是channel通道上的数据或者是与之通话的对端通道的数据。

215.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
type	int	否	返回数据所在的活动通道（枚举类型），默认当前通道
timeout	int	否	等待通道接通时间（秒），默认：0，最大：120

215.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "channel": "SIP\/603-00000013",
            "uniqueid": "1730100973.30",
            "dstchannel": "SIP\/601-00000014",
            "datachannel": "SIP\/603-00000013",
            "dstuniqueid": "1730100973.30",
            "did": "",
            "monitorfile": "",
            "dialednum": "601",
            "queuenum": "",
            "agentno": "",
            "ivrhist": "",
            "ivrkeyhist": "",
            "holdtime": "",
            "caller": "603",
            "callee": "601",
            "areacode": "",
            "city": "",
            "province": "",
            "simcardtype": "",
            "mvbob_taskid": ""
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1111,
    "message": "活动通道 SIP\/603-00000013 不存在。",
    "data": []
}

215.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

216 设置座席的惩罚值（优先级）

文件路径: webservice2/ctiqueuepenalty.php

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

版本: 1.0.0 最后更新: 2024-10-24

216.1 功能描述

此操作设置座席的惩罚值（优先级），用于调整来电分配策略。

216.2 请求参数

参数名	类型	必填	说明
interface	string	是	座席接口(如SIP/601)
queue	string	否	队列号码
ringinuse	string	否	是否启用振铃正在通话座席（枚举类型）,默认有效

216.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "设置队列成员的ringinuse值成功: Interface ringinuse set successfully",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1291,
    "message": "设置队列成员的ringinuse值失败: 'RingInUse' parameter must be a truth value (yes\/no, on\/off, 0\/1, etc)",
    "data": []
}

216.4 修订历史

版本	日期	作者	说明
1.0.0	2024-10-24	畅信达	信创改造，新增接口

217 通话中触发身份验证并等待验证结果

文件路径: webservice2/ctiwaitauth.php

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

版本: 1.0.1 最后更新: 2024-10-30

217.1 功能描述

通话中语音(验证AGI程序需单独编制)验证，坐席与客户通话中，要求客户进行身份验证,坐席等待验证结果数据，验证过程中，坐席处于静默或音乐状态。原理: 坐席或其他应用发起指令(快捷键定义)调用平台某一语音程序(AGI,如会员验证), 提示客户输入账户密码等信息，该语音程序对信息进行验证，并验证结果写入事先约定的通道变量CALLDATA_STATE等，此接口在给定的时间(timeout)内等待 CALLDATA_STATE变量发生变化(>0)，获取数据返回。语音程序(AGI)退出前应设置的通道变量: CALLDATA_STATE 必须调用状态 0=未处理 1=完成 2-输入不完整 3-已挂机 CALLDATA_AUTH 必须由使用者在语音程序中设定,代表认证是否通过( 0-未处理 1-通过 2-失败) CALLDATA_ID 按需 ID，由使用者在语音程序中设定 CALLDATA_ACCOUNT 按需 ACCOUNT，由使用者在语音程序中设定 CALLDATA_TIMESTAMP 按需时间戳，由使用者在语音程序中设定 CALLDATA_DATA1-4 按需预定义的变量自定义1-4 按需自定义的变量

217.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道（如SIP/601-0000006e）
code	string	是	快捷键编号(在平台管理界面定义,对应某一语音程序(如身份验证))
name	string	是	快捷键名称(在平台管理界面定义,对应某一语音程序(如身份验证)),code优先
type	int	否	类型（枚举类型0/1），默认0
timeout	int	否	等待结果时间（秒），默认：120。0秒为不等待立即返回
cdvar1	string	否	要获取的自定义通道变量名称1
cdvar2	string	否	要获取的自定义通道变量名称2
cdvar3	string	否	要获取的自定义通道变量名称3
cdvar4	string	否	要获取的自定义通道变量名称4

217.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通话中触发身份验证并等待验证结果指令成功",
    "data": [
        {
            "CALLDATA_STATE": 1,
            "CALLDATA_ID": "VIPID0001",
            "CALLDATA_ACCOUNT": "37020001",
            "CALLDATA_AUTH": 1,
            "CALLDATA_TIMESTAMP": 1730259986,
            "CALLDATA_DATA1": "模拟数据1",
            "CALLDATA_DATA2": "模拟数据2",
            "CALLDATA_DATA3": "模拟数据3",
            "CALLDATA_DATA4": "模拟数据4"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1451,
    "message": "执行通话中身份验证时发送快捷键指令失败(phpcti-10.1.0.2-20241030032937)：Channel specified does not exist",
    "data": []
}

217.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-30	畅信达	信创改造

218 删除紧急呼叫记录

文件路径: webservice2/deleteurgentcall.php

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

版本: 1.0.1 最后更新: 2024-10-30

218.1 功能描述

删除指定ID的紧急呼叫记录。

218.2 请求参数

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

218.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "已成功删除1条紧急呼叫记录！",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9002,
    "message": "缺少参数 \"id\".",
    "data": []
}

218.4 修订历史

版本	日期	作者	说明
1.0.0	2015-06-25	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-30	畅信达	信创改造

219 查询队列列表及运行计数

文件路径: webservice2/getqueuelist.php

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

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

219.1 功能描述

查询队列列表及运行计数。

219.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码

219.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "2",
    "data": [
        {
            "createtime": "2024-11-15 09:02:18",
            "queue": "90",
            "max": "0",
            "calls": "0",
            "holdtime": "0",
            "completed": "0",
            "abandoned": "0",
            "serviceLevel": "0",
            "servicelevelperf": "0.0",
            "weight": "0"
        },
        {
            "createtime": "2024-11-15 09:02:18",
            "queue": "91",
            "max": "0",
            "calls": "0",
            "holdtime": "0",
            "completed": "0",
            "abandoned": "0",
            "serviceLevel": "0",
            "servicelevelperf": "0.0",
            "weight": "0"
        }
    ]
}


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

219.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-11-15	畅信达	信创改造

220 通过名称获取呼入黑名单(旧版)

文件路径: webservice2/ctigetblacklist.php

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

版本: 1.0.1 最后更新: 2024-10-27

220.1 功能描述

此操作可将通过指定名称获取呼入黑名单号码。

220.2 请求参数

参数名	类型	必填	说明
name	string	是	呼入黑名单名称

220.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "id": "49",
            "extension": "10010",
            "blacklistname": "test",
            "reason": null,
            "isvalid": "1"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

220.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造，统一返回格式，无数据返回空数组

221 jmvbcti服务

文件路径: webservice2/jsctiserver.php

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

版本: 0.0.4 最后更新: 2024-11-22

221.1 功能描述

jmvbcti服务，此服务仅为前台js组件提供简化的封装服务，第三方开发者不应该单独使用此接口，调用时根据ctiaction参数的不同，传入的功能参数也不同，返回结果支持jsonp。

221.2 请求参数

参数名	类型	必填	说明
ctiaction	string	是	jmvbcti请求类型
jsonpCallback	string	否	jsonp函数名

221.3 响应示例


xxxxxxxxxx
{
    "errcode": 1,
    "message": "错误信息"
}

221.4 修订历史

版本	日期	作者	说明
0.0.1	2015-01-01	畅信达	新建
0.0.2	2019-05-16	畅信达	修正ORDERBY语法问题
0.0.3	2024-02-19	畅信达	修正短信通道发送表字段默认值问题
0.0.4	2024-11-22	畅信达	信创改造。

222 通过CTI锁定会议桥

文件路径: webservice2/cticonfbridgelock.php

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

版本: 1.0.0 最后更新: 2025-03-03

222.1 功能描述

通过CTI锁定会议桥。

222.2 请求参数

参数名	类型	必填	说明
conference	string	是	会议桥

222.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行通过CTI锁定会议桥成功：Conference locked",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1201,
    "message": "执行通过CTI锁定会议桥失败",
    "data": []
}

222.4 修订历史

版本	日期	作者	说明
1.0.0	2025-03-03	畅信达	新建

223 查询队列排队数据

文件路径: webservice2/getqueuecalls.php

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

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

223.1 功能描述

查询队列排队数据。

223.2 请求参数

参数名	类型	必填	说明
queue	string	否	队列号码
pbxv5	string	否	按pbxv5版本返回（返回priority字段）

223.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "1",
    "data": [
        {
            "createtime": "2024-11-14 17:34:49",
            "queue": "91",
            "queuestart": "1731576889",
            "channel": "SIP\/603-00000069",
            "uniqueid": "1731576889.195",
            "callerid": "603",
            "calleridname": "<unknown>",
            "position": "1",
            "count": "1",
            "priority": "0",
            "wait": 562
        }
    ]
}


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

223.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2022-03-31	畅信达	增加wait计算功能
1.0.2	2023-12-29	畅信达	增加pbxv5参数
1.0.3	2024-11-14	畅信达	信创改造

224 上传自定义语音文件(webcti_前缀开头)

文件路径: webservice2/putrecordings.php

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

版本: 1.0.1 最后更新: 2024-10-30

224.1 功能描述

上传自定义语音文件(webcti前缀开头)，用语音导航等播放。注意：上传至custom子目录，文件名自动加前缀webcti。

224.2 请求参数

参数名	类型	必填	说明
ivrfile	file	是	上传wav格式的文件
filename	string	否	文件名(不含目录和扩展名),缺省则自动命名
description	string	否	内容简介

224.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "上传自定义语音文件成功！",
    "data": [
        {
            "code": 0,
            "digitname": 421,
            "displayname": "webcti_ctitestvoice4"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1473,
    "message": "上传自定义语音文件失败：文件已存在！",
    "data": []
}

224.4 修订历史

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

225 根据呼叫编号删除呼损记录

文件路径: webservice2/delbadcall.php

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

版本: 1.0.1 最后更新: 2024-10-30

225.1 功能描述

根据一个或多个呼叫编号删除呼损记录。

225.2 请求参数

参数名	类型	必填	说明
uniqueid	string	是	呼叫编号，支持逗号分隔的多个编号

225.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "已成功删除1条呼损记录！",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 9002,
    "message": "缺少参数 \"uniqueid\".",
    "data": []
}

225.4 修订历史

版本	日期	作者	说明
1.0.0	2015-06-25	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-30	畅信达	信创改造

226 查询分机禁止呼出设置

文件路径: webservice2/ctigetcnd.php

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

版本: 1.0.1 最后更新: 2024-10-27

226.1 功能描述

此操作可查询分机禁止呼出设置

226.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码

226.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

226.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造

227 返回webcti接口版本号

文件路径: webservice2/about.php

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

版本: 1.0.1 最后更新: 2024-10-22

227.1 功能描述

获取webcti接口的版本和构建信息。

227.2 请求参数

参数名	类型	必填	说明

227.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "version": "2.1.17",
            "message": "WEBCTI2版本",
            "lastbuild": "2024-10-31"
        }
    ]
}


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

227.4 修订历史

版本	日期	作者	说明
1.0.0	2016-09-06	畅信达	统一响应码和响应消息
1.0.1	2024-10-22	畅信达	信创改造

228 获取指定分机信息

文件路径: webservice2/ctigetuser.php

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

版本: 1.0.2 最后更新: 2025-01-24

228.1 功能描述

此操作可获取指定分机的来电显示名称、绑定设备、保持音乐类别、出局号码、振铃时长（秒）、语音信箱

228.2 请求参数

参数名	类型	必填	说明
user	string	是	用户号码
pbxv5	string	否	按pbxv5版本返回（返回emergency_cid字段）

228.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "cidcnname": "预设",
            "cidname": "预设",
            "device": "601",
            "musichold": "default",
            "outboundcid": "",
            "ringtimer": "",
            "voicemail": "disabled"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1161,
    "message": " 用户号码 6016 不存在！",
    "data": []
}

228.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-27	畅信达	信创改造
1.0.2	2023-12-29	畅信达	增加pbxv5参数

229 激活禁止呼入（免打扰）功能

文件路径: webservice2/ctisetdndon.php

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

版本: 1.0.1 最后更新: 2024-10-29

229.1 功能描述

激活指定分机的禁止呼入（免打扰）功能。

229.2 请求参数

参数名	类型	必填	说明
extension	string	是	分机号码

229.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "激活禁止呼入（免打扰）成功！",
    "data": [
        {
            "status": "0"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9004,
    "message": "no_exten",
    "data": []
}

229.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造

230 查询队列日志记录数

文件路径: webservice2/getqueuelogcount.php

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

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

230.1 功能描述

查询队列日志记录数。

230.2 请求参数

参数名	类型	必填	说明
eventtime1	string	否	开始日期(如:2015-01-01或2015-01-01 01:22:25)
eventtime2	string	否	结束日期(如:2015-01-01或2015-01-01 01:22:25)
event	string	否	事件名称
uniqueid	string	否	呼叫编号
queuename	string	否	队列名称
agent	string	否	座席拨号接口（向右模糊匹配）
agentno	string	否	工号
history	string	否	查询历史数据库记录(枚举类型0/1)，默认0

230.3 响应示例


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


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

230.4 修订历史

版本	日期	作者	说明
1.0.0	2019-12-17	畅信达	新建
1.0.1	2024-11-15	畅信达	信创改造。

231 根据uniqueid查询通话与队列记录

文件路径: webservice2/getcdrbyuniqueid.php

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

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

231.1 功能描述

根据uniqueid查询通话与队列记录。

231.2 请求参数

参数名	类型	必填	说明
uniqueid	string	是	呼叫编号（支持逗号分隔的多个编号）
agentno	string	否	坐席工号

231.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "datatype": "queue",
            "caller": "603",
            "calldate": "2024-07-19 13:43:18",
            "uniqueid": "1721367798.161",
            "queuetime": "2024-07-19 13:43:18",
            "queuename": "90",
            "ringtime": "4",
            "answertime": "2024-07-19 13:43:45",
            "endtime": "2024-07-19 13:43:33"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 9000,
    "message": "infoid = a4478321-7f7f-4600-9e74-5812ec2187aa, Database Error code: 42S22\/0, Please search webcti.log by infoid for details.",
    "data": []
}

231.4 修订历史

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

232 取出被驻留电话

文件路径: webservice2/ctiunpark.php

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

版本: 1.0.1 最后更新: 2024-10-30

232.1 功能描述

取出被驻留电话，操作的话机先振铃,摘机后恢复与被取消对象的通话。注意事项: 1、设置正确的callerid参数和通道变量MVB_CALLER、MVB_CALLEE、MVB_DIRECT变量，以确保话单生成正确。如: callerid=602 MVB_CALLER=8001|MVB_CALLEE=114|MVB_DIRECT=out 2、操作失败时，如返回结果中有Reason字段，其含义见@see ctioriginate.php

232.2 请求参数

参数名	类型	必填	说明
channel	string	是	操作者的拨号接口（如SIP/601）
parklot	string	是	驻留位置（如701）
callerid	string	是	显示给操作者的主叫号码（通常设置驻留通话的号码，便于业务软件实现ScreenPOP）
timeout	string	否	等待操作者摘机的时间（毫秒），默认30000
variable	string	否	通道变量(如MVB_CALLER=8001
account	string	否	计费账号，通常用于后期数据查询统计
async	int	否	异步呼叫（枚举类型0/1），默认：否（同步）。设置异步时命令发送完立刻返回, 设置同步时等待channel接听才返回

232.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI取出被驻留电话指令成功：Originate successfully queued",
    "data": []
}


xxxxxxxxxx
{
    "errcode": "1441",
    "message": "Originate failed",
    "data": "[   {",
    "reason": "0\"}"
}

232.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-30	畅信达	信创改造

233 通话控制-询问转接

文件路径: webservice2/ctiatxfer.php

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

版本: 1.0.1 最后更新: 2024-10-23

233.1 功能描述

此接口实现询问转接通话功能，即A与B通话时，B先与第三方C建立通话，沟通后再把A转接给第三方C。

233.2 请求参数

参数名	类型	必填	说明
channel	string	是	活动通道
exten	string	是	电话号码
context	string	否	拨号权限

233.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "Atxfer successfully queued",
    "data": []
}


xxxxxxxxxx
{
    "errcode": 1031,
    "message": "执行CTI询问转接指令失败: Channel specified does not exist",
    "data": []
}

233.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	统一响应码和响应消息
1.0.1	2024-10-23	畅信达	信创改造

234 获取PBX信息

文件路径: webservice2/ctipbxsetting.php

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

版本: 1.0.1 最后更新: 2024-10-29

234.1 功能描述

此操作可获取PBX核心版本、最大并发、系统平均负载信息。

234.2 请求参数

参数名	类型	必填	说明

234.3 响应示例


xxxxxxxxxx
{
    "errcode": 0,
    "message": "执行CTI获取PBX信息指令成功：",
    "data": [
        {
            "pbxversion": "16.30.1",
            "maxcalls": "50",
            "maxloadavg": "0.000000"
        }
    ]
}


xxxxxxxxxx
{
    "errcode": 1261,
    "message": "执行CTI获取PBX信息指令失败",
    "data": []
}

234.4 修订历史

版本	日期	作者	说明
1.0.0	2015-01-01	畅信达	新建，统一响应码和响应消息
1.0.1	2024-10-29	畅信达	信创改造