MYVOIPAPP

miniSIPServer 用户手册

1. 介绍

miniSIPServer 是基于 Windows 系统以及 Linux 系统的专业 VoIP/SIP 服务器软件。

官方网站为https://www.myvoipapp.com/cn/ 或者 https://www.minisipserver.com.

软件下载链接: https://www.myvoipapp.com/cn/download.

2. 演示网络

network topology

在上图中,有个重要的网元。A和C是SIP电话,B是安装在PC系统中的SIP软终端。A和B部署在局域网中,miniSIPServer 也部署在同一网络中。我们将A和B命名为“本地用户”或者“分机”。C位于另一个网络中,我们将它命名为“外部用户”。它们通过Internet互联。

在这个网络中,我们假定C直接注册到VoIP运营商网络。A和B是本地VoIP网络的分机,同时给A分配可一个外线号码。当本地分机拨打外部用户,例如B呼叫C,我们称之为“外呼”或者“出群呼叫”。

请参考下面的表格了解更多的细节:

网元 地址 分机号 外线号码
miniSIPServer 192.168.1.100 - -
A 192.168.1.101 101 2001
B 192.168.1.100 100 -
C - - 2002
3. 演示拨号计划

miniSIPServer 支持多种呼叫场景,在不同的场景中可以应用不同的拨号计划。本地用户外呼时,需要在被叫号码前加'9'。'9'是系统缺省配置的外呼前缀。

下表描述了各种呼叫场景及相应的拨号计划.

主叫用户 被叫用户 如何拨打 示例
A B B的分机号码 100
A C 外呼前缀 + C的外部号码 92002
C A A的外部号码 2001
C B - 通过‘自动话务员’业务拨打
B A A的分机号码 101
B C 外呼前缀 + C的外部号码 92002
4. 分机

缺省情况下, miniSIPServer 预设了三个本地分机配置, 它们分别是'100', '101' and '102', 对应的密码分别是'100', '101' and '102'. 当然, 我们可以灵活地添加, 修改以及删除本地分机配置, 各项操作都非常简单.

请点击菜单"数据 / 分机"显示本地分机信息窗体.

在这个窗体中, 用不同的图标来区分分机的状态。

图标 状态
unregister user icon 分机还没有注册到 miniSIPServer 中
idle user icon 分机已经注册进系统, 并且目前处于空闲状态
alerting user icon 分机正在振铃
talking user icon 分机正在通话
4.1 基本配置

分机基本配置信息

配置项 类型或值 描述
分机 字符串 本地分机名称
密码 字符串 分机鉴权密码
描述 字符串 描述性说明。例如,可以记录该分机的物理位置、使用者等说明信息。
IP地址鉴权 是/否 采用IP地址对当前用户鉴权。如果选择了该项,分机就不再需要发送REGISTER消息进行注册,miniSIPServer 会直接检查该分机SIP消息的地址。
默认情况下没有选择该项,miniSIPServer 将采用分机号码和密码进行鉴权。
IP地址 字符串 SIP终端的实际地址。
端口 整数 SIP终端的实际端口。
4.2 基本呼叫

分机基本呼叫配置

配置项 类型或值 描述
结束日期 日期 当前分机的有效日期. 如果超出该日期, 则分机停机, 不能发起或者接受任何呼叫. 缺省值为0, 代表永久有效.
格式为'YYYY-MM-DD', 例如'2012-12-10'.
时间条件编号 整数 请参考“时间条件”文档了解细节。
拨号计划 字符串 当前分机的拨号计划名称, 缺省值为'default'. 在被叫号码分析以及路由选择过程中, miniSIPServer 将使用该参数作为关键索引之一. 如果您将它配置为其他值, 最终的呼叫选路结果很可能会不同.
显示号码 字符串 给被叫方显示的号码
例如, 分机'100'配置显示号码为'Gilson', 则被叫看到的主叫号码是'Gilson'. 如果将该项配置为空, 则被叫方看到的号码是'100'.
无应答时长 整数 无应答定时器时长
使用特定的外线做出局呼叫 是/否 如果选择该项, 就必须同时配置特定的外线号码. 该分机外呼时, 将采用配置的特定外线进行呼叫.
限制呼出呼叫的最大通话时长 整数 限制主叫最大通话时长, 超时则自动释放呼叫.
最大同时呼叫数 整数 限制分机最大同时呼叫数.
如果配置为0,则该用户即不能呼出,也不能呼入。
最大同时呼出呼叫数 整数 限制分机作主叫呼出时,最大同时呼叫数。
如果配置为0,则该用户只能呼入,不能呼出。
呼叫权限 整数 不同呼叫的呼叫权限设置.
在"拨号计划/分析被叫号码"表中, 号码分析结果可以设置要求不同的呼叫权限, 用户只有具有相应权限才能拨打该的呼叫.
4.3 前转类业务

分机前转业务配置

配置项 类型或值 描述
呼叫无条件前转到用户 是/否 设置各类前转业务权限。

如果选择了这些项,说明该分机具有相应的前转业务权限,同时也要求配置相应的前转号码。

请参考"呼叫前转业务文档"了解更多细节。

被叫不可达, 呼叫前转到用户 是/否
被叫忙, 呼叫前转到用户 是/否
被叫无应答, 呼叫前转到用户 是/否
被叫无应答或者不可达, 前转语音邮箱 是/否 如果用户缺席或者没有应答呼叫,miniSIPServer 将提示主叫用户留言并将语音留言发送给用户的email邮箱
电子邮箱地址 电子邮箱地址 分机电子邮箱地址。在语音邮箱业务中,miniSIPServer 将把该分机的语音留言发送到该邮箱中。请参考"语音邮箱业务"了解更多的细节。
4.4 呼叫跟随

请参考 "呼叫跟随业务文档"了解更多细节.

follow-me configuration

配置项 类型或值 描述
策略 0,1,2
  • 0(缺省) - 同时呼叫所有号码
  • 1 - 当前呼叫无应答, 继续呼叫下一个号码
  • 2 - 间隔一段时间, 呼叫下一个号码
间隔时间 整数 如果'策略'配置为2, 则必须同时配置该项.
号码 A 字符串 目的号码 A
号码 B 字符串 目的号码 B
号码 C 字符串 目的号码 C
4.5 补充业务

local user supplementary configuration

配置项 类型或值 描述
自动话务员 是/否 当前分机是否是话务员.
请参考"自动话务员业务文档"了解进一步的细节.
对于直接呼入的呼叫, 抑制同时振铃特性 是/否 如果配置了该项, 主叫直接呼叫该分机时, 该分机振铃, 但是同组的其他分机不会同时振铃.
振铃组编号 整数,>=0 如果设置为0,则该用户没有同时振铃特性;如果设置为其他值,则配置相同值的用户都属于同一个同时振铃组。 请参考"振铃组"业务文档了解更多细节。
呼叫代答组编号 整数,>=0 如果设置为0,则该用户没有呼叫代答特性;如果设置为其他值,则配置相同值的用户都属于同一个代答组,组内的用户都可以代答其他用户的呼叫。 请参考"指定代答与同组代答"业务文档。
Call park 是/否 "Call park"业务权限指示位. 请参考"Call park与call retrieve业务文档".
Call retrieve 是/否 "Call retrieve"业务权限指示位. 请参考"Call park与call retrieve业务文档".
呼叫等待 是/否 "呼叫等待"业务权限。请参考"呼叫等待业务文档"。
一号多机 是/否 "一号多机"业务权限指示位,请参考"一号多机业务文档"。
话务员强插 是/否 "话务员强插"业务权限指示位,请参考"话务员业务文档"。
话务员逾越 是/否 "话务员逾越"业务权限指示位,请参考""话务员业务文档"。
4.6 高级业务

local user advance service configuration

配置项 类型或值 描述
主叫预付费用户 是/否 主叫预付费权限指示位.
如果是预付费用户, 该用户每次完成呼叫后, miniSIPServer 将从其余额中扣除相应的费用. 这个权限位只有在正常连接MySQL数据库的情况下才能进行配置.
请参考"主叫预付费业务文档".
电话话吧用户 是/否 电话话吧业务权限指示位.
请参考"电话话吧业务文档".
订阅所有分机状态或者对话信息 是/否 如果配置了该业务权限, miniSIPServer 将上报所有分机的状态给当前用户.
请注意, 对于普通用户而言, 不应当配置该权限位, 否则将导致大量的状态报告消息, 有可能影响正常呼叫.
呈现信息分组 组编号 如果配置了该参数, 分机只能收到同组内其他分机的状态呈现消息.
主叫号码重定义 是/否 主叫号码重定义业务权限指示位.
请参考"主叫号码重定义业务文档"了解该配置的细节.
4.7 媒体类业务

local user media service configuration

配置项 类型或值 描述
HOLD住对话并播放音乐 是/否 当SIP终端/电话发送HOLD消息给 miniSIPServer 时, miniSIPServer 应当HOLD当前对话并给对端播放音乐.
转发媒体流 是/否 指示 miniSIPServer 为SIP终端/电话转发媒体流.
如果SIP终端部署在私网内并且不具备STUN能力, 这就需要 miniSIPServer 帮助转发媒体以避免出现语音单通等故障.
如果SIP终端部署在公网, 或者本身具备STUN等私网穿越能力, 就没有必要配置 miniSIPServer 转发媒体流, 从而减轻 miniSIPServer 服务器工作负荷.
监听呼出呼叫 是/否 指示 miniSIPServer 记录该用户呼出呼叫的语音流信息.
请参考"呼叫监听"业务文档.
监听呼入呼叫 是/否 指示 miniSIPServer 记录用户呼入呼叫的语音流信息.
请参考"呼叫监听"业务文档.
5. 外线

在我们的演示网络中, 本地分机A同时分配有外线号码, 该外线号码由VoIP语音运营商提供, 可用于外部用户呼叫本地分机, 或者本地分机利用外线外呼外部用户.

请点击菜单'数据/外线'显示外线主窗体并进行各项配置操作.

external lines window

在这个窗体中, 不同的图标代表外线不同的状态.

图标 状态
unregisterred external line 外线还没有注册到运营商网络 (或FXO网关还没有注册到 miniSIPServer ).
registerred external line 外线已注册到运营商网络 (或FXO网关已注册到 miniSIPServer )
5.1 基本配置

external lines window

配置项 类型或值 描述

外线类型

0, 1
  • 0 - (默认值)注册到 SIP/VoIP 服务器。与 VoIP 运营商对接时, 由运营商提供账号信息, miniSIPServer 外线采用这些信息向运营商注册。
  • 1 - 接受 FXO 网关注册。与网关对接时,通常由 miniSIPServer 分配账号信息给网关,网关以此向 miniSIPServer 注册。
外线/账户 字符串 由VoIP运营商提供的账户, 或者 miniSIPServer 为FXO网关分配的外线号码.
密码 字符串 外线注册时的鉴权密码. 该项可以为空, 如果配置为空, 则说明没有必要进行鉴权.
服务器地址/域 字符串 该地址可以是IP地址, 也可以是域名地址.
服务器端口 整数(>0) 对端服务器或者网关处理SIP消息的端口.
鉴权ID 字符串 鉴权时的用户名或者用户ID。该项可以不设置,那么 miniSIPServer 将使用“外线/账户”项进行鉴权。
部分VoIP运营商要求账户名和鉴权ID采用不同的值,这种情况下,必须根据VoIP运营商的要求设置该项。
5.2 出呼叫

外线的出呼叫配置

配置项 类型或值 描述
外呼时经过指定的代理服务器 是/否 部分大型 VoIP 运营商会在整个网络的边缘设置代理服务器,要求所有接入设备的 SIP 消息都需先经过代理服务器进行分发,此时, 我们就需要配置这些信息,以确保正确地将消息发给合适的代理服务器。
代理服务器地址 字符串 代理服务器地址
代理服务器端口 整数 代理服务器的端口
传输 UDP 或者 TCP SIP 消息传输协议。缺省情况下,一般采用 UDP 传输 SIP 消息。某些 SIP 设备只能采用 TCP 传输 SIP 消息,则我们必须在此处明确指定 TCP 传输。
Request URI 的附加参数 字符串 如果设置了附加参数, miniSIPServer 在向对方服务器(或者网关)发送消息时,将在 RequestURI 后添加该附加参数。中文界面时该项的默认值是“user=phone”,其他语种的界面中该项默认为空。是否配置该项,需要依据对接的 VoIP 运营商的要求。
其他分机可以使用该外线外呼 是/否 如果配置该项, 则其他分机也可以使用该外线进行外呼; 如果不配置该项, 则只有与该外线绑定的分机可以使用它进行外呼。
采用原主叫号码作为显示号码 是/否 外呼时, 通常向被叫显示该外线的号码. 配置该项后, miniSIPServer 将向被叫显示原主叫用户的号码.
时间条件编号 >=0 当前外线的时间条件编号。如果不处于工作时间,则该外线将停止工作。请参考"时间条件"业务了解更多细节。
出呼叫群编号 >=0 为当前外线定义出呼叫的群编号。若干外线或者SIP中继设置相同的出呼叫群编号。在“拨号规则”处理过程中,将使用该编号对呼叫进行号码变换。
无应答时长(秒) >=0 外呼经过该外线时,该值用于限制呼叫的无应答时长。如果超时,则呼叫会被释放,将尝试下一条外线。默认值是0,即采用系统默认的无应答时长。
最大同时呼出呼叫数 >=0 限制最大同时呼出呼叫数。如果设置为0,则该外线不允许任何外呼呼叫。
限制最大通话时长 >=0 如果限制了最大通话时长, 超时则 miniSIPServer 将自动释放呼叫.
呼叫失败时尝试另一外线 是/否 当前外呼失败, miniSIPServer 是否需要选择另一条可用外线继续外呼。 如果选择了该配置, 则必须同时指定下一条外线.

5.3 入呼叫

external lines incoming call configuration

配置项 类型或值 描述
入呼叫转接至
  • 自动话务员
  • 目的号码

如果将入呼叫转接至自动话务员, 将触发自动话务员业务.

如果将入呼叫转接目的号码, miniSIPServer 将重新分析新的目的号码(或者呼叫中原有的被叫号码)并得到最终路由信息。

目的号码 字符串 如果入呼叫转接至“目的号码”,则(1)可以在本项中配置新的目的号码,miniSIPServer 重新分析新的目的号码并得到新的路由信息。(2)也可以不设置目的号码,此时意味着 miniSIPServer 继续分析呼叫原有的被叫号码并得到呼叫路由信息。
监听呼入呼叫 是/否 如果设置了该项,miniSIPServer 将监听该外线的所有入呼叫,并将相应的语音流保存到本地目录。
5.4 其他

外线其他配置

配置项 类型或值 描述
鉴权用户名应包含地址信息 是/否 通常鉴权用户名不包含地址信息,例如“2001”。如果对方要求完整URL鉴权,则应当勾选本项,miniSIPServer 将采用完整的用户URL进行鉴权,例如"2001@192.168.1.200"。 请注意, 如果“鉴权ID”项配置了完整的 URL 信息,则无需配置本项。
不支持临时响应的可靠性 (sip:100rel) 是/否 这是个非常特殊的配置项。 某些运营商不具备“100rel”能力,同时也无法正确处理呼叫消息中的“100rel”参数,配置这项将迫使 miniSIPServer 在呼叫消息中删除“100rel”参数。
不需要注册 是/否 某些 SIP 中继运营商不要求 SIP 注册消息,仅仅会对每个呼叫单独鉴权,这种情况下我们可以配置这项。
转发媒体流 是/否 如果配置这项, miniSIPServer 将不得不转发媒体流。
最大同时呼叫数 整数(>0) 外线能处理的同时呼叫数,包含呼入数和呼出数。
6. 系统配置

本章节的各项配置将影响整个系统, 您可以通过以下方式进行配置:

1. 点击主界面工具条中的'系统配置'按钮

2. 点击菜单"数据/系统配置"

6.1 基本配置

系统基本配置窗体

配置项 描述
管理员密码 miniSIPServer 系统管理员密码. 缺省为空. 如果配置了该密码, 则登录 miniSIPServer GUI或者web管理界面时, 必须输入该密码进行鉴权.
出群呼叫前缀 又称为'外呼前缀'. 本地分机用户拨打外部用户号码是, 需要在被叫号码前先拨打出群呼叫前缀. 在我们的演示网络中, 例如A呼叫C, 拨打号码为'92002'. '9'就是缺省出群呼叫前缀. 我们可以配置为其他值, 也可以将其配置为空.
RTP起始端口* miniSIPServer 播放语音或者收集用户输入时, 将根据本项配置打开RTP端口.
HTTP服务器端口* 用于启动 miniSIPServer 内部的HTTP/WWW服务器, 提供web管理界面. 请参考"Web管理" .
事件通道端口* 用于启动 miniSIPServer 内部的websocket服务,报告 miniSIPServer 内部各种状态。请参考"事件通道"文档。
语音提示* 用于指示 miniSIPServer 采用何种语言播放语音. 目前仅支持中文普通话以及英语.
采用UPnP请求路由器映射端口 如果设置了该项,miniSIPServer 将采用 UPnP 协议请求路由器映射部分端口,包括: SIP-UDP端口,转发语音留端口等。

说明: 在 miniSIPServer 系统中, 凡是修改了带'*'号的配置项, 需要重新启动 miniSIPServer 才能使新配置生效。

6.2 SIP

SIP系统信息配置

默认情况下, miniSIPServer 总是自动获取本机 IP 地址以及缺省端口, 根据这些信息建立 SIP 连接。但是在某些环境,我们需要人工指定 SIP 地址或者端口,例如(1) 该计算机上配置有多网卡, 而管理员希望 miniSIPServer 绑定一个特定的网卡及其IP地址;(2) 由于某些特殊的原因, 5060端口对 SIP 应用不可用。

在本页的配置中, 我们通过修改SIP的基本配置, 可以解决上述问题.

配置项 类型或值 描述
首选地址 (IPv4)* 字符串 miniSIPServer 主要采用该地址与其它SIP设备交互,默认情况是IPv4地址。可以是IP地址,也可以是域名地址。
首选地址 (IPv6)* 字符串 miniSIPServer 主要采用该地址与其它SIP设备交互,默认情况是IPv6地址。可以是IP地址,也可以是域名地址。
次选地址 字符串 SIP服务器补充地址,其他设备(例如SIP分机)也可以采用该地址与 miniSIPServer 进行交互。可以设置为本地的私网地址,也可以设置为本网的外部地址。
次选地址可以是一个域名地址,也可以是IP地址。
UDP 端口* 整数(>0) miniSIPServer 应当打开的UDP端口, 用于处理 SIP over UDP 消息。根据SIP协议的要求, 缺省值为5060端口。

TCP 端口* 整数(>0) miniSIPServer 应打开的 TCP 端口,用于处理 SIP over TCP 消息。根据SIP协议的要求, 缺省值为5060端口。

请参考"基于TCP的SIP"了解更多细节。

TLS 端口* 整数(>0) miniSIPServer 应打开的 TLS 端口,用于处理 SIP over TLS 消息。根据SIP协议的要求, 缺省值为5061端口。

请参考"基于TLS的SIP"了解更多细节。

字符串 SIP协议要求的'Realm'参数字段,您可以设置为本地网络的IP地址或者网名。
6.3 MySQL服务器配置

MySQL数据库配置

配置项 类型或值 描述
数据库地址 域名地址或者IP地址 远端MySQL数据库地址.
注意, miniSIPServer 可以和MySQL安装在同一台PC上, 此时该项可以配置为"localhost".
数据库访问端口 整数 MySQL的访问端口. 如果您在MySQL的配置中修改了它的访问端口, 您需要同步更新 miniSIPServer 的这项配置.
MySQL缺省访问端口为3306, 请参考MySQL数据库的相关手册说明.
数据库名 字符串 在MySQL中应当创建的数据库名称
您可以配置为任何名称. 请注意, 您没有必要手工创建该数据库, 只需要在 miniSIPServer 中做好配置. 如果各项配置正确的话, 重启 miniSIPServer 后, miniSIPServer 会自动连接MySQL数据库, 并自动创建所需要的数据库, 数据表等.
用户名 字符串 MySQL数据库访问用户名.
MySQL中该用户应当具有足够的权限, 例如创建数据库, 添加, 修改, 删除表等.
密码 字符串 MySQL用户的访问密码, 这取决于MySQL的配置.
6.4 SMTP

SMTP配置用于与SMTP服务器建立连接, 并发送电子邮件. 例如, 在语音邮箱业务中, miniSIPServer 将使用该配置发送语音邮件到分机用户的电子邮箱中.

SMTP configuration

配置项 类型或值 描述
SMTP服务器 字符串 SMTP服务器地址, 例如"smtp.gmail.com".
用户名 字符串 登录SMTP服务器的用户名.
如果SMTP服务器不要求鉴权, 该项配置可以为空.
密码 字符串 SMTP用户的鉴权密码.
如果不要求鉴权, 该项配置也可以为空.
该服务器要求可靠连接 是/否 如果SMTP服务器要求SSL/TLS连接, 就必须要配置该项.
6.5 话单

系统话单配置窗体

配置项 类型或值 描述
本地用户主叫侧话单 是/否 如果设置, 本地用户做主叫发起呼叫, 通话结束后, miniSIPServer 将产生话单.
本地用户被叫侧话单 是/否 如果设置, 本地用户做被叫接受呼叫, 通话结束后, miniSIPServer 将产生话单.
外部用户主叫侧话单 是/否 如果设置, 呼叫来自外线或者中继, 通话结束后, miniSIPServer 将产生话单.
外部用户被叫侧话单 是/否 如果设置, 外呼通过外线或者中继, 通话结束后, miniSIPServer 将产生话单.
产生失败呼叫话单 是/否 如果设置, 被叫如果没有应答呼叫, miniSIPServer 仍然产生话单.
实时显示话单信息 是/否 在实时话单窗体中及时显示话单的信息。如果设置了该项,请点击菜单“窗体 - 实时话单”以了解实时话单的详情。
输出话单到文件 是/否 配置后, miniSIPServer 将把CDR文件保存在“//应用数据目录/cdr”子目录中。另外, 一天只产生一个CDR文件, 一个CDR文件包含当天所产生的所有CDR信息.
6.6 STUN

本页配置使 miniSIPServer 同时充当VoIP网络中的STUN服务器, 协助SIP客户端进行私网穿越. 通常, STUN服务器所在的PC应当安装两块网卡, 配置两个独立的公共IP地址. 如果只有一块网卡, 可能无法检测部分私网类型.

STUN window

配置项 类型或值 描述
主STUN服务器地址(MIP) 字符串 miniSIPServer 绑定的主STUN服务器地址.
主STUN服务器端口(MPORT) 整数 miniSIPServer 绑定的主STUN服务器端口.
缺省值为3478, 该端口是由STUN标准协议定义.

次STUN服务器地址 (SIP) 字符串 miniSIPServer 绑定的次STUN服务器地址.
次STUN服务器端口 (SPORT) 整数 miniSIPServer 绑定的次STUN服务器端口.
该端口必须和MPORT配置不一样的值.

完成配置后, miniSIPServer 将打开以下socket通道处理STUN请求:

  • MIP : MPORT
  • MIP : SPORT
  • SIP : MPORT
  • SIP : SPORT
7. SIP中继

请点击菜单"数据 / SIP中继", 显示该类信息的主要窗体进行各项配置.

7.1 基本配置

SIP中继基本配置

配置项 类型或值 描述
SIP中继编号 整数 SIP中继编号。该项是索引项, 不能重复定义相同的编号值.
描述 字符串 当前记录的描述性文字, 可以为空.
服务器地址 字符串 对端服务器地址, 不允许为空.

可以是IP地址, 或者域名地址.
服务器端口 整数 对端服务器端口, 该值不允许为空.
传输 UDP或者TCP SIP消息传输协议。缺省情况下,一般采用UDP传输SIP消息。某些SIP设备只能采用TCP传输SIP消息,则采用SIP中继对接时,我们必须在此处明确指定TCP传输。
7.2 出呼叫

SIP中继出呼叫配置

配置项 类型或值 描述
统一的主叫号码 字符串 该项可以不用配置。如果配置该项, miniSIPServer 将采用这个号码作为外呼呼叫的主叫号码。
Request-URI 附加参数 字符串 该项可以不用配置。如果配置该项, miniSIPServer 在外呼呼叫的 SIP 消息中的 Request-URI 后附加该参数。
时间条件编号 整数(>=0) 设定中继的工作时间条件。具体信息请参考“时间条件”文档。
出呼叫群编号 整数(>=0) 若干外线或者SIP中继出呼叫时可以采用相同的群编号。
在“拨号规则”处理过程中,该编号将用于号码变换或者路由选择。缺省值"0"意味着不需要该编号,“拨号规则”处理过程将不再规整它的外呼号码。
最大同时呼出呼叫数 整数(>=0) 该中继允许的最大同时呼出呼叫数,超过该值的呼叫将直接被拒绝。
如果设置为0,则禁止该中继呼出任何呼叫。
呼叫失败时尝试另一中继 整数(>=0) 中继编号。该中继的出呼叫失败时,尝试使用另一中继继续进行出呼叫。
如果设置为0,则在呼叫失败时直接释放呼叫。
转发媒体流 是/否 默认出呼叫不转发媒体流。勾选该项,对通过该中继呼出的呼叫,都将进行媒体流转发(目前仅转发语音流)。
7.3 入呼叫

SIP中继入呼叫配置

配置项 类型或值 描述
入呼叫拨号计划 字符串 入呼叫对应的拨号计划名. 缺省值为'default'. 如果修改为其他值, 将影响最终的被叫号码分析以及呼叫路由选择过程.
最大同时呼入呼叫数 >=0 该中继允许的最大同时呼入呼叫数,超过该值的呼叫将直接被拒绝。

如果设置为0,则禁止该中继接受任何外部呼入呼叫。

8. 拨号计划(拨号规则)

miniSIPServer 支持强大的拨号计划以及灵活的路由选择, 在本节中, 我们将描述以下几个与拨号计划相关的配置:

  • 号码变换
  • 规整主叫号码
  • 规整被叫号码
  • 分析主叫号码
  • 分析被叫号码

请参考“拨号规则”文档了解相关的重要概念和过程,本文档仅描述配置项的一些细节。

8.1 (号码)变换

"变换"用于变换号码, 例如主叫号码, 被叫号码等.

请点击菜单"拨号规则/变换", 显示其主窗体进行各项配置.

transition window

配置项 类型或值 描述
变换编号 整数 正整数值,它是记录索引项, 不允许重复。其他配置将引用该编号值。
变换类型 1: 增加前缀 在当前号码前增加前缀.
必须同时配置"前缀/替换字符串" 项.
2: 替换 将目的号码的部分或者全部替换为指定的字符串, 必须同时配置"前缀/替换字符串" 项.
目的号码需要替换的部分由"起始位置" 以及 "长度"两项配置来决定.
3: 删除 删除目的号码的部分或者全部. 删除部分由"起始位置" 以及 "长度"两项配置来决定.
起始位置 整数 号码变换的起始位置.
有效值为0~31. '0'是指目的号码的第一个数字(或者字符).
长度 整数 变换长度, 即有多少个数字(或字符)需要被删除或者替换. 有效值为1~31.
前缀/替换字符串 字符串 指定的字符串, 用于'添加前缀'或者'替换'操作.

由于'变换'功能是号码分析过程中非常重要并且实用的功能, 我们列举一些示例进一步说明如何使用该功能:

示例 1: 将 "1234" 变换为 "Holly1234".

            变换类型 = 增加前缀
            前缀/替换字符串 = Holly
        

示例 2: 将"1234"变换为"34".

            变换类型 = 删除
            起始位置 = 0
            长度 = 2
        

示例 3: 将"1234"变换为"Holly34".

            变换类型 = 替换
            起始位置 = 0
            长度 = 2
            前缀/替换字符串 = Holly
        
8.2 规整主叫号码

请点击菜单"拨号规则/规整主叫号码", 显示该配置的主窗体.

Refine caller number window

配置项 类型或值 描述
号码规整组 整数 号码规整组编号
主叫号码前缀 字符串 miniSIPServer 采用最长匹配方法匹配主叫号码.
例如, 配置了两条记录, 主叫号码前缀分别是'123'以及'12', 如果呼叫中的主叫号码是'1234', 则记录'123'将匹配当前呼叫.
变换编号 整数 如果当前记录匹配了呼叫中的主叫号码, 则采用该变换编号对主叫号码进行变换。
8.3 规整被叫号码

在“拨号规则”分析结果中,如果呼叫路由给外线或者SIP中继,我们可以使用本功能规整外呼呼叫最终的被叫号码。

请点击菜单"拨号规则 / 规整被叫号码",显示该配置的主窗体.

配置项 类型或值 描述
出呼叫群编号 整数 该参数在外线或者SIP中继的“出呼叫”中配置,本处理过程将采用才参数作为索引参数之一来规整出呼叫的被叫号码。
被叫号码前缀 字符串 miniSIPServer 的“拨号规则”处理过程将采用该参数以及“出呼叫群编号”匹配呼叫。如果呼叫可以匹配,将规整这些呼叫的最终被叫号码。
变换编号 整数 如果当前记录匹配了呼叫, 则采用该变换编号对被叫号码进行变换.
8.4 分析主叫号码

请点击菜单"拨号规则/分析主叫号码"显示该配置信息.

caller number analysis configuration

配置项 类型或值 描述
主叫号码前缀 字符串 主叫号码前缀.
miniSIPServer 采用最长匹配方式匹配呼叫中的主叫号码.
变换编号 整数 当前主叫号码前缀对应的号码变换编号.
如果呼叫的主叫号码与当前主叫号码前缀匹配, miniSIPServer 将根据变换编号配置对该主叫号码进行变换.
拨号计划 字符串 拨号计划名称.
缺省值为"default". 我们可以将其指定为其他值, 改变呼叫的"拨号计划". 在后续被叫号码分析流程中, "拨号计划"名称将作为关键分析参数.
8.5 分析被叫号码

"被叫号码分析"是整个拨号规则的核心部分. 被叫号码分析的结论将可能变换主叫号码, 变换被叫号码以及影响到最终的呼叫选路.

请点击菜单"拨号规则/分析被叫号码",显示该配置的主窗体.

被叫号码分析窗体

配置项 类型或值 描述
拨号计划 字符串 拨号计划名称.
在被叫号码分析过程中, "拨号计划"与"被叫号码前缀"共同组成关键分析索引.
不同的"拨号计划", 可以配置相同的"被叫号码前缀".
不同的"被叫号码前缀"可以对应相同的"拨号计划".
在主叫号码分析过程中, 我们可以为不同的主叫号码指定不同的"拨号计划", 从而对同一个被叫号码, 不同的主叫会有不同的分析结论.
被叫号码前缀 字符串 miniSIPServer 采用最长匹配方式匹配呼叫中的被叫号码.
路由类型 本地分机 呼叫将路由给本地分机.
外线 通过外线外呼呼叫.
如果没有指定外线号码, 则由 miniSIPServer 自行选择一条可用的外线. 如果指定了外线号码, 则呼叫将通过该外线外呼.
SIP中继 呼叫路由给指定中继对应的SIP服务器. 此时, 必须要配置"SIP中继编号".
"SIP中继编号"应与 "SIP中继"中的配置对应.
路由群 呼叫路由给“路由群”。

如果设置该路由类型,必须同时指定“路由群编号”。

请参考"路由群业务文档"了解更多的细节。

拦截呼叫 拦截并立刻结束当前呼叫。
被叫号码变换 是/否 对被叫号码进行变换.
如果选择了该配置, 则有另外两个重要的项需要配置:
一个是"变换编号" , 将用来变换号码.
另一个是"变换后重分析", 如果要求重分析, 则 miniSIPServer 将重新对变换后的被叫号码进行分析, 获取新的分析结论.

主叫号码规整组ID 整数 如果需要对呼叫中的主叫号码进行规整, 则需要配置对应的规整组ID.
如果配置为0, 则认为不需要对主叫进行规整.
如果配置为非0值, 则 miniSIPServer 将根据'规整主叫号码'中的配置, 对主叫号码进行变换规整.

呼叫权限 整数 当前记录对应的呼叫所要求的呼叫权限.
如果配置为0, 则意味着不需要进行限制, 任何用户都可以拨打该被叫前缀对应的呼叫.
如果配置为非0值, 则只有具备相应呼叫权限的分机用户能够拨打此类呼叫.

限制通话时长 整数(>=0) 当前记录对应的呼叫能允许的最大通话时长。
如果超时, 则 miniSIPServer 会自动释放呼叫. '0'代表不做任何限制.

我们可以看到: miniSIPServer 根据不同的拨号计划, 不同的被叫号码前缀, 不同的主叫号码等因素, 对呼叫进行不同地路由. 这对我们的VoIP部署而言是非常灵活的.

9. 业务

请参考业务指导文档了解更多细节。 本章节仅描述各业务之间共有的一些配置。

9.1 Lua 业务触发

miniSIPServer 提供多种方式实现业务逻辑。部分业务是固化在 miniSIPServer 内部,有些业务是用 IVR-XML 实现;也有些业务是用 Lua 脚本实现,例如卡号业务,DISA业务等。对于高级用户而言,Lua 脚本非常灵活、强大。实际上,miniSIPServer 核心提供了一整套的 Lua 脚本接口。

无论是我们的开发人员还是高级客户,都可以采用 Lua 脚本实现复杂的或者定制化的业务。本手册中不提供 Lua 脚本的细节,仅描述如何根据呼叫的被叫号码前缀触发 Lua 业务。

请点击菜单"业务 / Lua业务":

Lua业务触发配置

配置项 类型或值 描述
拨号计划 字符串

拨号计划名称。

不同的本地分机或者SIP中继等都可以有不同的拨号计划名称。如果没有特殊指定,缺省值为"default"。

被叫号码前缀 字符串

匹配当前呼叫的被叫号码,遵循拨号计划的最长匹配方式。

miniSIPServer 根据不同的拨号计划和被叫号码前缀触发不同的 Lua 业务, 您也可以采用不同的被叫号码前缀触发相同的 Lua 业务。

描述 字符串 当前配置记录的文字性描述。
Lua业务模块名称 字符串

希望触发的 Lua 业务文件名。注意,此处仅需填写基础文件名,不需要包含文件路径或者文件后缀。

系统自带的 Lua 业务文件存放在安装目录下的“lua/services”子目录下。

客户自定义的 Lua 业务文件应存放在“应用数据目录”下的 lua 子目录下。

附录1. 语音ID

安装 miniSIPServer 系统时, 自带的中文语音文件会自动保存在 miniSIPServer 安装目录下的子目录"mss_ann/cn"中。

下表是系统自带的中文语音文件列表及语音内容说明。您在实际部署中,可以根据需求替换为自己的语音文件,但是请注意,不要直接替换上述安装目录下的语音文件,自定义语音文件应当保存在应用数据目录下的 'custAnn' 子目录下,请参考“如何录制自己的语音?”文档。

在 miniSIPServer 中,语音文件名必须是"xxx.wav"格式,其中"xxx"必须为8个字符,而且只能是 0 到 9 以及 a 到 f 字符。 同时"xxx"也是 miniSIPServer 内部的语音ID十六进制编号。

WAV 文件必须是 'CCITT A-law, 8KHZ, 8Bit, 7kb/sec' 格式。

语音ID 业务 内容

00080002

一般业务

音乐

00080003

普通回铃音

00080030

0

00080031

1

00080032

2

00080033

3

00080034

4

00080035

5

00080036

6

00080037

7

00080038

8

00080039

9

0008003a

0008003b

0008003c

0008003d

0008003e

亿

00080050

00080051

00080052

00080053

01080000

'滴'提示音

01080001

您的操作已成功

02080003

语音邮件

按0删除当前信息,按1或者等待几秒听下一条信息。

02080004

请留言

02080005

没有信息

07080001

主叫预付费

对不起,您的余额已不足,请及时充值

08080001

连选组

话务员全忙,请稍等。您的等待号码是

0a080001

自动话务员

您好!请输入分机号

84080001

预付费卡号业务

请输入您的卡号

84080002

请输入密码

84080003

请输入目的号码,按#号结束

84080004

您可以通话

84080005

您的余额是

84080006

目的号码不可达

84080007

不正确的卡

84080008

再见

84080009

拨打新号码请按1,拨打原号码请按2,使用新卡号请按3

85080001

DISA

请输入您的账号

85080002

请输入密码

85080003

请输入目的号码

86080001

呼叫前转

当前呼叫将被前转,请稍后

附录2. mss_var_param.ini文件

某些时候,会有一些特殊的应用场景要求 miniSIPServer 处理一些特殊的流程,并且这些流程通常与一般需求是不一致的。为满足这些特殊需求同时又不影响常规流程, miniSIPServer 采用特殊参数来控制这些特定的修改或者特定的流程。这些特殊参数都保存在"mss_var_param.ini"文件中。

miniSIPServer 安装包缺省不包含 “mss_var_param.ini” 文件,因此安装完成后您实际上是找不到这个文件。如果有需要,您应当在 miniSIPServer 的应用数据目录的 config 子目录下手工创建该文件。 miniSIPServer 启动时会提示当前的应用数据目录,请参考下图。

miniSIPServer 应用数据目录

例如,如果是 Windows 系统并且 miniSIPServer 应用数据目录是“C:\Users\Gilson\AppData\Roaming\minisipserver”,该文件应该存放在“C:\Users\Gilson\AppData\Roaming\minisipserver\config\mss_var_param.ini”。 如果是 Linux 系统并且 miniSIPServer 应用数据目录是“/home/pi/.minisipserver”目录,则该文件应该存放为“/home/pi/.minisipserver/config/mss_var_param.ini”。

"mss_var_param.ini"文件是.INI格式的文本文件,您可以用任何一款文本编辑工具创建、编辑以及保存该文件。该文件采用以下INI格式:

[参数段]
参数名=参数值

例如,以下是一个‘gVarGuiLang’参数的示例,其中‘参数段’为‘gui’,‘参数名’为‘gVarGuiLang’,该参数的值为‘1’。

[gui]
gVarGuiLang=1

miniSIPServer 为内部不同的模块定义了若干个参数段名,请参考下表了解各模块的细节:

参数段 描述
ccf 呼叫控制(Call-control)模块使用该参数段的参数控制一些特殊的呼叫流程,例如,去掉'music-on-hold'流程。
gui 与图形界面相关的一些特殊需求。
scp 业务控制(Service-control-process)模块使用该参数段的参数控制一些业务中的特殊需求。例如,控制不同的语音邮箱模式。
sip SIP模块使用该参数段控制SIP的流程或者修改一些默认的SIP协议栈参数。
srf 特殊资源功能(Special-resource-function)模块使用该参数段控制一些特殊的摩提处理流程。例如,修改缺省语音文件的语种。
sys 定义了一些能修改整个miniSIPServer 系统的参数。

本文不讨论详细的控制参数及对应的参数值,因为如果您对它们了解不彻底的话,随意应用这些控制参数将对整个系统产生不利的影响,因此请务必小心。如果您有特殊的需求,请先和我们的支持团队联系,我们非常乐意提供帮助和指导。