API概述
Analog Gateway (OIAD) 提供API接口，用于集成第三方应用服务器，你可以在第三方服务器上通过接口获取信息或者配置各种功能
· 客户端必须以POST方式发送restful api的JSON格式
· 服务端以固定格式的json数据返回
Client→Server Request
| KEY | VAL | Default | Remark |
|---|---|---|---|
| token | string | - | 身份验证，部分白名单程序忽略 |
| [ANY] | [ANY] | [ANY] | 其他参数由API功能定义 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| uri | string | - | 返回请求对应的URI名字 |
| code | int | - | 成功或失败标识码 |
| msg | string | - | 信息提示 |
| data | array | - | 数据内容，由API功能定义 |
注意事项：
· 项目的各API在/appenv/lib/icvpapi文件中封装,请查阅代码确认具体API功能和实现
· 请先参考公共封装，下面的接口描述为了专注在接口上，因此描述减少了内容
· 在client请求的时候数据只描述了专有的key部分(公共部分没有描述，请参考如上)
· 在Server返回数据只描述了data_subkey的内容(公共部分没有描述，请参考如上)
· 尽量使用string作为数据类型，避免在新开发接口上使用int,也不要使用其他数据类型。
REQ(针对KEY说明)
· Y表示必须传递
· Y/N表示有条件必须传递，参考说明理解条件
· N表示可选参数，如不传递将会自动忽略
DEF(针对值说明)
· -：表示当值不合法或错误时候直接报错
· Empty：表示当值不合法或错时自动使用空字符串修正（注意不是null）
· 其他：如果值不合法，则自动使用这个值修正
注意事项：
· 互斥：当remark有说明与其他key存在互斥的时候，一旦检测到问题自动使用Default值
· 其他：当出现其他问题时，自动使用Default值
注意：本接口访问无需token
注意：防止黑客login DDOS攻击，处理请求随机delay 0-2s
Client→Server Request
| KEY | VAL | Default | Remark |
|---|---|---|---|
| username | string | - | 账号 格式：4-32个字符 |
| password | string | - | 密码(MD5值) 格式：4-32个字符 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| level | string | - | 账户级别信息 | 230424 |
| token | string | - | 当前账号的token，有效期600秒 | 231201 |
Server→Client Response
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| ip | string | - | 当前IP地址 | 230415 |
| token | string | - | 当前账号的token，有效期600秒 | 231201 |
Server→Client Response
注意：本类别接口设置执行过可能存在有需要生效的部分(/general/apply_do)
注意：进行macaddr克隆时，请将isclonemac设置为1，否则设置不成功。克隆成功的macaddr导出配置后，恢复配置时会设置macaddr
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| ip6enable | string | N | 0 | 开启ipv6 格式：1是，0否(默认) | 240326 |
| proto | string | Y | - | 格式：dhcp, static, pppoe | 240123 |
| ipaddr | string | N/Y | - | static=REQ_Y IP地址 ip6enable=0 格式：IPv4地址，长度1-15；ip6enable=1 格式：IPv6地址，长度2-39 | 240123 |
| netmask | string | N/Y | - | static=REQ_Y 子网掩码 格式：IPv4地址，长度1-15 | 240123 |
| gateway | string | N/Y | - | static=REQ_Y 网关 ip6enable=0 格式：IPv4地址，长度1-15；ip6enable=1 格式：IPv6地址，长度2-39 | 240123 |
| username | string | N/Y | - | pppoe=REQ_Y 账号 格式：长度1-64 | 240123 |
| password | string | N/Y | - | pppoe=REQ_Y 密码 格式：长度1-64 | 240123 |
| ac | string | N | Empty | pppoe=REQ_Y 接入集中器 格式：长度0-64 | 240123 |
| service | string | N | Empty | pppoe=REQ_Y 服务商名称 格式：长度0-64 | 240123 |
| peerdns | string | N | 1 | 允许远端DNS 格式：1允许(默认)，0不允许 | 240123 |
| dns | string | N | Empty | 固定DNS，多DNS空格分隔 格式：长度0-64 ip6enable=0 单个dns格式：IPv4地址，长度1-15；ip6enable=1 单个dns格式：IPv6地址，长度2-39 | 240123 |
| macaddr | string | N | Empty | MAC地址克隆 格式：MAC地址，长度0(不设)/17(新MAC) | 240123 |
| isclonemac | string | N | 0 | 开启MAC地址克隆 格式：1是，0否(默认) | 240123 |
| management_access | string | N | 1 | 管理访问限制 格式：1 WAN和MGT(默认)，0 MGT | 240123 |
| vendorid | string | N | Empty | 设置OPT 60送给服务器的vendorid 格式：长度0-64 | 240123 |
| ip6subnetprefixlength | string | N/Y | Empty | ip6enable=REQ_Y IPv6子网前缀长度 范围0-128 | 240326 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考 /net_wan/set | ||||
| assign_ipaddr | string | 动态数据，当前IP地址 | ||
| assign_netmask | string | 动态数据，当前子网掩码 | ||
| assign_gateway | string | 动态数据，当前网关 | ||
| assign_dns | string | 动态数据，当前DNS | ||
| dhcp_expire_time | string | 动态数据，当前dhcp失效时间(秒) | ||
| assign_ip6subnetprefixlength | string | 动态数据，当前IP6 子网前缀长度 | 240326 |
· 注意：platform为netbus的设备不要支持本接口，切记!!
· 注意：本接口设置后需有生效需求
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| ipaddr | string | Y | - | IP地址 格式：IPv4地址 | 240418 |
| netmask | string | Y | - | 子网掩码 格式：IPv4地址 | 240418 |
Server→Client Response
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_lan/set | 240418 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| disabled | string | Y | - | mgt口禁用 格式：0否，1是 | 240319 |
| proto | string | Y | - | 网络协议类型 格式：dhcp，static | 240319 |
| ipaddr | string | N/Y | - | static=REQ_Y，IP地址 格式：IPv4地址，长度1-15；wan口ip6enable=1 格式：IPv6地址，长度2-39 | 240614 |
| netmask | string | N/Y | - | static=REQ_Y，子网掩码 格式：IPv4地址，长度1-15；wan口ip6enable=1，无效 | 240319 |
| gateway | string | N | - | 网关 格式：IPv4地址，长度0-15；wan口ip6enable=1 格式：IPv6地址，长度0-39 | 240614 |
| peerdns | string | N | 1 | 允许远端DNS 格式：1允许，0不允许 | 240319 |
| dns | string | N | 空 | 固定DNS地址，多个DNS之间空格分隔 格式：长度0-64 | 240319 |
| ip6subnetprefixlength | string | N/Y | 空 | wan口ip6enable=REQ_Y IPv6子网前缀长度 范围0-128 | 240614 |
Server→Client Response
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_mgt/set | 240319 | ||||
| assign_ipaddr | string | 动态数据，当前IP地址 | 240319 | ||
| assign_netmask | string | 动态数据，当前子网掩码 | 240319 | ||
| assign_gateway | string | 动态数据，当前网关 | 240319 | ||
| assign_dns | string | 动态数据，当前DNS | 240319 | ||
| dhcp_expire_time | string | 动态数据，当前dhcp失效时间(秒) | 240319 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| wan_vlanid | int | N | 0 | WAN口的第二层QoS 802.1Q/VLAN 标记，格式：0, 3-4094，1,2为系统内部使用 | 240417 |
| wan_signaling_priority | int | N | 0 | 第二层SIP信令QoS 802.1p优先级，格式：0-7 | 240417 |
| wan_media_priority | int | N | 0 | 第二层语音QoS 802.1p优先级，格式：0-7 | 240417 |
| mgt_vlanid | int | N | 0 | mgt口的第二层QoS 802.1Q/VLAN 标记，格式：0, 3-4094，1,2为系统内部使用 | 240417 |
| mgt_priority | int | N | 0 | 第二层QoS 802.1p优先级，格式：0-7 | 240417 |
Server→Client Response
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_vlan/set | 240417 |
注意：route表示路由，router表示路由器功能两者不是一个含义。
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| routes | array | N | - | 格式[{ROUTEKV}...]，参考"ROUTEKV" | 240423 |
| ROUTEKV | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| interface | string | N | wan | Interface接口(基本,逻辑) 格式：wan lan vpn1 | 240423 |
| target | string | Y | - | 目标IP地址 格式：IPv4地址 | 240423 |
| netmask | string | Y | - | 子网掩码 格式：子网掩码(IPv4地址) | 240423 |
| gateway | string | N | 空 | 经由网关 格式：IP地址，空 | 240423 |
| metric | int | N | 0 | 跃点数 格式：0-1024 | 240423 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_route/set | 240423 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| start | String | N | 100 | 开始的IP地址 格式：1-500 | 240412 |
| limit | int | N | 150 | 最大分配数量 格式：1-500 | 240412 |
| leasetime | string | N | 12h | 租用时间 格式：(1-1000)h | 240412 |
| ignore | int | N | 0 | 禁用LAN的服务 格式：0(不禁用) 1(禁用) | 240412 |
Server→Client Response
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_dhcp/set | 240412 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| lists | array | N | - | 格式[{RULESKV}...]，参考"RULESKV" | 240412 |
| RULESKV | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| domain | string | Y | - | 域名 格式：1-63字符 | 240412 |
| parse_ip | string | Y | - | 解析IP 格式：IPv4地址 | 240412 |
Server→Client Response
Server→Client Response
| RULESKV | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_dhcp/dns_set | 240412 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| rules | array | N | - | 格式[{RULESKV}...]，参考"RULESKV" | 240422 |
| RULESKV | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| name | string | N | 空 | 名称 格式：0-32字符 | 240422 |
| proto | string | N | tcp | 协议 格式：tcp udp icmp igmp all | 240422 |
| src | string | N | 空 | 源网络域 格式：wan lan mgt 空(不指定) | 240422 |
| src_ip | string | N | 空 | 源IP或源网络 格式：IP地址 或 IP/CIDR, 可空，长度0-32 | 240422 |
| src_port | string | N | 空 | 源端口 格式：单端口1-65536 多端口(1-65536):(1-65536) | 240422 |
| dest | string | N | 空 | 目标网络域 格式：wan lan mgt 空(不指定) | 240422 |
| dest_ip | string | N | 空 | 目标IP或目标网络 格式：IP地址 或 IP/CIDR, 可空，长度0-32 | 240422 |
| dest_port | string | N | 空 | 目标端口 格式：单端口1-65536 多端口(1-65536):(1-65536) | 240422 |
| target | string | N | ACCEPT | 规则动作 格式：ACCEPT REJECT DROP | 240422 |
| enabled | int | N | 1 | 开关 格式：0(关闭)、1（开启） | 240422 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_firewall/rule_set | 240422 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| redirects | array | N | - | 格式[{RDRTSKV}...]，参考"RDRTSKV" | 240422 |
| RDRTSKV | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| name | string | N | 空 | 名称 格式：0-32字符 | 240422 |
| proto | string | N | tcp | 协议 格式(单选)：tcp udp icmp | 240422 |
| src | string | N | wan | 源网络域 格式：wan lan | 240422 |
| src_dport | string | Y | - | 源目的端口 格式：单端口1-65536 多端口(1-65536):(1-65536)，proto为icmp时，此值为空，页面标签隐藏 | 240422 |
| dest | string | N | lan | 目标网络域 格式：wan lan | 240422 |
| dest_ip | string | Y | - | 目标IP 格式：IP地址 | 240422 |
| dest_port | string | Y | - | 目标端口 格式：单端口1-65536 多端口(1-65536):(1-65536)，proto为icmp时，此值为空，页面标签隐藏 | 240422 |
| target | string | N | dnat | 转发模型 格式：dnat | 240422 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_firewall/redirect_set | 240422 |
· 注意：本接口设置后需有生效需求
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| alias1_device | string | N | 空 | 绑定接口(基本) 格式：wan, lan，空 | 240412 |
| alias1_ipaddr | string | N | 空 | IP地址 格式：IP格式，0-15个字符，空 | 240412 |
| alias1_netmask | string | N | 空 | 子网掩码 格式：0-15个字符，空 | 240412 |
| alias2_device | string | N | 空 | 绑定接口(基本) 格式：wan, lan，空 | 240412 |
| alias2_ipaddr | string | N | 空 | IP地址 格式：IP格式，0-15个字符，空 | 240412 |
| alias2_netmask | string | N | 空 | 子网掩码 格式：0-15个字符，空 | 240412 |
Server→Client Response
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /net_alias/set | 240412 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| switch | string | N | 空 | VPN开启类型 格式：openvpn 空(关闭) | 240425 |
| ovpn_username | string | N | 空 | 账户验证名 格式：0-32字符，空 | 240425 |
| ovpn_password | string | N | 空 | 账户验证密码 格式：0-32字符，空 | 240425 |
| ovpn_cert_password | string | N | 空 | cert验证密码 格式：0-32字符，空 | 240425 |
| ovpn_config | string | N | 空 | ovpn配置内容 格式：0-32678字符，空 | 240425 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| ovpn_status | string | 0 | VPN连接状态 格式：0(未连接) 、1(已连接) | 240425 | |
| ovpn_ipaddr | string | 空 | VPN连接成功后IP地址 | 240425 | |
| ovpn_netmask | string | 空 | VPN连接成功后Mask | 240425 | |
| 参考 /net_vpn/set |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| limit | int | N | 128 | 日志行数 格式：1-1024 | 240425 |
Server→Client Response
| DATA_SUBKEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| log | string | 240425 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| network_mode | string | Y | - | 网络模式 格式可选值通过配置获取，示例：route/bridge | 240123 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| type_list | array | - | 切换模式可选择列表 格式：[bridge,route]，包含列表值有bridge和route | 230925 |
| 参考 /net_switch/set | 230901 |
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| platform | string | netbus(多CPU架构)，combined(单CPU架构) | 230209 | |
| firmware_model | string | 固件型号 | ||
| firmware_version | string | 固件版本 | ||
| vendor | string | 发行商名称(仅显示用) | ||
| website | string | 发行商网站(仅显示用) | ||
| product | string | 产品名称(仅显示用) | ||
| region | string | 国家或地区2位码(未知作用) | ||
| language | string | 默认语言2位码(仅显示用) | ||
| model2 | string | 产品型号(仅显示用) | ||
| sn | string | 序列号信息 | 230608 | |
| maxslots | int | 最大槽位数量(编号从0开始)，combined认为只有槽位0，所以maxslots为1 | 230209 | |
| interface | string | 物理接口类型：analog，digital | 230209 | |
| maxspans | int | 每个槽位最大SPAN数量(编号从1开始，模拟总是1) | 230209 | |
| maxchannels | int | 每SPAN最大channels数量(编号从1开始) | 230209 | |
| maxprofiles | int | 最大允许的策略数量(编号从0开始) | ||
| fxs_enable | string | 设备是否有fxs，值为yes或no | 230613 | |
| fxo_enable | string | 设备是否有fxo，值为yes或no | 230613 | |
| maxacls | int | ACL白名单最大列表数量 | ||
| maxlocalswitchlist | int | 自交换最大的规则数量 | ||
| maxdigitmaprule | int | 每数图策略最大的规则数量 | ||
| maxcallrouterule | int | 最大呼叫路由规则数量 | 230309 | |
| maxroutelist | int | 最大静态路由规则数量 | 220902 | |
| maxfirewallrules | int | 最大防火墙规则数量 | 220906 | |
| fxo_groupstart | int | FXO分组开始编号 | 221208 | |
| fxo_groupmax | int | FXO分组总数 | 221208 | |
| mac_str | string | 主mac地址 | 230228 | |
| extraface | string | 扩展接口参数。数字中继为bri或t1e1 | 230303 | |
| maxsiptrunk | int | 最大中继数量(仅在interface为digital有效)(编号从0开始) | 230309 | |
| product_id | string | 主控板硬件版本 | 230815 | |
| vendor_cn | string | 发行商中文 | 231121 | |
| style | string | 菜单样式风格 | 231121 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| uptime | int | 系统运行时间（单位：秒） | 20220811 | |
| processor_total | int | 处理器全数值 | ||
| processor_idle | int | 处理器空闲数值 | ||
| memory_total | int | 内存总容量(KB) | ||
| memory_idle | int | 内存空闲量(KB) |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240520 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| uptime | int | 当前系统uptime时间，用作参考，当接口板uptime超过30秒没更新，则视为接口板不存在 | |
| interface | array | 接口板基本信息 格式[{IFACEKV}...]，参考"IFACEKV" | |
| voip_port | array | 默认分配端口情况 格式： |
| IFACEKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | 槽号 | ||
| uptime | int | 接口板数据更新时间 | ||
| model | string | 接口板固件型号 | ||
| version | string | 接口板固件版本 | ||
| interface | string | 接口板支持的物理接口类型 | ||
| product_id | string | 接口板硬件版本 | 230815 | |
| macaddr | string | 接口板mac地址 | 231221 | |
| dahdi_scan | json-string | 接口板接口信息 格式：[{SPAN:DETAILS}...] 模拟和数字板不一样，请实际测试。注意SPAN | ||
| dahdi_port | json-string | 端口状态信息 格式：[{SPAN:DETAILS}...] 模拟和数字板不一样，请实际测试。注意SPAN | ||
| sip_register | json-string | SIP注册信息 格式：[{XXX:DETAILS}...] 模拟和数字板使用不一样，请实际测试。 | ||
| dahdi_analog | json-string | 模拟板端口摘机状态{channel:status} 示例数据 | 230224 | |
| voltage | json-string | 端口电压 格式：{channel:voltage} 示例数据 | 240313 |
| VOIPPORTKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| sip_start | int | SIP可分配端口开始号 | ||
| sip_end | int | SIP可分配端口结束号 | ||
| rtp_start | int | RTP可使用端口开始号 | ||
| rtp_end | int | RTP可使用端口结束号 | ||
| udptl_start | int | UDPTL可使用端口开始号 | ||
| udptl_end | int | UDPTL可使用端口结束号 | ||
| sip_anonymous | int | SIP匿名端口号 | ||
| sip_channel_start | int | SIP通道模式端口号 | 221208 | |
| sip_group_start | int | SIP分组模式端口号 | 221208 | |
| sip_other_start | int | SIP其他端口号 | 221208 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240520 |
| limit | string | N | 空 | 数量 格式：空(不限) 或数字长度限0-8 | 240520 |
| source_tpl | string | N | 空 | 关联source_tpl(参考worker.md) 格式：空(无) 长度0-32 | 240520 |
| source | string | N | 空 | 关联source(参考worker.md) 格式：空(无) 长度0-32 | 240520 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | 槽位号 | 230317 | |
| source_tpl | string | TPL值 | 230317 | |
| source | string | SOURCE值 | 230317 | |
| callerid | string | 主叫信息 | 230317 | |
| from | string | 主叫号码 | 230317 | |
| from_channel | string | 主叫通道 | 230317 | |
| to | string | 被叫号码 | 230317 | |
| to_channel | string | 被叫通道 | 230317 | |
| disposition | string | 呼叫状态 格式："NO ANSWER" FAILED BUSY ANSWERED CONGESTION UNKNOWN | 230317 | |
| start | string | 呼叫开始时间 | 230317 | |
| answer | string | 应答开始时间 | 230317 | |
| end | string | 总体结束时间 | 230317 | |
| billsec | string | 应答时间长度 | 230317 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| name | string | N | - | 软件包名称 格式：长度1-64 | 240520 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| name | string | - | 软件包名称 格式：空表示没找到 | 230415 |
| version | string | - | 软件包版本 例如：1.0-1 | 230415 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| class_name | string | N | 空 | API的class名称 格式：长度0-64 0表示全部class | 240520 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| api | array | - | API返回信息 格式 | 230415 |
注意：本接口访问无需token
注意：防止黑客 DDOS攻击，处理请求随机delay 0-2s
Client→Server Request
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| device_sn | string | 序列号 | 230601 | |
| product | string | 产品名称 | 230601 | |
| product_id | string | 主控板硬件版本 | 240227 | |
| vendor | string | 发行商名称 | 231108 | |
| website | string | 发行商网站 | 231108 | |
| region | string | 国家或地区2位码 | 231108 | |
| language | string | 默认语言2位码 | 231108 | |
| platform | string | 架构类型 | 230601 | |
| device_model | string | 产品型号 | 230601 | |
| firmware_model | string | 固件型号 | 230601 | |
| firmware_version | string | 固件版本 | 230601 | |
| mac_str | string | MAC地址 | 230601 | |
| device_ip | string | 设备IP | 230601 | |
| interface | string | 物理接口 | 230601 | |
| os_time | string | 系统时间 | 230601 | |
| uptime | string | 运行时长 | 230601 | |
| use_cpu | string | cpu占用 | 230601 | |
| use_memory | string | 内存占用 | 230601 | |
| use_storage | string | 存储占用 | 230601 |
注意：本接口访问无需token
注意：防止黑客 DDOS攻击，处理请求随机delay 0-2s
Client→Server Request
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| device_model | string | 产品型号 | 231123 | |
| vendor | string | 发行商名称 | 231123 | |
| vender_cn | string | 发行商中文 | 231123 | |
| style | string | 菜单样式风格 | 231123 | |
| i18n_user | string | i18n支持配置项 | 240109 |
· 注意：可上传固件大小，64M内存<18M，128M内存<26M
· 注意：如当前设备可用内存小于上传最大值将启用低内存模式（此时核心业务被关闭，待/upload上传完成后再开启，如上传过程出现失败，手工重启设备也可恢复）
Client→Server Request
Server→Client Response
· 注意：调用本接口前需调用upload_permission接口获得许可
o 设备卡死：没有获得upload_permission许可，设备内存不足
o HTTP 413：上传文件超过最大限制
o HTTP 500：设备内存不足，被强制终止上传
· 注意：本接口为POST表单接口，encrypt为multipart/form-data，不是rest api接口。
· 注意：请参考附录中的“固件上传测试结果”
Client→Server Request
| POST_NAME | POST_TYPE | Default | Remark | Renew |
|---|---|---|---|---|
| type | text | - | 上传文件类型 格式：controller interface 注意：只有设备为netbus模式才能调用interface | 221117 |
| binary | file | - | POST的file类型文件 | 221117 |
| keep_sys | text | no | 保留系统配置 格式：yes/no | 221117 |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| msg | string | 空 | 返回文字内容 | 221117 |
| code | int | - | 返回编码，编码符合API定义标准 | 221117 |
Client→Server Request
Server→Client Response
Client→Server Request
Server→Client Response
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| action | int | Y | - | 动作类型 格式：0(无操作) 1(本地备份生成) 2(本地备份恢复) | 240521 |
Server→Client Response
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| backup_data | string | Y | - | 备份数据(base64数据) 格式：长度16-524288(约等于512K最大) | 240521 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| backup_data | string | - | 备份数据(base64数据) 格式：长度16-524288(约等于512K最大) | 230412 |
· 注意：level != admin的账户"原用户名"只能填自己，并且验证"原密码"是否正确。
· 注意：CLI账户等同于WEB的level=admin
· 注意：修改以后"原用户"的登录即可失效，必须重新登录。
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| username | string | - | 原用户名 格式：4-32个字符 | |
| password | string | - | 原密码(MD5) 格式：4-32个字符 | |
| new_username | string | - | 新用户名 格式：4-32个字符 | |
| new_password | string | - | 新密码(MD5) 格式：4-32个字符 | |
| new_password_confirm | string | - | 新密码确认(MD5) 格式：4-32个字符 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| list | array | 用户列表 格式：[{ULKV}...]，参考"ULKV" | 231102 | |
| ULKV | VAL | Default | Remark | Renew |
| -------- | ------- | ----------- | ---------------------------------- | --------- |
| username | string | - | 用户名 格式：4-32个字符 | 231102 |
| password | string | - | 密码(MD5) 格式：4-32个字符 | 231102 |
| level | string | - | 等级数据 格式：admin, user, viewer | 231102 |
Client→Server Request
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考 /sys_user/export | 231102 |
Server→Client Response
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| new_password | string | - | 新密码(明文) 格式：8-32个字符 | 220914 |
| new_password_confirm | string | - | 新密码确认(明文) 格式：8-32个字符 | 220914 |
Server→Client Response
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| timezone | string | N | UTC | 时区字符串，长度64 | 240522 |
| ntp_enable | int | N | 1 | 开启NTP时间同步，1开启，0关闭 | 240522 |
| ntp_server_list | string | N | 空 | NTP服务器地址，多个空格分隔，长度128 ntp_enable开启时，不能为空；其他情况可以为空 | 240522 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考/sys_option/datetime_set | ||||
| timestamp | string | 当前系统时间 | ||
| datetime_str | string | 所设置时区偏移的时间字符串,前端根据当前语言,格式化显示,例如：date=new Date("2023-07-05T20:24:52");date.toLocaleString("zn-CN"); | 20230707 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| log_ip | string | N | 空 | 日志服务器地址 格式：为空表示不开启，长度0-63 | 240522 |
| log_port | int | N | 0 | 日志服务器端口 格式：0(关闭) 1-65535 备注：推荐514 | 240522 |
| conloglevel | int | N | 0 | 内核日志级别 格式：8(DEBUG) 7(INFO) 6(NOTICE) 5(WARNING) 4(ERROR) 3(CRIT) 2(ALERT) 1(EMERG) 0(关闭) 备注：推荐7 | 240522 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考sys_option/syslog_set | 220819 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| enable | int | N | 1 | 开启SSH服务 格式：0(取消) 1(开启) | 240522 |
| port | int | N | 3505 | SSH服务端口 格式：100-65535 | 240522 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考sys_option/ssh_set | 220914 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| mode | int | N | 0 | HTTP服务模式 格式：0(HTTP) 1(HTTPS) 2(关闭) | 240522 |
| http_port | int | N | 80 | HTTP服务端口 格式：80-65535 | 240522 |
| https_port | int | N | 443 | HTTPS服务端口 格式：80-65535 | 240522 |
| https_pem | int | N | 0 | HTTPS服务的PEM证书选择 格式：0(缺省证书) 1 2 3 4 | 240522 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考sys_option/http_set | 230413 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| reboot | int | N | 0 | 重启计划 格式：0(关闭计划),1(每天),2(每周) | 240522 |
| reboot_hour | int | N | 0 | (reboot=1/2)重启计划 每天 格式：0-23(小时) | 240522 |
| reboot_dayofweek | int | N | 0 | (reboot=2)重启计划 每周 格式：0-6(0为周日) | 240522 |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考sys_option/schedule_set | 230418 |
Server→Client Response
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| session_user | int | N | 600 | WEB登录超时时间配置项 格式：120-3600 单位(秒) | 240522 |
| i18n_user | string | N | - | i18n支持配置项 格式：1-64个字符 多值空格隔开，示例："zh en fr pt th ru" | 240522 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考sys_option/web_set | 240109 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| host | string | N | - | 测试地址 格式：1-63字符 | 240514 |
| count | int | N | 5 | 测试次数 格式：1-100 | 240514 |
| size | int | N | 56 | 包长度 格式：56-1024 单位(字节) | 240514 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| status | int | 0 | 状态 格式：0无 1待处理 2处理中 3完成 注意：完成后需多次读取(流动数据) | 230424 |
| result | string | 空 | URL下载相对地址 | 230423 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| host | string | N | - | 测试地址 格式：1-63字符 | 240514 |
| waittime | int | N | 3 | 设置等待响应消息的时间 格式：范围1-10 | 240514 |
| maxhops | int | N | 30 | 设置最大的跳数 格式：范围1-255 | 240514 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| status | int | 0 | 状态 格式：0无 1待处理 2处理中 3完成 注意：完成后需多次读取(流动数据) | 230424 |
| result | string | 空 | URL下载相对地址 | 230423 |
注意：dns_server 不允许输入127开头的IPv4地址，如果使用OIAD自身的DNS解析（127.0.0.1），dns_server设置为空即可。
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| host | string | N | - | 测试地址 格式：1-63字符 | 240514 |
| dns_server | string | N | 空 | 域名服务器 格式：IPv4 | 240514 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| status | int | 0 | 状态 格式：0无 1待处理 2处理中 3完成 注意：完成后需多次读取(流动数据) | 230424 |
| result | string | 空 | URL下载相对地址 | 230423 |
· 测试发出后结果需要使用/sys_analysis/capture_result接口获得。
· 注意：如果是netbus模式，建议interface只能选择wan
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| interface | string | N | wan | 接口名称(基本,逻辑) 格式：wan lan vpn1 mgt | 240514 |
| proto | string | N | 空 | 过滤协议类型 格式：ip, arp, udp, tcp 空表示忽略 | 240514 |
| host | string | N | 空 | 过滤地址 格式：0-63 空表示忽略 | 240514 |
| port | int | N | 0 | 过滤端口 格式：0-65535 当0时表示忽略 | 240514 |
| action | string | N | 0 | 抓包动作 格式：0停止 1开始 | 240514 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| status | int | 0 | 状态 格式：0无 1待处理 2处理中 3完成 注意：完成后一次性读取完成 | 230424 |
| result | string | 空 | URL下载相对地址 | 230423 |
· 测试发出后结果需要使用/sys_analysis/record_result接口获得。
· 注意：录音文件格式为8000HZ采样率，16位，双声道(0为RX,1为TX)，格式PCM16
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240510 |
| record | int | N | 2 | 录音动作 格式：1开始 2停止 | 240510 |
| record_channel | int | N | 1 | 端口号 格式：不可空，注意限制，无效报错 | 240510 |
| record_limit | int | N | 60 | 录音时长(秒) 格式：1-300 注意：300秒容量达到了5MB，建议时间不超过60秒 | 240510 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| status | int | 0 | 录音状态 格式：0无 1正在录音 2录音结束 注意：完成后一次性读取完成 | 240510 |
| result | string | 空 | URL下载相对地址 | 230424 |
· 信息日志是页面显示通信日志的一种手段
· 注意：设备目前写死只允许2MB最大日志空间。即便以后修改也不会允许第三方设置
· 注意：切换消息级别会自动清空旧的日志数据
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240531 |
| msglog_level | string | N | disable | 消息级别 单选：disable、callflow、debug | 240531 |
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240531 |
| clean | string | N | no | 获取数据前清空旧的数据 格式：yes/no | 240531 |
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考 /sys_analysis/msglog_do | 240531 | ||||
| msglog_result | string | - | 空 | msg文本数据内容 | 240531 |
Client→Server Request
| KEY | VAL | Default | Remark |
|---|---|---|---|
| addresses | array | [] | 格式：[{LISTKV}...]，参考"LISTKV"，空数组表示清空 数量限制sys_info/oem的maxacls |
| LISTKV | VAL | Default | Remark |
|---|---|---|---|
| start | string | - | 开始地址 格式：IPv4 |
| end | string | 空 | 结束地址 格式：空表示只有start，有效IP并且跟开始地址是在同一个范围内，当开始地址大于结束地址时自动使用开始地址作为结束地址 |
Server→Client Response
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| addresses | array | - | 参考sys_security/acl_web_set |
注意：如果证书更新了并且正好被http服务选中，则需重启http服务 注意：如果证书更新了那么voip服务会自动重启
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| certs_iad1 | string | 空 | 设备证书pem 格式：长度0-4096 | 230505 |
| certs_iad2 | string | 空 | 设备证书pem 格式：长度0-4096 | 230505 |
| certs_iad3 | string | 空 | 设备证书pem 格式：长度0-4096 | 230505 |
| certs_iad4 | string | 空 | 设备证书pem 格式：长度0-4096 | 230505 |
| certs_calist | string | 空 | CA证书链 格式：长度0-16384 备注：CA证书链允许多个CA证书存在 | 230505 |
Server→Client Response
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| 参考sys_security/certs_set |
注意：还有两个功能：下载本机配置/上载本机配置，该功能需要客户端实现(WEB)。实现的方法原则请咨询欧工和参考后台代码icvp-provision
· 注意：设置执行条件后后台将调用icvp-provision与icvp-cli配合实现自动部署。
· 注意：后台provision并不限制上传文件大小，只要上传后内存还有5M剩余空间既可完成(如内存剩余空间不足，则失败)。
· 注意：如当前设备可用内存小于上传最大值将启用低内存模式（此时核心业务被关闭）。
· 默认的主控固件文件名为：(pre)(当前固件名称).img(post)
· 默认的接口板固件文件名为：(pre)ixu(mac).img(post)
· 默认的配置文件名为：(pre)cfg(mac)(post)
· 文件名格式：
a. 长度限制，注意文件全名最大长度不超过255 b. 文件名限制使用特殊字符【如空格(" ")，斜杠("/")，反斜杠("")，冒号(": ")，星号("*")，问号("?")，双引号('"')，尖括号("<",">")等】
主固件INFO文件说明(20240226新增)，INFO文件为固件说明文件可以实现对固件升级的buildversion控制
// INFO设计说明:
// 2. 如主固件叫iac-v1102.img 则INFO文件为iac-v1102.info
// 2. 当INFO文件无法获取时，将按照标准流程继续处理固件升级
// 3. 当INFO文件格式错误时，将终止升级固件流程
// 4. 服务器端开启升级的处理步骤：先复制info、再复制img
// 5. 服务器端关闭升级的处理步骤：先删除img、再删除info
// 6. INFO内容举例，将xx和yy版升级为zz版：
{"firmware_version_filter":["xx","yy"],"firmware_version_new":"zz"}
// INFO内容举例，全部升级为zz版:
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| auto_switch | string | N | no | 自动部署 格式：no(关闭),boot(上电),day(每天),week(每周) | 240313 |
| auto_hour | int | N | 0 | 自动部署小时 格式：0-23 | 240313 |
| auto_dayofweek | int | N | 0 | 自动部署周几 格式：0-6(0为周日) | 240313 |
| auto_target | string | N | all | 自动部署范围 格式：all(全部), firmware(固件), config(配置) | 240313 |
| upgrade_type | string | N | tftp | 升级方式 格式：tftp,http,https | 240313 |
| upgrade_dhcp | string | N | yes | 开启DHCP 66自动覆盖服务器地址 格式：yes/no | 240313 |
| upgrade_user | string | N | 空 | HTTP/HTTPS 验证用户名 格式：0-32字符 | 240313 |
| upgrade_pass | string | N | 空 | HTTP/HTTPS 验证密码 格式：0-32字符 | 240313 |
| firmware_url | string | N | 空 | 固件升级地址(不带协议头) 格式：0-64字符 | 240313 |
| firmware_pre | string | N | null | 固件文件前缀 格式：0-32字符，文件名格式 | 240313 |
| firmware_post | string | N | null | 固件文件后缀 格式：0-32字符，文件名格式 | 240313 |
| config_url | string | N | 空 | 配置升级地址(不带协议头) 格式：0-64字符 | 240313 |
| config_pre | string | N | null | 配置文件前缀 格式：0-32字符，文件名格式 | 240313 |
| config_post | string | N | null | 配置文件后缀 格式：0-32字符，文件名格式 | 240313 |
| config_filename | string | N | null | 配置文件名称 格式：0-32字符，文件名格式 | 240313 |
| Server→Client Response |
Server→Client Response
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| 参考/sys_provision/set | 240313 |
· 注意: SNMP相关接口目前只在ARM平台的设备上默认安装。7688平台(iac-v20)对应设备若想使用，制作固件把icvp-snmp勾选上。
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| enabled | int | 0 | 开关 格式：0(关闭)、1（开启） | |
| ip | string | 空 | 支持ip及ip段 格式：0-18字符，为空时表示不限制IP访问 | |
| port | int | 161 | 开放的端口必须防火墙允许，参考 sys_snmp/set 管理站请求端口 格式：默认端口值为161，取值范围为1025～65535 | |
| versions | string | v2c | 版本选择 格式：v1、v2c、v3，多选以逗号分隔 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考 /sys_snmp/set |
· 该接口是插件接口，只有安装了ocloudclient插件才能用，可以通过/sys_info/package接口传ocloudclient查询
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| disabled | int | 0 | 开关 格式：0(开启)、1（关闭） | 230531 |
| server_addr | string | openvox.cloud | 服务器地址 支持ip及域名,长度1~100 | 230531 |
| server_port | int | 7000 | 开放的端口必须防火墙允许, 服务器地端口 格式：默认端口值为7000，取值范围为1～65535 | 230531 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考 /sys_ocloudclient/set |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| bind_code | string | 云管理绑定码 | 230531 |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| msg | string | 提示语 | 230531 | |
| code | string | 200为成功,非200为失败 | 230531 |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| bind_code | string | 云管理绑定码 | 230531 |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| msg | string | 连接状态信息,web直接展示 | 230531 |
· 用于http端口和类型配置变化后生效并重启ocloudclient
Client→Server Request
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| server_addr | string | 服务器地址 支持ip及域名,长度1~100 | 231115 | |
| remote_port | int | 端口，取值范围为1～65535 | 231115 | |
| sign_str | string | 鉴权字符串，md5(sn+openvox+server_addr+port) 32位小写格式 | 231115 |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| code | int | 200为成功，400或其他为失败 | 231116 | |
| msg | string | 提示信息 | 231116 | |
| data | json | remote_port 设置的端口 | 231116 |
· 注意：槽位可用数量，参考sys_info/oem的说明。
· 注意：各种限制数量，参考sys_info/oem说明。
· 注意：仅在当前controller为analog时本类接口才可调用，参考sys_info/oem说明。
· 注意：本类别接口设置执行过可能存在有需要生效的部分(/general/apply_do)
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| driver_custom | string | N | 空 | (ALL) 驱动扩展参数 格式：不超过64字符、可空 | 240131 |
| opermode | string | N | FCC | (ALL) 线路阻抗匹配 可选：FCC, CHINA, BRAZIL, PHILIPPINES, INDONESIA, NIGERIA, INDIA, ARGENTINA, AUSTRALIA | 240131 |
| alawoverride | int | N | 0 | (ALL) 线路强制alaw编码(有BUG) 格式：1强制 0不强制 | 240131 |
| fxshonormode | int | N | 1 | (FXS) FXS阻抗方式 格式：1(opermode生效) 0(FCC) | 240131 |
| boostringer | int | N | 0 | (FXS) 高压振铃 格式：0(关闭) 1(开启) 注意：如opermode为AUSTRALIA自动设置为1 | 240131 |
| fastringer | int | N | 0 | (FXS) 振铃频率 格式：0(20Hz) 1(25Hz) | 240131 |
| signaling | string | N | ls | (ALL) Ports signaling: ks(kewlstart) ls(loopstart) | 240131 |
| loadzone | string | N | cn | (ALL) 线路音频区域码 可选：us, au, fr, nl, uk, fi, es, jp, no, at, nz, it, us-old, gr, tw, cl, se, be, sg, il, br, hu, lt, pl, za, pt, ee, mx, in, de, ch, dk, cz, cn, ar, my, th, bg, ve, ph, ru, tr, pa, mo, cr, ae | 240131 |
| language | string | N | cn | (ALL) 音频区域码 可选：at, au, bg, br, be, ch, cl, cn, cz, de, dk, ee, es, fi, fr, gr, hu, id, il, in, it, lt, jp, mx, my, nl, no, nz, ph, pl, pt, ru, se, sg, th, uk, us, us-old, tw, ve, za | 240131 |
| pulsedial | string | N | no | (FXO)使用脉冲拨号 格式：yes/no | 240131 |
| ringtimeout | int | N | 8000 | (FXO)应答前对方挂机检测 格式：1000-20000 单位ms | 240131 |
| waitfordialtone | int | N | 0 | (FXO)挂机后再摘机拨号音检测 格式：0-20000 单位ms | 240131 |
| dialtone_detect | int | N | 10000 | (FXO)摘机后拨号音检测时长 格式：0-100000，单位ms | 240131 |
| busycount | int | N | 4 | (FXO)忙音检测匹配次数 格式：1-16 注意：小于4没配置busypattern可能错检 | 240131 |
| busypattern | string | N | 空 | (FXO)忙音检测节奏 格式：空(关闭) 长度0-64 注意：如不设置将采用自动节奏 | 240131 |
| cidstart | string | N | ring | (FXO)来电显示时机 格式：ring,polarity,polarity_IN,dtmf | 240131 |
| cidsignalling | string | N | bell | (FXO)来电显示信号 格式：bell,v23,dtmf | 240131 |
| dtmfcidlevel | int | N | 256 | (FXO)来电DTMF强度 格式：128-1024 注意：仅cidstart=dtmf时有效，太小漏检太大误检 | 240131 |
| port_osi | string | N | 500 | (ALL) Open Switching Interval开关电路间隔，仅在kewlstart时有效，用于通过改变电压实现挂机，单位ms，范围100-10000 | 240131 |
| port_led_reg | string | N | no | (FXS)接口灯SIP注册成功常亮 格式：yes/no | 240131 |
| port_led_idle | string | N | 0,2000 | (FXS)接口灯空闲时 格式：[on,off] 单位ms 备注：例如0,2000长灭，100的整数倍，两数之和能被2000整除，不可以是2000,2000 | 240131 |
| port_led_nobat | string | N | 1000,1000 | FXO接口灯未接线时 格式：[on,off] 单位ms | 240131 |
| port_led_offhook | string | N | 500,500 | (FXS)接口灯摘机时 格式：[on,off] 单位ms | 240131 |
| port_led_ring | string | N | 100,100 | (FXS)接口灯振铃时 格式：[on,off] 单位ms | 240131 |
| port_led_talk | string | N | 500,500 | (FXS)接口灯通话时 格式：[on,off] 单位ms | 240131 |
| port_led_talkend | string | N | 500,500 | (FXS)接口灯通话结束时 格式：[on,off] 单位ms | 240131 |
| dahdi_pulsedial | int | N | 0 | (FXS) Support Pulse Dialing 可选：0(no)/1(yes) | 240131 |
| dahdi_maxpulsetime | int | N | 200 | (FXS) Maxmum Pulse Time 可选：16-2000 建议<=rxminflash | 240131 |
| fxs_dialdebounce | int | N | 64 | (FXS) 摘挂机检测去抖时间 可选：32(脉冲拨号) 64 96 128 | 240131 |
| rxflash | int | N | 1250 | (FXS) 最大拍叉时长 可选：100-3000 单位ms | 240131 |
| rxminflash | int | N | 40 | (FXS) 最小拍叉时长 可选：40-2000 单位ms 建议<=rxflash | 240131 |
| firstdigit_timeout | int | N | 10000 | (FXS) 首位拨号超时 可选：1000-40000 单位ms | 240530 |
| interdigit_timeout | int | N | 6000 | (FXS) 位间拨号超时 可选：1000-20000 单位ms | 240530 |
| mwi_hz | int | N | 1 | (FXS)设置MWI 波形频率 可选：1,2,4 | 240418 |
| jbenable | string | N | no | (ALL) 抖动缓冲开启 可选：yes/no | 240131 |
| jbmaxsize | int | N | 200 | (ALL) 抖动最大缓冲 可选：10-10000 单位ms | 240131 |
| jbresyncthreshold | int | N | 1000 | (ALL) 抖动重新同步时跳转帧时间戳 可选：10-10000 单位ms | 240131 |
| jbimpl | string | N | fixed | (ALL) 抖动缓冲方式 可选：fixed(静态缓冲，只用jbmaxsize), adaptive(可变缓冲) | 240131 |
| jbtargetextra | int | N | 40 | (ALL) 抖动可变新缓冲大小(仅在adaptive有效)，用于突发高峰抖动时。 可选：10-10000 单位ms | 240131 |
| dtmf_to_total_energy | int | N | 35 | (ALL) DTMF总能量比例系数 可选：10-100 | 240131 |
| dtmf_gsize | int | N | 120 | (ALL) DTMF每检测区段采样点数 可选：80-160 | 240131 |
| dtmf_threshold | int | N | 80000000 | (ALL) DTMF能量阈值 可选：80000000-2400000000 | 240131 |
| transferremote | string | N | yes | (ALL)呼叫转移至远程分机 格式：yes/no | 240131 |
| threeway_up_only | string | N | yes | (ALL)三方通话拍叉规则(表头说明) 格式：yes/no，前端不做配置 | 240520 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/analog/tel_set说明 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| user_agent | string | N | OIAD | SIP协议中user-agent字符串 长度：1-64 注意：当UCI的user_agent_force不为空时本参数不可修改 | 240228 |
| quick_dnssrv_switch | string | N | no | 快速DNSSRV切换 格式: yes(是) no(否) | 240418 |
| timer_t1 | int | N | 500 | 传输时间T1值 格式：(毫秒) 100-10000000 | 240131 |
| timer_t2 | int | N | 4000 | 传输时间T2值 格式：(毫秒) 800-10000000 | 240131 |
| allow_tx_hash_in_uri | string | N | no | 不转义"#"号 格式: yes(是) no(否) | 240131 |
| timers | string | N | yes | Session Timer(RFC4028)支持方式 格式：yes/no/always/required | 240131 |
| timers_min_se | int | N | 90 | Session刷新最小间隔 格式：(毫秒) 90-10000000 | 240131 |
| timers_sess_expires | int | N | 1800 | Session刷新最大间隔(必须大于等于最小值) 格式：(毫秒) 90-10000000 | 240131 |
| g723_rate | string | N | 63 | G723速率 可选: 63(6.3kbps编码速率) 53(5.3kbps编码速率) 如果设备不支持G723编解码，无此字段 | 240223 |
| ilbc_mode | string | N | 30 | iLBC帧时长 可选: 20(20ms) 30(30ms) 如果设备不支持iLBC编解码，无此字段 | 240223 |
| sip_anonymous | string | N | no | (pjsip_account) 启动SIP的匿名呼入 格式：yes/no | 240131 |
| in_ringtime | int | N | 55 | (dialplan) 呼入等待超时 可选：10-1000 单位s | 240131 |
| out_ringtime | int | N | 55 | (dialplan) 呼出等待超时 可选：10-1000 单位s | 240131 |
| cadence | array | N | - | FXS区别振铃表 格式：[c1,c2...c10]，必须10条 数据cN格式：r1,s1[,r2,s2...r8,s8] 总长度不超过64字符 | 240202 |
| sip_cid2 | int | N | 0 | (dialplan) 主叫号码显示优先：0(FROM), 1(P-Asserted-Identity) | 240131 |
| calltimeout | int | N | 43200000 | (FXO)呼叫最大限时 格式：0-99999999 单位ms 0表示不限 | 240131 |
| net_failover | string | N | yes | (FXS) 断网逃生 可选：yes/no 备注：当网络失败或呼叫超时自动使用FXO口呼出 | 240131 |
| early_media | string | N | no | (dialplan) 开启early_media 格式: yes(是) no(否) | 240312 |
| ring_cadence | int | N | 0 | (FXS) 区别振铃功能使用振铃间隔匹配，可选:0-10 0代表不使用区别振铃的cadence | 240407 |
| ring_alert_info | array | N | - | (FXS) 区别振铃功能使用alert_info匹配 空数组表示清空，数量限制5条，格式[{k1:v1},{k2:v2}] value取值范围1-10，举例数据[{"ring2":"2"},{"ccc":"4"}] | 240407 |
| ring_caller_id | array | N | - | (FXS) 区别振铃功能使用caller_id匹配,caller_id支持前缀匹配 空数组表示清空，数量限制5条，格式[{k1:v1},{k2:v2}] value取值范围1-10，举例数据[{"102":"2"},{"9002":"7"}] | 240407 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| user_agent | 注意：当UCI的user_agent_force不为空时本参数值为空 | 240228 | ||
| 参考/analog/voip_set |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | |
| sipid | string | - | 字符串SIP号 格式：FXS为"channel"号,FXO为"group"号 | 220908 |
| cmd_register | int | 0 | 对应SIP注册动作 格式：0 无动作, 1 注册, 2 注销 |
Server→Client Response
· 注意：读取到的端口配置数据为最大支持的数据，存在假数据
· 注意：数据是否有效一定要核对sys_info/interface的结果值
· 比如：1O1S的设备，可能FXS有channel=1和channel=2两个数据，而实际上接口只有channel=1为FXO，因此必须核对上报来的interface数据。
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 221208 |
| type | string | fxs | 类型 格式：fxo fxs all | 230515 |
| enable | string | 空 | 过滤数为enable 格式：yes/no/空 | 230414 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | 槽号 格式：不可空，注意限制，无效报错 | 221208 | |
| fxs | array | FXS表 格式：[{POKV}..]，参考"PSKV" | 221208 | |
| fxo | array | FXO表 格式：[{PSKV}..]，参考"POKV" | 221208 |
| PSKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考analog_port/fxs_get说明 | 221212 |
| POKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考analog_port/fxo_get说明 | 221212 |
"uri": "analog_port/port_get",
"msg": "",
"code": 200,
"data": {
"slotnum": 0,
"fxs": [
{
"slotnum": 0,
"channel": 1,
"sip_listen_port": 30000,
"enable": "yes",
"fxs_tpl": "iadfxs",
"group": "",
"callwaiting": "yes",
"threewaycalling": "yes",
"transfer": "yes",
"canpark": "yes",
"callerid_name": "",
"cidformat": 3,
"port_profile": 0,
"sip_tpl": "iadfxs",
"callerid_num": "",
"from_user": "",
"auth_username": "",
"auth_password": "",
"register": "yes",
"sip_server_profile": 0,
"voip_profile": 0,
"send_pai": "no",
"send_rpid": "no",
"user_eq_phone": "no",
"hotline_num": "",
"hotline_delaytime": 1,
"dnd": 0,
"digitmap_profile": 0,
"ucf": "",
"bcf": "",
"nacf": "",
"send_pani": "no",
"send_pei": "no"
}
],
"fxo": []
}
}
· enable为yes的时候检测前端程序检测：
o sys_info/interface 检查接口板上报数据，uptime时间等参数是否有效合理。
o sys_info/interface 检查接口板上报数据的dahdi_scan中是否为SPAN=1并且type为analog，检测channel的对应的是否为FXS
· enable为no的时候检测：无需如上检测
o 推荐界面有一个选项可以批量将所有的port都设置为disable方便更换板卡后的操作
Client→Server Request
| KEY | VAL | Default | Remark | renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | |
| channel | int | - | 端口号 格式：不可空，注意限制，无效报错 | |
| enable | string | no | 启用端口 格式：yes/no | |
| 主要用于chan_dahdi_channels | ||||
| group | string | 空 | (FXS) 端口分组 格式：内容为4-63 | 240507 |
| callwaiting | string | yes | (FXS) 呼叫等待支持通过hook-flash切换 格式：yes/no | |
| threewaycalling | string | yes | (FXS) 三方呼叫/通话支持(需开启transfer) 格式：yes/no 注意：设置为no将发送排叉事件给sip server | 230420 |
| transfer | string | yes | (FXS) 呼叫转移支持(需开启threewaycalling, 自动覆盖canpark) 格式：yes/no | |
| canpark | string | yes | (FXS) 允许驻留支持(受到transfer影响) 格式：yes/no | |
| callerid_name | string | 空 | (FXS) 显示名称 格式：禁止'"<>填写，32位长度，可空 | 221209 |
| cidformat | int | 3 | (FXS) 配置来电显示 格式：1 CID Only,2 Display Name Only,3 Display Name and CID | 231115 |
| port_profile | int | 0 | (FXS) 绑定PORT策略 格式：策略号，不可空 | |
| 主要用于pjsip_accounts | ||||
| callerid_num | string | 空 | (FXS/SIP) 账户名 格式：32位长度 注意：如为空则register强制为no | 230515 |
| from_user | string | 空 | (SIP) FROM强制账户 格式：32位长度，空(不强制) | 220723 |
| auth_username | string | 空 | (SIP) 认证账户 格式：64位长度，空 注意：如为空则使用callerid_num替代 | 230515 |
| auth_password | string | 空 | (SIP) 认证密码 格式：64位长度，空 | 220723 |
| register | string | yes | (SIP) 启用注册 格式：yes/no | |
| sip_server_profile | int | 0 | (SIP) 绑定服务策略 格式：策略号，不可空 | |
| voip_profile | int | 0 | (SIP) 绑定VOIP策略 格式：策略号，不可空 | |
| send_pai | string | no | (SIP) INVITE时增加P-Asserted-Identity头 格式：yes/no | 230523 |
| send_rpid | string | no | (SIP) INVITE时增加Remote Party ID头 格式：yes/no | 230523 |
| user_eq_phone | string | no | (SIP) INVITE时增加user=phone头 格式：yes/no | 230523 |
| 主要用于AGI | ||||
| hotline_num | string | 空 | (AGI动态) 热线号码 格式：(0-9a-zA-Z+-#*)，空(关闭) 长度不超过32位 | |
| hotline_delaytime | int | 1 | (AGI动态) 热线延时等待 格式：0-1000 单位s | |
| dnd | int | 0 | (AGI动态) 开启免打扰 格式：0(关闭) 1(开启) 注意：话机摘机听到stutter音表示免打扰在工作状态 | 230509 |
| digitmap_profile | int | 0 | (AGI动态) 绑定数图策略 格式：策略号，不可空，注意限制，无效报错 | 220729 |
| ucf | string | 空 | (AGI动态) 无条件呼转号码 格式：长度0-256位 空表示关闭 注意：允许使用DEVICE/RES方式转发，将直接处理，例如DAHDI/g0。或共振DAHDI/1&DAHDI/2。 注意：话机还是只能设置16位长度 | 240404 |
| bcf | string | 空 | (AGI动态) 遇忙呼转号码 格式：长度0-256位 空表示关闭 注意：话机还是只能设置16位长度 | 240404 |
| nacf | string | 空 | (AGI动态) 无应答呼转号码 格式：长度0-256位 空表示关闭 注意：话机还是只能设置16位长度 | 240404 |
| send_pani | string | no | (AGI动态) INVITE时增加P-Access-Network-Info头 格式：yes/no | 230523 |
| send_pei | string | no | (AGI动态) INVITE时增加P-Emergency-Info头 格式：yes/no | 230523 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| channel | int | - | 端口号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| sip_listen_port | int | - | (SIP) SIP信令端口 | 221115 |
| fxs_tpl | string | - | 模板类型：iadfxs | 221212 |
| sip_tpl | string | - | 模板类型：iadfxs/anon/iadfxo | 221212 |
| 参考/analog_port/fxs_set说明 |
· enable为yes的时候检测前端程序检测：
o sys_info/interface 检查接口板上报数据，uptime时间等参数是否有效合理。
o sys_info/interface 检查接口板上报数据的dahdi_scan中是否为SPAN=1并且type为analog，检测channel的对应的是否为FXO
o 检测出当前的channel=中的channel是否已经被其他fxo分组使用，不能重复存在
· enable为no的时候检测：无需如上检测
o 推荐界面有一个选项可以批量将所有的port都设置为disable方便更换板卡后的操作
Client→Server Request
| KEY | VAL | Default | Remark | renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 221208 |
| group | string | - | 分组编号 格式：不可空，注意限制，无效报错 | 221208 |
| enable | string | no | 启用端口 格式：yes/no | 221208 |
| 主要用于chan_dahdi_channels | ||||
| channel | string | 空 | (FXO) 端口 格式：多端口逗号分隔，长度0-256 注意：端口为空强制enable=no 注意：避免channel在其他已enable的fxo中存在 | 221208 |
| port_profile | int | 0 | (FXS) 绑定PORT策略 格式：策略号，不可空 | 221208 |
| 主要用于pjsip_accounts | ||||
| callerid_num | string | 空 | (SIP) 账户名 格式：32位长度 注意：如为空则register强制为no | 230515 |
| from_user | string | 空 | (SIP) FROM强制账户 格式：32位长度，空(不强制) | 221208 |
| auth_username | string | 空 | (SIP) 认证账户 格式：64位长度，空 注意：如为空则使用callerid_num替代 | 230515 |
| auth_password | string | 空 | (SIP) 认证密码 格式：64位长度，空 | 221208 |
| register | string | yes | (SIP) 启用注册 格式：yes/no | 221208 |
| identify | string | 空 | (SIP) IP直送表 格式：地址[:0-65535] 注意：逗号分隔，最大8条 | 221208 |
| identify_prefix | string | 空 | (SIP) 被叫前缀 格式： 32位长度，可为空 | 240219 |
| sip_server_profile | int | 0 | (SIP) 绑定服务策略 格式：策略号，不可空 | 221208 |
| voip_profile | int | 0 | (SIP) 绑定VOIP策略 格式：策略号，不可空 | 221208 |
| 主要用于AGI | ||||
| ip2tel_callee_mode | int | 0 | (AGI) IP2TEL被叫模式二次拨号 格式：0禁用,1启用 | 221208 |
| ip2tel_callee_policy | string | g | (AGI) IP2TEL轮询策略 格式：g(递增) G(递减) r(循环递增) R(循环递减) | 240103 |
| tel2ip_callee_mode | int | 1 | (AGI) TEL2IP被叫模式被叫生成 格式：0分组号,1端口号,2自定义 | 221208 |
| tel2ip_callee | string | 空 | (AGI) TEL2IP自定义被叫号 格式：长度0-33位 | 221208 |
| callroute_profile | int | 0 | (AGI) 绑定呼叫路由策略 格式：策略号，不可空 | 221208 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| group | string | - | 分组编号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| sip_listen_port | int | - | (SIP) SIP信令端口 | 221208 |
| fxo_tpl | string | - | 模板类型：iadfxo | 221212 |
| sip_tpl | string | - | 模板类型：iadfxs/anon/iadfxo | 221212 |
| 参考/analog_port/fxo_set说明 |
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240201 |
| channel | int | Y | - | 端口号 格式：不可空，注意限制，无效报错 | 240201 |
| number | string | N | 空 | 测试号码，O口使用 格式：不超过64字符、可空 | 240201 |
Server→Client Response
5.3 模拟策略
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | |
| name | string | 空 | 策略名称 格式：32字符、可空 | |
| media_encryption | string | no | (RTP) 媒体开启SRTP 格式：sdes、no | |
| media_encryption_optimistic | string | no | (RTP) 媒体强制SRTP 格式：yes/no(自动) | |
| registration_expiration | int | 3600 | (SIP) 注册有效期时间 格式：10-10000 单位s | |
| registration_retry_interval | int | 30 | (SIP) 注册重试间隔 格式：0-2147483647 单位s | 240105 |
| registration_max_retries | int | 2147483647 | (SIP) 注册重试次数 格式：0-2147483647 | 240105 |
| auth_realm | string | * | (SIP) 认证域 格式：*(对端为准)，其他，长度1-64 | 220730 |
| aor_qualify_frequency | int | 0 | (SIP) 信令发送心跳时间 格式：0-10000 单位s | 220723 |
| aor_qualify_timeout | int | 60 | (SIP) 信令心跳超时间隔 格式：1-10000 单位s | 220723 |
| aor_authenticate_qualify | string | no | (SIP) qualify验证 格式：yes/no | 220730 |
| sip_port_mode | string | udp | (SIP) 信令端口类型 格式：udp/tcp/tls | 220723 |
| primary_ipaddr | string | 空 | (SIP) 主服务器地址 格式：(域名和IP地址标准)63字符、可空 注意：如primary_ipaddr为空则不下发SIP配置 | 230515 |
| primary_sip_port | int | 5060 | (SIP) 主服务器信令端口 格式：100-65535 | |
| second_ipaddr | string | 空 | (SIP) 备服务器地址 格式：(域名和IP地址标准)63字符、可空 primary为空时second自动强制为空 | 221001 |
| second_sip_port | int | 5060 | (SIP) 备服务器信令端口 格式：100-65535 | |
| from_domain | string | 空 | (SIP) 使用指定URI作为From Header的域 长度：0-64 | 230605 |
| external_boundle | string | 空 | (SIP) 业务绑定接口(基本,逻辑,虚拟) 格式：wan lan vpn1 alias1 alias2 空值 | 240202 |
| outbound_proxy | string | 空 | (SIP) 呼出代理服务器 格式：(address):(port) address为地址或域名 port为端口 长度0-63 空表示无 | 230427 |
| dns_mode | string | 空 | (SIP) DNS模式 格式：空(自动识别A Record还是IP) srv(dnssrv模式) | 230223 |
| ice_support | string | no | (SIP) 该服务器启用STUN 格式：yes/no 备注：需配置stun地址及开启本参数才有效 | 230504 |
| method | string | 空 | (SIP) TLS版本 格式：空(tlsv1) tlsv1 tlsv1_1 tlsv1_2 sslv2 sslv3 ssv23 | 230508 |
| tls_uri | int | 0 | (SIP) TLS的URI模式 格式：0(SIP) 1(SIPS) | 230508 |
| tls_pem | int | -1 | (SIP) TLS的设备证书PEM选择 格式：-1(无) 0(缺省) 1 2 3 4 | 230508 |
| tls_calist | int | -1 | (SIP) TLS的CA证书链选择 格式：-1(关闭) 0(启用) | 230508 |
| verify_server | string | no | (SIP) TLS的UAC行为验证对端证书有效性 格式：yes/no | 230508 |
| require_client_cert | string | no | (SIP) TLS的UAS行为验证对端证书有效性 格式：yes/no | 230508 |
| identify_mode | string | 空 | (SIP) 兼容模式,用于identify,可以扩展 格式：默认值空串，可选header_cidnum | 240117 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/analog_profile/sip_server_get说明 |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | |
| name | string | 空 | 策略名称 格式：32字符、可空 | |
| allow_transfer | string | yes | (SIP) 允许REFER 格式：yes/no | |
| sip_udptl | string | yes | (SIP) 开启UDPTL 格式：yes/no | 220722 |
| sip_udptl_ec | string | redundancy | (SIP) UDPTL纠错 格式：none/fec/redundancy | 220722 |
| dtmf_mode | string | rfc4733 | (RTP) DTMF模式 格式：rfc4733(改进rfc2833), inband(带内音频), info(信令发送), auto(优先rfc4733次选inband),auto_info(优先rfc4733次选info) | |
| use_ptime | string | no | (RTP) 使用要求的编码打包时长 格式：yes/no | |
| allow | string | ulaw,alaw,g729,g722 | (RTP) 编码优先 格式： 1.多选用逗号分隔有先后顺序 2.默认模型：ulaw, alaw, g729, g722 3.可选模型从voip_get的available_codecs获取 4.页面去掉打包时长模型配置 | 231220 |
| voice_frames_per_tx | int | 2 | 语音帧/TX 格式：可选 1，2，3，4，6 | 231220 |
| rtp_keepalive | int | 0 | (RTP) 媒体保活发送间隔 格式：0-10000 单位s | |
| rtp_timeout | int | 0 | (RTP) 在OFF HOLD的不活跃挂机时间 格式： 0-10000 单位s | |
| rtp_timeout_hold | int | 0 | (RTP) 在ON HOLD的不活跃挂机时间 格式： 0-10000 单位s |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | |
| available_codecs | string | - | 可选codecs模型 示例:ulaw,alaw,g729,g722,g723,g726 | 231220 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/analog_profile/voip_set |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | |
| name | string | 空 | 策略名称 格式：32字符、可空 | |
| echocancel | string | 128 | (ALL) 回音消除长度(单位ms) ，前端实现时，建议只提供打开和关闭选项，no代表关闭，读时非no代表打开，（cli是可以设成：16, 32, 64, 128，no），写时打开传128 | 231013 |
| answeronpolarityswitch | string | no | (ALL) 应答反极(FXO接收/FXS产生) 可选：yes/no | |
| hanguponpolarityswitch | string | no | (ALL) 挂机反极(FXO接收/FXS产生) 可选：yes/no | |
| rxgain | string | -2.5 | (ALL) 收音能量增益 格式：-12.0到12.0 单位dB | 230426 |
| txgain | string | 0.0 | (ALL) 送音能量增益 格式：-12.0到12.0 单位dB | |
| sendcalleridafter | int | 1 | (FXS) 发送主叫号码方式 可选：0(振铃前),1(第一声后),2,3 | |
| mwi_enable | string | no | (FXS) 开启MWI 可选：yes/no 注意：如未设置callerid_num则等同于no | 231124 |
| mwitype_number | string | fsk | (FXS) 本机号码显示方式 可选：fsk(FSK显示) nofsk(关闭) rpas(FSK先发送脉冲再显示) | 230518 |
| mwitype_led | string | no | (FXS) MWI点亮留言灯方式 可选：no(关闭) lrev(极性反转) hvdc(90V挂机直流电) hvac(90V挂机交流电) | 230518 |
| tx_mwi_sub_enable | string | no | (FXS) 开启MWI订阅 可选：yes/no | 231124 |
| tx_mwi_sub_expiry | int | 3600 | (FXS) MWI订阅超时时间 格式：10-2147483647 | 231124 |
Server→Client Response
Client→Server Request
| KEY | VAL | Default | Remark |
|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/analog_profile/port_set |
· 注意：本接口仅限使用在FXS中用于进行收号处理
· 注意：本接口为AGI静态功能，设置后需有生效需求
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | |
| name | string | 空 | 策略名称 格式：32字符、可空 | |
| priority | int | 0 | 数图模型 格式：0本地优先 1远端数图(远端模式热键失效) | 220726 |
| match_fail | int | 0 | 不完整匹配送号 格式：0关闭 1开启 | |
| sharp_asdial | int | 1 | #键作为发送 格式：0否 1是 | 221216 |
| rules | array | - | (数图规则) 格式：[{RSKV}..]，参考"RSKV"，空数组表示清空 数量限制sys_info/oem的maxdigitmaprule | |
| key_sayip | string | *02 | (SYSKEY) 播报wan IP地址 格式：星号+XX 长度3位 | 231204 |
| key_saylanip | string | *03 | (SYSKEY) 播报lan IP地址 格式：星号+XX 长度3位 | 231204 |
| key_saymgtip | string | *04 | (SYSKEY) 播报mgt IP地址 格式：星号+XX 长度3位 | 231212 |
| key_saychid | string | *97 | (SYSKEY) 播报通道号 格式：星号+XX 长度3位 | 230509 |
| key_sayexten | string | *98 | (SYSKEY) 播报号码 格式：星号+XX 长度3位 | 230509 |
| enable_key_dnd | int | 0 | (CALLKEY) 免打扰功能 格式：0(启用) 1(禁用) | 230509 |
| key_dnd_on | string | *78 | (CALLKEY) 免打扰开启 格式：星号+XX 长度3位 | 230509 |
| key_dnd_off | string | *79 | (CALLKEY) 免打扰关闭 格式：星号+XX 长度3位 | 230509 |
| enable_key_ucf | int | 0 | (CALLKEY) 无条件呼转功能 格式：0(启用) 1(禁用) | 230510 |
| key_ucf_on | string | *72 | (CALLKEY) 无条件呼转开启 格式：(星号+XX) 长度3位 拨打格式：热键+号码(不超过16位)+井号(如开启sharp_asdial) | 230510 |
| key_ucf_off | string | *73 | (CALLKEY) 无条件呼转关闭 格式：星号+XX 长度3位 | 230510 |
| enable_key_bcf | int | 0 | (CALLKEY) 遇忙呼转功能 格式：0(启用) 1(禁用) | 230510 |
| key_bcf_on | string | *90 | (CALLKEY) 遇忙呼转开启 格式：星号+XX 长度3位 拨打格式：热键+号码(不超过16位)+井号(如开启sharp_asdial) | 230510 |
| key_bcf_off | string | *91 | (CALLKEY) 遇忙呼转关闭 格式：星号+XX 长度3位 | 230510 |
| enable_key_nacf | int | 0 | (CALLKEY) 无应答呼转功能 格式：0(启用) 1(禁用) | 230510 |
| key_nacf_on | string | *92 | (CALLKEY) 无应答呼转开启 格式：星号+XX 长度3位 拨打格式：热键+号码(不超过16位)+井号(如开启sharp_asdial) | 230510 |
| key_nacf_off | string | *93 | (CALLKEY) 无应答呼转关闭 格式：星号+XX 长度3位 | 230510 |
| RSKV | VAL | Default | Remark |
|---|---|---|---|
| rule | string | - | 路由规则 格式：长度1-33 1."." 只能出现一次，只能在结尾 2."#" 只能在开始或结束 3."" 不受限制 4."[]" 不能为空[] 5."[]" 中只允许X-X,Digit,,#* |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/analog_profile/digitmap_set说明 |
· 注意：本接口设置后需有生效需求
· 注意：本策略仅能与FXO口协同工作, 匹配条件之间是"与"的关系, 匹配条件是有先后顺序的
· 注意：类似iptables的设计，一旦match则结束匹配不再处理后续匹配
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | 221207 |
| name | string | 空 | 策略名称 格式：32字符、可空 | 221207 |
| match_fail | int | 0 | (AGI静态) 匹配失败处理 格式：1直接失败 0直接呼叫 | 221207 |
| ip2tel | array | - | (AGI静态) IP到端口 格式：[{I2TKV}..]，参考"I2TKV"，空数组表示清空 先后有优先顺序，数量限制sys_info/oem的maxcallrouterule | 221207 |
| tel2ip | array | - | (AGI静态) 端口到IP 格式：[{T2IKV}..]，参考"T2IKV"，空数组表示清空 先后有优先顺序，数量限制sys_info/oem的maxcallrouterule | 221207 |
| IP****到端口 I2TKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| src | string | 空 | 呼叫源设备 格式：空(忽略)/其他(内容)，长度0-33 | 221215 |
| match_callerprefix | string | 空 | 主叫前缀匹配 格式：空(忽略)/any(任意)/其他(内容)，长度0-33 | |
| match_calleeprefix | string | 空 | 被叫前缀匹配 格式：空(忽略)/any(任意)/其他(内容)，长度0-33 | |
| target | int | 0 | 路由动作 格式：0拒绝 1许可 | |
| replace_callerdel_prefix | int | 0 | 主叫 前缀删除 格式：0-128 | |
| replace_callerdel_suffix | int | 0 | 主叫 后缀删除 格式：0-128 | |
| replace_calleradd_prefix | string | 空 | 主叫 前缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| replace_calleradd_suffix | string | 空 | 主叫 后缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| replace_calleedel_prefix | int | 0 | 被叫 前缀删除 格式：0-64 | |
| replace_calleedel_suffix | int | 0 | 被叫 后缀删除 格式：0-64 | |
| replace_calleeadd_prefix | string | 空 | 被叫 前缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| replace_calleeadd_suffix | string | 空 | 被叫 后缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| dest | string | 空 | 呼叫目的设备 格式：空(自动)/端口号/端口分组号，长度0-33 注意：可任意设置或通过查询analog_port/port_get获取号 注意：如果不设置则以默认设置为准 | 231229 |
| 端口到IP T2IKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| src | string | 空 | 呼叫源设备 格式：空(忽略)/其他(内容)，长度0-33 | 221215 |
| match_callerprefix | string | 空 | 主叫前缀匹配 格式：空(忽略)/any(任意)/其他(内容)，长度0-33 | |
| match_calleeprefix | string | 空 | 被叫前缀匹配 格式：空(忽略)/any(任意)/其他(内容)，长度0-33 | |
| target | int | 0 | 路由动作 格式：0拒绝 1许可 | |
| replace_callerdel_prefix | int | 0 | 主叫 前缀删除 格式：0-128 | |
| replace_callerdel_suffix | int | 0 | 主叫 后缀删除 格式：0-128 | |
| replace_calleradd_prefix | string | 空 | 主叫 前缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| replace_calleradd_suffix | string | 空 | 主叫 后缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| replace_calleedel_prefix | int | 0 | 被叫 前缀删除 格式：0-64 | |
| replace_calleedel_suffix | int | 0 | 被叫 后缀删除 格式：0-64 | |
| replace_calleeadd_prefix | string | 空 | 被叫 前缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| replace_calleeadd_suffix | string | 空 | 被叫 后缀增加 格式：空(忽略)/其他(内容)，长度0-33 | |
| dest | string | 空 | 呼叫目的设备 格式：空(自动)/端口号/端口分组号，长度0-33 注意：可任意设置或通过查询analog_port/port_get获取号 注意：如果不设置则以默认设置为准 | 231229 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/analog_profile/callroute_set说明 |
· 注意：槽位可用数量，参考sys_info/oem的说明。
· 注意：策略限制数量，参考sys_info/oem说明。
· 注意：仅在当前interface为digital时本类接口才可调用，参考sys_info/oem说明。
· 注意：BRI, PRI, MFCR2的group是共享的
· SS7包含：SS7LINK SS7LINKSET
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| driver_custom | string | N | 空 | (ALL) 驱动扩展参数 格式：不超过64字符、可空 | 240131 |
| default_linemode | string | N | e1 | (extraface=t1e1有效) 数字中继接口类型 格式：e1,t1,j1 | 240131 |
| loadzone | string | N | cn | (ALL) 线路音频区域码 可选：us, au, fr, nl, uk, fi, es, jp, no, at, nz, it, us-old, gr, tw, cl, se, be, sg, il, br, hu, lt, pl, za, pt, ee, mx, in, de, ch, dk, cz, cn, ar, my, th, bg, ve, ph, ru, tr, pa, mo, cr, ae | 240131 |
| language | string | N | cn | (ALL) 音频区域码 可选：at, au, bg, br, be, ch, cl, cn, cz, de, dk, ee, es, fi, fr, gr, hu, id, il, in, it, lt, jp, mx, my, nl, no, nz, ph, pl, pt, ru, se, sg, th, uk, us, us-old, tw, ve, za | 240131 |
| priindication | string | N | outofband | (BRI/PRI) 产生BUSY和CONGESTION通知的方式 格式： inband(不应答播放音调, 对端不一定支持) outofband(发送拆线信息，对端播放音调) | 240131 |
| jbenable | string | N | no | (ALL) 抖动缓冲开启 可选：yes/no | 240131 |
| jbmaxsize | int | N | 200 | (ALL) 抖动最大缓冲 可选：10-10000 单位ms | 240131 |
| jbresyncthreshold | int | N | 1000 | (ALL) 抖动重新同步时跳转帧时间戳 可选：10-10000 单位ms | 240131 |
| jbimpl | string | N | fixed | (ALL) 抖动缓冲方式 可选：fixed(静态缓冲，只用jbmaxsize), adaptive(可变缓冲) | 240131 |
| jbtargetextra | int | N | 40 | (ALL) 抖动可变新缓冲大小(仅在adaptive有效)，用于突发高峰抖动时。 可选：10-10000 单位ms | 240131 |
| dtmf_to_total_energy | int | N | 42 | (ALL) DTMF总能量比例系数 可选：10-100 | 240131 |
| dtmf_gsize | int | N | 120 | (ALL) DTMF每检测区段采样点数 可选：80-160 | 240131 |
| dtmf_threshold | int | N | 80000000 | (ALL) DTMF能量阈值 可选：80000000-240000000 | 240131 |
| MFCR2配置(TODO 注意会导致接口板磁盘撑满，暂不要实现) | 240131 | ||||
| mfcr2_call_files | string | N | no | (MFCR2) MFCR2是否存日志 格式：yes，no | 240131 |
| mfcr2_logging | string | N | nothing | (MFCR2) MFCR2日志级别 格式：all error warning debug notice cas mf stack nothing | 240131 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/digital/tel_set说明 |
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| user_agent | string | N | OIAD | SIP协议中user-agent字符串 长度：1-64 注意：当UCI的user_agent_force不为空时本参数不可修改 | 240228 |
| quick_dnssrv_switch | string | N | no | 快速DNSSRV切换 格式: yes(是) no(否) | 240418 |
| timer_t1 | int | N | 500 | 传输时间T1值 格式：(毫秒) 100-10000000 | 240131 |
| timer_t2 | int | N | 4000 | 传输时间T2值 格式：(毫秒) 800-10000000 | 240131 |
| allow_tx_hash_in_uri | string | N | no | 不转义"#"号 格式: yes(是) no(否) | 240131 |
| timers | string | N | yes | Session Timer(RFC4028)支持方式 格式：yes/no/always/required | 240131 |
| timers_min_se | int | N | 90 | Session刷新最小间隔 格式：(毫秒) 90-10000000 | 240131 |
| timers_sess_expires | int | N | 1800 | Session刷新最大间隔(必须大于等于最小值) 格式：(毫秒) 90-10000000 | 240131 |
| g723_rate | string | N | 63 | G723速率 可选: 63(6.3kbps编码速率) 53(5.3kbps编码速率) 如果设备不支持G723编解码，无此字段 | 240223 |
| ilbc_mode | string | N | 30 | iLBC帧时长 可选: 20(20ms) 30(30ms) 如果设备不支持iLBC编解码，无此字段 | 240223 |
| in_ringtime | int | N | 55 | (dialplan) 呼入等待超时 可选：10-1000 单位s | 240131 |
| out_ringtime | int | N | 55 | (dialplan) 呼出等待超时 可选：10-1000 单位s | 240131 |
| sip_cid2 | int | N | 0 | (dialplan) 主叫号码显示优先：0(FROM), 1(P-Asserted-Identity) | 240131 |
| calltimeout | int | N | 43200000 | 呼叫最大限时 格式：0-99999999 单位ms 0表示不限 | 240131 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| user_agent | 注意：当UCI的user_agent_force不为空时本参数值为空 | 240228 | ||
| 参考/digital/voip_set |
· 注意：读取到的端口配置数据为最大支持的数据
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230310 |
| type | string | span | 类型 格式：span bri pri mfcr2 all | 230515 |
| enable | string | 空 | 过滤数为enable 格式：yes/no/空 | 230515 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | 槽号 格式：不可空，注意限制，无效报错 | 230310 | |
| span | array | 格式：[{KV}..]，参考digital_span/span_set说明 | 230314 | |
| bri | array | 格式：[{KV}..]，参考digital_span/bri_set说明 | 230310 | |
| pri | array | 格式：[{KV}..]，参考digital_span/pri_set说明 | 230310 | |
| mfcr2 | array | 格式：[{KV}..]，参考digital_span/mfcr2_set说明 | 230321 |
· 线缆距离可填值:
0: 0 db (CSU) / 0-133 feet (DSX-1) 1: 133-266 feet (DSX-1) 2: 266-399 feet (DSX-1) 3: 399-533 feet (DSX-1) 4: 533-655 feet (DSX-1) 5: -7.5db (CSU) 6: -15db (CSU) 7: -22.5db (CSU)
Client→Server Request
| KEY | VAL | REQ | Default | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 230307 |
| span | int | Y | - | 接口号 格式：不可空，注意限制，无效报错 | 230307 |
| timing | string | N | remote | 时钟源 格式： local(本地)，remote(远端) | 230307 |
| pcm_encoding | string | N | 空 | PCM编码 格式：空(默认) alaw mulaw 注意：MFCR2强制alaw | 230315 |
| hardhdlc | int | N | 0 | 是否启用HDLC编码和解码 格式： 0(不启用) 1(启用) | 240612 |
| bri_framing | string | N | ccs | (BRI) 成帧 格式：ccs | 230307 |
| bri_coding | string | N | ami | (BRI) 线路编码 格式：ami | 230307 |
| bri_dchan | int | N | 3 | (BRI) D信道 格式：1-3 | 230308 |
| t1e1_lbo | int | N | 0 | (T1/E1/J1) 线缆距离 格式：0 1 2 3 4 5 6 7，线缆距离可填值(参考表说明) | 240612 |
| t1e1_framing | string | N | ccs | (T1/E1/J1) 成帧 格式：cas(E1) ccs(E1) d4(T1) esf(T1) 注意：MFCR2强制cas | 230315 |
| t1e1_coding | string | N | hdb3 | (T1/E1/J1) 线路编码 格式：ami(E1/T1) hdb3(E1) b8zs(T1) | 230307 |
| t1e1_crc4 | string | N | no | (E1) CRC4效验 格式：yes(仅限E1) no | 230307 |
| t1e1_type | string | N | pri | (T1/E1/J1) 信令模型 格式：pri ss7 mfcr2 注意：(数字接口为E1)时才能设置mfcr2 | 230307 |
| t1e1_dchan | int | N | 16 | (T1/E1/J1) D信道 PRI格式：1-31(E1) 1-24(T1) MFCR2格式：强制16 SS7格式：强制0 | 230315 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| span | int | - | 接口号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考/digital_span/span_set说明 |
· 可以生效条件：该SPAN没有使用过
· 可以生效条件：硬件SPAN存在
· 可以生效条件：span的type类型为digital-NT, digital-TE
· DIGITAL的交换类型:
a. national(National ISDN 2) b. ni1(National ISDN 1) c. dms100(Nortel DMS100) d. 4ess(AT&T 4ESS) e. 5ess(Lucent 5ESS) f. euroisdn(EuroISDN) g. qsig(Q.SIG)
· 对端拨号方案：
a. from_channel(使用CONNECTEDLINE(ton)值) b. unknown c. private d. local e. national f. international
· 发送/接收ISDN显示IE选项:
a. block(不传输显示文本数据) b. name_initial(使用显示文本设置/连接消息作为组名) c. name_update(在其他消息显示文本通知/设施使用为COLP更新名称) d. name(组合初始名称和更新后名称选项) e. text(在呼叫期间通过任一不使用文本数据作为任意显示信息)
Client→Server Request
| KEY | VAL | REQ | Default | Remark | renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240606 |
| span | int | Y | - | 接口号 格式：不可空，注意限制，无效报错 | 240606 |
| enable | string | N | no | 启用 格式：yes/no | 240606 |
| 主要用于dahdi_channels | |||||
| nsf | string | N | none | ATT运营商网络特殊参数 格式：none sdn megacom tollfreemegacom accunet | 240606 |
| switchtype | string | N | euroisdn | DIGITAL的交换类型 格式： DIGITAL的交换类型(参考表说明) | 240606 |
| service_message_support | string | N | yes | 开启消息服务支持 格式：yes/no | 240606 |
| facilityenable | string | N | no | 开启ISDN补充服务选项(例如CPE模式从facility获取caller name) 格式：yes/no | 240606 |
| hold_disconnect_transfer | string | N | no | (PTMP-NT) 允许hold呼叫断线时变活跃 格式：yes/no | 230321 |
| layer1_presence | string | N | ignore | (PTMP) Layer1模式线路idle时down 格式：required ignore | 230321 |
| layer2_persistence | string | N | 空 | (PTMP) Layer2模式线路idle时down 格式：空(默认) keep_up leave_down | 230321 |
| signalling | string | N | bri_cpe | 信令类型 格式：bri_cpe bri_net bri_cpe_ptmp bri_net_ptmp | 230321 |
| pridialplan | string | N | unknown | 拨号方案 格式：unknown private local national international | 240606 |
| prilocaldialplan | string | N | unknown | 本地拨号方案(RARELY) 格式：同上 | 240606 |
| pricpndialplan | string | N | from_channel | 对端拨号方案 格式：对端拨号方案(参考表说明) | 240606 |
| internationalprefix | string | N | 空 | 号码前缀 国际 格式：长度0-16 | 240606 |
| nationalprefix | string | N | 空 | 号码前缀 国家 格式：长度0-16 | 240606 |
| localprefix | string | N | 空 | 号码前缀 本地 格式：长度0-16 | 240606 |
| privateprefix | string | N | 空 | 号码前缀 隐私 格式：长度0-16 | 240606 |
| unknownprefix | string | N | 空 | 号码前缀 未知 格式：长度0-16 | 240606 |
| resetinterval | string | N | never | 未使用B信道重启周期 格式：长度0-32(单位s) never(不开启) 注意：很多不支持，例如以色列Bezeq/UK/China | 240606 |
| inband_on_setup_ack | string | N | no | 在SETUP ACK时接收带内音频 (Q.SIG如果启用了overlap必须打开) 格式：yes/no | 240606 |
| inband_on_proceeding | string | N | no | 在PROCEEDING时接收带内音频 格式：yes/no | 240606 |
| overlapdial | string | N | no | 叠纵拨号 格式：incoming outgoing no yes | 240606 |
| mcid_send | string | N | no | 在SPAN上发送ISDN Malicious Caller ID请求 格式：yes no | 240606 |
| force_restart_unavailable_chans | string | N | no | 自动重启不可用信道 格式：yes no | 240606 |
| hidecallerid | string | N | no | 隐藏主叫号码 格式：yes no | 240606 |
| hidecalleridname | string | N | no | 隐藏主叫名称 格式：yes no | 240606 |
| echocancel | string | N | no | 回音消除长度(单位ms) 可选：16, 32, 64, 128, no | 240606 |
| rxgain | string | N | 0.0 | 收音能量增益 格式：-12.0到12.0 单位dB | 240606 |
| txgain | string | N | 0.0 | 送音能量增益 格式：-12.0到12.0 单位dB | 240606 |
| group | string | N | 4 | 绑定分组(PRI/MFCR2/BRI共享) 格式：内容为4-63 | 240606 |
| display_send | string | N | text | 发送显示 格式：发送/接收ISDN显示IE选项(参考表说明) 注意：only NET侧支持、cpe和Q.SIG不支持 | 240606 |
| display_receive | string | N | text | 接收显示 格式：发送/接收ISDN显示IE选项(参考表说明) 注意：only NET侧支持、cpe和Q.SIG不支持 | 240606 |
| colp_send | string | N | update | 发送connect的时候是否发送 connect number 信息 格式：block connect update | 240606 |
| priindication | string | N | inband | PRI繁忙和拥塞提示方式 格式：inband outofband | 240606 |
| qsigchannelmapping | string | N | physical | Q.SIG通道映射方式 格式：physical(物理) logical(逻辑) 注意：T1强制physical | 240606 |
| cc_qsig_signaling_link_req | string | N | retain | Q.SIG呼叫方信令链路 格式：retain release do_not_care | 240611 |
| cc_qsig_signaling_link_rsp | string | N | retain | Q.SIG响应方信令链路 格式：retain release | 240611 |
| datetime_send | string | N | no | NET侧给CPE侧发送datetime 格式：no date date_hh date_hhmm date_hhmmss 注意：only NET侧支持 | 240606 |
| 主要用于AGI | |||||
| callroute_profile | int | N | 0 | (AGI) 绑定呼叫路由策略 格式：策略号，不可空 | 240606 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| span | int | - | 接口号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| bri_tpl | string | 模板 | 230321 | |
| 参考/digital_span/bri_set说明 |
· 可以生效条件：该SPAN没有使用过
· 可以生效条件：硬件SPAN存在
· 可以生效条件：span的type类型为digital-T1,digital-J1,digital-E1
· 可以生效条件：t1e1_type为pri
· DIGITAL的交换类型:
a. national(National ISDN 2) b. ni1(National ISDN 1) c. dms100(Nortel DMS100) d. 4ess(AT&T 4ESS) e. 5ess(Lucent 5ESS) f. euroisdn(EuroISDN) g. qsig(Q.SIG)
· 对端拨号方案：
a. from_channel(使用CONNECTEDLINE(ton)值) b. unknown c. private d. local e. national f. international
· 发送/接收ISDN显示IE选项:
a. block(不传输显示文本数据) b. name_initial(使用显示文本设置/连接消息作为组名) c. name_update(在其他消息显示文本通知/设施使用为COLP更新名称) d. name(组合初始名称和更新后名称选项) e. text(在呼叫期间通过任一不使用文本数据作为任意显示信息)
Client→Server Request
| KEY | VAL | REQ | Default | Remark | renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240606 |
| span | int | Y | - | 接口号 格式：不可空，注意限制，无效报错 | 240606 |
| enable | string | N | no | 启用 格式：yes/no | 240606 |
| 主要用于dahdi_channels | |||||
| nsf | string | N | none | ATT运营商网络特殊参数 格式：none sdn megacom tollfreemegacom accunet | 240606 |
| switchtype | string | N | euroisdn | DIGITAL的交换类型 格式： DIGITAL的交换类型(参考表说明) | 240606 |
| service_message_support | string | N | yes | 开启消息服务支持 格式：yes/no | 240606 |
| facilityenable | string | N | no | 开启ISDN补充服务选项(例如CPE模式从facility获取caller name) 格式：yes/no | 240606 |
| signalling | string | N | pri_cpe | 信令类型 格式：pri_cpe pri_net | 230321 |
| pridialplan | string | N | unknown | 拨号方案 格式：unknown private local national international | 240606 |
| prilocaldialplan | string | N | unknown | 本地拨号方案(RARELY) 格式：同上 | 240606 |
| pricpndialplan | string | N | from_channel | 对端拨号方案 格式：对端拨号方案(参考表说明) | 240606 |
| internationalprefix | string | N | 空 | 号码前缀 国际 格式：长度0-16 | 240606 |
| nationalprefix | string | N | 空 | 号码前缀 国家 格式：长度0-16 | 240606 |
| localprefix | string | N | 空 | 号码前缀 本地 格式：长度0-16 | 240606 |
| privateprefix | string | N | 空 | 号码前缀 隐私 格式：长度0-16 | 240606 |
| unknownprefix | string | N | 空 | 号码前缀 未知 格式：长度0-16 | 240606 |
| resetinterval | string | N | never | 未使用B信道重启周期 格式：长度0-32(单位s) never(不开启) 注意：很多不支持，例如以色列Bezeq/UK/China | 240606 |
| inband_on_setup_ack | string | N | no | 在SETUP ACK时接收带内音频 (Q.SIG如果启用了overlap必须打开) 格式：yes/no | 240606 |
| inband_on_proceeding | string | N | no | 在PROCEEDING时接收带内音频 格式：yes/no | 240606 |
| overlapdial | string | N | no | 叠纵拨号 格式：incoming outgoing no yes | 240606 |
| mcid_send | string | N | no | 在SPAN上发送ISDN Malicious Caller ID请求 格式：yes no | 240606 |
| force_restart_unavailable_chans | string | N | no | 自动重启不可用信道 格式：yes no | 240606 |
| hidecallerid | string | N | no | 隐藏主叫号码 格式：yes no | 240606 |
| hidecalleridname | string | N | no | 隐藏主叫名称 格式：yes no | 240606 |
| echocancel | string | N | no | 回音消除长度(单位ms) 可选：16, 32, 64, 128, no | 240606 |
| rxgain | string | N | 0.0 | 收音能量增益 格式：-12.0到12.0 单位dB | 240606 |
| txgain | string | N | 0.0 | 送音能量增益 格式：-12.0到12.0 单位dB | 240606 |
| group | string | N | 4 | 绑定分组(PRI/MFCR2/BRI共享) 格式：内容为4-63 | 240606 |
| display_send | string | N | text | 发送显示 格式：发送/接收ISDN显示IE选项(参考表说明) 注意：only NET侧支持、cpe和Q.SIG不支持 | 240606 |
| display_receive | string | N | text | 接收显示 格式：发送/接收ISDN显示IE选项(参考表说明) 注意：only NET侧支持、cpe和Q.SIG不支持 | 240606 |
| colp_send | string | N | update | 发送connect的时候是否发送 connect number 信息 格式：block connect update | 240606 |
| priindication | string | N | inband | PRI繁忙和拥塞提示方式 格式：inband outofband | 240606 |
| qsigchannelmapping | string | N | physical | Q.SIG通道映射方式 格式：physical(物理) logical(逻辑) 注意：T1强制physical | 240606 |
| cc_qsig_signaling_link_req | string | N | retain | QSIG 呼叫方在呼叫完成后保留信令链路 格式：retain release do_not_care | 240606 |
| cc_qsig_signaling_link_rsp | string | N | retain | QSIG 响应方在呼叫完成后保留信令 格式：retain release | 240606 |
| datetime_send | string | N | no | NET侧给CPE侧发送datetime 格式：no date date_hh date_hhmm date_hhmmss 注意：only NET侧支持 | 240606 |
| 主要用于AGI | |||||
| callroute_profile | int | N | 0 | (AGI) 绑定呼叫路由策略 格式：策略号，不可空 | 240606 |
Server→Client Response
Client→Server Request
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| span | int | - | 接口号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| pri_tpl | string | 模板 | 230321 | |
| 参考/digital_span/pri_set说明 |
· 可以生效条件：该SPAN没有使用过
· 可以生效条件：硬件SPAN存在
· 可以生效条件：span的type类型为digital-T1,digital-J1,digital-E1
· 可以生效条件：t1e1_type为mfcr2
Client→Server Request
| KEY | VAL | Default | Remark | renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230321 |
| span | int | - | 接口号 格式：不可空，注意限制，无效报错 | 230321 |
| enable | string | no | 启用 格式：yes/no | 230321 |
| 主要用于dahdi_channels | ||||
| group | string | 4 | 绑定分组(PRI/MFCR2/BRI共享) 格式：内容为4-63 | 230321 |
| mfcr2_variant | string | cn | 随路信令遵循的国际规范 格式：ar br cn cz co ec id itu mx ph ve | 230321 |
| mfcr2_get_ani_first | string | no | 在获得 DNIS 之前获得 ANI(一些电信公司要求) 格式：yes no | 230321 |
| mfcr2_max_ani | int | 10 | 请求的最大 ANI 位数 格式：0-64 | 230321 |
| mfcr2_max_dnis | int | 6 | 请求的最大 DNIS 位数 格式：0-64 | 230321 |
| mfcr2_category | string | n_s... | 呼入订阅类别 格式：(默认)national_subscriber national_priority_subscriber international_subscriber international_priority_subscriber | 230321 |
| mfcr2_mfback_timeout | int | -1 | MF超时 单位(ms) 格式：-1(默认) 不建议小于500 范围-1到10000 | 230321 |
| mfcr2_metering_pulse_timeout | int | -1 | 脉冲超时 单位(ms) 格式：-1(默认) 不建议小于500 范围-1到10000 | 230321 |
| mfcr2_skip_category | string | no | 跳过请求主叫类别和ANI 格式：yes no | 230321 |
| mfcr2_double_answer | string | no | 支持double answer 格式：yes no | 230321 |
| echocancel | string | no | 回音消除长度(单位ms) 可选：16, 32, 64, 128, no | 230613 |
| rxgain | string | 0.0 | 收音能量增益 格式：-12.0到12.0 单位dB | 230321 |
| txgain | string | 0.0 | 送音能量增益 格式：-12.0到12.0 单位dB | 230321 |
| 主要用于AGI | ||||
| callroute_profile | int | 0 | (AGI) 绑定呼叫路由策略 格式：策略号，不可空 | 230321 |
Server→Client Response
Client→Server Request
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| span | int | - | 接口号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| mfcr2_tpl | string | 模板 | 230321 | |
| 参考/digital_span/mfcr2_set说明 | 230321 |
· 注意：读取到的端口配置数据为最大支持的数据
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230320 |
| type | string | linkset | 类型 格式：linkset link all | 230515 |
| enable | string | 空 | 过滤数为enable 格式：yes/no/空 | 230515 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | 槽号 格式：不可空，注意限制，无效报错 | 230320 | |
| linkset | array | 格式：[{KV}..]，参考digital_ss7/linkset_set说明 | 230320 | |
| link | array | 格式：[{KV}..]，参考digital_ss7/link_set说明 | 230320 |
· LINKSET的编号从1开始，可用总数量与sys_info/interface中的maxspans一样
· LINKSET不用设置enable是否，只有当被link关联并且link生效的时候才会自动enable
Client→Server Request
| KEY | VAL | Default | Remark | renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230313 |
| linkset | int | - | LINKSET编号 格式：不可空，注意限制，无效报错 | 230313 |
| 主要用于ss7_linkset | ||||
| enable_st | string | no | 启用end-of-pulsing(如接收地址完整不需启动) 格式：yes no | 230313 |
| use_connect | string | no | 使用CON回复来电 格式：yes(CON) no(ACM/ANM) | 230313 |
| hunting_policy | string | even_mru | CIC搜索原则 格式：even_mru(最近偶数编号) odd_lru seq_lth seq_htl | 230313 |
| subservice | string | auto | 子服务 格式：national international auto 或dec/hex值，auto表示从第一个接收到的SLTM获取 长度1-16 | 230313 |
| variant | string | itu | 点码位数变体 格式：itu(14位) china(24位) | 230313 |
| opc | string | 0x6 | 源点码值 格式：DEC/HEX值 长度1-32 | 230315 |
| dpc | string | 0x5 | 目的点码值 格式：DEC/HEX值 长度1-32 | 230315 |
| 主要用于AGI | ||||
| callroute_profile | int | 0 | (AGI) 绑定呼叫路由策略 格式：策略号，不可空 | 230313 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| linkset | int | - | LINKSET编号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| linkset_tpl | string | - | 模板类型：iadss7 | 230315 |
| 参考/digital_ss7/linkset_set说明 |
· 可以生效条件：该SPAN没有使用过
· 可以生效条件：硬件SPAN存在
· 可以生效条件：span的type类型为digital-T1,digital-J1,digital-E1
· 可以生效条件：t1e1_type为ss7
· SPAN的编号从1开始，可用总数量与sys_info/interface中的maxspans一样
Client→Server Request
| KEY | VAL | Default | Remark | renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230315 |
| span | int | - | 接口号 格式：不可空，注意限制，无效报错 | 230315 |
| enable | string | no | 启用 格式：yes/no | 230315 |
| 主要用于ss7_link ss7_host | ||||
| linkset | int | 1 | 绑定LINKSET编号 格式：LINKSET编号 | 230315 |
| schannel | int | 16 | 信令信道 格式：0(表示无) 范围1-31(E1) 1-24(T1/J1) | 230315 |
| channels | string | auto | 音频信道 格式：auto(自动) 空(表示无) 自定义(长度0-32) auto：自动生成 空：无channels 自定义：范围1-31(E1) 1-24(T1) 例如：1-15,17-31 | 230316 |
| firstcic | string | auto | CIC起始位 格式：auto(自动) 自定义(长度0-6) 备注：相同linkset下(e1)一口为1，二口33等 | 230316 |
| echocancel | string | no | 回声消除开关 格式：no 31speech(传输中间值3.1khz) allways | 230315 |
| echocan_train | int | 300 | 回声训练周期 格式：范围10-1000 单位msec | 230315 |
| echocan_taps | string | 128 | 回音消除TAPS(ms=taps/8) 格式：32 64 128 256 | 230315 |
| rx_gain | string | 0.0 | 收音能量增益 格式：-12.0到12.0 单位dB | 230315 |
| tx_gain | string | 0.0 | 送音能量增益 格式：-12.0到12.0 单位dB | 230315 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| span | int | - | 接口号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| link_tpl | string | - | 模板类型：iadss7 | 230315 |
| 参考/digital_ss7/link_set说明 |
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230309 |
| type | string | trunk | 类型 格式：trunk all | 230309 |
| enable | string | 空 | 过滤数为enable 格式：yes/no/空 | 230515 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | 槽号 格式：不可空，注意限制，无效报错 | 230309 | |
| trunk | array | TRUNK表 格式：[{VTKV}..]，参考"VTKV" | 230309 |
| VTKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考digital_trunk/trunk_get说明 | 230309 |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230309 |
| sipid | string | - | 字符串SIP号 格式：SIP编号(trunk)编号 | 230309 |
| cmd_register | int | 0 | 对应SIP注册动作 格式：0 无动作, 1 注册, 2 注销 | 230309 |
Server→Client Response
Client→Server Request
| KEY | VAL | Default | Remark | renew |
|---|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 | 230309 |
| trunk | int | - | 中继编号 格式：不可空，注意限制，无效报错 | 230309 |
| enable | string | no | 启用 格式：yes/no | 230309 |
| 主要用于pjsip_accounts 账户 | ||||
| callerid_num | string | 空 | (SIP) 账户名 格式：32位长度 | 230309 |
| from_user | string | 空 | (SIP) FROM强制账户 格式：32位长度，空(不强制) | 230309 |
| auth_username | string | 空 | (SIP) 认证账户 格式：64位长度，空 | 230309 |
| auth_password | string | 空 | (SIP) 认证密码 格式：64位长度，空 | 230309 |
| register | string | yes | (SIP) 启用注册 格式：yes/no | 230309 |
| identify | string | 空 | (SIP) IP直送表 格式：地址[:0-65535] 注意：逗号分隔，最大8条 | 230309 |
| sip_server_profile | int | 0 | (SIP) 绑定服务策略 格式：策略号，不可空 | 230309 |
| voip_profile | int | 0 | (SIP) 绑定VOIP策略 格式：策略号，不可空 | 230309 |
| 主要用于AGI | ||||
| callroute_profile | int | 0 | (AGI) 绑定呼叫路由策略 格式：策略号，不可空 | 230309 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| slotnum | int | - | 槽号 格式：不可空，注意限制，无效报错 |
| trunk | int | - | 中继编号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| sip_listen_port | int | - | (SIP) SIP信令端口 | 230309 |
| sip_tpl | string | - | 模板类型：iadtrunk | 230309 |
| 参考/digital_voip/trunk_set说明 |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | 230309 |
| name | string | 空 | 策略名称 格式：32字符、可空 | 230309 |
| media_encryption | string | no | (RTP) 媒体开启SRTP 格式：sdes、no | 230309 |
| media_encryption_optimistic | string | no | (RTP) 媒体强制SRTP 格式：yes/no(自动) | 230309 |
| registration_expiration | int | 3600 | (SIP) 注册有效期时间 格式：10-10000 单位s | 230309 |
| registration_retry_interval | int | 30 | (SIP) 注册重试间隔 格式：0-2147483647 单位s | 240105 |
| registration_max_retries | int | 2147483647 | (SIP) 注册重试次数 格式：0-2147483647 | 240105 |
| auth_realm | string | * | (SIP) 认证域 格式：*(对端为准)，其他，长度1-64 | 230309 |
| aor_qualify_frequency | int | 0 | (SIP) 信令发送心跳时间 格式：0-10000 单位s | 230309 |
| aor_qualify_timeout | int | 60 | (SIP) 信令心跳超时间隔 格式：1-10000 单位s | 230309 |
| aor_authenticate_qualify | string | no | (SIP) qualify验证 格式：yes/no | 230309 |
| sip_port_mode | string | udp | (SIP) 信令端口类型 格式：udp/tcp/tls | 230309 |
| primary_ipaddr | string | 空 | (SIP) 主服务器地址 格式：(域名和IP地址标准)63字符、可空 | 230309 |
| primary_sip_port | int | 5060 | (SIP) 主服务器信令端口 格式：100-65535 | 230309 |
| second_ipaddr | string | 空 | (SIP) 备服务器地址 格式：(域名和IP地址标准)63字符、可空 primary为空时second自动强制为空 | 230309 |
| second_sip_port | int | 5060 | (SIP) 备服务器信令端口 格式：100-65535 | 230309 |
| from_domain | string | 空 | (SIP) 使用指定URI作为From Header的域 长度：0-64 | 230605 |
| external_boundle | string | 空 | (SIP) 业务绑定接口(基本,逻辑,虚拟) 格式：wan lan vpn1 alias1 alias2 空值 | 240202 |
| dns_mode | string | 空 | (SIP) DNS模式 格式：空(自动识别A Record还是IP) srv(dnssrv模式) | 230309 |
| outbound_proxy | string | 空 | (SIP) 呼出代理服务器 格式：(address):(port) address为地址或域名 port为端口 长度0-63 空表示无 | 230427 |
| ice_support | string | no | (SIP) 该服务器启用STUN 格式：yes/no 备注：需配置stun地址及开启本参数才有效 | 230504 |
| method | string | 空 | (SIP) TLS版本 格式：空(tlsv1) tlsv1 tlsv1_1 tlsv1_2 sslv2 sslv3 ssv23 | 230508 |
| tls_uri | int | 0 | (SIP) TLS的URI模式 格式：0(SIP) 1(SIPS) | 230508 |
| tls_pem | int | -1 | (SIP) TLS的设备证书PEM选择 格式：-1(无) 0(缺省) 1 2 3 4 | 230508 |
| tls_calist | int | -1 | (SIP) TLS的CA证书链选择 格式：-1(关闭) 0(启用) | 230508 |
| verify_server | string | no | (SIP) TLS的UAC行为验证对端证书有效性 格式：yes/no | 230508 |
| require_client_cert | string | no | (SIP) TLS的UAS行为验证对端证书有效性 格式：yes/no | 230508 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/digital_profile/sip_server_get说明 |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | 230309 |
| name | string | 空 | 策略名称 格式：32字符、可空 | 230309 |
| allow_transfer | string | yes | (SIP) 允许REFER 格式：yes/no | 230309 |
| sip_udptl | string | yes | (SIP) 开启UDPTL 格式：yes/no | 230309 |
| sip_udptl_ec | string | redundancy | (SIP) UDPTL纠错 格式：none/fec/redundancy | 230309 |
| dtmf_mode | string | rfc4733 | (RTP) DTMF模式 格式：rfc4733(改进rfc2833), inband(带内音频), info(信令发送), auto(优先rfc4733次选inband),auto_info(优先rfc4733次选info) | 230309 |
| use_ptime | string | no | (RTP) 使用要求的编码打包时长 格式：yes/no | 230309 |
| allow | string | ulaw,alaw,g729,g722 | (RTP) 编码优先 格式： 1.多选用逗号分隔有先后顺序 2.默认模型：ulaw, alaw, g729, g722 3.可选模型从voip_get的available_codecs获取 4.页面去掉打包时长模型配置 | 240506 |
| voice_frames_per_tx | int | 2 | 语音帧/TX 格式：可选 1，2，3，4，6 | 240506 |
| rtp_keepalive | int | 0 | (RTP) 媒体保活发送间隔 格式：0-10000 单位s | 230309 |
| rtp_timeout | int | 0 | (RTP) 在OFF HOLD的不活跃挂机时间 格式： 0-10000 单位s | 230309 |
| rtp_timeout_hold | int | 0 | (RTP) 在ON HOLD的不活跃挂机时间 格式： 0-10000 单位s | 230309 |
Server→Client Response
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | |
| available_codecs | string | - | 可选codecs模型 示例:ulaw,alaw,g729,g722,g723,g726 | 240506 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/digital_profile/voip_set |
· 注意：匹配条件之间是"与"的关系, 匹配条件是有先后顺序的
· 注意：类似iptables的设计，一旦match则结束匹配不再处理后续匹配
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 | 230309 |
| name | string | 空 | 名称 格式：32字符、可空 | 230309 |
| match_tech | string | 空 | (AGI静态) 失败备用线 格式：空(禁止) DAHDI(包含bri/pri/mfcr2) SS7 PJSIP | 230322 |
| match_dest | string | 空 | (AGI静态) 目的设备 格式：空(禁止) 长度0-33 DAHDI信道：(chid)，例如33 DAHDI分组：(g/G/r/R)(group)，例如g4 SS7格式：(linksetid)，例如0 PJSIP格式：(sipid)，例如1 | 230322 |
| rules | array | - | (AGI静态) 路由规则 格式：[{CRRKV}..]，参考"CRRKV" 空数组表示清空 先后有优先顺序，数量限制sys_info/oem的maxcallrouterule | 230322 |
| 路由规则 CRRKV | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| rule_name | string | 空 | 规则名称 格式：32字符、可空 | 240605 |
| src_tech | string | 空 | 呼叫源类型 格式：空(禁止) DAHDI(包含bri/pri/mfcr2) SS7 PJSIP | 240605 |
| src | string | 空 | 呼叫源设备 格式：空(忽略)/其他(内容)，长度0-33 | 230309 |
| match_callerprefix | string | 空 | 主叫前缀匹配 格式：空(忽略)/any(任意)/其他(内容)，长度0-33 | 230309 |
| match_calleeprefix | string | 空 | 被叫前缀匹配 格式：空(忽略)/any(任意)/其他(内容)，长度0-33 | 230309 |
| target | int | 0 | 路由动作 格式：0拒绝 1许可 | 230309 |
| replace_callerdel_prefix | int | 0 | 主叫 前缀删除 格式：0-128 | 230309 |
| replace_callerdel_suffix | int | 0 | 主叫 后缀删除 格式：0-128 | 230309 |
| replace_calleradd_prefix | string | 空 | 主叫 前缀增加 格式：空(忽略)/其他(内容)，长度0-33 | 230309 |
| replace_calleradd_suffix | string | 空 | 主叫 后缀增加 格式：空(忽略)/其他(内容)，长度0-33 | 230309 |
| replace_calleedel_prefix | int | 0 | 被叫 前缀删除 格式：0-64 | 230309 |
| replace_calleedel_suffix | int | 0 | 被叫 后缀删除 格式：0-64 | 230309 |
| replace_calleeadd_prefix | string | 空 | 被叫 前缀增加 格式：空(忽略)/其他(内容)，长度0-33 | 230309 |
| replace_calleeadd_suffix | string | 空 | 被叫 后缀增加 格式：空(忽略)/其他(内容)，长度0-33 | 230309 |
| dest_tech | string | 空 | 目的设备类型 格式：空(禁止) DAHDI(包含bri/pri/mfcr2) SS7 PJSIP | 230322 |
| dest | string | 空 | 目的设备 格式：空(禁止) 长度0-33 DAHDI信道：(chid)，例如33 DAHDI分组：(g/G/r/R)(group)，例如g4 SS7格式：(linksetid)，例如0 PJSIP格式：(sipid)，例如1 | 230322 |
Server→Client Response
| KEY | VAL | Default | Remark |
|---|---|---|---|
| profile | int | - | 策略号 格式：不可空，注意限制，无效报错 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/digital_profile/callroute_set说明 |
· 抓包文件大小最大2M
Client→Server Request
| KEY | VAL | REQ | DEF | Remark | Renew |
|---|---|---|---|---|---|
| slotnum | int | Y | - | 槽号 格式：不可空，注意限制，无效报错 | 240611 |
| signaling_capture | int | N | 2 | 动作 格式：1开始 2停止 | 240611 |
| type | string | N | pri | 类型 格式：pri ss7 | 240611 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| status | int | 0 | 状态 格式：0无 1正在进行 2结束 注意：完成后一次性读取完成 | 240611 |
| result | string | 空 | URL下载相对地址 | 240611 |
| slotnum | int | 0 | 槽号 | 240611 |
| signaling_capture_channel | string | 空 | 抓包的信令通道，多个以逗号分隔 | 240611 |
| type | string | pri | 抓包类型 | 240611 |
· 注意：槽位可用数量，槽位号是-1还是0开始，参考sys_info/oem的说明。
· 注意：策略限制数量，参考sys_info/oem说明。
· 注意：返回需要生效的列表。这个接口就像某些路由器或某些大型IAD的产品一样，当部分操作之后，他们的界面会有一个按钮让你按一下才生效(按一下就是执行apply_do)。
· 注意：建议界面每间隔一定时间自动调用本接口检测并且界面提示生效banner，按键确认后生效。
· 注意：因为有一些端口有生效需要，但是其他一部分没有，为了简化前端处理，因此采用间隔一段时间调用一次本接口是最适合的做法
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| 参考/general/apply_set说明 |
· 注意：通过这个接口设置后会改变apply_do和apply_get的行为
· 注意：主要用于前端实现强制重启网络或voip
· 注意：本接口如只传一个参数，则其他参数将被忽略(既不会变0也不会变1)
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| network | int | 0 | 网络修改需要生效 格式：0 不需要 1需要 | 221114 |
| voip | int | 0 | VOIP修改需要生效 格式：0 不需要 1需要 | 221114 |
Server→Client Response
Client→Server Request
Server→Client Response
· 注意：摘要使用需要咨询开发工程师，如不存在需讨论让开发工程是给与支持
// 如下为策略摘要示例
{"point":"analog","type":"sip_server"} // 模拟SIP服务器
{"point":"analog","type":"voip"} // 模拟voip选项策略
{"point":"analog","type":"port"} // 模拟端口选项策略
{"point":"analog","type":"digitmap"} // 模拟数图策略
Client→Server Request
| KEY | VAL | Default | Remark |
|---|---|---|---|
| point | string | - | 策略所在位置。格式： analog仅在sys_info/oem的interface为analog有效 digital仅在sys_info/oem的interface为digital有效 |
| type | string | - | 策略编号 格式：由各策略接口说明 不超过32字符 |
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| list | array | 格式：[{'profile':'','name':''}...] |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| t38_modem | string | v17,v27,v29 | modem类型 格式：v17/v27/v29，可逗号分隔多选 | |
| t38_maxrate | string | 14400 | 最大速率 格式：14400/9600/7200/4800/2400 当最大速率比最小速率小的时候则自动强制使用最小速率作为最大速率 | 221001 |
| t38_minrate | string | 7200 | 最小速率 格式：14400/9600/7200/4800/2400 | |
| t38_ecm | string | no | 打开错误校验 格式：yes/no | |
| t38_negotiate_both | string | no | 开启自动双向协商 格式：yes/no | |
| t38_detect_timeout | int | 0 | 检测传真音Gateway模式时长 格式：0-1000，单位s |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/general_option/fax_set说明 |
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| tos_audio | int | 0 | RTP音频TOS值 格式：0-255 | 220915 |
| tos_signal | int | 0 | SIP信令TOS值 格式：0-255 | 220915 |
Server→Client Response
Client→Server Request
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/general_option/qos_set说明 |
· 注意：修改了端口设置方法和端口后将自动更新
· 注意：voip分配中的sip_channel_start根据slot自动分配(参考sys_info/interface接口可以得到准确的各slotnum分配)
· 注意：digital目前不支持单端口模式
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| sip_mode | int | 0 | SIP的FXS监听模式 格式：0(连续多端口) 1(单端口，仅对FXS有效) | 230310 |
| sip_start | int | 30000 | SIP开始端口 格式：1000-65000 | 221115 |
| sip_unregister_mode | int | 0 | (SIP) 设备重启时SIP注销 格式：0(关闭) 1(开启) | 230420 |
| rtp_start | int | 10000 | RTP开始端口 格式：1000-65000 备注：需与SIP间隔避免有重叠产生，建议间隔1W以上 | 221115 |
| icesupport | string | no | RTP的STUN开启 格式：yes/no 注意：需在sip中配置开启才最终生效 | 230504 |
| stunaddr | string | 空 | RTP的STUN地址 格式：长度0-63字符[addr]:[port] 备注：空为关闭，port默认3478 | 230503 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/general_option/voip_set说明 |
注意：CDR数据的查看请调用接口/sys_info/cdr 注意：为提高FLASH寿命，CDR仅保留在内存中，重启丢失
Client→Server Request
| KEY | VAL | Default | Remark | Renew |
|---|---|---|---|---|
| cdr_enable | string | no | 开启CDR记录 格式：yes/no | 230317 |
| cdr_filter | string | ANSWERED | 过滤数据 格式：空(不过滤) "NO ANSWER"(不要引号) FAILED BUSY ANSWERED CONGESTION UNKNOWN | 230317 |
| cdr_limit | int | 100 | 保存数量限制 格式：范围100-5000 注意：小型设备尽量不要超过1000否则可能崩溃(500KB) 5000条(2MB) | 230317 |
| action | int | 0 | 动作执行 格式：0 无动作, 1 清空CDR数据 | 230317 |
Server→Client Response
Server→Client Response
| DATA_SUBKEY | VAL | Default | Remark |
|---|---|---|---|
| 参考/general_option/cdr_set说明 |