开放 API 接口文档

索引

描述
通用格式
API接口

版本（Version）
系统（System）
分机（Local user）
外线（External line）
SIP中继（SIP trunk）
路由群（Routing group）

组（Group）
路由（Routing）

拨号规则（Dial plan）

变换（Transition）
规整主叫号码（Refine caller number）
规整被叫号码（Refine called number）
分析主叫号码（Analyze caller number）
分析被叫号码（Analyze called number）

缩位拨号（Speed dial）
连选组（Hunting group）

组（Group）
话务员（Operator）
检测方式（Detection）

会话（Session）

描述

miniSIPServer开放API接口可以让开发者开发自己的用户界面来管理、配置 miniSIPServer。所有的API接口都是web接口，而且仅使用 GET 请求。

因为 miniSIPServer 需要采用 web 服务来提供 API 接口，因此首先要启动 miniSIPServer 的web系统。请参考这篇文档了解 miniSIPServer web系统的细节。

本文档基于 miniSIPServer 最新的版本。

回到索引

通用格式

所有API的请求和反馈结果都默认采用JSON格式。

1. HTTP 路径

A本文档定义的所有 API 方法都是以下路径的子路径：

http://localhost:8080/openapi/

API 的完整路径为以下方式：

http://localhost:8080/openapi/object[/operation]

"object"为配置目标。例如可以是'localuser'，这样就可以实现增加、删除本地分机等。

"operation"是对配置目标进行的配置动作。目前支持"query", "delete", "set"等动作。该项是可选项，如果请求的URL中不包含该项，默认就是“query”。此处我们给出一些示例：

示例 1: 查询miniSIPServer版本

http://localhost:8080/openapi/version

示例 2: 增加分机

http://localhost:8080/openapi/localuser/set

2. 通用 API 参数

所有API调用都必须包含一个API关键参数，该参数就是miniSIPServer的系统管理员密码。在API中，通过'syskey'来使用该关键参数。

以下参数是所有API请求中都必须包含的参数：

参数名	是否必须	描述
syskey	必须	miniSIPServer 系统管理员密码。miniSIPServer 的 web 服务接口对所有请求都会校验该密码。

在 miniSIPServer 主窗体，请点击菜单“数据 - 系统”，如下图所示配置“管理员密码”。

Configure administrator password in system dialog

回到索引

API - 版本

该接口用于查询 miniSIPServer 当前版本号。

本方法除了通用API参数，不需要携带任何其他参数。

1. 路径

/version

2. 返回值

参数名	描述
verInfo	miniSIPServer 版本信息。

示例请求：

http://localhost:8080/openapi/version?{"syskey":"1234"}

回到索引

API - 系统

本接口用于查询或者修改 miniSIPServer 系统信息。

1. 通用路径

/sysinfo/operation

"operation"可以为以下操作项：

query - 查询系统信息.
update - 更新系统信息.

2. 查询

2.1 路径

/sysinfo/query

示例请求：

http://localhost:8080/openapi/sysinfo/query?{"syskey":"1234"}

2.2 返回值

参数名	类型	描述
admpwd	字符串	miniSIPServer 系统管理员密码。
cdrcallerusr	整数	本地主叫用户话单
cdrcalledusr	整数	本地被叫用户话单
cdrcallerextline	整数	外线主叫话单
cdrcalledextline	整数	外线被叫话单
cdrfailcall	整数	是否产生失败呼叫的话单
cdroutput	整数	将话单保存到本地文件
cdrshow	整数	是否显示实时话单
dbaddr	字符串	MySQL 服务器地址
dbname	字符串	MySQL数据库名称
dbport	整数	MySQL 服务器访问端口
dbpwd	字符串	MySQL访问密码
dbusr	字符串	MySQL访问用户名
evtChannelPort	整数	Event事件通道端口
httpport	整数	HTTP服务器端口
ogpfx	字符串	出群呼叫前缀。
publicaddr	字符串	SIP服务器外部地址，可以是一个域名地址。
realm	字符串	SIP域(realm参数)
rtpport	整数	RTP起始端口
rtType	整数	默认路由类型 0 - 本地分机 1 - 外线
sipaddr	字符串	SIP服务器本机地址(IPv4)
sipaddr6	字符串	SIP服务器本机地址(IPv6)
sipport	整数	SIP服务器UDP端口
smtppwd	字符串	SMTP服务器访问密码
smtpserv	字符串	SMTP服务器地址
smtptls	整数	当前SMTP服务器是否要求TLS连接
smtpusr	字符串	SMTP访问用户名
srfannlang	整数	提示音语言种类
stunaddr1	字符串	主STUN服务器地址
stunaddr2	字符串	次STUN服务器地址
stunport1	整数	主STUN服务器端口
stunport2	整数	次STUN服务器端口
tcpport	整数	SIP服务器TCP端口
tlsport	整数	SIP服务器TLS端口

3. 更新

3.1 路径

/sysinfo/update

示例请求:

http://localhost:8080/openapi/sysinfo/update?{"syskey":"1234","ogpfx":"0"}

应用本接口时，建议首先查询系统已有的数据，然后修改您需要的参数项，再使用本接口重新更新回 miniSIPServer 中。

回到索引

API - 分机

本接口用于查询或者更新本地分机配置信息。

1. 通用路径

/localuser/operation

"operation"包含以下操作项：

list - 查询所有分机的概要信息
query - 查询某分机的具体信息
delete - 删除一部分机的配置
set - 添加或者更新分机配置信息

2. 列表

2.1 路径

/localuser/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20个分机的概要信息。如果当前配置超过20部分机，则需要指定该参数来返回相应的分机概要信息。该参数默认值为0，即返回最初的20部分机的信息。

示例请求:

http://localhost:8080/openapi/localuser/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
usrname	字符串	分机号码
description	字符串	本记录的描述
dispname	字符串	分机显示名称
addr	字符串	分机的地址

3. 查询

3.1 路径

/localuser/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
usrname	字符串	查询的分机号

示例请求:

http://localhost:8080/openapi/localuser/query?{"syskey":"1234", "usrname":"100"}

3.2 返回值

参数名	类型	描述
usrname	字符串	查询的分机号
usrpwd	字符串	分机密码
description	字符串	描述
right_ipauth	整数	IP地址鉴权标识
addr	字符串	当前分机IP地址
port	整数	当前分机的实际端口
state	整数	分机状态
right_aa	整数	自动话务员业务权限
right_rg	整数	振铃组权限
right_sup_rg	整数	"直接呼入时，抑制振铃组"业务权限
ringgrpid	整数	振铃组组ID
right_pickup	整数	"呼叫代答"业务权限
pickupgrpid	整数	"呼叫代答"组ID
right_park	整数	"call park"业务权限
right_retrieve	整数	"call retrieve"业务权限
right_cw	整数	"呼叫等待"业务权限
fmtype	整数	“呼叫跟随”策略
fminterval	整数	“呼叫跟随”业务间隔时间
fmdesta	字符串	“呼叫跟随”号码A。
fmdestb	字符串	“呼叫跟随”号码B。
fmdestc	字符串	“呼叫跟随”号码C。
enddate	整数	结束日期
dialPlan	字符串	拨号计划
dispname	字符串	显示号码
specextline	字符串	使用指定的外线做出局呼叫
maxdura	整数	最大通话时长
maxcall	整数	最大并发呼叫数
momaxcall	整数	最大外呼并发呼叫数
calllevel	整数	呼叫级别
right_cfu	整数	无条件前转（CFU）业务权限
cfunbr	字符串	CFU 号码
right_cfnc	整数	不可达前转(CFNC)业务权限
cfncnbr	字符串	CFNC 号码
right_cfb	整数	遇忙前转(CFB)业务权限
cfbnbr	字符串	CFB 号码
right_cfna	整数	无应答前转(CFNA)业务权限
cfnanbr	字符串	CFNA 号码
cfnatmr	整数	无应答定时器时长
right_vms	整数	"语音邮箱"业务权限
vmannid	整数	语音邮箱个性化欢迎词语音ID
email	字符串	电邮地址
right_prepaid	整数	主叫预付费业务权限
right_subpre	整数	状态或者对话信息呈现权限
presgrpid	整数	状态呈现组ID
right_clrid	整数	主叫号码重定义业务权限
right_moh	整数	“呼叫保持时播放音乐”业务权限.
right_relay	整数	"转发媒体流"业务权限
right_oli	整数	“监听呼出呼叫”指示
right_tli	整数	“监听呼入呼叫”指示
tcID	整数	时间条件编号。

4. 删除

4.1 路径

/localuser/delete

以下是必选参数：

参数名	类型	描述
usrname	字符串	需要删除的分机号

示例请求:

http://localhost:8080/openapi/localuser/delete?{"syskey":"1234", "usrname":"100"}

5. 设置

5.1 路径

/localuser/set

以下是必选参数：

参数名	类型	描述
usrname	字符串	需要配置的分机号

其他参数都是可选参数，定义与"查询"章节的返回值相同。

示例请求:

http://localhost:8080/openapi/localuser/set?{"syskey":"1234", "usrname":"100", "usrpwd":"100"}

回到索引

API - 外线

本接口用于查询或者更新“外线”配置信息。

1. 通用路径

/extline/operation

"operation"包含以下操作项：

list - 查询所有外线的概要信息
query - 查询某外线的具体信息
delete - 删除一条外线的配置
set - 添加或者更新外线配置信息

2. 列表

2.1 路径

/extline/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求:

http://localhost:8080/openapi/extline/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
extLine	字符串	外线名称
description	字符串	本记录描述
host	字符串	对端服务器地址
port	整数	对端服务器端口
localUser	字符串	入呼叫转接至目的号码
transport	整数	底层传输类型，例如UDP, TCP.
state	整数	当前外线状态

3. 查询

3.1 路径

/extline/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
extLine	字符串	需要查询的外线名称或者号码

示例请求：

http://localhost:8080/openapi/extline/query?{"syskey":"1234", "extLine":"5678"}

3.2 返回值

参数名	类型	描述
extLine	字符串	外线名称
state	整数	当前外线的状态 0 - 未注册 1 - 空闲 2 - 振铃或者放回铃音 3 - 通话
host	字符串	对端服务器或者网关地址
port	整数	对端服务器或者网关的端口
localUser	字符串	入呼叫转接至目的号码
type	整数	外线类型 0 - 连接到对端 VoIP/SIP 服务器 1 - 连接到 FXO 网关
password	字符串	鉴权密码
authID	字符串	（单独的）鉴权ID
maxDur	整数	最大通话时长。默认值为0，表示不限制通话时长。
chain	字符串	如果当前外线外呼失败，转接至另一个外线尝试外呼。
transport	整数	底层传输协议. 0 - UDP, 1 - TCP.
ogGroupID	整数	出呼叫群编号
maxMOCalls	整数	最大同时呼出呼叫数。
otcID	整数	出呼叫时间条件编号。
noAnsTimer	整数	无应答时长
description	字符串	当前记录描述
maxCalls	整数	最大同时呼叫数
aaInd	整数	入呼叫转接至自动话务员标识。
outbandInd	整数	外呼是否经过外置服务器或者代理服务器。
outbandServer	字符串	外呼代理服务器地址
outbandPort	整数	外呼代理服务器端口
shareInd	整数	其他分机是否可以使用当前外线外呼。
origCallerNbr	整数	是否采用原主叫作为显示号码
authidWithAddrInd	整数	鉴权ID是否应携带地址信息
reInviteInd	整数	本外线不支持reINVITE操作更改操作
donotRegInd	整数	是否不需要注册
incomingLI	整数	是否监听呼入呼叫

4. 删除

4.1 路径

/extline/delete

以下是必选参数：

参数名	类型	描述
extLine	字符串	需要删除的外线

示例请求：

http://localhost:8080/openapi/extline/delete?{"syskey":"1234", "extLine":"5678"}

5. 设置

5.1 路径

/extline/set

以下是必选参数：

参数名	类型	描述
extLine	字符串	需要配置或者修改的外线

其他参数都是可选参数，定义与"查询"章节的返回值相同。

示例请求：

http://localhost:8080/openapi/extline/set?{"syskey":"1234", "extLine":"5678", "host":"10.0.0.1"}

回到索引

API - SIP 中继

本接口用于查询或者更新“SIP中继”配置信息。

1. 通用路径

/peerserver/operation

"operation"包含以下操作项：

list - 查询所有中继的概要信息
query - 查询某中继的具体信息
delete - 删除一条中继
set - 增加或者修改SIP中继配置

2. 列表

2.1 路径

/peerserver/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求:

http://localhost:8080/openapi/peerserver/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
servID	整数	SIP 中继编号
desc	字符串	描述
servAddr	字符串	服务器地址
servPort	整数	服务器端口
transport	整数	传输层协议，可以是 UDP 或者 TCP。

3. 查询

3.1 路径

/peerserver/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
servID	整数	SIP 中继编号

示例请求:

http://localhost:8080/openapi/peerserver/query?{"syskey":"1234", "servID":1}

3.2 返回值

参数名	类型	描述
servID	整数	SIP 中继编号
desc	字符串	描述
servAddr	字符串	服务器地址
servPort	整数	服务器端口
callerID	字符串	出呼叫主叫号码
dialPlan	字符串	入呼叫拨号计划
transport	整数	传输协议， 0 - UDP, 1 - TCP.
ogGroupID	整数	出呼叫群编号
otcID	整数	出呼叫时间条件编号
oMaxCalls	整数	最大同时呼出呼叫数
iMaxCalls	整数	最大同时呼入呼叫数
orelayMediaInd	整数	出呼叫是否需要转发媒体流
chainTrunkID	整数	呼叫失败时转用另一SIP中继

4. 删除

4.1 路径

/peerserver/delete

以下是必选参数:

参数名	类型	描述
servID	整数	SIP中继编号

示例请求:

http://localhost:8080/openapi/peerserver/delete?{"syskey":"1234", "servID":1}

5. 设置

5.1 路径

/peerserver/set

以下是必选参数 :

参数名	类型	描述
servID	整数	SIP 中继编号

其他参数都是可选参数，定义与 "查询" 章节的返回值相同。

示例请求：

http://localhost:8080/openapi/peerserver/set?{"syskey":"1234", "servID":1, "servAddr":"10.0.0.1", "servPort":5678}

回到索引

API - 路由群 - 群

本接口用于查询或者更新“路由群”群信息配置。

1. 通用路径

/routegroup/operation

"operation"包含以下操作项：

list - 查询所有群的概要信息
query - 查询某群的具体信息
delete - 删除一个群
set - 增加或者修改群配置

2. 列表

2.1 路径

/routegroup/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求：

http://localhost:8080/openapi/routegroup/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
groupID	整数	路由群编号
description	字符串	记录描述

3. 查询

3.1 路径

/routegroup/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
groupID	整数	路由群编号

示例请求：

http://localhost:8080/openapi/routegroup/query?{"syskey":"1234", "groupID":1}

3.2 返回值

所有返回值与“列表结果”一致。

4. 删除

4.1 路径

/routegroup/delete

以下是必选参数:

参数名	类型	描述
groupID	整数	路由群编号

示例请求：

http://localhost:8080/openapi/routegroup/delete?{"syskey":"1234", "groupID":1}

5. 设置

5.1 路径

/routegroup/set

以下是必选参数 :

参数名	类型	描述
groupID	整数	路由群编号

其他参数都是可选参数，定义与 "列表" 章节的返回值相同。

示例请求：

http://localhost:8080/openapi/routegroup/set?{"syskey":"1234", "groupID":1, "description":"to NY"}

回到索引

API - 路由群 - 路由

本接口用于查询或者更新“路由群”中路由的信息配置。

1. 通用路径

/route/operation

"operation"包含以下操作项：

list - 查询所有路由的概要信息
delete - 删除一条路由
add - 增加一条路由

2. 列表

2.1 路径

/route/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求：

http://localhost:8080/openapi/route/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
groupID	整数	路由组编号
routeType	整数	路由类型. 1 - 外线, 2 - SIP中继.
sipTrunkID	整数	如果路由类型是“SIP中继”，设置 SIP 中继编号
extLine	字符串	如果路由类型是“外线”时，设置外线信息。

3. 删除

3.1 路径

/route/delete

以下是必选参数:

参数名	类型	描述
groupID	整数	路由组编号
routeType	整数	路由类型
sipTrunkID	整数	SIP 中继编号
extLine	字符串	外线

示例请求：

http://localhost:8080/openapi/route/delete?{"syskey":"1234", "groupID":1, "routeType":1, "extLine":"eee", "sipTrunkID":0}

4. 增加

4.1 路径

/route/add

所有参数与 "列表结果" 相同，并且都是必选参数。

示例请求：

http://localhost:8080/openapi/route/add?{"syskey":"1234", "groupID":1, "routeType":1, "extLine":"eee", "sipTrunkID":0}

回到索引

API - 拨号规则 - 变换

本接口用于查询或者更新“变换”的配置。

1. 通用路径

/natran/operation

"operation"包含以下操作项：

list - “变换”记录列表
query - 查询“变换”记录细节
delete - 删除一条“变换”记录
set - 增加或者修改“变换”记录

2. 列表

2.1 路径

/natran/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求：

http://localhost:8080/openapi/natran/list?{"syskey":"1234","pageIndex":0}

2.2 返回值

参数名	类型	描述
tranID	整数	变换编号
type	整数	变换类型, 1 - 增加, 2 - 替换, 3 - 删除.
tranStart	整数	变换起始位置
tranLen	整数	变换长度
prefix	字符串	增加或者替换的号码前缀
description	字符串	描述

3. 查询

3.1 路径

/natran/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
tranID	整数	变换编号

示例请求：

http://localhost:8080/openapi/natran/query?{"syskey":"1234","tranID":101}

3.2 返回值

所有返回值与 "列表" 章节的返回值相同。

4. 删除

4.1 路径

/natran/delete

以下是必选参数：

参数名	类型	描述
tranID	整数	变换编号

示例请求：

http://localhost:8080/openapi/natran/delete?{"syskey":"1234","tranID":101}

5. 设置

5.1 路径

/natran/set

所有在 "列表" 章节定义的返回值都要求进行设置。

示例请求：

http://localhost:8080/openapi/natran/set?{"syskey":"1234", "tranID":101, "type":2, "tranStart":0, "tranLen":3,"prefix":"0105678","description":"demo record"}

回到索引

API - 拨号规则 - 规整主叫号码

本接口用于查询或者更新 "规整主叫号码" 的配置。

1. 通用路径

/refineclrnbr/operation

"operation"包含以下操作项：

list - 查询所有"规整主叫号码"概要信息
query - 查询单条记录具体信息
delete - 删除一条记录
set - 增加或者修改一条记录

2. 列表

2.1 路径

/refineclrnbr/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求：

http://localhost:8080/openapi/refineclrnbr/list?{"syskey":"1234","pageIndex":0}

2.2 返回值

参数名	类型	描述
grpID	整数	号码规整组编号
callerNbr	字符串	主叫号码前缀
tranID	整数	号码变换编号
description	字符串	描述

3. 查询

3.1 路径

/refineclrnbr/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
grpID	整数	号码规整组编号
callerNbr	字符串	主叫号码前缀

示例请求：

http://localhost:8080/openapi/refineclrnbr/query?{"syskey":"1234","grpID":1, "callerNbr":"1"}

3.2 返回值

所有返回值与 "列表" 章节的返回值相同。

4. 删除

4.1 路径

/refineclrnbr/delete

以下是必选参数 :

参数名	类型	描述
grpID	整数	号码规整组编号
callerNbr	字符串	主叫号码前缀

示例请求：

http://localhost:8080/openapi/refineclrnbr/delete?{"syskey":"1234","grpID":1, "callerNbr":"1"}

5. 设置

5.1 路径

/refineclrnbr/set

所有在章节 "列表" 章节定义的返回值都是必选参数。

示例请求：

http://localhost:8080/openapi/refineclrnbr/set?{"syskey":"1234", "grpID":1, "callerNbr":"1", "tranID":1,"description":"demo record"}

回到索引

API - 拨号规则 - 规整被叫号码

本接口用于查询或者更新 “规整被叫号码” 配置信息。

1. 通用路径

/refinecldnbr/operation

"operation"包含以下操作项：

list - 列表所有记录的摘要信息
query - 查询一条记录的详细信息
delete - 删除一条记录
set - 新增加或者修改一条记录

2. 列表

2.1 路径

/refinecldnbr/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求：

http://localhost:8080/openapi/refinecldnbr/list?{"syskey":"1234","pageIndex":0}

2.2 返回值

参数名	类型	描述
groupID	整数	出呼叫群编号
calledPrefix	字符串	被叫号码前缀
transID	整数	变换编号
description	字符串	描述

3. 查询

3.1 路径

/refinecldnbr/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
groupID	整数	出呼叫群编号
calledPrefix	字符串	被叫号码前缀

示例请求：

http://localhost:8080/openapi/refinecldnbr/query?{"syskey":"1234","groupID":1, "calledPrefix":"1"}

3.2 返回值

所有返回值与 "列表" 章节的返回值相同。

4. 删除

4.1 路径

/refinecldnbr/delete

以下是必选参数 :

参数名	类型	描述
groupID	整数	出呼叫群编号
calledPrefix	字符串	被叫号码前缀

示例请求：

http://localhost:8080/openapi/refinecldnbr/delete?{"syskey":"1234","groupID":1, "calledPrefix":"1"}

5. 设置

5.1 路径

/refinecldnbr/set

所有参数与 "列表" 章节的返回值定义相同，都是必选参数。

示例请求：

http://localhost:8080/openapi/refinecldnbr/set?{"syskey":"1234", "groupID":1, "calledPrefix":"1", "transID":1,"description":"demo record"}

回到索引

API - 拨号规则 - 分析主叫号码

本接口用于查询或者更新 “分析主叫号码” 配置信息。

1. 通用路径

/anaclrnbr/operation

"operation"包含以下操作项：

list - 列表所有记录的摘要信息
query - 查询一条记录的相信信息
delete - 删除一条记录
set - 增加或者修改一条记录

2. 列表

2.1 路径

/anaclrnbr/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求：

http://localhost:8080/openapi/anaclrnbr/list?{"syskey":"1234","pageIndex":0}

2.2 返回值

参数名	类型	描述
callerNbr	字符串	主叫号码前缀
description	字符串	描述
tranID	整数	变换编号
dialPlan	字符串	（新）拨号规则

3. 查询

3.1 路径

/anaclrnbr/query

以下是必选参数：

参数名	类型	描述
callerNbr	字符串	主叫号码前缀

示例请求：

http://localhost:8080/openapi/anaclrnbr/query?{"syskey":"1234", "callerNbr":"1"}

3.2 返回值

所有返回值与 "列表" 章节的返回值相同。

4. 删除

4.1 路径

/anaclrnbr/delete

以下是必选参数：

参数名	类型	描述
callerNbr	字符串	主叫号码前缀

示例请求：

http://localhost:8080/openapi/anaclrnbr/delete?{"syskey":"1234","callerNbr":"1"}

5. 设置

5.1 路径

/anaclrnbr/set

所有参数与 "列表" 章节的返回值定义相同，都是必选参数。

示例请求：

http://localhost:8080/openapi/anaclrnbr/set?{"syskey":"1234", "groupID":1, "callerNbr":"1","description":"demo record", "dialPlan":"default","tranID": 1}

回到索引

API - 拨号规则 - 分析被叫号码

本接口用于查询或者更新 “分析被叫号码” 配置信息。

1. 通用路径

/anacldnbr/operation

"operation"包含以下操作项：

list - 列表所有记录的摘要信息
query - 查询一条记录的相信信息
delete - 删除一条记录
set - 增加或者修改一条记录

2. 列表

2.1 路径

/anacldnbr/list

本接口有可能包含以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求：

http://localhost:8080/openapi/anacldnbr/list?{"syskey":"1234","pageIndex":0}

2.2 返回值

参数名	类型	描述
dialPlan	字符串	拨号计划
calledNbr	字符串	被叫号码前缀
description	字符串	描述
routeType	整数	路由类型 0 - 分机 1 - 外线 2 - SIP 中继 4 - 拦截 6 - 路由群
servID	整数	SIP 中继编号。如果路由类型是 “SIP中继”，则本参数必须配置。
extLine	字符串	指定的外线
rtGroupID	整数	路由组编号。如果路由类型是 “路由组”，则本参数必须配置。
changeInd	整数	是否变换被叫号码
tranID	整数	被叫号码变换编号
reAnaInd	整数	被叫号码变换后，是否重新分析
clrRefineID	整数	主叫号码规整组编号
maxDuration	整数	最大通话时长
callLevel	整数	呼叫级别

3. 查询

3.1 路径

/anacldnbr/query

以下是必选参数（附加于“通用API参数”)：

参数名	类型	描述
dialPlan	字符串	拨号计划
calledNbr	字符串	被叫号码前缀

示例请求：

http://localhost:8080/openapi/anacldnbr/query?{"syskey":"1234", "dialPlan":"default", "calledNbr":"1"}

3.2 返回值

所有返回值与 "列表" 章节的返回值相同。

4. 删除

4.1 路径

/anacldnbr/delete

以下是必选参数 :

参数名	类型	描述
dialPlan	字符串	拨号计划
calledNbr	字符串	被叫号码前缀

示例请求：

http://localhost:8080/openapi/anacldnbr/delete?{"syskey":"1234", "dialPlan":"default", "calledNbr":"1"}

5. 设置

5.1 路径

/anacldnbr/set

以下是必选参数 :

参数名	类型	描述
dialPlan	字符串	拨号计划
calledNbr	字符串	被叫号码前缀

其他参数是可选参数，与 "列表" 章节的返回值相同。

示例请求：

http://localhost:8080/openapi/anacldnbr/set?{"syskey":"1234","dialPlan":"default", "calledNbr":"1", "description":"demo record","routeType":0}

回到索引

API - 缩位拨号

本接口用于配置、查询“缩位拨号”业务的相关记录。

1. 通用路径

/speeddial/operation

"operation"可以为以下类型：

list - 缩位拨号记录列表
query - 查询缩位拨号记录细节
delete - 删除缩位拨号记录
set - 增加或者更新缩位拨号记录

2. 列表

2.1 路径

/speeddial/list

本接口要求以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求:

http://localhost:8080/openapi/speeddial/list?{"syskey":"1234","pageIndex":0}

2.2 返回值

参数名	类型	描述
callerNbr	字符串	主叫号码
dialedNbr	字符串	拨打号码
desc	字符串	描述
destNbr	字符串	最终目的号码

3. 查询

3.1 路径

/speeddial/query

接口要求以下参数 :

参数名	类型	描述
callerNbr	字符串	主叫号码
dialedNbr	字符串	拨打号码

示例请求:

http://localhost:8080/openapi/speeddial/query?{"syskey":"1234","callerNbr":"1", "dialedNbr":"1"}

3.2 返回值

参数名	类型	描述
callerNbr	字符串	主叫号码
dialedNbr	字符串	拨打号码
desc	字符串	描述
destNbr	字符串	最终目的号码

4. 删除

4.1 路径

/speeddial/delete

本接口包含以下参数:

参数名	类型	描述
callerNbr	字符串	主叫号码
dialedNbr	字符串	拨打号码

示例请求:

http://localhost:8080/openapi/speeddial/delete?{"syskey":"1234","callerNbr":"1", "dialedNbr":"1"}

5. 设置

5.1 路径

/speeddial/set

本接口包含以下必选参数：

参数名	类型	描述
callerNbr	字符串	主叫号码
dialedNbr	字符串	拨打号码

其他参数是可选参数，与"查询"操作的返回值一致。

示例请求:

http://localhost:8080/openapi/speeddial/set?{"syskey":"1234", "callerNbr":"3", "dialedNbr":"3", "desc":"demo record", "destNbr":"333"}

回到索引

API - 连选组 - 组配置

本接口用于配置“连选组”组信息的相关记录。

1. 通用路径

/hginfo/operation

"operation"可以为以下类型：

list - 组信息记录列表
query - 查询组信息记录细节
delete - 删除组信息记录
set - 增加或者更新组信息记录

2. 列表

2.1 路径

/hginfo/list

本接口要求以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求:

http://localhost:8080/openapi/hginfo/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
grpID	整数	组编号
desc	字符串	描述
strategy	整数	连选策略：1-轮询, 2-线性。
noAnsTmr	整数	话务员无应答时长（秒）

3. 查询

3.1 路径

/hginfo/query

接口要求以下参数

参数名	类型	描述
grpID	整数	组编号

示例请求:

http://localhost:8080/openapi/hginfo/query?{"syskey":"1234","grpID":1}

3.2 返回值

参数名	类型	描述
grpID	整数	组编号
desc	字符串	描述
strategy	整数	连选策略：1-轮询, 2-线性
noAnsTmr	整数	话务员无应答时长（秒）
queueInd	整数	话务员全忙，呼叫是否进入等待队列
maxCall	整数	最大等待呼叫数
maxDura	整数	最长等待时间（秒）

4. 删除

4.1 路径

/hginfo/delete

本接口包含以下参数：

参数名	类型	描述
grpID	整数	组编号

示例请求:

http://localhost:8080/openapi/hginfo/delete?{"syskey":"1234","grpID":1}

5. 设置

5.1 路径

/hginfo/set

本接口包含以下必选参数：

参数名	类型	描述
grpID	整数	组编号
strategy	整数	连选策略

其他参数是可选参数，与"查询"操作的返回值一致。

示例请求:

http://localhost:8080/openapi/hginfo/set?{"syskey":"1234", "grpID":1,"strategy":1}

回到索引

API - 连选组 - 话务员

本接口用于配置“连选组”话务员的相关记录

1. 通用路径

/hgoper/operation

"operation"可以为以下类型：

list - 话务员信息记录列表
delete - 删除话务员记录
set - 增加或者更新话务员记录

2. 列表

2.1 路径

/hgoper/list

本接口要求以下可选参数：

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求:

http://localhost:8080/openapi/hgoper/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
oper	字符串	话务员号码
grpID	整数	组编号
autoInd	整数	话务员是否自动登陆连选组

3. 删除

3.1 路径

/hgoper/delete

本接口包含以下参数：

参数名	类型	描述
oper	字符串	话务员号码

示例请求:

http://localhost:8080/openapi/hgoper/delete?{"syskey":"1234","oper":"100"}

4. 设置

4.1 路径

/hgoper/set

本接口参数均为必选参数，与"列表"操作的返回值一致。

示例请求:

http://localhost:8080/openapi/hgoper/set?{"syskey":"1234","oper":"100","grpID":1,"autoInd":1}

回到索引

API - 连选组 - 检测方式

本接口用于配置“连选组”检测方式的相关记录。

1. 通用路径

/hgdect/operation

"operation"可以为以下类型：

list - 检测方式记录列表
query - 查询检测方式记录细节
delete - 删除检测方式记录
set - 增加或者更新检测方式

2. 列表

2.1 路径

/hgdect/list

参数名	类型	描述
pageIndex	整数	默认情况下，miniSIPServer 每次最多返回20条记录的概要信息。如果当前配置超过20条记录，则需要指定该参数来返回相应的记录。该参数默认值为0，即返回最初的20条记录。

示例请求:

http://localhost:8080/openapi/hgdect/list?{"syskey":"1234", "pageIndex":0}

2.2 返回值

参数名	类型	描述
dialPlan	字符串	拨号计划
calledNbr	字符串	被叫号码
grpID	整数	连选组编号

3. 查询

3.1 路径

/hgdect/query

接口要求以下参数

参数名	类型	描述
dialPlan	字符串	拨号计划
calledNbr	字符串	被叫号码

示例请求:

http://localhost:8080/openapi/hgdect/query?{"syskey":"1234","dialPlan":"default","calledNbr":"1234"}

3.2 返回值

返回值与"列表"操作的返回值一致。

4. 删除

4.1 路径

/hgdect/delete

本接口包含以下参数：

参数名	类型	描述
dialPlan	字符串	拨号计划
calledNbr	字符串	被叫号码

示例请求:

http://localhost:8080/openapi/hgdect/delete?{"syskey":"1234","dialPlan":"default","calledNbr":"5678"}

5. 设置

5.1 路径

/hgdect/set

本接口参数均为必选参数，与"列表"操作的返回值一致。

示例请求:

http://localhost:8080/openapi/hgdect/set?{"syskey":"1234","dialPlan":"default","calledNbr":"5678","grpID":1}

回到索引

API - 会话

会话接口用于修改、更新甚至删除 miniSIPServer 内部的一个SIP会话。

1. 通用路径

/session/operation

2. 释放会话

2.1 路径

/session/release

以下是必选参数：

参数名	类型	描述
number	字符串	分机号码或者外部用户号码。 miniSIPServer 将根据这个号码释放内部对应的 SIP 会话。

示例请求:

http://localhost:8080/openapi/session/release?{"syskey":"1234", "number":"100"}

回到索引

MYVOIPAPP

miniSIPServer 开放 API 接口文档

1. HTTP 路径

2. 通用 API 参数

1. 路径

2. 返回值

1. 通用路径

2. 查询

2.1 路径

2.2 返回值

3. 更新

3.1 路径

1. 通用路径

2. 列表

2.1 路径

2.2 返回值

3. 查询

3.1 路径

3.2 返回值

4. 删除

4.1 路径

5. 设置

5.1 路径

1. 通用路径

2. 列表

2.1 路径

2.2 返回值

3. 查询

3.1 路径

3.2 返回值

4. 删除

4.1 路径

5. 设置

5.1 路径

1. 通用路径

2. 列表

2.1 路径

2.2 返回值

3. 查询

3.1 路径

3.2 返回值

4. 删除

4.1 路径

5. 设置

5.1 路径

1. 通用路径

2. 列表

2.1 路径

2.2 返回值

3. 查询

3.1 路径

3.2 返回值

4. 删除

4.1 路径

5. 设置

5.1 路径

1. 通用路径

2. 列表

2.1 路径

2.2 返回值

3. 删除

3.1 路径

4. 增加

4.1 路径

1. 通用路径

2. 列表

2.1 路径

2.2 返回值

3. 查询

3.1 路径

3.2 返回值

4. 删除

4.1 路径

5. 设置

5.1 路径

1. 通用路径

2. 列表

2.1 路径

2.2 返回值

3. 查询