昆石VOS2009_VOS3000接口说明书

Size: px

Start display at page:

Download "昆石VOS2009_VOS3000接口说明书"

侣箴卫
6 years ago
Views:

2 目录 1 概述接受请求创建账户修改账户删除账户查询账户创建话机修改话机删除话机查询话机查询在线话机创建对接网关修改对接网关查询对接网关删除对接网关查询在线对接网关创建落地网关修改落地网关... 95

3 2.17 删除落地网关查询落地网关查询在线落地网关查询当前通话充值创建套餐删除套餐查询套餐创建套餐订单修改套餐订单删除套餐订单查询套餐订单查询生效套餐删除生效套餐创建在用电话卡修改在用电话卡删除在用电话卡查询在用电话卡创建绑定号码修改绑定号码...152

4 2.37 删除绑定号码查询绑定号码查询费率组创建费率组修改费率组删除费率组查询费率查询号码变换表查询缴费记录查询历史话单查询账户明细报表查询话机明细报表查询账户地区明细报表外部计费查询账户电话簿创建账户电话簿修改账户电话簿删除账户电话簿查询软交换查询性能...182

5 2.57 电话卡充值电话卡激活回拨播放语音获取可用通话时长获取 Ivr 第二路可用通话时长查询其它收入记录获取所有账户账号半直拨预约被叫号码创建号码组号码创建 Ivr 语音修改 Ivr 语音删除 Ivr 语音获取 Ivr 语音修改 Ivr 语音数据创建号码变换表修改号码变换表删除号码变换表中断通话获取所有在线话机...209

6 2.77 删除号码组号码查询电话卡创建告警创建受禁媒体 IP 删除受禁媒体 IP 获取当前告警 IVR 中断通话对外请求 IVR 请求外部数据控制语音流程 IVR 请求外部数据控制语音流程平台话机上下线通知呼叫状态通知账户余额变化当前告警通知

7 1 概述本文档描述在昆石 VOS2009/VOS3000 标准接口部分接口需购买特定功能组件才可实施, 请在使用接口时核实您安装的产品具备该功能接口综述 : 接口格式采用 JSON 定义, 采用 UTF-8 格式编码接口采用 POST 方式提交至 VOS2009/VOS3000 WEB 服务对于接口返回码, 非 0 表示失败失败原因参考返回码定义 HTML 头部信息 Content-Type 设置为 text/html;charset=utf-8 一般返回错误格式样例 {"retcode":-10007,"exception":"not found, operation failed."} 对于有性能以及压力要求的接口请求, 建议安排相同机器环境, 测试后方可实际环境部署 1

8 2 接受请求 2.1 创建账户接口地址 /external/server/createcustomer 请求格式 account M String 64 账户号码 ( 具备唯一性的可显标识 ) name M String 64 账户名称 money O Double 开户初始余额 ( 默认 :0) limitmoney O Double 开户初始透支限额 ( 默认 :0) feerategroup O String 64 计费费率 type O Integer 账户类型 0: 普通账户 ( 默认 ) 1: 电话卡 2: 结算账户 locktype O Integer 锁定类型 0: 未锁定 ( 默认 ) 1: 锁定 agentaccount O String 64 代理商账号 phonebooklimit O Integer 电话簿上限 ( 默认 :0) validtime O Long 账户有效期 (UTC 至今的毫秒数 ) 0: 使用系统参数决定的过期时间 ctdbillingtype O Integer 代理商回拨计费模式 0: 普通 ( 默认 ) 2

9 1: 流量 memo O String 255 备注信息 infocustomeradditional O InfoCustomerAdditional 账户补充信息 InfoCustomerAdditional 格式 cardtype O Integer 证件类型 0: 身份证 ( 默认 ) 1: 护照 2: 军官证 3: 工作证 4: 学生证 5: 其他证件 cardnumber O String 证件号码 address O String 地址 postcode O String 邮政编码 linkman O String 联系人 telephone O String 电话号码 fax O String 传真 O String 邮件地址 cc O String 抄送地址 bcc O String 密送地址 reporttype O Integer 报表发送类型 0: 不发送 ( 默认 ) 1: 每日 2: 每周 3: 每月 companyname O String 公司名称 bank O String 银行名称返回格式 3

10 retcode M int 返回码 exception O String 错误原因 4

11 2.2 修改账户接口地址 /external/server/modifycustomer 请求格式 account M String 64 账户号码 ( 具备唯一性的可显标识 ) limitmoney O Double 开户初始透支限额 ( 默认 :0) feerategroup O String 64 计费费率 type O Integer 账户类型 0: 普通账户 ( 默认 ) 1: 电话卡 2: 结算账户 locktype O Integer 锁定类型 0: 未锁定 ( 默认 ) 1: 锁定 agentaccount O String 64 代理商账号 phonebooklimit O Integer 电话簿上限 ( 默认 :0) validtime O Long 账户有效期 (UTC 至今的毫秒数 ) ctdbillingtype O Integer 代理商回拨计费模式 0: 普通 1: 流量 memo O String 255 备注信息 infocustomeradditional O InfoCustomerAdditional 账户补充信息返回格式 retcode M int 返回码 5

12 exception O String 错误原因 6

13 2.3 删除账户接口地址 /external/server/deletecustomer 请求格式 account M String 64 计费账户号码 ( 具备唯一性的可显标识 ) 返回格式 retcode M int 返回码 exception O String 错误原因 7

14 2.4 查询账户接口地址 /external/server/getcustomer 请求格式 accounts O String[] 账户号码列表 ( 与 e164s filteragentaccount 三项至少选其一 ) e164s O String[] 电话号码列表 filteragentaccount O FilterAgentAccount 代理商账户 ( 表示仅查询该代理商的下属账户 ) type O Integer 账户类型 0: 普通账户 1: 电话卡 2: 结算账户 FilterAgentAccount 格式 agentaccount M String 代理商账户号码 querysonmode M int 0: 所有下属账户 1: 直属下属账户返回格式 retcode M int 返回码 exception O String 错误原因 infocustomers O InfoCustomer[] 账户信息 InfoCustomer 格式 8

15 account M String 64 账户号码 ( 具备唯一性的可显标识 ) name M String 64 账户名称 money M double 开户初始余额 ( 默认 :0) limitmoney M double 开户初始透支限额 ( 默认 :0) feerategroup M String 64 计费费率空串 : 无费率组 type M int 账户类型 0: 普通账户 ( 默认 ) 1: 电话卡 2: 结算账户 locktype M int 锁定类型 0: 未锁定 ( 默认 ) 1: 锁定 agentaccount M String 64 代理商账号空串 : 无代理商 phonebooklimit M int 电话簿上限 ( 默认 :0) canceled M boolean true: 已注销 false: 未注销 starttime M long 账户有效期 (UTC 至今的毫秒数 ) 0: 使用系统参数决定的过期时间 validtime M long 账户有效期 (UTC 至今的毫秒数 ) 0: 使用系统参数决定的过期时间 todayconsumption M double 今日消费 9

16 ctdbillingtype M int 代理商回拨计费模式 0: 普通 1: 流量 category M int 账户类别 0: 普通账户 1: 代理商账户 bindede164s M String [] 绑定号码列表 memo M String 255 备注信息 infocustomeradditional M InfoCustomerAdditional 账户补充信息 10

17 2.5 创建话机接口地址 /external/server/createphone 请求格式 autocreateaccount M boolean 创建话机时同时创建计费账户 e164 M String 64 话机号码 password O String 32 话机密码 displaynumber O String 64 去电显示 locktype O Integer 锁定类型 0: 无锁定 1: 锁定呼出 2: 锁定呼入 3: 全部锁定 calllevel O Integer 权限类型 1: 网内通话 2: 本地市话 4: 国内长途 5: 国际长途 feerategroup O String 255 话机私有计费费率 ( 请参考操作手册费率相关描述 ) 通常情况不使用此设置 monthlymoneyminimum O Double 月最低消费额 monthlymoneymaximum O Double 月最高消费额 monthlyrentfee O Double 月租 rewriterulesoutcallee O String 呼出被叫改写规则, 需符合改写规则书写格式 11

18 rewriterulesincallee O String 呼入被叫改写规则, 需符合改写规则书写格式 rewriterulesincaller O String 呼入主叫改写规则, 需符合改写规则书写格式 routinggatewaygroupsallo w O Boolean true: 仅允许设定的网关群组作为落地 false: 禁止设定的网关群组作为落地 routinggatewaygroups O String 255 落地网关群组名称 ( 空表示所有 ) account O String 64 话机所属账户 equipment O String 64 话机所属软交换 ( 空表示属于所有软交换 ) calleebilling O Boolean true: 开启被叫计费 false: 普通计费 ( 主叫计费 ) customerpassword O String 32 Web 查询密码 linecallin O Integer 呼入线路数量限制 linecallout O Integer 呼出数量限制 linecapacity O Integer 同时呼叫数限制 ( 含呼入与呼出 ) phonebooklimit O Integer 电话簿数量限制 callerlimite164groupsallo w O Boolean true: 允许主叫号码组呼入 false: 禁止主叫号码组呼入 callerlimite164groups O String 255 当话机为被叫时允许 / 禁止的主叫号码组 ( 空表示所有 ) calleelimite164allow O Boolean true: 允许呼出的被叫号码组 false: 禁止呼出的被叫号码组 calleelimite164groups O String 255 当话机为主叫时允许 / 禁止 12

19 的被叫号码组 ( 空表示所有 ) dids O String 一机多号 memo O String 255 备注 infophonevalueadded O InfoPhoneValueAdded 话机增值业务 infophoneadditional O InfoPhoneAdditional 话机补充设置 InfoPhoneValueAdded 格式参数名称必须类型长度描述信息 calleriddisplay O Boolean true: 开启来电显示 false: 关闭来电显示 calltransfer O Boolean true: 允许呼叫转移 false: 禁止呼叫转移 donotdisturb O Boolean true: 开启免打扰 false: 关闭免打扰 periodforwarding O Boolean true: 开启时段前转 false: 关闭时段前转 infophonevalueaddedperio O InfoPhoneValueAddedPerio 时段转移设置 dforwardings dforwarding[] unconditionalforward O Boolean true: 开启无条件前转 false: 关闭无条件前转 unconditionalforwarde164 O InfoPhoneValueAddedForw 无条件前转号码 arde164 noanswerforward O Boolean true: 开启无应答前转 false: 关闭无应答前转 noanswerforwarde164 O InfoPhoneValueAddedForw 无应答前转号码 arde164 offlineforward O Boolean true: 开启不在线前转 false: 关闭不在线前转 offlineforwarde164 O InfoPhoneValueAddedForw arde164 不在线前转号码 13

20 busyforward O Boolean true: 开启遇忙前转 false: 关闭遇忙前转 busyforwarde164 O InfoPhoneValueAddedForw 遇忙前转号码 arde164 callforwarddisplay O Integer 呼叫前转去电显示 0: 默认, 使用系统参数值 1: 原始主叫 2: 本机号码 calltransfernormaldisplay O Integer 普通呼叫转移去电显示 0: 默认, 使用系统参数值 1: 原始主叫 2: 本机号码 calltransferaskdisplay O Integer 询问式呼叫转移去电显示 0: 默认, 使用系统参数值 1: 原始主叫 2: 本机号码 colorring O Boolean true: 开启彩铃 false: 关闭彩铃 remotecolorringpassthrou gh O Boolean true: 开启彩铃透传 false: 关闭彩铃透传 colorringname O String 64 彩铃名称 language O String 64 无法接通语音提示 / 余额不足语音提示 / 通话剩余时长插播使用的语言 unabletoconnectvoicepro mpts O Integer 无法接通语音提示 0: 默认, 使用系统参数值 1: 开启 2: 关闭 callremainingtimeprompts O Integer 余额不足语音提示 0: 默认, 使用系统参数值 14

21 1: 开启 2: 关闭 balancenotenoughalarm O Integer 通话剩余时长插播 0: 默认, 使用系统参数值 1: 提示剩余金额 2: 提示剩余分钟数 3: 不进行提示 voic O Boolean true: 语音信箱开通 false: 语音信箱关闭 voic checkpassword O Boolean true: 接入语音信箱校验密码 false: 接入语音信箱不校验密码 voic maxnumber O Integer 语音信箱保留的条数 -1: 由系统参数决定 voic expireday O Integer 语音信箱留言过期天数 -1: 由系统参数决定 voic audiotype O Integer 0: 默认 1: 自定义 InfoPhoneValueAddedPeriodForwarding 格式 weekofday O String 32 星期几生效设定, 可使用逗号分隔多个生效天如 0,1 不设置默认为 0,1,2,3,4,5,6 0: 星期日 1: 星期一 2: 星期二 3: 星期三 4: 星期四 5: 星期五 15

22 6: 星期六全星期生效可设置为 0,1,2,3,4,5,6 beginsecondinday O Integer 起始时间 ( 当前时间与当天 0 点的秒偏差 ) 不设置默认为 0 取值范围 endsecondinday O Integer 终止时间 ( 当前时间与当天 0 点的秒偏差 ) 不设置默认为取值范围 forwarde164 O InfoPhoneValueAddedForw arde164 前转号码 InfoPhoneValueAddedForwardE164 格式 forwardmethod O Integer 前转方式, 不设置则默认为 0 0: 顺序 1: 轮询 3: 随机 alertsecond O Integer 前转后振铃时长 ( 单位 : 秒 ), 对最后一个前转号码无效不设置默认为 -1-1: 使用默认值 e164 O String 255 前转号码, 可使用逗号分隔多个号码 InfoPhoneAdditional 格式参数名称必须类型长度描述信息 registertype O Integer 注册方式 16

23 0: 静态 1: 动态 2: 对接网关 protocol O Integer 协议 0:H323 1:SIP ip O String 32 静态注册方式时的 IP 地址 port O Integer 静态注册方式时的端口 localip O String 静态注册方式时使用的本地 IP 地址 rtprelay O Integer 媒体转发 0: 自动 1: 开启 2: 关闭 rtpinterruptdetection O Integer 媒体中断监测 0: 无 1: 服务器至远端 2: 远端至服务器 3: 双向 calldurationlimit O Integer 通话时长限制 ( 单位 : 秒 ) -1: 默认, 使用系统参数设置值 0: 无, 不限制通话时长 calltransferbillingmethod O Integer 被叫转移计费方式 0: 被叫 1: 主叫 usecallerphonedisplay O Integer 非电话簿主叫话机使用其去电显示 0: 默认, 使用系统参数设置值 17

24 1: 开启 2: 关闭 nobillingtophone O Integer 当对方是话机设备时免计费 0: 默认, 使用系统参数设置值 1: 开启 2: 关闭 displaycallershortnumber O Boolean true: 显示主叫短号 false: 不显示主叫短号 useroutinggatewaynotonli ne O Integer 不在线尝试落地网关路由 0: 默认, 使用系统参数设置值 1: 开启 2: 关闭 minprofitpercentenable O Boolean 是否开启最低利润率限制 minprofitpercent O Integer 最低利润率限制若设置为 10 表示利润率为 10% 取值范围至 maxsecondratesenable O Boolean 最高秒费率限制 true: 开启 false 关闭 maxsecondrates O Double 最高秒费率值 ( 若分钟费率为 0.6, 此值应该设置为 0.01) firstroutingpolicy O Integer 第一路由策略 0: 无 1: 接通率 2: 最少秒费率 secondroutingpolicy O Integer 第二路由策略 0: 无 1: 接通率 18

25 2: 最少秒费率 sipauthenticationmethod O Integer SIP 呼叫时认证方式 0: 根据 IP 地址 1: 根据 IP 地址和端口 2: 需再次校验密码 sipremotealertingmethod O Integer 远端回铃方式 0: 自动 1:183+SDP 2:180+SDP siptimersupport O Boolean true: 允许 timer 协议 (RFC4028) false: 禁止 timer 协议 sip100relsupport O Boolean true: 开启 100rel 协议 false: 关闭 100rel 协议 sipt38support O Boolean true: 允许 t38 协议 false: 禁止 t38 协议 sipprivacysupport O Boolean true: 识别 Privacy false: 忽略 Privacy sipprivacy O Integer 0: 无 1: 透传 2:id sipppreferredidentity O Integer 0: 无 1: 透传 2: 主叫号码 sippassertedidentity O Integer 0: 无 1: 透传 2: 主叫号码 dtmfreceivemethod O Integer DTMF 接收方式 0: 自动 10:RFC

26 20: 信令方式 30: 关闭 dtmfsipsendmethod O Integer SIP DTMF 发送方式 0: 自动 10:RFC :SIP INFO 60: 关闭 sipcodecassign O Boolean true: 指定 SIP 媒体编码 false: 自动协商 SIP 媒体编码 sipcodecs O String [] 媒体编码范围 audio/amr audio/dvi4 audio/g722 audio/g723 audio/g audio/g audio/g audio/g audio/g728 audio/g729 audio/g729d audio/g729e audio/gsm audio/gsm-efr audio/ilbc audio/l8 audio/l16 audio/lpc audio/mpa audio/parityfec audio/pcma audio/pcmu 20

27 audio/qcelp audio/red audio/vdvi audio/speex audio/speex-fec audio/speex-wideband audio/speex-wideband-fe C audio/silk video/bt656 video/celb video/jpeg video/h261 video/h263 video/h video/h video/h264 video/mpv video/mp2t video/mp1s video/mp2p video/parityfec video/red video/bmpeg video/nv video/vp8 ivrequipmenttype O Integer 语音设备类型 -1: 无 1: 直拨回拨 2: 企业总机 3: 增值业务 ivrservicename O String 语音业务名称 21

28 ivrcallbackbillingmode O Integer 回拨计费 0: 接入号对应话机 1: 在用电话卡 2: 自适应 ( 顺序 : 绑定号码 - 在用电话卡 - 主叫号对应话机 - 接入号对应话机 ) 3: 主叫号对应话机 ivrcallbackmergebillingmod e O Integer 回拨第二路叠加计费方式 0: 无 1: 叠加接入号到第二路 2: 叠加主叫号码到第二路 ivrdirectmergebillingmode O Integer 直拨第二路叠加计费方式 0: 无 1: 叠加接入号到第二路 2: 叠加主叫号码到第二路 ivrsecondbillingmode O Integer 第二路计费方式 0: 接入号对应话机 1: 在用电话卡 3: 主叫号对应话机 ivrcallbackbillingsecordnot ConnectedOnAccessE164 ivrcallbackbillingsecordco nnectedonsecondaccount ivraccessverifyactivephone Card O Boolean true: 第二路未接通则按照接入号对应话机计费 false: 此参数不生效 O Boolean true: 第二路接通则按照第二路账户计费 false: 此参数不生效 O Boolean true: 主叫号码校验在用电话卡 ivraccessverifybindede164 O Boolean true: 主叫号码校验绑定号码 ivraccessverifycallere164p O Boolean true: 主叫号码校验平台话机 hone 22

29 ivraccessverifyaccesse164 Phone O Boolean true: 被叫号码校验接入号存在账户 ivrenablephonesetting O Boolean true: 启用话机设设置 false: 不启用话机设置 lrnenable O Boolean LRN 查询 true: 启用 false: 禁用 lrneatprefixlength O Integer LRN 查询时忽略被叫号码前缀的长度 lrnfailureaction O Integer 查询失败后的行为 0: 拒绝此次呼叫 1: 使用原有号码继续后续处理 lrninterstatebillingprefix O String LRN 查询后非同地区计费前缀 lrnundeterminedbillingprefi x O String LRN 查询后有一个或两个号码无法获知其地区时的计费前缀 rewritecalleemobileareaen able O Boolean true: 开启手机区号添加 false: 关闭手机区号添加 rewritecalleemobilearea O String 开启或关闭手机区号添加的地区信息, 采用逗号分隔多个地区 callstatereport O Boolean 开启或关闭呼叫状态通知返回格式 retcode M int 返回码 exception O String 错误原因 23

30 password O String 当创建请求未设置密码时, 系统自动生成随机密码 24

31 2.6 修改话机接口地址 /external/server/modifyphone 请求格式 e164 M String 64 创建话机时同时创建计费账户 password O String 32 话机密码 displaynumber O String 64 去电显示 locktype O Integer 锁定类型 0: 无锁定 1: 锁定呼出 2: 锁定呼入 3: 全部锁定 calllevel O Integer 权限类型 1: 网内通话 2: 本地市话 3: 国内长途 4: 国际长途 feerategroup O String 255 话机私有计费费率 ( 请参考操作手册费率相关描述 ) 通常情况不使用此设置 monthlymoneyminimum O Double 月最低消费额 monthlymoneymaximum O Double 月最高消费额 monthlyrentfee O Double 月租 rewriterulesoutcallee O String 呼出被叫改写规则, 需符合改写规则书写格式 rewriterulesincallee O String 呼入被叫改写规则, 需符合 25

32 改写规则书写格式 rewriterulesincaller O String 呼入主叫改写规则, 需符合改写规则书写格式 routinggatewaygroupsallo w O Boolean true: 仅允许设定的网关群组作为落地 false: 禁止设定的网关群组作为落地 routinggatewaygroups O String 255 落地网关群组名称 ( 空表示所有 ) account O String 64 话机所属账户 equipment O String 64 话机所属软交换 ( 空表示属于所有软交换 ) calleebilling O Boolean true: 开启被叫计费 false: 普通计费 ( 主叫计费 ) customerpassword O String 32 Web 查询密码 linecallin O Integer 呼入线路数量限制 linecallout O Integer 呼出数量限制 linecapacity O Integer 同时呼叫数限制 ( 含呼入与呼出 ) phonebooklimit O Integer 电话簿数量限制 callerlimite164groupsallo w O Boolean true: 允许主叫号码组呼入 false: 禁止主叫号码组呼入 callerlimite164groups O String 255 当话机为被叫时允许 / 禁止的主叫号码组 ( 空表示所有 ) calleelimite164allow O Boolean true: 允许呼出的被叫号码组 false: 禁止呼出的被叫号码组 calleelimite164groups O String 255 当话机为主叫时允许 / 禁止的被叫号码组 ( 空表示所有 ) 26

33 dids O String 一机多号 memo O String 255 备注 infophonevalueadded O InfoPhoneValueAdded 话机增值业务 infophoneadditional O InfoPhoneAdditional 话机补充设置返回格式 retcode M int 返回码 exception O String 错误原因 27

34 2.7 删除话机接口地址 /external/server/deletephone 请求格式 e164 M String 64 电话号码返回格式 retcode M int 返回码 exception O String 错误原因 28

35 2.8 查询话机接口地址 /external/server/getphone 请求格式 e164s O String [] 电话号码列表 ( 若 accounts 不设置则此参数必选 ) accounts O String [] 账户号码列表 ( 若 e164s 不设置则此参数必选 ) 返回格式 retcode M int 返回码 exception O String 错误原因 infophones O InfoPhone [] 话机信息 InfoPhone 格式 e164 M String 64 创建话机时同时创建计费账户 password O String 32 话机密码 displaynumber O String 64 去电显示 locktype O Integer 锁定类型 0: 无锁定 1: 锁定呼出 2: 锁定呼入 3: 全部锁定 calllevel O Integer 权限类型 1: 网内通话 29

36 2: 本地市话 3: 国内长途 4: 国际长途 feerategroup O String 255 话机私有计费费率 ( 请参考操作手册费率相关描述 ) 通常情况不使用此设置 monthlymoneyminimum O Double 月最低消费额 monthlymoneymaximum O Double 月最高消费额 monthlyrentfee O Double 月租 rewriterulesoutcallee O String 呼出被叫改写规则, 需符合改写规则书写格式 rewriterulesincallee O String 呼入被叫改写规则, 需符合改写规则书写格式 rewriterulesincaller O String 呼入主叫改写规则, 需符合改写规则书写格式 routinggatewaygroupsallo w O Boolean true: 仅允许设定的网关群组作为落地 false: 禁止设定的网关群组作为落地 routinggatewaygroups O String 255 落地网关群组名称 ( 空表示所有 ) account O String 64 话机所属账户 equipment O String 64 话机所属软交换空 : 表示属于所有软交换未选择 : 表示不属于任何软交换 calleebilling O Boolean true: 开启被叫计费 false: 普通计费 ( 主叫计费 ) customerpassword O String 32 Web 查询密码 30

37 linecallin O Integer 呼入线路数量限制 linecallout O Integer 呼出数量限制 linecapacity O Integer 同时呼叫数限制 ( 含呼入与呼出 ) phonebooklimit O Integer 电话簿数量限制 callerlimite164groupsallo w O Boolean true: 允许主叫号码组呼入 false: 禁止主叫号码组呼入 callerlimite164groups O String 255 当话机为被叫时允许 / 禁止的主叫号码组 ( 空表示所有 ) calleelimite164allow O Boolean true: 允许呼出的被叫号码组 false: 禁止呼出的被叫号码组 calleelimite164groups O String 255 当话机为主叫时允许 / 禁止的被叫号码组 ( 空表示所有 ) dids O String 一机多号 memo O String 255 备注 infophonevalueadded O InfoPhoneValueAdded 话机增值业务 infophoneadditional O InfoPhoneAdditional 话机补充设置 31

38 2.9 查询在线话机接口地址 /external/server/getphoneonline 请求格式 e164s M String [] 电话号码列表返回格式 retcode M int 返回码 exception O String 错误原因 infophoneonlines O InfoPhoneOnline [] 在线话机信息 InfoPhoneOnline 格式 e164 M String 64 电话号码 currentcall M int 当前呼叫总数 remoteip M String 远端地址 localip M String 本地地址 registertime M long 注册时间 (UTC 至今的毫秒数 ) updatetime M long 上次更新时间 (UTC 至今的毫秒数 ) protocol M int 协议类型 0:H323 1:SIP cryptotype M int 加密类型 0: 未加密 1:RC4 32

39 productid M String 设备名称 33

40 2.10 创建对接网关接口地址 /external/server/creategatewaymapping 请求格式 name M String 64 对接网关名称 password O String 64 对接网关注册密码 locktype O Integer 锁定类型 0: 无锁定 3: 全部锁定 calllevel O Integer 权限类型 1: 网内通话 2: 本地市话 4: 国内长途 5: 国际长途 capacity O Integer 线路上限 priority O Integer 优先级 gatewaygroups O String 所属网关群组 ( 逗号分隔多个群组名称 ) routinggatewaygroupsallo w O Boolean true: 允许使用落地群组 false: 禁止使用落地群组 routinggatewaygroups O String 限制的落地网关群组名称, 空串表示所有 registertype O Integer 注册类型 0: 静态 1: 动态 remoteips O String 对接网关 IP 地址列表 ( 逗号分隔多个 IP 地址 ) 34

41 callere164checkenable O Boolean true: 检查主叫号码规范性 false: 不检查主叫号码规范性 callere164checkcity O Boolean true: 允许主叫号码为城市号码 false: 不允许主叫号码为城市号码 callere164checkmobile O Boolean true: 允许主叫号码为移动号码 false: 不允许主叫号码为移动号码 callere164checkother O Boolean true: 允许主叫号码为非城市号码与非移动号码 false: 不允许主叫号码为非城市号码与非移动号码 calleee164checkenable O Boolean true: 检查被叫号码规范性 false: 不检查被叫号码规范性 calleee164checkcity O Boolean true: 允许被叫号码为城市号码 false: 不允许被叫号码为城市号码 calleee164checkmobile O Boolean true: 允许被叫号码为移动号码 false: 不允许被叫号码为移动号码 calleee164checkother O Boolean true: 允许被叫号码为非城市号码与非移动号码 false: 不允许被叫号码为非城市号码与非移动号码 35

42 customerpassword O String WEB 查询密码 rtpforwardtype O Integer 媒体转发类型 0: 自动 1: 开启 2: 关闭 mediacheckdirection O Integer 媒体中断检测 ( 仅在通话进行了媒体转发时有效 ) 0: 不检测 1: 检测是否有媒体报文传输给远端 2: 检测是否收到来自远端的媒体报文 3: 检测远端与本地有双向的媒体报文 calleee164restrict O Integer 被叫号码限制 0: 不限制 1: 限制被叫号码必须是平台存在的话机号码 2: 限制被叫号码必须不是平台存在的话机号码 maxcalldurationlower O Integer 大于 0: 最长通话时间下限 -1: 使用系统参数值 ( 需与 maxcalldurationupper 保持一致 ) 0: 无限制 ( 需与 maxcalldurationupper 保持一致 ) maxcalldurationupper O Integer 大于 0: 最长通话时间上限 -1: 使用系统参数值 ( 需与 maxcalldurationlower 保持 36

43 一致 ) 0: 无限制 ( 需与 maxcalldurationlower 保持一致 ) allowphonebilling O Boolean 当主叫号码与平台话机号码匹配, 可使用话机号码的账户对呼叫进行计费 allowbindede164billing O Boolean 当主叫号码与绑定号码匹配, 可使用绑定号码的账户对呼叫进行计费 enablephonesetting O Boolean 当主叫号码与平台话机号码匹配, 则主叫使用平台话机的配置进行后续处理 denysamecitycodesallow O Boolean true: 允许 denysamecitycodes 设置的区号进行同城呼叫 false: 禁止 denysamecitycodes 设置的区号进行同城呼叫 denysamecitycodes O String 同城呼叫功能限制的城市区号列表 ( 使用逗号分隔多个区号 ) checkmobileareaallow O Boolean true: 允许呼叫 checkmobilearea 设置的区号对应城市的移动号码 false: 禁止呼叫 checkmobilearea 设置的区号对应城市的移动号码 checkmobilearea O String 移动号码呼叫功能限制的城市区号列表 ( 使用逗号分隔 37

44 多个区号 ) calloutcalleeprefixesallow O Boolean true: 允许 calloutcalleeprefixes 设置的前缀列表作为被叫号码前缀 false: 禁止 calloutcalleeprefixes 设置的前缀列表作为被叫号码前缀 calloutcalleeprefixes O String 被叫号码限制功能中被叫号码前缀列表 ( 可使用逗号分隔 ) calloutcallerprefixesallow O Boolean true: 允许 calloutcallerprefixes 设置的前缀列表作为主叫号码前缀 false: 禁止 calloutcallerprefixes 设置的前缀列表作为主叫号码前缀 calloutcallerprefixes O String 主叫号码限制功能中主叫号码前缀列表 ( 可使用逗号分隔 ) rewriterulesoutcallee O String 被叫改写规则 rewriterulesoutcaller O String 主叫改写规则 rewriterulesinmobileareaal low O Boolean true: 开启 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 false: 关闭 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 rewriterulesinmobilearea O String 移动号码需改写的区号 ( 可 38

45 使用逗号分隔 ) timeoutcallproceeding O Integer 呼叫未振铃或接通允许的最长持续时长 ( 单位 : 秒 ) -1: 使用系统参数设置值 0: 无限制 sipresponseaddressmetho d O Integer SIP Response 信令的地址 0: 回应至原始请求的地址 1: 回应至原始请求的 IP, 但端口使用 Via 头部中标识的端口 siprequestaddressmethod O Integer SIP Request 信令的地址 0: 请求至原始请求的地址 1: 请求至原始请求的 IP, 但端口使用 Contact 头部中标识的端口 2: 请求至 Contact 头部中标识的地址 dtmfsendmethodh323 O Integer H323 协议, 软交换发送 DTMF 方式 0: 自动 10:RFC :H.245 alphanumeric 30:H.245 signal 40:Q.931 keypad 60: 关闭 dtmfsendmethodsip O Integer SIP 协议 : 软交换发送主叫 DTMF 方式 0: 自动 10:RFC :SIP Info 39

46 60: 关闭 dtmfreceivemethod O Integer 软交换接收主叫 DTMF 方式 0: 自动 10:RFC : 信令 30: 关闭 dtmfsendpayloadtypeh32 3 O Integer Dtmf 为 RFC2833 在 H323 协议时使用的 Payload Type dtmfsendpayloadtypesip O Integer Dtmf 为 RFC2833 在 SIP 协议时使用的 Payload Type dtmfreceivepayloadtype O Integer Dtmf 为 RFC2833 软交换接收 Dtmf 信号使用的 Payload Type q931progressindicator O Integer H323 协议中 Q931ProgressIndicator 的填写方式 -1: 自动 0: 关闭 1: ProgressNotEndToEndISD N 2: ProgressDestinationNonIS DN 3:ProgressOriginNotISDN 4: ProgressReturnedToISDN 5:ProgressServiceChange 8: ProgressInbandInformation Available 40

47 account O String 对接网关的计费账户号码 callfailedq931causevalue O String 将失败的终止原因转换为设定的 H323 终止原因, 格式为 < 原始终止原因 >:< 目标终止原因 > 原始终止原因 0: 其它目标终止原因 0: 不替换大于 0: 请参考 H323/SIP 协议通话中断定义规范 callfailedsipcode O String 将失败的终止原因转换为设定的 SIP 终止原因, 格式为 < 原始终止原因 >:< 目标终止原因 > 原始终止原因 0: 其它目标终止原因 0: 不替换大于 0: 请参考 H323/SIP 协议通话中断定义规范 sipremoteringsignal O Integer SIP 远端回铃信令 0: 自动 1:183+SDP 2:180+SDP sipcalleee164domain O Integer SIP 被叫号码取得方式 0: 从信令头部 To 中取得 1: 从信令头部 Invite 中取得 sipcallere164domain O Integer SIP 主叫号码取得方式 0: 从信令头部 From 中取得 1: 从信令头部 RemotePartId 中取得 2: 从信令头部 Display 中取得 h323calleee164domain O Integer H323 被叫号码取得方式 41

48 0: 从信令 CalledPartyNumber 中取得 1: 从信令 DestinationAddress 中取得 h323callere164domain O Integer H323 主叫号码取得方式 0: 从信令 CallingPartyNumber 中取得 1: 从信令 SourceAddress 中取得 2: 从信令 Display 中取得 memo O String 备注信息 sipauthenticationmethod O Integer SIP 呼叫认证方式 0: 根据 IP 地址认证 1: 根据 IP 地址与端口共同认证 2: 通过校验密码进行认证 h323faststart O Boolean true: 启用 H323 的 fast start 功能 false: 关闭 H323 的 fast start 功能 h323h245tunneling O Boolean true: 启用 H323 的 H245 tunneling 功能 false: 关闭 H323 的 H245 tunneling 功能 h323h245insetup O Boolean true: 在 H323 的 Setup 信令中包含 H245 信令 false: 在 H323 的 Setup 信令中不包含 H245 信令 h323autocallproceeding O Boolean true:h323 协议收到呼叫请求后立即回应 42

49 h323callproceedingfromsi PTrying h323alertingfromsip183sd p CallProceeding false:h323 协议收到呼叫后不立即回应 CallProceeding O Boolean 主叫为 H323 协议被叫为 SIP 协议时, 被叫接收 Trying 信令对应的主叫信令处理方式 true: 转换为 CallProceeding 回应主叫 false: 不进行信令转换 O Boolean 主叫为 H323 协议被叫为 SIP 协议时, 被叫接收 183+SDP 回应时对应的主叫处理方式 true: 转换为 Alerting 回应主叫 false: 转换为 CallProceeding 回应主叫 h323t38 O Boolean true:h323 协议时支持 T38 信令 false:h323 协议时忽略 T38 信令 siptimer O Boolean true: 支持 SIP Timer 协议 (RFC4028) false: 禁止 SIP Timer 协议 sip100rel O Boolean true: 支持 SIP 100rel 协议 false: 禁止 SIP 100rel 协议 sipt38 O Boolean true: 支持 SIP T38 协议 false: 禁止 SIP T38 协议 sipdisplay O Boolean true: 在向远端发送信令时包含 Display 头部 false: 在向远端发送信令时不包含 Display 43

50 头部 sipremotepartyid O Boolean true: 在向远端发送信令时包含 RemotePartyId 头部 false: 在向远端发送信令时不包含 RemotePartyId 头部 sipprivacysupport O Boolean true: 识别 Privacy false: 忽略 Privacy groupe164change O Boolean true: 启用号码变换功能 false: 关闭号码变换功能 callerallowlength O Integer 主叫号码允许的号码长度掩码 0: 表示允许所有长度 1<<x: 表示允许长度为 x 的号码 (x 小于 32) calleeallowlength O Integer 被叫号码允许的号码长度掩码 0: 表示允许所有长度 1<<x: 表示允许长度为 x 的号码 (x 小于 32) callerlimite164groupsallo w O Boolean true: 允许 callerlimite164groups 所设置的号码组作为主叫号码呼叫 false: 禁止 callerlimite164groups 所设置的号码组作为主叫号码呼叫 callerlimite164groups O String 主叫号码组列表 ( 可使用逗号分隔 ) calleelimite164groupsallo O Boolean true: 允许 44

51 w calleelimite164groups 所设置的号码组作为被叫号码呼叫 false: 禁止 calleelimite164groups 所设置的号码组作为被叫号码呼叫 calleelimite164groups O String 被叫号码组列表 ( 可使用逗号分隔 ) minprofitpercentenable O Boolean 是否开启最低利润率限制 minprofitpercent O Integer 最低利润率限制若设置为 10 表示利润率为 10% 取值范围至 maxsecondratesenable O Boolean 最高秒费率限制 true: 开启 false 关闭 maxsecondrates O Double 最高秒费率值 ( 若分钟费率为 0.6, 此值应该设置为 0.01) firstroutepolicy O Integer 第一路由策略 : 0: 无 1: 接通率 2: 最小秒费率 secondroutepolicy O Integer 第二路由策略 : 0: 无 1: 接通率 2: 最小秒费率 h323g729sendmode O Integer H323 G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 45

52 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729sendmode O Integer SIP G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729annexb O Integer G729 annexb 参数填写方式 0: 自动 1:annex=yes 2:annex=no 3: 无 annex 4: 透传对端的 annex sipg723annexa O Integer G723 annexa 参数填写方式 0: 自动 1:annex=yes 2:annex=no 3: 无 annex 4: 透传对端的 annex h323codecassign O Boolean true: 限制 H323 音频 / 视频编码为 h323codecs 设定值 false: 软交换自动协商 h323codecs O Vector<String> H323 音频 / 视频列表 sipcodecassign O Boolean true: 限制 SIP 音频 / 视频编码为 SIPCodecs 设定值 46

53 false: 软交换自动协商 sipcodecs O Vector<String> SIP 音频 / 视频列表 forwardsignalrewritee164 GroupEnable O Boolean true: 开启呼叫前转信令改写 false: 关闭呼叫前转信令改写 forwardsignalrewritee164 Group O String 255 呼叫前转信令改使用的号码群组名称 softswitchname O String 软交换名称 lrnenable O Boolean LRN 查询 true: 启用 false: 禁用 lrneatprefixlength O Integer LRN 查询时忽略被叫号码前缀的长度 lrnfailureaction O Integer 查询失败后的行为 0: 拒绝此次呼叫 1: 使用原有号码继续后续处理 lrninterstatebillingprefix O String LRN 查询后非同地区计费前缀 lrnundeterminedbillingprefi x O String LRN 查询后有一个或两个号码无法获知其地区时的计费前缀 language O String 无法接通提示所使用的语言返回格式 retcode M int 返回码 exception O String 错误原因 47

54 2.11 修改对接网关接口地址 /external/server/modifygatewaymapping 请求格式 name M String 64 对接网关名称 password O String 64 对接网关注册密码 locktype O Integer 锁定类型 0: 无锁定 3: 全部锁定 calllevel O Integer 权限类型 1: 网内通话 2: 本地市话 4: 国内长途 5: 国际长途 capacity O Integer 线路上限 priority O Integer 优先级 gatewaygroups O String 所属网关群组 ( 逗号分隔多个群组名称 ) routinggatewaygroupsallo w O Boolean true: 允许使用落地群组 false: 禁止使用落地群组 routinggatewaygroups O String 限制的落地网关群组名称, 空串表示所有 registertype O Integer 注册类型 0: 静态 1: 动态 remoteips O String 对接网关 IP 地址列表 ( 逗号分隔多个 IP 地址 ) 48

55 callere164checkenable O Boolean true: 检查主叫号码规范性 false: 不检查主叫号码规范性 callere164checkcity O Boolean true: 允许主叫号码为城市号码 false: 不允许主叫号码为城市号码 callere164checkmobile O Boolean true: 允许主叫号码为移动号码 false: 不允许主叫号码为移动号码 callere164checkother O Boolean true: 允许主叫号码为非城市号码与非移动号码 false: 不允许主叫号码为非城市号码与非移动号码 calleee164checkenable O Boolean true: 检查被叫号码规范性 false: 不检查主叫号码规范性 calleee164checkcity O Boolean true: 允许被叫号码为城市号码 false: 不允许被叫号码为城市号码 calleee164checkmobile O Boolean true: 允许被叫号码为移动号码 false: 不允许被叫号码为移动号码 calleee164checkother O Boolean true: 允许被叫号码为非城市号码与非移动号码 false: 不允许被叫号码为非城市号码与非移动号码 49

56 customerpassword O String WEB 查询密码 rtpforwardtype O Integer 媒体转发类型 0: 自动 1: 开启 2: 关闭 mediacheckdirection O Integer 媒体中断检测 ( 仅在通话进行了媒体转发时有效 ) 0: 不检测 1: 检测是否有媒体报文传输给远端 2: 检测是否收到来自远端的媒体报文 3: 检测远端与本地有双向的媒体报文 calleee164restrict O Integer 被叫号码限制 0: 不限制 1: 限制被叫号码必须是平台存在的话机号码 2: 限制被叫号码必须不是平台存在的话机号码 maxcalldurationlower O Integer 大于 0: 最长通话时间下限 -1: 使用系统参数值 ( 需与 maxcalldurationupper 保持一致 ) 0: 无限制 ( 需与 maxcalldurationupper 保持一致 ) maxcalldurationupper O Integer 大于 0: 最长通话时间上限 -1: 使用系统参数值 ( 需与 maxcalldurationlower 保持 50

57 一致 ) 0: 无限制 ( 需与 maxcalldurationlower 保持一致 ) allowphonebilling O Boolean 当主叫号码与平台话机号码匹配, 可使用话机号码的账户对呼叫进行计费 allowbindede164billing O Boolean 当主叫号码与绑定号码匹配, 可使用绑定号码的账户对呼叫进行计费 enablephonesetting O Boolean 当主叫号码与平台话机号码匹配, 则主叫使用平台话机的配置进行后续处理 denysamecitycodesallow O Boolean true: 允许 denysamecitycodes 设置的区号进行同城呼叫 false: 禁止 denysamecitycodes 设置的区号进行同城呼叫 denysamecitycodes O String 同城呼叫功能限制的城市区号列表 ( 使用逗号分隔多个区号 ) checkmobileareaallow O Boolean true: 允许呼叫 checkmobilearea 设置的区号对应城市的移动号码 false: 禁止呼叫 checkmobilearea 设置的区号对应城市的移动号码 checkmobilearea O String 移动号码呼叫功能限制的城市区号列表 ( 使用逗号分隔 51

58 多个区号 ) calloutcalleeprefixesallow O Boolean true: 允许 calloutcalleeprefixes 设置的前缀列表作为被叫号码前缀 false: 禁止 calloutcalleeprefixes 设置的前缀列表作为被叫号码前缀 calloutcalleeprefixes O String 被叫号码限制功能中被叫号码前缀列表 ( 可使用逗号分隔 ) calloutcallerprefixesallow O Boolean true: 允许 calloutcallerprefixes 设置的前缀列表作为主叫号码前缀 false: 禁止 calloutcallerprefixes 设置的前缀列表作为主叫号码前缀 calloutcallerprefixes O String 主叫号码限制功能中主叫号码前缀列表 ( 可使用逗号分隔 ) rewriterulesoutcallee O String 被叫改写规则 rewriterulesoutcaller O String 主叫改写规则 rewriterulesinmobileareaal low O Boolean true: 开启 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 false: 关闭 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 rewriterulesinmobilearea O String 移动号码需改写的区号 ( 可 52

59 使用逗号分隔 ) timeoutcallproceeding O Integer 呼叫未振铃或接通允许的最长持续时长 ( 单位 : 秒 ) -1: 使用系统参数设置值 0: 无限制 sipresponseaddressmetho d O Integer SIP Response 信令的地址 0: 回应至原始请求的地址 1: 回应至原始请求的 IP, 但端口使用 Via 头部中标识的端口 siprequestaddressmethod O Integer SIP Request 信令的地址 0: 请求至原始请求的地址 1: 请求至原始请求的 IP, 但端口使用 Contact 头部中标识的端口 2: 请求至 Contact 头部中标识的地址 dtmfsendmethodh323 O Integer H323 协议, 软交换发送 DTMF 方式 0: 自动 10:RFC :H.245 alphanumeric 30:H.245 signal 40:Q.931 keypad 60: 关闭 dtmfsendmethodsip O Integer SIP 协议, 软交换发送 DTMF 方式 0: 自动 10:RFC :SIP Info 53

60 60: 关闭 dtmfreceivemethod O Integer 软交换接收主叫 DTMF 方式 0: 自动 10:RFC : 信令 30: 关闭 dtmfsendpayloadtypeh32 3 O Integer Dtmf 为 RFC2833 在 H323 协议时使用的 Payload Type dtmfsendpayloadtypesip O Integer Dtmf 为 RFC2833 在 SIP 协议时使用的 Payload Type dtmfreceivepayloadtype O Integer Dtmf 为 RFC2833 软交换接收 Dtmf 信号使用的 Payload Type q931progressindicator O Integer H323 协议中 Q931ProgressIndicator 的填写方式 -1: 自动 0: 关闭 1: ProgressNotEndToEndISD N 2: ProgressDestinationNonIS DN 3:ProgressOriginNotISDN 4: ProgressReturnedToISDN 5:ProgressServiceChange 8: ProgressInbandInformation Available 54

61 account O String 对接网关的计费账户号码 callfailedq931causevalue O String 将失败的终止原因转换为设定的 H323 终止原因, 格式为 < 原始终止原因 >:< 目标终止原因 > 原始终止原因 0: 其它目标终止原因 0: 不替换大于 0: 请参考 H323/SIP 协议通话中断定义规范 callfailedsipcode O String 将失败的终止原因转换为设定的 SIP 终止原因, 格式为 < 原始终止原因 >:< 目标终止原因 > 原始终止原因 0: 其它目标终止原因 0: 不替换大于 0: 请参考 H323/SIP 协议通话中断定义规范 sipremoteringsignal O Integer SIP 远端回铃信令 0: 自动 1:183+SDP 2:180+SDP sipcalleee164domain O Integer SIP 被叫号码取得方式 0: 从信令头部 To 中取得 1: 从信令头部 Invite 中取得 sipcallere164domain O Integer SIP 主叫号码取得方式 0: 从信令头部 From 中取得 1: 从信令头部 RemotePartId 中取得 2: 从信令头部 Display 中取得 h323calleee164domain O Integer H323 被叫号码取得方式 55

62 0: 从信令 CalledPartyNumber 中取得 1: 从信令 DestinationAddress 中取得 h323callere164domain O Integer H323 主叫号码取得方式 0: 从信令 CallingPartyNumber 中取得 1: 从信令 SourceAddress 中取得 2: 从信令 Display 中取得 memo O String 备注信息 sipauthenticationmethod O Integer SIP 呼叫认证方式 0: 根据 IP 地址认证 1: 根据 IP 地址与端口共同认证 2: 通过校验密码进行认证 h323faststart O Boolean true: 启用 H323 的 fast start 功能 false: 关闭 H323 的 fast start 功能 h323h245tunneling O Boolean true: 启用 H323 的 H245 tunneling 功能 false: 关闭 H323 的 H245 tunneling 功能 h323h245insetup O Boolean true: 在 H323 的 Setup 信令中包含 H245 信令 false: 在 H323 的 Setup 信令中不包含 H245 信令 h323autocallproceeding O Boolean true:h323 协议收到呼叫请求后立即回应 56

63 h323callproceedingfromsi PTrying h323alertingfromsip183sd p CallProceeding false:h323 协议收到呼叫后不立即回应 CallProceeding O Boolean 主叫为 H323 协议被叫为 SIP 协议时, 被叫接收 Trying 信令对应的主叫信令处理方式 true: 转换为 CallProceeding 回应主叫 false: 不进行信令转换 O Boolean 主叫为 H323 协议被叫为 SIP 协议时, 被叫接收 183+SDP 回应时对应的主叫处理方式 true: 转换为 Alerting 回应主叫 false: 转换为 CallProceeding 回应主叫 h323t38 O Boolean true:h323 协议时支持 T38 信令 false:h323 协议时忽略 T38 信令 siptimer O Boolean true: 支持 SIP Timer 协议 (RFC4028) false: 禁止 SIP Timer 协议 sip100rel O Boolean true: 支持 SIP 100rel 协议 false: 禁止 SIP 100rel 协议 sipt38 O Boolean true: 支持 SIP T38 协议 false: 禁止 SIP T38 协议 sipdisplay O Boolean true: 在向远端发送信令时包含 Display 头部 false: 在向远端发送信令时不包含 Display 57

64 头部 sipremotepartyid O Boolean true: 在向远端发送信令时包含 RemotePartyId 头部 false: 在向远端发送信令时不包含 RemotePartyId 头部 sipprivacysupport O Boolean true: 识别 Privacy false: 忽略 Privacy groupe164change O Boolean true: 启用号码变换功能 false: 关闭号码变换功能 callerallowlength O Integer 主叫号码允许的号码长度掩码 0: 表示允许所有长度 1<<x: 表示允许长度为 x 的号码 (x 小于 32) calleeallowlength O Integer 被叫号码允许的号码长度掩码 0: 表示允许所有长度 1<<x: 表示允许长度为 x 的号码 (x 小于 32) callerlimite164groupsallo w O Boolean true: 允许 callerlimite164groups 所设置的号码组作为主叫号码呼叫 false: 禁止 callerlimite164groups 所设置的号码组作为主叫号码呼叫 callerlimite164groups O String 主叫号码组列表 ( 可使用逗号分隔 ) calleelimite164groupsallo O Boolean true: 允许 58

65 w calleelimite164groups 所设置的号码组作为被叫号码呼叫 false: 禁止 calleelimite164groups 所设置的号码组作为被叫号码呼叫 calleelimite164groups O String 被叫号码组列表 ( 可使用逗号分隔 ) minprofitpercentenable O Boolean 是否开启最低利润率限制 minprofitpercent O Integer 最低利润率限制若设置为 10 表示利润率为 10% 取值范围至 maxsecondratesenable O Boolean 最高秒费率限制 true: 开启 false 关闭 maxsecondrates O Double 最高秒费率值 ( 若分钟费率为 0.6, 此值应该设置为 0.01) firstroutepolicy O Integer 第一路由策略 : 0: 无 1: 接通率 2: 最小秒费率 secondroutepolicy O Integer 第二路由策略 : 0: 无 1: 接通率 2: 最小秒费率 h323g729sendmode O Integer H323 G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 59

66 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729sendmode O Integer SIP G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729annexb O Integer G729 annexb 参数填写方式 0: 自动 1:annex=yes 2:annex=no 3: 无 annex 4: 透传对端的 annex sipg723annexa O Integer G723 annexa 参数填写方式 0: 自动 1:annex=yes 2:annex=no 3: 无 annex 4: 透传对端的 annex h323codecassign O Boolean true: 限制 H323 音频 / 视频编码为 h323codecs 设定值 false: 软交换自动协商 h323codecs O Vector<String> H323 音频 / 视频列表 sipcodecassign O Boolean true: 限制 SIP 音频 / 视频编码为 SIPCodecs 设定值 60

67 false: 软交换自动协商 sipcodecs O Vector<String> SIP 音频 / 视频列表 forwardsignalrewritee164 GroupEnable O Boolean true: 开启呼叫前转信令改写 false: 关闭呼叫前转信令改写 forwardsignalrewritee164 Group O String 255 呼叫前转信令改使用的号码群组名称 lrnenable O Boolean LRN 查询 true: 启用 false: 禁用 lrneatprefixlength O Integer LRN 查询时忽略被叫号码前缀的长度 lrnfailureaction O Integer 查询失败后的行为 0: 拒绝此次呼叫 1: 使用原有号码继续后续处理 lrninterstatebillingprefix O String LRN 查询后非同地区计费前缀 lrnundeterminedbillingprefi x O String LRN 查询后有一个或两个号码无法获知其地区时的计费前缀 language O String 无法接通提示所使用的语言返回格式 retcode M int 返回码 exception O String 错误原因 61

68 2.12 查询对接网关接口地址 /external/server/getgatewaymapping 请求格式 names M String [] 网关名称不设置表示获取所有对接网关信息返回格式 retcode M int 返回码 exception O String 错误原因 infogatewaymappings O InfoGatewayMapping [] 话机信息类型 InfoGatewayMapping 格式 name M String 64 对接网关名称 locktype M int 锁定类型 0: 无锁定 1: 锁定呼出 2: 锁定呼入 3: 全部锁定 calllevel M int 权限类型 1: 网内通话 2: 本地市话 4: 国内长途 5: 国际长途 capacity M int 线路上限 62

69 priority M int 优先级 gatewaygroups M String 所属网关群组 ( 逗号分隔多个群组名称 ) routinggatewaygroupsallo w M boolean true: 允许使用落地群组 false: 禁止使用落地群组 routinggatewaygroups M String 限制的落地网关群组名称, 空串表示所有 registertype M int 注册类型 0: 静态 1: 动态 remoteips M String 对接网关 IP 地址列表 ( 逗号分隔多个 IP 地址 ) callere164checkenable M boolean true: 检查主叫号码规范性 false: 不检查主叫号码规范性 callere164checkcity M boolean true: 允许主叫号码为城市号码 false: 不允许主叫号码为城市号码 callere164checkmobile M boolean true: 允许主叫号码为移动号码 false: 不允许主叫号码为移动号码 callere164checkother M boolean true: 允许主叫号码为非城市号码与非移动号码 false: 不允许主叫号码为非城市号码与非移动号码 calleee164checkenable M boolean true: 检查主叫号码规范性 false: 不检查主叫号码规范性 63

70 calleee164checkcity M boolean true: 允许主叫号码为城市号码 false: 不允许主叫号码为城市号码 calleee164checkmobile M boolean true: 允许主叫号码为移动号码 false: 不允许主叫号码为移动号码 calleee164checkother M boolean true: 允许主叫号码为非城市号码与非移动号码 false: 不允许主叫号码为非城市号码与非移动号码 rtpforwardtype M int 媒体转发类型 0: 自动 1: 开启 2: 关闭 mediacheckdirection M int 媒体中断检测 ( 仅在通话进行了媒体转发时有效 ) 0: 不检测 1: 检测是否有媒体报文传输给远端 2: 检测是否收到来自远端的媒体报文 3: 检测远端与本地有双向的媒体报文 calleee164restrict M int 被叫号码限制 0: 不限制 1: 限制被叫号码必须是平台存在的话机号码 2: 限制被叫号码必须不是平 64

71 台存在的话机号码 maxcalldurationlower M int 大于 0: 最长通话时间下限 -1: 使用系统参数值 ( 需与 maxcalldurationupper 保持一致 ) 0: 无限制 ( 需与 maxcalldurationupper 保持一致 ) maxcalldurationupper M int 大于 0: 最长通话时间上限 -1: 使用系统参数值 ( 需与 maxcalldurationlower 保持一致 ) 0: 无限制 ( 需与 maxcalldurationlower 保持一致 ) allowphonebilling M boolean 当主叫号码与平台话机号码匹配, 可使用话机号码的账户对呼叫进行计费 allowbindede164billing M boolean 当主叫号码与绑定号码匹配, 可使用绑定号码的账户对呼叫进行计费 enablephonesetting M boolean 当主叫号码与平台话机号码匹配, 则主叫使用平台话机的配置进行后续处理 denysamecitycodesallow M boolean true: 允许 denysamecitycodes 设置的区号进行同城呼叫 false: 禁止 denysamecitycodes 设置的区号进行同城呼叫 65

72 denysamecitycodes M String 同城呼叫功能限制的城市区号列表 ( 使用逗号分隔多个区号 ) checkmobileareaallow M boolean true: 允许呼叫 checkmobilearea 设置的区号对应城市的移动号码 false: 禁止呼叫 checkmobilearea 设置的区号对应城市的移动号码 checkmobilearea M String 移动号码呼叫功能限制的城市区号列表 ( 使用逗号分隔多个区号 ) calloutcalleeprefixesallow M boolean true: 允许 calloutcalleeprefixes 设置的前缀列表作为被叫号码前缀 false: 禁止 calloutcalleeprefixes 设置的前缀列表作为被叫号码前缀 calloutcalleeprefixes M String 被叫号码限制功能中被叫号码前缀列表 ( 可使用逗号分隔 ) calloutcallerprefixesallow M boolean true: 允许 calloutcallerprefixes 设置的前缀列表作为主叫号码前缀 false: 禁止 calloutcallerprefixes 设置的前缀列表作为主叫号码前缀 calloutcallerprefixes M String 主叫号码限制功能中主叫号码前缀列表 ( 可使用逗号分隔 ) 66

73 rewriterulesoutcallee M String 被叫改写规则 rewriterulesoutcaller M String 主叫改写规则 rewriterulesinmobileareaal low M boolean true: 开启 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 false: 关闭 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 rewriterulesinmobilearea M String 移动号码需改写的区号 ( 可使用逗号分隔 ) timeoutcallproceeding M int 呼叫未振铃或接通允许的最长持续时长 ( 单位 : 秒 ) -1: 使用系统参数设置值 0: 无限制 sipresponseaddressmetho d M int SIP Response 信令的地址 0: 回应至原始请求的地址 1: 回应至原始请求的 IP, 但端口使用 Via 头部中标识的端口 siprequestaddressmethod M int SIP Request 信令的地址 0: 请求至原始请求的地址 1: 请求至原始请求的 IP, 但端口使用 Contact 头部中标识的端口 2: 请求至 Contact 头部中标识的地址 dtmfsendmethodh323 M int H323 协议, 软交换发送 DTMF 方式 67

74 0: 自动 10:RFC :H.245 alphanumeric 30:H.245 signal 40:Q.931 keypad 60: 关闭 dtmfsendmethodsip M int SIP 协议, 软交换发送 DTMF 方式 0: 自动 10:RFC :SIP Info 60: 关闭 dtmfreceivemethod M int 软交换接收主叫 DTMF 方式 0: 自动 10:RFC : 信令 30: 关闭 dtmfsendpayloadtypeh32 3 M int Dtmf 为 RFC2833 在 H323 协议时使用的 Payload Type dtmfsendpayloadtypesip M int Dtmf 为 RFC2833 在 SIP 协议时使用的 Payload Type dtmfreceivepayloadtype M int Dtmf 为 RFC2833 软交换接收 Dtmf 信号使用的 Payload Type q931progressindicator M int H323 协议中 Q931ProgressIndicator 的填写方式 -1: 自动 0: 关闭 1: 68

75 ProgressNotEndToEndISD N 2: ProgressDestinationNonIS DN 3:ProgressOriginNotISDN 4: ProgressReturnedToISDN 5:ProgressServiceChange 8: ProgressInbandInformation Available account M String 对接网关的计费账户号码 accountname M String 对接网关的计费账户名称 password M String 对接网关注册密码 customerpassword M String 对接网关 web 查询密码 callfailedq931causevalue M String 将失败的终止原因转换为设定的 H323 终止原因, 格式为 < 原始终止原因 >:< 目标终止原因 > 原始终止原因 0: 其它目标终止原因 0: 不替换大于 0: 请参考 H323/SIP 协议通话中断定义规范 callfailedsipcode M String 将失败的终止原因转换为设定的 SIP 终止原因, 格式为 < 原始终止原因 >:< 目标终止原因 > 原始终止原因 0: 其它目标终止原因 0: 不替换大于 0: 请参考 H323/SIP 协议 69

76 通话中断定义规范 sipremoteringsignal M int SIP 远端回铃信令 0: 自动 1:183+SDP 2:180+SDP sipcalleee164domain M int SIP 被叫号码取得方式 0: 从信令头部 To 中取得 1: 从信令头部 Invite 中取得 sipcallere164domain M int SIP 主叫号码取得方式 0: 从信令头部 From 中取得 1: 从信令头部 RemotePartId 中取得 2: 从信令头部 Display 中取得 h323calleee164domain M int H323 被叫号码取得方式 0: 从信令 CalledPartyNumber 中取得 1: 从信令 DestinationAddress 中取得 h323callere164domain M int H323 主叫号码取得方式 0: 从信令 CallingPartyNumber 中取得 1: 从信令 SourceAddress 中取得 2: 从信令 Display 中取得 memo M String 备注信息 sipauthenticationmethod M int SIP 呼叫认证方式 0: 根据 IP 地址认证 1: 根据 IP 地址与端口共同认证 2: 通过校验密码进行认证 70

77 h323faststart M boolean true: 启用 H323 的 fast start 功能 false: 关闭 H323 的 fast start 功能 h323h245tunneling M boolean true: 启用 H323 的 H245 tunneling 功能 false: 关闭 H323 的 H245 tunneling 功能 h323h245insetup M boolean true: 在 H323 的 Setup 信令中包含 H245 信令 false: 在 H323 的 Setup 信令中不包含 H245 信令 h323autocallproceeding M boolean true:h323 协议收到呼叫请求后立即回应 CallProceeding false:h323 协议收到呼叫后不立即回应 CallProceeding h323callproceedingfromsi PTrying h323alertingfromsip183sd p M boolean 主叫为 H323 协议被叫为 SIP 协议时, 被叫接收 Trying 信令对应的主叫信令处理方式 true: 转换为 CallProceeding 回应主叫 false: 不进行信令转换 M boolean 主叫为 H323 协议被叫为 SIP 协议时, 被叫接收 183+SDP 回应时对应的主叫处理方式 true: 转换为 Alerting 回应主叫 false: 转换为 CallProceeding 回应主叫 71

78 h323t38 M boolean true:h323 协议时支持 T38 信令 false:h323 协议时忽略 T38 信令 siptimer M boolean true: 支持 SIP Timer 协议 (RFC4028) false: 禁止 SIP Timer 协议 sip100rel M boolean true: 支持 SIP 100rel 协议 false: 禁止 SIP 100rel 协议 sipt38 M boolean true: 支持 SIP T38 协议 false: 禁止 SIP T38 协议 sipdisplay M boolean true: 在向远端发送信令时包含 Display 头部 false: 在向远端发送信令时不包含 Display 头部 sipremotepartyid M boolean true: 在向远端发送信令时包含 RemotePartyId 头部 false: 在向远端发送信令时不包含 RemotePartyId 头部 sipprivacysupport O Boolean true: 识别 Privacy false: 忽略 Privacy groupe164change M boolean true: 启用号码变换功能 false: 关闭号码变换功能 callerallowlength M int 主叫号码允许的号码长度 calleeallowlength M int 被叫号码允许的号码长度 callerlimite164groupsallo w M boolean true: 允许 callerlimite164groups 所设置的号码组作为主叫号码呼叫 false: 禁止 72

79 callerlimite164groups 所设置的号码组作为主叫号码呼叫 callerlimite164groups M String 主叫号码组列表 ( 可使用逗号分隔 ) calleelimite164groupsallo w M boolean true: 允许 calleelimite164groups 所设置的号码组作为被叫号码呼叫 false: 禁止 calleelimite164groups 所设置的号码组作为被叫号码呼叫 calleelimite164groups M String 被叫号码组列表 ( 可使用逗号分隔 ) minprofitpercentenable M boolean 是否开启最低利润率限制 minprofitpercent M int 最低利润率限制若设置为 10 表示利润率为 10% 取值范围至 maxsecondratesenable M boolean 最高秒费率限制 true: 开启 false 关闭 maxsecondrates M double 最高秒费率值 firstroutepolicy M int 第一路由策略 : 0: 无 1: 接通率 2: 最小秒费率 secondroutepolicy M int 第二路由策略 : 0: 无 73

80 1: 接通率 2: 最小秒费率 h323g729sendmode M int H323 G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729sendmode M int SIP G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729annexb M int G729 annexb 参数填写方式 0: 自动 1:annex=yes 2:annex=no 3: 无 annex 4: 透传对端的 annex sipg723annexa M int G723 annexa 参数填写方式 0: 自动 1:annex=yes 2:annex=no 3: 无 annex 4: 透传对端的 annex 74

81 h323codecassign M boolean true: 限制 H323 音频 / 视频编码为 h323codecs 设定值 false: 软交换自动协商 h323codecs M Vector<String> H323 音频 / 视频列表 sipcodecassign M boolean true: 限制 SIP 音频 / 视频编码为 SIPCodecs 设定值 false: 软交换自动协商 sipcodecs M Vector<String> SIP 音频 / 视频列表 softswitchname M String 软交换名称未设置 : 表示不属于任何软交换空串 : 表示属于所有软交换 forwardsignalrewritee164 GroupEnable forwardsignalrewritee164 Group M boolean true: 开启呼叫前转信令改写 false: 关闭呼叫前转信令改写 M String 255 呼叫前转信令改使用的号码群组名称 lrnenable M boolean LRN 查询 true: 启用 false: 禁用 lrneatprefixlength M int LRN 查询时忽略被叫号码前缀的长度 lrnfailureaction M int 查询失败后的行为 0: 拒绝此次呼叫 1: 使用原有号码继续后续处理 lrninterstatebillingprefix M String LRN 查询后非同地区计费前缀 lrnundeterminedbillingprefi M String LRN 查询后有一个或两个号码无法获知其地区时的计费 75

82 x language M String 无法接通提示所使用的语言前缀 76

83 2.13 删除对接网关接口地址 /external/server/deletegatewaymapping 请求格式 name M String 对接网关名称返回格式 retcode M int 返回码 exception O String 错误原因 77

84 2.14 查询在线对接网关接口地址 /external/server/getgatewaymappingonline 请求格式 names O String [] 对接网关名称不设置 : 表示此过滤条件无效 softswitchname O String 软交换名称不设置 : 表示此过滤条件无效, 查询所有的软交换返回格式 retcode M int 返回码 exception O String 错误原因 infogatewaymappingonline s O InfoGatewayMappingOnline [] 套餐订单列表类型 InfoGatewayMappingOnline 格式 id M int 对接网关 ID name M String 对接网关名称 currentcall M int 当前呼叫总数 capacity M int 呼叫线路上限 asr M double 呼叫应答率 acd M long 平均通话时长 ( 单位 : 秒 ) remoteips M String 远端地址 ( 逗号分隔多个 IP) natip O String NAT 内部地址, 仅在网关与 78

85 软交换间存在地址转换设备时有效 localip M String 注册本地地址 registertime M long 注册时间 (UTC 至今的毫秒数 ) 0: 静态网关 updatetime M long 上次更新时间 (UTC 至今的毫秒数 ) 0: 静态网关 keeptime M long 在线时间 ( 单位 : 秒 ) 0: 静态网关 cryptotype M int 加密类型 0: 未加密 1:RC4 softswitchname M String 软交换名称 softswitchip M String 软交换 IP 79

86 2.15 创建落地网关接口地址 /external/server/creategatewayrouting 请求格式 name M String 64 落地网关名称 prefix O String 落地网关前缀 ( 可使用逗号分隔 ) prefixstyle O Integer 前缀匹配方式 0: 终结模式 1: 延续模式 password O String 落地网关注册密码 customerpassword O String 落地网关 web 查询密码 gatewaygroups O String 所属网关群组 ( 逗号分隔多个群组名称 ) capacity O Integer 线路上限 locktype O Integer 锁定类型 0: 无锁定 3: 全部锁定 priority O Integer 优先级 registertype O Integer 注册类型 0: 静态 1: 动态 2: 注册 ( 向其他平台进行注册 ) remoteip O String 64 落地网关远端地址 rtpforwardtype O Integer 媒体转发类型 0: 自动 80

87 1: 开启 2: 关闭 encrypt O Boolean true: 加密 false: 不加密 protocol O Integer 信令协议 0:H323 1:SIP signalport O Integer 信令端口 localip O String 64 本地地址空 : 表示由系统自行选择本地地址 mediacheckdirection O Integer 媒体中断检测 ( 仅在通话进行了媒体转发时有效 ) 0: 不检测 1: 检测是否有媒体报文传输给远端 2: 检测是否收到来自远端的媒体报文 3: 检测远端与本地有双向的媒体报文 maxcalldurationlower O Integer 大于 0: 最长通话时间下限 -1: 使用系统参数值 ( 需与 maxcalldurationupper 保持一致 ) 0: 无限制 ( 需与 maxcalldurationupper 保持一致 ) maxcalldurationupper O Integer 大于 0: 最长通话时间上限 -1: 使用系统参数值 ( 需与 maxcalldurationlower 保持 81

88 一致 ) 0: 无限制 ( 需与 maxcalldurationlower 保持一致 ) calleee164restrict O Integer 被叫号码限制 0: 不限制 1: 限制被叫号码必须是平台存在的话机号码 2: 限制被叫号码必须不是平台存在的话机号码 callere164checkenable O Boolean true: 检查主叫号码规范性 false: 不检查主叫号码规范性 callere164checkcity O Boolean true: 允许主叫号码为城市号码 false: 不允许主叫号码为城市号码 callere164checkmobile O Boolean true: 允许主叫号码为移动号码 false: 不允许主叫号码为移动号码 callere164checkother O Boolean true: 允许主叫号码为非城市号码与非移动号码 false: 不允许主叫号码为非城市号码与非移动号码 calleee164checkenable O Boolean true: 检查被叫号码规范性 false: 不检查被叫号码规范性 calleee164checkcity O Boolean true: 允许被号码为城市号码 false: 不允许被叫号码为城 82

89 市号码 calleee164checkmobile O Boolean true: 允许被叫号码为移动号码 false: 不允许被叫号码为移动号码 calleee164checkother O Boolean true: 允许被叫号码为非城市号码与非移动号码 false: 不允被主叫号码为非城市号码与非移动号码 callincallerprefixesallow O Boolean true: 允许 callincallerprefixes 设置的前缀列表作为主叫号码前缀 false: 禁止 callincallerprefixes 设置的前缀列表作为主叫号码前缀 callincallerprefixes O String 主叫号码限制功能中主叫号码前缀列表 ( 可使用逗号分隔 ) callincalleeprefixesallow O Boolean true: 允许 callincalleeprefixes 设置的前缀列表作为被叫号码前缀 false: 禁止 callincalleeprefixes 设置的前缀列表作为被叫号码前缀 callincalleeprefixes O String 被叫号码限制功能中被叫号码前缀列表 ( 可使用逗号分隔 ) callinforwardprefixesallow O Boolean true: 允许 callinforwardprefixes 设置的前缀列表作为前转号码前 83

90 缀 false: 禁止 callinforwardprefixes 设置的前缀列表作为前转号码前缀 callinforwardprefixes O String 前转号码限制功能中前转号码前缀列表 ( 可使用逗号分隔 ) rewriterulesincaller O String 主叫改写规则 rewriterulesincallee O String 被叫改写规则 rewriterulesinmobileareaal low O Boolean true: 开启 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 false: 关闭 rewriterulesinmobilearea 所设置的区号对应城市的移动号码改写 rewriterulesinmobilearea O String 移动号码需改写的区号 ( 可使用逗号分隔 ) timeoutsetup O Integer H323 Setup 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 timeoutcallproceeding O Integer H323 CallProceeding 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 timeoutcallproceedingolc O Integer H323 CallProceeding 包含 Open Logical Channel 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 84

91 timeoutalerting O Integer H323 Alerting 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 timeoutinvite O Integer SIP Invite 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 timeouttrying O Integer SIP Trying 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 timeoutsessionprogresssd p O Integer SIP SessionProgress 含 SDP 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 timeoutsessionprogress O Integer SIP SessionProgress 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 timeoutringing O Integer SIP Ring 超时时间 ( 单位 : 秒 ) 0: 表示使用系统参数设定值 denycallercalleeallow O Boolean true: 允许 denycallercallee 设置的主叫向对应被叫进行呼叫 false: 禁止 denycallercallee 设置的主向叫对应被叫进行呼叫 denycallercallee O String 主叫向对应被叫进行呼叫的限制列表格式为 [< 主叫号码 >:< 被叫号码 >[,< 主叫号码 >:< 被叫号码 >] ] 例如 :025:010,021:023 denysamecitycodesallow O Boolean true: 允许 denysamecitycodes 设置的 85

92 区号进行同城呼叫 false: 禁止 denysamecitycodes 设置的区号进行同城呼叫 denysamecitycodes O String 同城呼叫功能限制的城市区号列表 ( 使用逗号分隔多个区号 ) checkmobileareaallow O Boolean true: 允许呼叫 checkmobilearea 设置的区号对应城市的移动号码 false: 禁止呼叫 checkmobilearea 设置的区号对应城市的移动号码 checkmobilearea O String 移动号码呼叫功能限制的城市区号列表 ( 使用逗号分隔多个区号 ) stopswitchafterolc O Integer H323 协议时, 当信令内包含 OpenLogicalChanel 时的后续处理方式 0: 使用系统参数定制值 1: 不再进行后续网关切换 2: 继续后续网关切换 stopswitchaftersdp O Integer SIP 协议时, 当信令内包含 Sdp 时的后续处理方式 0: 使用系统参数定制值 1: 不再进行后续网关切换 2: 继续后续网关切换 stopswitchafterrtpstart O Integer 当在媒体转发时收到来自远端的媒体报文时的后续处理方式 86

93 0: 使用系统参数定制值 1: 不再进行后续网关切换 2: 继续后续网关切换 stopswitchafterrtpstart O Integer 当收到被叫忙后的后续处理方式 0: 使用系统参数定制值 1: 不再进行后续网关切换 2: 继续后续网关切换 switchuntilconnect O Integer 忽略信令状态, 进行后续网关切换 0: 使用系统参数定制值 1: 忽略信令状态, 在未接通前可继续后续网关切换 2: 根据信令状态决定后续网关的切换 sipresponseaddressmetho d O Integer SIP Response 信令的地址 0: 回应至原始请求的地址 1: 回应至原始请求的 IP, 但端口使用 Via 头部中标识的端口 siprequestaddressmethod O Integer SIP Request 信令的地址 0: 请求至原始请求的地址 1: 请求至原始请求的 IP, 但端口使用 Contact 头部中标识的端口 2: 请求至 Contact 头部中标识的地址 dtmfsendmethodh323 O Integer H323 协议, 软交换发送 DTMF 方式 0: 自动 87

94 10:RFC :H.245 alphanumeric 30:H.245 signal 40:Q.931 keypad 60: 关闭 dtmfsendmethodsip O Integer SIP 协议, 软交换发送 DTMF 方式 0: 自动 10:RFC :SIP Info 60: 关闭 dtmfreceivemethod O Integer 软交换接收主叫 DTMF 方式 0: 自动 10:RFC : 信令 30: 关闭 dtmfsendpayloadtypeh32 3 O Integer Dtmf 为 RFC2833 在 H323 协议时使用的 Payload Type dtmfsendpayloadtypesip O Integer Dtmf 为 RFC2833 在 SIP 协议时使用的 Payload Type dtmfreceivepayloadtype O Integer Dtmf 为 RFC2833 软交换接收 Dtmf 信号使用的 Payload Type q931numberingplan O Integer Q931NumberingPlan -1: 默认, 使用系统参数设定 0:UnknownPlan 1:ISDNPlan 3:DataPlan 4:TelexPlan 8:NationalStandardPlan 88

95 9:PrivatePlan 15:ReservedPlan q931numbertype O Integer Q931NumberType -1: 默认, 使用系统参数设定 0:UnknownType 1:InternationalType 2:NationalType 3:NetworkSpecificType 4:SubscriberType 6:AbbreviatedType 7:ReservedType q931presentationindicator O Integer Q931PresentationIndicator -1: 默认, 使用系统参数设定 0:Presentation allowed 1:Presentation restricted 2:Number not available due to interworking 3:Reserved 4: 无 q931screeningindicator O Integer Q931ScreeningIndicator -1: 默认, 使用系统参数设定 0:User-provided,not screened 1:User-provided,verified and passed 2:User-provided,verified and failed 3:Network provided 4: 无 clearingaccount O String 64 结算账户名称 h323faststart O Boolean true: 启用 H323 的 fast start 89

96 功能 false: 关闭 H323 的 fast start 功能 h323h245tunneling O Boolean true: 启用 H323 的 H245 tunneling 功能 false: 关闭 H323 的 H245 tunneling 功能 h323h245insetup O Boolean true: 在 H323 的 Setup 信令中包含 H245 信令 false: 在 H323 的 Setup 信令中不包含 H245 信令 h323t38 O Boolean true:h323 协议时支持 T38 信令 false:h323 协议时忽略 T38 信令 siptimer O Boolean true: 支持 SIP Timer 协议 (RFC4028) false: 禁止 SIP Timer 协议 sip100rel O Boolean true: 支持 SIP 100rel 协议 false: 禁止 SIP 100rel 协议 sipt38 O Boolean true: 支持 SIP T38 协议 false: 禁止 SIP T38 协议 sipdisplay O Boolean true: 在向远端发送信令时包含 Display 头部 false: 在向远端发送信令时不包含 Display 头部 sipremotepartyid O Boolean true: 在向远端发送信令时包含 RemotePartyId 头部 false: 在向远端发送信令时不包含 RemotePartyId 头部 90

97 sipprivacy O Integer 0: 无 1: 透传 2:id sipppreferredidentity O Integer 0: 无 1: 透传 2: 主叫号码 sippassertedidentity O Integer 0: 无 1: 透传 2: 主叫号码 groupe164change O Boolean true: 启用号码变换功能 false: 关闭号码变换功能 callerallowlength O Integer 主叫号码允许的号码长度掩码 0: 表示允许所有长度 1<<x: 表示允许长度为 x 的号码 (x 小于 32) calleeallowlength O Integer 被叫号码允许的号码长度掩码 0: 表示允许所有长度 1<<x: 表示允许长度为 x 的号码 (x 小于 32) callerlimite164groupsallo w O Boolean true: 允许 callerlimite164groups 所设置的号码组作为主叫号码呼叫 false: 禁止 callerlimite164groups 所设置的号码组作为主叫号码呼叫 callerlimite164groups O String 255 主叫号码组列表 ( 可使用逗 91

98 号分隔 ) calleelimite164groupsallo w O Boolean true: 允许 calleelimite164groups 所设置的号码组作为被叫号码呼叫 false: 禁止 calleelimite164groups 所设置的号码组作为被叫号码呼叫 calleelimite164groups O String 255 被叫号码组列表 ( 可使用逗号分隔 ) h323g729sendmode O Integer H323 G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729sendmode O Integer SIP G729 协商模式 0: 自动 1: 将 G729a 与 G729 当作 G729 协商 2: 将 G729a 与 G729 当作 G729a 协商 3: 将 G729 或 G729 作为 G729 与 G729a 进行协商 sipg729annexb O Integer G729 annexb 参数填写方式 0: 自动 1:annex=yes 92

99 2:annex=no 3: 无 annex 4: 透传对端的 annex sipg723annexa O Integer G723 annexa 参数填写方式 0: 自动 1:annex=yes 2:annex=no 3: 无 annex 4: 透传对端的 annex h323codecassign O Boolean true: 限制 H323 音频 / 视频编码为 h323codecs 设定值 false: 软交换自动协商 h323codecs O Vector<String> H323 音频 / 视频列表 sipcodecassign O Boolean true: 限制 SIP 音频 / 视频编码为 SIPCodecs 设定值 false: 软交换自动协商 sipcodecs O Vector<String> SIP 音频 / 视频列表 feeraterestrict O Boolean true: 校验被叫号码费率 false: 不校验费率 leastcostrouting O Boolean 最低秒费率排序 ( 在 feeraterestrict 为 true 时有效 ) true: 启用 false: 关闭 minprofitpercentenable O Boolean feeraterestrict 为 true 时有效是否开启最低利润率限制 minprofitpercent O Integer 最低利润率限制若设置为 10 表示利润率为 10% 取值范围至

展开

VOS3000_VOS2009 操作指南

VOS3000_VOS2009 操作指南资料编码 VOS3000/VOS2009 V2.1.6.00 文档版本 01 发布日期 2015-04-08 昆石网络技术有限公司版权所有昆石网络技术有限公司 2013 保留一切权利非经本公司书面许可, 任何单位和个人不得擅自摘抄复制本文档内容的部分或全部, 并不得以任何形式传播商标声明和其他昆石商标均为昆石网络技术有限公司的商标本文档提及的其他所有商标或注册商标, 由各自的所有人拥有