vos3000webinterface forthirdparty - linknat web interface man… · 3 memo o string 255 memo...
Post on 13-Apr-2018
242 Views
Preview:
TRANSCRIPT
VOS3000 Web InterfaceFor Third Party
Version 2.1.7.0
Kunshi Network Technology Co., Ltd.www.linknat.com
2017.05
Contents
1 Descriptions............................................................................................................................................................................................................................................. 12 Receive Request.......................................................................................................................................................................................................................................2
2.1 Create Customer.............................................................................................................................................................................................................................. 22.2 Modify Customer.............................................................................................................................................................................................................................52.3 Delete Customer.............................................................................................................................................................................................................................. 72.4 Get Customer...................................................................................................................................................................................................................................82.5 Create Phone..................................................................................................................................................................................................................................102.6 Modify Phone................................................................................................................................................................................................................................ 222.7 Delete Phone..................................................................................................................................................................................................................................242.8 Get Phone...................................................................................................................................................................................................................................... 252.9 Get Online Phone.......................................................................................................................................................................................................................... 282.10 Create Gateway Mapping..............................................................................................................................................................................................................292.11 Modify Mapping Gateway............................................................................................................................................................................................................ 402.12 Get Mapping Gateway...................................................................................................................................................................................................................512.13 Delete Mapping Gateway..............................................................................................................................................................................................................622.14 Get Online Mapping Gateway.......................................................................................................................................................................................................632.15 Create Routing Gateway............................................................................................................................................................................................................... 652.16 Modify Routing Gateway..............................................................................................................................................................................................................782.17 Delete Routing Gateway............................................................................................................................................................................................................... 902.18 Get Routing Gateway.................................................................................................................................................................................................................... 912.19 Get Online Routing Gateway...................................................................................................................................................................................................... 1032.20 Get Current Call.......................................................................................................................................................................................................................... 1052.21 Pay............................................................................................................................................................................................................................................... 1082.22 Create Suite..................................................................................................................................................................................................................................1092.23 Delete Suite..................................................................................................................................................................................................................................1112.24 Get Suite...................................................................................................................................................................................................................................... 1122.25 Create Suite Order....................................................................................................................................................................................................................... 1132.26 Modify Suite Order......................................................................................................................................................................................................................1142.27 Delete Suite Order....................................................................................................................................................................................................................... 1152.28 Get Suite Order............................................................................................................................................................................................................................116
2.29 Get Current Suite.........................................................................................................................................................................................................................1172.30 Delete Current Suite.................................................................................................................................................................................................................... 1182.31 Create Active Phone Card........................................................................................................................................................................................................... 1192.32 Modify Active Phone Card..........................................................................................................................................................................................................1202.33 Delete Active Phone Card........................................................................................................................................................................................................... 1212.34 Get Active Phone Card................................................................................................................................................................................................................ 1222.35 Create Binded E164.....................................................................................................................................................................................................................1232.36 Modify Binded E164................................................................................................................................................................................................................... 1242.37 Delete Binded E164.....................................................................................................................................................................................................................1252.38 Get Binded E164..........................................................................................................................................................................................................................1262.39 Get Fee Rate Group..................................................................................................................................................................................................................... 1272.40 Create Fee Rate Group................................................................................................................................................................................................................ 1282.41 Modify Fee Rate Group...............................................................................................................................................................................................................1292.42 Delete Fee Rate Group................................................................................................................................................................................................................ 1302.43 Get Fee Rate................................................................................................................................................................................................................................ 1312.44 Get E164 Convert........................................................................................................................................................................................................................ 1332.45 Get Pay History............................................................................................................................................................................................................................1342.46 Get Cdr.........................................................................................................................................................................................................................................1362.47 Get Customer Fee Report............................................................................................................................................................................................................ 1392.48 Get Phone Fee Report..................................................................................................................................................................................................................1412.49 Get Customer Location Fee Report.............................................................................................................................................................................................1432.50 Create CDR..................................................................................................................................................................................................................................1452.51 Get Customer Phone Book.......................................................................................................................................................................................................... 1472.52 Create Customer Phone Book..................................................................................................................................................................................................... 1492.53 Modify Customer Phone Book....................................................................................................................................................................................................1502.54 Delete Customer Phone Book..................................................................................................................................................................................................... 1512.55 Get Soft Switch............................................................................................................................................................................................................................1522.56 Get Performance.......................................................................................................................................................................................................................... 1532.57 Pay By Phone Card......................................................................................................................................................................................................................1542.58 Phone Card Active.......................................................................................................................................................................................................................1552.59 Callback....................................................................................................................................................................................................................................... 1562.60 Play Audio................................................................................................................................................................................................................................... 1582.61 Get Available Time......................................................................................................................................................................................................................1592.62 Get IVR Second Available Time.................................................................................................................................................................................................161
2.63 Get Consumption.........................................................................................................................................................................................................................1632.64 Get All Customers....................................................................................................................................................................................................................... 1642.65 Reserve CalleeE164.....................................................................................................................................................................................................................1652.66 Create LimitedE164.....................................................................................................................................................................................................................1662.67 Create IvrAudio........................................................................................................................................................................................................................... 1672.68 Modify IvrAudio..........................................................................................................................................................................................................................1682.69 Delete IvrAudio........................................................................................................................................................................................................................... 1692.70 Get IvrAudio................................................................................................................................................................................................................................1702.71 Modify IvrAudio Data................................................................................................................................................................................................................. 1722.72 Create E164Convert.................................................................................................................................................................................................................... 1732.73 Modify E164Convert...................................................................................................................................................................................................................1742.74 Delete E164Convert.................................................................................................................................................................................................................... 1752.75 Disconnect Current Call.............................................................................................................................................................................................................. 1762.76 GetAllPhoneOnline..................................................................................................................................................................................................................... 1772.77 DeleteLimitE164..........................................................................................................................................................................................................................1782.78 Get Phone Card............................................................................................................................................................................................................................1792.79 Create Alarm................................................................................................................................................................................................................................1812.80 CreateMediaBlockIp....................................................................................................................................................................................................................1822.81 DeleteMediaBlockIp....................................................................................................................................................................................................................1832.82 GetAlarmCurrent......................................................................................................................................................................................................................... 184
3 Send Request........................................................................................................................................................................................................................................1863.1 IVR Request Push DTMF Information....................................................................................................................................................................................... 1863.2 IVR Request Push DTMF Information 2.................................................................................................................................................................................... 1873.3 Phone Online/offline Report........................................................................................................................................................................................................1883.4 Call State Report..........................................................................................................................................................................................................................1893.5 Customer Money Change............................................................................................................................................................................................................ 1913.6 Current Alarm Report..................................................................................................................................................................................................................192
1
1DescriptionsThis document describes the interface of VOS3000 for third party developers. Interfaces described in this document and the final interpretation of
the copyright belongs to Kunshi Network Technology Co., Ltd. Any third party need to get permission from Kunshi.
Defined in JSON, use "UTF-8".Use POST to submit to VOS Web Service.For return code, use 0 for success, non 0 for failed, e.g. {"retCode":-10007,"exception":"Not found, operation failed."}HTML head, Content-Type use “text/html;charset=UTF-8”.After install, edit /home/kunshiweb/base/apache-tomcat-7.0.23/conf/Catalina/localhost/external.xml to set access IP, separate by |.
Web interface field attribute: "Required", must contain this parameter; "Optional", default value will be used if not set this parameter; empty meansthis parameter is invalid.
2
2Receive Request2.1Create Customer
http://VOSIP/external/server/CreateCustomer
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account Numbername O String 64 Account Namemoney O Double For Create Account Only
Default: 0limitMoney O Double Overdraft Limit
Default: 0feeRateGroup O String 64 Billing Fee Rate Group
Name(Do not support "Use LowerRate")
type O Integer Account Type0: General Account1: Phone Card2: Clearing AccountDefault: 0
lockType O Integer Lock Type0: Normal1: LockedDefault: 0
agentAccount O String 64 AgentphoneBookLimit O Integer Phone Book Number Limit
Default: 0validTime O Long Account Valid Time (UTC
Time)Default: 0 (Set by SystemParameter)
3
memo O String 255 MemoinfoCustomerAdditional O InfoCustomerAdditional Additional Information
InfoCustomerAdditional FormatParameter M/O Type Length DescriptioncardType O Integer Certification Type
0: ID Card1: Passport2: Officer ID3: Employee ID4: Student ID5: OthersDefault: 0
cardNumber O String Certification Numberaddress O String Detailed AddresspostCode O String Post CodelinkMan O String Contacttelephone O String Phone Numberfax O String Faxemail O String EmailemailCc O String CCemailBcc O String BCCreportType O Integer Report Sending Type
0: None1: Daily2: Weekly3: MonthlyDefault: 0
companyName O String Company Namebank O String Bank Account
Response FormatParameter M/O Type Length Description
4
retCode M Integer Response Codeexception O String Error Information
5
2.2Modify Customerhttp://VOSIP/external/server/ModifyCustomer
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account Numbername O String 64 Account NamelimitMoney O Double Overdraft Limit
Default: 0feeRateGroup O String 64 Billing Fee Rate Group
Name(Do not support "Use LowerRate")
type O Integer Account Type0: General Account1: Phone Card2: Clearing AccountDefault: 0
lockType O Integer Lock Type0: Normal1: LockedDefault: 0
agentAccount O String 64 AgentphoneBookLimit O Integer Phone Book Number Limit
Default: 0validTime O Long Account Valid Time (UTC
Time)Default: 0 (Set by SystemParameter)
memo O String 255 MemoinfoCustomerAdditional O InfoCustomerAdditional Additional Information
6
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
7
2.3Delete Customerhttp://VOSIP/external/server/DeleteCustomer
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account Number
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
8
2.4Get Customerhttp://VOSIP/external/server/GetCustomer
Request FormatParameter M/O Type Length Descriptionaccounts O String[] Account Liste164s O String[] E164 List
One of parameters is needed at least.
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoCustomers O InfoCustomer[] Customer Information
InfoCustomer FormatParameter M/O Type Length Descriptionaccount M String 64 Account Numbername M String 64 Account Namemoney M double BalancelimitMoney M double Over DraftfeeRateGroup M String 64 Billing Fee Rate
Blank: no fee rate grouptype M Integer Account Type
0: General Account1: Phone Card2: Clearing Account
lockType M Integer Lock Type0: Normal1: Locked
agentAccount M String 64 Agent AccountBlank: no agent
9
phoneBookLimit M Integer Phone Book Number LimitstartTime M Long Customer Create TimevalidTime M Long Customer Expire TimetodayConsumption M double Today Consumptionmemo M String 255 MemoinfoCustomerAdditional M InfoCustomerAdditional Customer Additional
Information
10
2.5Create Phonehttp://VOSIP/external/server/CreatePhone
Request FormatParameter M/O Type Length DescriptionautoCreateAccount M Boolean Create Phone and Accounte164 M String 64 Phone Numberpassword O String 32 Phone PassworddisplayNumber O String 64 Display NumberlockType O Integer Lock Type
0: No Lock1: Lock Call Out2: Lock Call In3: Lock All
callLevel O Integer Call Level1: Net2: Local4: Domestic5: International
feerateGroup O String 255 Fee Rate GroupmonthlyMoneyMinimum O Double Monthly Minimum
ConsumptionmonthlyMoneyMaximum O Double Monthly Maximum
ConsumptionmonthlyRentFee O Double Monthly Rent FeerewriteRulesOutCallee O String 65535 Call Out Callee Rewrite
RulerewriteRulesInCallee O String 65535 Call In Callee Rewrite RulerewriteRulesInCaller O String 65535 Call In Caller Rewrite RuleroutingGatewayGroupsAllow
O Boolean true: Allow SelectedGateway Groupfalse: Forbidden Selected
11
Gateway GrouproutingGatewayGroups O String 255 Routing Gateway Group
NameBlank for All
account O String 64 Phone’s Accountequipment O String 64 Phone’s Soft Switch
Blank for AllcalleeBilling O Boolean true: Enable
false: DisablecustomerPassword O String 32 Web Query PasswordlineCallIn O Integer Call In Number LimitlineCallOut O Integer Call Out Number LimitlineCapacity O Integer Total Number LimitphonebookLimit O Integer Phone Book Number LimitcallerLimitE164GroupsAllow
O Boolean true: Allow SelectedCaller Groupfalse: Forbidden SelectedCaller Group
callerLimitE164Groups O String 255 Caller Limit E164 GroupsBlank for All
calleeLimitE164Allow O Boolean true: Allow SelectedCallee Groupfalse: Forbidden SelectedGallee Group
calleeLimitE164Groups O String 255 Callee Limit E164 GroupsBlank for All
memo O String 255 MemoinfoPhoneValueAdded O InfoPhoneValueAdded Value Added SettingsinfoPhoneAdditional O InfoPhoneAdditional Additional Settings
InfoPhoneValueAdded FormatParameter M/O Type Length Description
12
callerIdDisplay O Boolean true: Enablefalse: Disable
callTransfer O Boolean true: Enablefalse: Disable
doNotDisturb O Boolean true: Enablefalse: Disable
periodForwarding O Boolean true: Enablefalse: Disable
infoPhoneValueAddedPeriodForwardings
O InfoPhoneValueAddedPeriodForwarding[]
Period Forward Settings
unconditionalForward O Boolean true: Enablefalse: Disable
unconditionalForwardE164 O InfoPhoneValueAddedForwardE164
Unconditional ForwardSettings
noAnswerForward O Boolean true: Enablefalse: Disable
noAnswerForwardE164 O InfoPhoneValueAddedForwardE164
No Answer ForwardSettings
offlineForward O Boolean true: Enablefalse: Disable
offlineForwardE164 O InfoPhoneValueAddedForwardE164
Off Line Forward Settings
busyForward O Boolean true: Enablefalse: Disable
busyForwardE164 O InfoPhoneValueAddedForwardE164
Busy Forward Settings
colorRing O Boolean true: Enablefalse: Disable
remoteColorRingPassthrough
O Boolean true: Enablefalse: Disable
colorRingName O String 64 Color Ring NameunableToConnectVoicePrompts
O Integer Prompt for Unable Connect0: Default
13
1: On2: Off
callRemainingTimePrompts O Integer Prompt for Remain Time0: Default1: On2: Off
balanceNotEnoughAlarm O Integer Prompt for Balance0: Default1: Money Left2: Time Left3: Off
voiceMail O Boolean true: Enablefalse: Disable
voiceMailCheckPassword O Boolean true: Enablefalse: Disable
voiceMailMaxNumber O Integer Voice Mail Number-1: Set by SystemParameter
voiceMailExpireDay O Integer Voice Mail Expire Day-1: Set by SystemParameter
voiceMailAudioType O Integer 0: Default1: Customized
InfoPhoneValueAddedPeriodForwarding FormatParameter M/O Type Length DescriptionweekOfDay O String 32 0: Sunday
1: Monday2: Tuesday3: Wednesday4: Thursday5: Friday6: Saturday
14
Blank: 0,1,2,3,4,5,6beginSecondInDay O Integer Start Time
(Seconds from 0:00)Default: 0Range: 0-86400
endSecondInDay O Integer Stop Time(Seconds from 0:00)Default: 0Range: 0-86400
forwardE164 O InfoPhoneValueAddedForwardE164
Forward E164 Settings
InfoPhoneValueAddedForwardE164 FormatParameter M/O Type Length DescriptionforwardMethod O Integer Forwarding Mode
0: Sequence1: Poll3: RandomDefault: 0
alertSecond O Integer Ringing DurationUnit: Seconds, no use forlast number.Default: -1, use defaultvalue
e164 O String 255 Forward Number, usecomma to separate
InfoPhoneAdditional FormatParameter M/O Type Length Description
registerType O Integer Register Type0: Static1: Dynamic2: Mapping Gateway
15
protocol O Integer Protocol0: H3231: SIP
ip O String 32 IP for Static Registerport O Integer Port for Static RegisterlocalIp O String Local IP for Static
RegisterrtpRelay O Integer Media Proxy
0: Auto1: Enable2: DisableDefault: 0
rtpInterruptDetection O Integer RTP Interrupt DetectionMode0: No Detect1: Detect whether VOS hassent RTP to Remote2: Detect whether VOS hasreceived Remote RTP3: Detect Both Side's RTPDefault: 0
callDurationLimit O Integer Conversation Limitation,Unit: Seconds-1: Use System Parameter0: No limitDefault: -1
callTransferBillingMethod O Integer Call Transfer Billing Mode0: Callee1: Caller
useCallerPhoneDisplay O Integer Use Phone Display Number0: Use System Parameter1: On2: OffDefault: 0
16
noBillingToPhone O Integer No billing, when the otherside is phone0: Use System Parameter1: On2: OffDefault: 0
displayCallerShortNumber O Boolean true: Onfalse: Off
useRoutingGatewayNotOnline
O Integer If phone is offline, tryrouting gateway0: Use System Parameter1: On2: OffDefault: 0
minProfitPercentEnable O Boolean Enable Min Profit PercentminProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second RatemaxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, setthis value as 0.01
firstRoutingPolicy O Integer First Routing Strategy0: None1: ASR2: Lowest Rate per Second
secondRoutingPolicy O Integer Second Routing Strategy0: None1: ASR2: Lowest Rate per Second
sipAuthenticationMethod O Integer SIP Call AuthenticationMode0: IP
17
1: IP and Port2: Password
sipRemoteAlertingMethod O Integer Remote Ring Back Mode0: Default1: d183+SDP2: 180+SDP
sipTimerSupport O Boolean true: Enable Timer(RFC4028)false: Disable Timer
sip100RelSupport O Boolean true: Enable 100relfalse: Disable 100rel
sipT38Support O Boolean true: Enable t38false: Disable t38
sipPrivacySupport O Boolean true: Enable Privacyfalse: Omit Privacy
sipPrivacy O Integer 0: None1: Pass through2: id
sipPPreferredIdentity O Integer 0: None1: Pass through2: Caller number
sipPAssertedIdentity O Integer 0: None1: Pass through2: Caller number
dtmfReceiveMethod O Integer DTMF Receive0: All10: RFC283320: Signaling30: Off
dtmfSIPSendMethod O Integer SIP DTMF Send0: Auto10: RFC283350: SIP INFO
18
60: OffsipCodecAssign O Boolean true: Specify SIP Codec
false: Auto NegotiationsipCodecs O String [] Codec:
audio/AMRaudio/DVI4audio/G722audio/G723audio/G726-16audio/G726-24audio/G726-32audio/G726-40audio/G728audio/G729audio/G729Daudio/G729Eaudio/GSMaudio/GSM-EFRaudio/iLBCaudio/L8audio/L16audio/LPCaudio/MPAaudio/parityfecaudio/PCMAaudio/PCMUaudio/QCELPaudio/REDaudio/VDVIaudio/Speexaudio/Speex-FECaudio/Speex-Widebandaudio/Speex-Wideband-FEC
19
audio/SILKvideo/BT656video/CelBvideo/JPEGvideo/H261video/H263video/H263-1998video/H263-2000video/H264video/MPVvideo/MP2Tvideo/MP1Svideo/MP2Pvideo/parityfecvideo/REDvideo/BMPEGvideo/nvvideo/VP8
ivrEquipmentType O Integer Equipment Type-1: None1: Direct/Callback2: IP PBX3: Value Added
ivrServiceName O String Service NameivrCallbackBillingMode O Integer Callback First Line
Billing0: Access Number’ Phone1: In-use Phone Card2: Auto(Order: Binded Number,Active Phone Card, Phone,Access Number’s Phone)3: Phone
20
ivrCallbackMergeBillingMode
O Integer Callback Second LineBilling Mode0: None1: Add to Access NumberRate2: Add to Caller Rate
ivrDirectMergeBillingMode O Integer Direct Second Line BillingMode0: None1: Add to Access NumberRate2: Add to Caller Rate
ivrSecondBillingMode O Integer Second Line Billing Mode0: Access Number’s Phone1: In-use Phone Card3: Phone
ivrCallbackBillingSecordNotConnectedOnAccessE164
O Boolean true: Billing on accessnumber, if second line notconnected
ivrCallbackBillingSecordConnectedOnSecondAccount
O Boolean true: Billing on second lineaccount, if second lineconnected
ivrAccessVerifyActivePhoneCard
O Boolean true: Caller Number VerifyActive Phone Card
ivrAccessVerifyBindedE164 O Boolean true: Caller Number VerifyBinded Number
ivrAccessVerifyCallerE164Phone
O Boolean true: Caller Number VerifyPhone
ivrAccessVerifyAccessE164Phone
O Boolean true: Callee Number VerifyAccess Number Account
ivrEnablePhoneSetting O Boolean true: Enablefalse: Disable
lrnEnable O Boolean Enable LRN Query
21
lrnEatPrefixLength O Integer Omit prefix lengthlrnFailureAction O Integer 0: Reject the call
1: Use original numberlrnInterstateBillingPrefix O String Billing Prefix for different
arealrnUndeterminedBillingPrefix
O String Billing Prefix for unknownarea
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Informationpassword O String If no password, system will
generate one automatically.
22
2.6Modify Phonehttp://VOSIP/external/server/ModifyPhone
Request FormatParameter M/O Type Length Descriptione164 M String 64 Phone Numberpassword O String 32 Phone PassworddisplayNumber O String 64 Display NumberlockType O Integer Lock Type
0: No Lock1: Lock Call Out2: Lock Call In3: Lock All
callLevel O Integer Call Level1: Net2: Local4: Domestic5: International
feerateGroup O String 255 Fee Rate GroupmonthlyMoneyMinimum O Double Monthly Minimum
ConsumptionmonthlyMoneyMaximum O Double Monthly Maximum
ConsumptionmonthlyRentFee O Double Monthly Rent FeerewriteRulesOutCallee O String 65535 Call Out Callee Rewrite
RulerewriteRulesInCallee O String 65535 Call In Callee Rewrite RulerewriteRulesInCaller O String 65535 Call In Caller Rewrite RuleroutingGatewayGroupsAllow
O Boolean true: Allow SelectedGateway Groupfalse: Forbidden SelectedGateway Group
23
routingGatewayGroups O String 255 Routing Gateway GroupNameBlank for All
account O String 64 Phone’s Accountequipment O String 64 Phone’s Soft Switch
Blank for AllcalleeBilling O Boolean true: Enable
false: DisablecustomerPassword O String 32 Web Query PasswordlineCallIn O Integer Call In Number LimitlineCallOut O Integer Call Out Number LimitlineCapacity O Integer Total Number LimitphonebookLimit O Integer Phone Book Number LimitcallerLimitE164GroupsAllow
O Boolean true: Allow SelectedCaller Groupfalse: Forbidden SelectedCaller Group
callerLimitE164Groups O String 255 Caller Limit E164 GroupsBlank for All
calleeLimitE164Allow O Boolean true: Allow SelectedCallee Groupfalse: Forbidden SelectedGallee Group
calleeLimitE164Groups O String 255 Callee Limit E164 GroupsBlank for All
memo O String 255 MemoinfoPhoneValueAdded O InfoPhoneValueAdded Value Added SettingsinfoPhoneAdditional O InfoPhoneAdditional Additional Settings
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
24
2.7Delete Phonehttp://VOSIP/external/server/DeletePhone
Request FormatParameter M/O Type Length Descriptione164 M String 64 Phone Number
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
25
2.8Get Phonehttp://VOSIP/external/server/GetPhone
Request FormatParameter M/O Type Length Descriptione164s O String [] E164 Listaccounts O String [] Account List
One of parameters is needed at least.
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoPhones O InfoPhone [] Phone Information
InfoPhone FormatParameter M/O Type Length Descriptione164 M String 64 Phone Numberpassword O String 32 Phone PassworddisplayNumber O String 64 Display NumberlockType O Integer Lock Type
0: No Lock1: Lock Call Out2: Lock Call In3: Lock All
callLevel O Integer Call Level1: Net2: Local4: Domestic5: International
feerateGroup O String 255 Fee Rate GroupmonthlyMoneyMinimum O Double Monthly Minimum
26
ConsumptionmonthlyMoneyMaximum O Double Monthly Maximum
ConsumptionmonthlyRentFee O Double Monthly Rent FeerewriteRulesOutCallee O String 65535 Call Out Callee Rewrite
RulerewriteRulesInCallee O String 65535 Call In Callee Rewrite RuleroutingGatewayGroupsAllow
O Boolean true: Allow SelectedGateway Groupfalse: Forbidden SelectedGateway Group
routingGatewayGroups O String 255 Routing Gateway GroupNameBlank for All
account O String 64 Phone’s Accountequipment O String 64 Phone’s Soft Switch
Blank for AllcalleeBilling O Boolean true: Enable
false: DisablecustomerPassword O String 32 Web Query PasswordlineCallIn O Integer Call In Number LimitlineCallOut O Integer Call Out Number LimitlineCapacity O Integer Total Number LimitphonebookLimit O Integer Phone Book Number LimitcallerLimitE164GroupsAllow
O Boolean true: Allow SelectedCaller Groupfalse: Forbidden SelectedCaller Group
callerLimitE164Groups O String 255 Caller Limit E164 GroupsBlank for All
calleeLimitE164Allow O Boolean true: Allow SelectedCallee Groupfalse: Forbidden Selected
27
Gallee GroupcalleeLimitE164Groups O String 255 Callee Limit E164 Groups
Blank for Allmemo O String 255 MemoinfoPhoneValueAdded O InfoPhoneValueAdded Value Added SettingsinfoPhoneAdditional O InfoPhoneAdditional Additional Settings
28
2.9Get Online Phonehttp://VOSIP/external/server/GetPhoneOnline
Request FormatParameter M/O Type Length Descriptione164s M String [] E164 List
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoPhoneOnlines O InfoPhoneOnline [] Online Phone Information
InfoPhoneOnline FormatParameter M/O Type Length Descriptione164 M String 64 Phone NumbercurrentCall M Integer Current CallremoteIp M String Remote IPlocalIp M String Local IPregisterTime M Long Register Time (UTC)updateTime M Long Update Time (UTC)protocol M Integer Protocol Type
0: H3231: SIP
cryptoType M Integer Encryption Type0: No Encryption1: RC4
productId M String Device Name
29
2.10Create Gateway Mappinghttp://VOSIP/external/server/CreateGatewayMapping
Request FormatParameter M/O Type Length Descriptionname M String 64 Mapping Gateway Namepassword O String 64 Register PasswordlockType O Integer Lock Type
0: No Lock3: Lock All
callLevel O Integer Call Level1: Net2: Local4: Domestic5: International
capacity O Integer Line Limitpriority O Integer PrioritygatewayGroups O String 65535 Gateway Groups, use
comma to separateroutingGatewayGroupsAllow
O Boolean true: Allowfalse: Forbidden
routingGatewayGroups O String 65535 Routing Gateway GroupsBlank: All
registerType O Integer Register Type0: Static1: Dynamic
remoteIps O String 65535 IP list, use comma toseparate
callerE164CheckEnable O Boolean true: Enable Caller Checkfalse: Disable CallerCheck
callerE164CheckCity O Boolean true: Enable Caller CityCheck
30
false: Disable Caller CityCheck
callerE164CheckMobile O Boolean true: Enable Caller MobileCheckfalse: Disable Caller MobileCheck
callerE164CheckOther O Boolean true: Enable Caller OtherCheckfalse: Disable Caller OtherCheck
calleeE164CheckEnable O Boolean true: Enable Callee Checkfalse: Disable CalleeCheck
calleeE164CheckCity O Boolean true: Enable Callee CityCheckfalse: Disable Callee CityCheck
calleeE164CheckMobile O Boolean true: Enable Callee MobileCheckfalse: Disable Callee MobileCheck
calleeE164CheckOther O Boolean true: Enable Callee OtherCheckfalse: Disable Callee OtherCheck
customerPassword O String Web Query PasswordrtpForwardType O Integer Media Proxy
0: Auto1: Enable2: DisableDefault: 0
mediaCheckDirection O Integer RTP Interrupt DetectionMode
31
0: No Detect1: Detect whether VOS hassent RTP to Remote2: Detect whether VOS hasreceived Remote RTP3: Detect Both Side's RTPDefault: 0
calleeE164Restrict O Integer Callee Limit0: No Limit1: Limit Callee is Phone2: Limit Callee not Phone
maxCallDurationLower O Integer -1: Use System Parameter0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter0: No limit
allowPhoneBilling O Boolean Billing on Phone Account, Ifcaller matches phonenumber
allowBindedE164Billing O Boolean Billing on Binded E164Account, If caller matchesbinded e164
enablePhoneSetting O Boolean Use phone settings whencaller matches phonenumber
denySameCityCodesAllow O Boolean true: EnabledenySameCityCodesSettingfalse: DisabledenySameCityCodesSetting
denySameCityCodes O String 65535 Deny Same City CodesSettings, use comma toseparate
32
checkMobileAreaAllow O Boolean true: EnablecheckMobileArea Settingsfalse: DisablecheckMobileArea Settings
checkMobileArea O String 65535 Mobile Area Settings, usecomma to separate
calloutCalleePrefixesAllow O Boolean true: EnablecalloutCalleePrefixesSettingsfalse: DisablecalloutCalleePrefixesSettings
calloutCalleePrefixes O String 65535 Callout Callee PrefixesSettings
calloutCallerPrefixesAllow O Boolean true: EnablecalloutCallerPrefixesSettingsfalse: DisablecalloutCallerPrefixesSettings
calloutCallerPrefixes O String 65535 Callout Caller PrefixesSettings
rewriteRulesOutCallee O String 65535 Callee Rewrite RulerewriteRulesOutCaller O String 65535 Caller Rewrite RulerewriteRulesInMobileAreaAllow
O Boolean true: EnablerewriteRulesInMobileAreaSettingsfalse: DisablerewriteRulesInMobileAreaSettings
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite RulesSettings, separate bycomma
33
timeoutCallProceeding O Integer Unit: Second-1: Use System Parameter0: No limit
sipResponseAddressMethod
O Integer SIP Response Address0: Response to RequestAddress1: Response to Request IPuse port from Via
sipRequestAddressMethod O Integer SIP Request Address0: To Original Address1: To Original IP and Portfrom Contact2: To Contact
dtmfSendMethodH323 O Integer 0: Auto10: RFC283320: H.245 alphanumeric30: H.245 signal40: Q.931 keypad60: Off
dtmfSendMethodSIP O Integer 0: Auto10: RFC283350: SIP Info60: Off
dtmfReceiveMethod O Integer 0: All10: RFC283320: Signaling30: Off
dtmfSendPayloadTypeH323
O Integer Payload Type for H323DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMFSend
dtmfReceivePayloadType O Integer Payload Type for DTMFReceive
34
q931ProgressIndicator O Integer -1: Auto0: Off1:ProgressNotEndToEndISDN2:ProgressDestinationNonISDN3: ProgressOriginNotISDN4:ProgressReturnedToISDN5: ProgressServiceChange8:ProgressInbandInformationAvailable
account O String Billing AccountcallTimeoutQ931CauseValue
O Integer H323 Cause Replace0: No ReplaceAbove 0: Refer to RFC
callTimeoutSIPCode O Integer SIP Cause Replace0: No ReplaceAbove 0: Refer to RFC
sipRemoteRingSignal O Integer SIP Remote Ring Signal0: Auto1: 183+SDP2: 180+SDP
sipCalleeE164Domain O Integer SIP Callee0: Use field To1: Use field Invite
sipCallerE164Domain O Integer SIP Caller0: Use field From1: Use field RemotePartId2: Use field Display
h323CalleeE164Domain O Integer H323 Callee
35
0: Use fieldCalledPartyNumber1: Use fieldDestinationAddress
h323CallerE164Domain O Integer H323 Caller0: Use fieldCallingPartyNumber1: Use field SourceAddress2: Use field Display
memo O String MemosipAuthenticationMethod O Integer SIP Call Authentication
Mode0: IP1: IP and Port2: Password
h323FastStart O Boolean true: Enable H323 fast startfalse: Disable H323 faststart
h323H245Tunneling O Boolean true: Enable H323 H245tunnelingfalse: Disable H323 H245tunneling
h323H245InSetup O Boolean true: Enable H323 H245 inSetupfalse: Disable H323 H245 inSetup
h323AutoCallProceeding O Boolean true: Enable H323 sendresponse after receive callrequestfalse: Disable H323 sendresponse after receive callrequest
h323CallProceedingFromSIPTrying
O Boolean Caller is H323, Callee is SIPtrue: convert trying to
36
CallProceedingfalse: no convert
h323AlertingFromSIP183Sdp
O Boolean Caller is H323, Callee is SIPtrue: convert Alerting toCallProceedingfalse: no convert
h323T38 O Boolean true: Enable H323 T38false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer(RFC4028)false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100relfalse: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38false: Disable SIP T38
sipDisplay O Boolean true: Include Displayfalse: Exclude Display
sipRemotePartyId O Boolean true: IncludeRemotePartyIdfalse: ExcludeRemotePartyId
sipPrivacySupport O Boolean true: Enable privacyfalse: Omit privacy
groupE164Change O Boolean true: Enable Group E164Changefalse: Disable Group E164Change
callerAllowLength O Integer Mask of Caller AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
calleeAllowLength O Integer Mask of Callee Allow
37
Length0: Allow All Length1<<x: Allow Length is x(x < 32)
callerLimitE164GroupsAllow
O Boolean true: AllowcallerLimitE164Groupsfalse: ForbiddencallerLimitE164Groups
callerLimitE164Groups O String Caller List, separate bycomma
calleeLimitE164GroupsAllow
O Boolean true: AllowcalleeLimitE164Groupsfalse: ForbiddencalleeLimitE164Groups
calleeLimitE164Groups O String Callee List, separate bycomma
minProfitPercentEnable O Boolean Enable Min Profit PercentminProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second RatemaxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, setthis value as 0.01
firstRoutePolicy O Integer First Routing Strategy0: None1: ASR2: Lowest Rate per Second
secondRoutePolicy O Integer Second Routing Strategy0: None1: ASR2: Lowest Rate per Second
h323G729SendMode O Integer H323 G729 Negotiation
38
Mode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729SendMode O Integer SIP G729 Negotiation Mode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729Annexb O Integer G729 annexb0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
sipG723Annexa O Integer G723 annexa0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecsfalse: Auto Negotiation
39
h323Codecs O Vector<String> H323 Codec ListsipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto NegotiationsipCodecs O Vector<String> SIP Codec ListforwardSignalRewriteE164GroupEnable
O Boolean true: Enable ForwardSignal Rewritefalse: Disable ForwardSignal Rewrite
forwardSignalRewriteE164Group
O String 255 Forward Signal RewriteE164 Group
lrnEnable O Boolean Enable LRN QuerylrnEatPrefixLength O Integer Omit prefix lengthlrnFailureAction O Integer 0: Reject the call
1: Use original numberlrnInterstateBillingPrefix O String Billing Prefix for different
arealrnUndeterminedBillingPrefix
O String Billing Prefix for unknownarea
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
40
2.11Modify Mapping Gatewayhttp://VOSIP/external/server/ModifyGatewayMapping
Request FormatParameter M/O Type Length Descriptionname M String 64 Mapping Gateway Namepassword O String 64 Register PasswordlockType O Integer Lock Type
0: No Lock3: Lock All
callLevel O Integer Call Level1: Net2: Local4: Domestic5: International
capacity O Integer Line Limitpriority O Integer PrioritygatewayGroups O String 65535 Gateway Groups, use
comma to separateroutingGatewayGroupsAllow
O Boolean true: Allowfalse: Forbidden
routingGatewayGroups O String 65535 Routing Gateway GroupsBlank: All
registerType O Integer Register Type0: Static1: Dynamic
remoteIps O String 65535 IP list, use comma toseparate
callerE164CheckEnable O Boolean true: Enable Caller Checkfalse: Disable CallerCheck
callerE164CheckCity O Boolean true: Enable Caller CityCheck
41
false: Disable Caller CityCheck
callerE164CheckMobile O Boolean true: Enable Caller MobileCheckfalse: Disable Caller MobileCheck
callerE164CheckOther O Boolean true: Enable Caller OtherCheckfalse: Disable Caller OtherCheck
calleeE164CheckEnable O Boolean true: Enable Callee Checkfalse: Disable CalleeCheck
calleeE164CheckCity O Boolean true: Enable Callee CityCheckfalse: Disable Callee CityCheck
calleeE164CheckMobile O Boolean true: Enable Callee MobileCheckfalse: Disable Callee MobileCheck
calleeE164CheckOther O Boolean true: Enable Callee OtherCheckfalse: Disable Callee OtherCheck
customerPassword O String Web Query PasswordrtpForwardType O Integer Media Proxy
0: Auto1: Enable2: DisableDefault: 0
mediaCheckDirection O Integer RTP Interrupt DetectionMode
42
0: No Detect1: Detect whether VOS hassent RTP to Remote2: Detect whether VOS hasreceived Remote RTP3: Detect Both Side's RTPDefault: 0
calleeE164Restrict O Integer Callee Limit0: No Limit1: Limit Callee is Phone2: Limit Callee not Phone
maxCallDurationLower O Integer -1: Use System Parameter0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter0: No limit
allowPhoneBilling O Boolean Billing on Phone Account, Ifcaller matches phonenumber
allowBindedE164Billing O Boolean Billing on Binded E164Account, If caller matchesbinded e164
enablePhoneSetting O Boolean Use phone settings whencaller matches phonenumber
denySameCityCodesAllow O Boolean true: EnabledenySameCityCodesSettingfalse: DisabledenySameCityCodesSetting
denySameCityCodes O String 65535 Deny Same City CodesSettings, use comma toseparate
43
checkMobileAreaAllow O Boolean true: EnablecheckMobileArea Settingsfalse: DisablecheckMobileArea Settings
checkMobileArea O String 65535 Mobile Area Settings, usecomma to separate
calloutCalleePrefixesAllow O Boolean true: EnablecalloutCalleePrefixesSettingsfalse: DisablecalloutCalleePrefixesSettings
calloutCalleePrefixes O String 65535 Callout Callee PrefixesSettings
calloutCallerPrefixesAllow O Boolean true: EnablecalloutCallerPrefixesSettingsfalse: DisablecalloutCallerPrefixesSettings
calloutCallerPrefixes O String 65535 Callout Caller PrefixesSettings
rewriteRulesOutCallee O String 65535 Callee Rewrite RulerewriteRulesOutCaller O String 65535 Caller Rewrite RulerewriteRulesInMobileAreaAllow
O Boolean true: EnablerewriteRulesInMobileAreaSettingsfalse: DisablerewriteRulesInMobileAreaSettings
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite RulesSettings, separate bycomma
44
timeoutCallProceeding O Integer Unit: Second-1: Use System Parameter0: No limit
sipResponseAddressMethod
O Integer SIP Response Address0: Response to RequestAddress1: Response to Request IPuse port from Via
sipRequestAddressMethod O Integer SIP Request Address0: To Original Address1: To Original IP and Portfrom Contact2: To Contact
dtmfSendMethodH323 O Integer 0: Auto10: RFC283320: H.245 alphanumeric30: H.245 signal40: Q.931 keypad60: Off
dtmfSendMethodSIP O Integer 0: Auto10: RFC283350: SIP Info60: Off
dtmfReceiveMethod O Integer 0: All10: RFC283320: Signaling30: Off
dtmfSendPayloadTypeH323
O Integer Payload Type for H323DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMFSend
dtmfReceivePayloadType O Integer Payload Type for DTMFReceive
45
q931ProgressIndicator O Integer -1: Auto0: Off1:ProgressNotEndToEndISDN2:ProgressDestinationNonISDN3: ProgressOriginNotISDN4:ProgressReturnedToISDN5: ProgressServiceChange8:ProgressInbandInformationAvailable
account O String Billing AccountcallTimeoutQ931CauseValue
O Integer H323 Cause Replace0: No ReplaceAbove 0: Refer to RFC
callTimeoutSIPCode O Integer SIP Cause Replace0: No ReplaceAbove 0: Refer to RFC
sipRemoteRingSignal O Integer SIP Remote Ring Signal0: Auto1: 183+SDP2: 180+SDP
sipCalleeE164Domain O Integer SIP Callee0: Use field To1: Use field Invite
sipCallerE164Domain O Integer SIP Caller0: Use field From1: Use field RemotePartId2: Use field Display
h323CalleeE164Domain O Integer H323 Callee
46
0: Use fieldCalledPartyNumber1: Use fieldDestinationAddress
h323CallerE164Domain O Integer H323 Caller0: Use fieldCallingPartyNumber1: Use field SourceAddress2: Use field Display
memo O String MemosipAuthenticationMethod O Integer SIP Call Authentication
Mode0: IP1: IP and Port2: Password
h323FastStart O Boolean true: Enable H323 fast startfalse: Disable H323 faststart
h323H245Tunneling O Boolean true: Enable H323 H245tunnelingfalse: Disable H323 H245tunneling
h323H245InSetup O Boolean true: Enable H323 H245 inSetupfalse: Disable H323 H245 inSetup
h323AutoCallProceeding O Boolean true: Enable H323 sendresponse after receive callrequestfalse: Disable H323 sendresponse after receive callrequest
h323CallProceedingFromSIPTrying
O Boolean Caller is H323, Callee is SIPtrue: convert trying to
47
CallProceedingfalse: no convert
h323AlertingFromSIP183Sdp
O Boolean Caller is H323, Callee is SIPtrue: convert Alerting toCallProceedingfalse: no convert
h323T38 O Boolean true: Enable H323 T38false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer(RFC4028)false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100relfalse: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38false: Disable SIP T38
sipDisplay O Boolean true: Include Displayfalse: Exclude Display
sipRemotePartyId O Boolean true: IncludeRemotePartyIdfalse: ExcludeRemotePartyId
sipPrivacySupport O Boolean true: Enable Privacyfalse: Omit Privacy
groupE164Change O Boolean true: Enable Group E164Changefalse: Disable Group E164Change
callerAllowLength O Integer Mask of Caller AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
calleeAllowLength O Integer Mask of Callee Allow
48
Length0: Allow All Length1<<x: Allow Length is x(x < 32)
callerLimitE164GroupsAllow
O Boolean true: AllowcallerLimitE164Groupsfalse: ForbiddencallerLimitE164Groups
callerLimitE164Groups O String Caller List, separate bycomma
calleeLimitE164GroupsAllow
O Boolean true: AllowcalleeLimitE164Groupsfalse: ForbiddencalleeLimitE164Groups
calleeLimitE164Groups O String Callee List, separate bycomma
minProfitPercentEnable O Boolean Enable Min Profit PercentminProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second RatemaxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, setthis value as 0.01
firstRoutePolicy O Integer First Routing Strategy0: None1: ASR2: Lowest Rate per Second
secondRoutePolicy O Integer Second Routing Strategy0: None1: ASR2: Lowest Rate per Second
h323G729SendMode O Integer H323 G729 Negotiation
49
Mode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729SendMode O Integer SIP G729 Negotiation Mode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729Annexb O Integer G729 annexb0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
sipG723Annexa O Integer G723 annexa0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecsfalse: Auto Negotiation
50
h323Codecs O Vector<String> H323 Codec ListsipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto NegotiationsipCodecs O Vector<String> SIP Codec ListforwardSignalRewriteE164GroupEnable
M Boolean true: Enable ForwardSignal Rewritefalse: Disable ForwardSignal Rewrite
forwardSignalRewriteE164Group
M String 255 Forward Signal RewriteE164 Group
lrnEnable O Boolean Enable LRN QuerylrnEatPrefixLength O Integer Omit prefix lengthlrnFailureAction O Integer 0: Reject the call
1: Use original numberlrnInterstateBillingPrefix O String Billing Prefix for different
arealrnUndeterminedBillingPrefix
O String Billing Prefix for unknownarea
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
51
2.12Get Mapping Gatewayhttp://VOSIP/external/server/GetGatewayMapping
Request FormatParameter M/O Type Length Descriptionnames M String [] Gateway Name
Blank: All
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoGatewayMappings O InfoGatewayMapping [] Gateway Information
InfoGatewayMapping FormatParameter M/O Type Length Descriptionname M String 64 Mapping Gateway NamelockType M Integer Lock Type
0: No Lock3: Lock All
callLevel M Integer Call Level1: Net2: Local4: Domestic5: International
capacity M Integer Line Limitpriority M Integer PrioritygatewayGroups M String 65535 Gateway Groups, use
comma to separateroutingGatewayGroupsAllow
M Boolean true: Allowfalse: Forbidden
routingGatewayGroups M String 65535 Routing Gateway Groups
52
Blank: AllregisterType M Integer Register Type
0: Static1: Dynamic
remoteIps M String 65535 IP list, use comma toseparate
callerE164CheckEnable M Boolean true: Enable Caller Checkfalse: Disable CallerCheck
callerE164CheckCity M Boolean true: Enable Caller CityCheckfalse: Disable Caller CityCheck
callerE164CheckMobile M Boolean true: Enable Caller MobileCheckfalse: Disable Caller MobileCheck
callerE164CheckOther M Boolean true: Enable Caller OtherCheckfalse: Disable Caller OtherCheck
calleeE164CheckEnable M Boolean true: Enable Callee Checkfalse: Disable CalleeCheck
calleeE164CheckCity M Boolean true: Enable Callee CityCheckfalse: Disable Callee CityCheck
calleeE164CheckMobile M Boolean true: Enable Callee MobileCheckfalse: Disable Callee MobileCheck
calleeE164CheckOther M Boolean true: Enable Callee Other
53
Checkfalse: Disable Callee OtherCheck
rtpForwardType M Integer Media Proxy0: Auto1: Enable2: DisableDefault: 0
mediaCheckDirection M Integer RTP Interrupt DetectionMode0: No Detect1: Detect whether VOS hassent RTP to Remote2: Detect whether VOS hasreceived Remote RTP3: Detect Both Side's RTPDefault: 0
calleeE164Restrict M Integer Callee Limit0: No Limit1: Limit Callee is Phone2: Limit Callee not Phone
maxCallDurationLower M Integer -1: Use System Parameter0: No limit
maxCallDurationUpper M Integer -1: Use System Parameter0: No limit
allowPhoneBilling M Boolean Billing on Phone Account, Ifcaller matches phonenumber
allowBindedE164Billing M Boolean Billing on Binded E164Account, If caller matchesbinded e164
enablePhoneSetting M Boolean Use phone settings whencaller matches phonenumber
54
denySameCityCodesAllow M Boolean true: EnabledenySameCityCodesSettingfalse: DisabledenySameCityCodesSetting
denySameCityCodes M String 65535 Deny Same City CodesSettings, use comma toseparate
checkMobileAreaAllow M Boolean true: EnablecheckMobileArea Settingsfalse: DisablecheckMobileArea Settings
checkMobileArea M String 65535 Mobile Area Settings, usecomma to separate
calloutCalleePrefixesAllow M Boolean true: EnablecalloutCalleePrefixesSettingsfalse: DisablecalloutCalleePrefixesSettings
calloutCalleePrefixes M String 65535 Callout Callee PrefixesSettings
calloutCallerPrefixesAllow M Boolean true: EnablecalloutCallerPrefixesSettingsfalse: DisablecalloutCallerPrefixesSettings
calloutCallerPrefixes M String 65535 Callout Caller PrefixesSettings
rewriteRulesOutCallee M String 65535 Callee Rewrite RulerewriteRulesOutCaller M String 65535 Caller Rewrite Rule
55
rewriteRulesInMobileAreaAllow
M Boolean true: EnablerewriteRulesInMobileAreaSettingsfalse: DisablerewriteRulesInMobileAreaSettings
rewriteRulesInMobileArea M String 65535 Mobile Area Rewrite RulesSettings, separate bycomma
timeoutCallProceeding M Integer Unit: Second-1: Use System Parameter0: No limit
sipResponseAddressMethod
M Integer SIP Response Address0: Response to RequestAddress1: Response to Request IPuse port from Via
sipRequestAddressMethod M Integer SIP Request Address0: To Original Address1: To Original IP and Portfrom Contact2: To Contact
dtmfSendMethodH323 M Integer 0: Auto10: RFC283320: H.245 alphanumeric30: H.245 signal40: Q.931 keypad60: Off
dtmfSendMethodSIP M Integer 0: Auto10: RFC283350: SIP Info60: Off
dtmfReceiveMethod M Integer 0: All10: RFC2833
56
20: Signaling30: Off
dtmfSendPayloadTypeH323
M Integer Payload Type for H323DTMF Send
dtmfSendPayloadTypeSIP M Integer Payload Type for SIP DTMFSend
dtmfReceivePayloadType M Integer Payload Type for DTMFReceive
q931ProgressIndicator M Integer -1: Auto0: Off1:ProgressNotEndToEndISDN2:ProgressDestinationNonISDN3: ProgressOriginNotISDN4:ProgressReturnedToISDN5: ProgressServiceChange8:ProgressInbandInformationAvailable
account M String Billing AccountcallTimeoutQ931CauseValue
M Integer H323 Cause Replace0: No ReplaceAbove 0: Refer to RFC
callTimeoutSIPCode M Integer SIP Cause Replace0: No ReplaceAbove 0: Refer to RFC
sipRemoteRingSignal M Integer SIP Remote Ring Signal0: Auto1: 183+SDP2: 180+SDP
57
sipCalleeE164Domain M Integer SIP Callee0: Use field To1: Use field Invite
sipCallerE164Domain M Integer SIP Caller0: Use field From1: Use field RemotePartId2: Use field Display
h323CalleeE164Domain M Integer H323 Callee0: Use fieldCalledPartyNumber1: Use fieldDestinationAddress
h323CallerE164Domain M Integer H323 Caller0: Use fieldCallingPartyNumber1: Use field SourceAddress2: Use field Display
memo M String MemosipAuthenticationMethod M Integer SIP Call Authentication
Mode0: IP1: IP and Port2: Password
h323FastStart M Boolean true: Enable H323 fast startfalse: Disable H323 faststart
h323H245Tunneling M Boolean true: Enable H323 H245tunnelingfalse: Disable H323 H245tunneling
h323H245InSetup M Boolean true: Enable H323 H245 inSetupfalse: Disable H323 H245 inSetup
58
h323AutoCallProceeding M Boolean true: Enable H323 sendresponse after receive callrequestfalse: Disable H323 sendresponse after receive callrequest
h323CallProceedingFromSIPTrying
M Boolean Caller is H323, Callee is SIPtrue: convert trying toCallProceedingfalse: no convert
h323AlertingFromSIP183Sdp
M Boolean Caller is H323, Callee is SIPtrue: convert Alerting toCallProceedingfalse: no convert
h323T38 M Boolean true: Enable H323 T38false: Disable H323 T38
sipTimer M Boolean true: Enable SIP Timer(RFC4028)false: Diable SIP Timer
sip100Rel M Boolean true: Enable SIP 100relfalse: Disable SIP 100rel
sipT38 M Boolean true: Enable SIP T38false: Disable SIP T38
sipDisplay M Boolean true: Include Displayfalse: Exclude Display
sipRemotePartyId M Boolean true: IncludeRemotePartyIdfalse: ExcludeRemotePartyId
sipPPreferredIdentity M Boolean true: IncludeP-Preferred-Identityfalse: ExcludeP-Preferred-Identity
59
sipPAssertedIdentity M Boolean true: IncludeP-Asserted-Identityfalse: ExcludeP-Asserted-Identity
groupE164Change M Boolean true: Enable Group E164Changefalse: Disable Group E164Change
callerAllowLength M Integer Mask of Caller AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
calleeAllowLength M Integer Mask of Callee AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
callerLimitE164GroupsAllow
M Boolean true: AllowcallerLimitE164Groupsfalse: ForbiddencallerLimitE164Groups
callerLimitE164Groups M String Caller List, separate bycomma
calleeLimitE164GroupsAllow
M Boolean true: AllowcalleeLimitE164Groupsfalse: ForbiddencalleeLimitE164Groups
calleeLimitE164Groups M String Callee List, separate bycomma
minProfitPercent M Integer Lowest Profit Rate Limit-1: No limitRange: -1-9999Default: -1
60
firstRoutePolicy M Integer First Routing Strategy0: None1: ASR2: Lowest Rate per Second
secondRoutePolicy M Integer Second Routing Strategy0: None1: ASR2: Lowest Rate per Second
h323G729SendMode M Integer H323 G729 NegotiationMode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729SendMode M Integer SIP G729 Negotiation Mode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729Annexb M Integer G729 annexb0: Auto1: annex=yes2: annex=no3: no annex
61
4: transmit annexsipG723Annexa M Integer G723 annexa
0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
h323CodecAssign M Boolean true: Assign H323 Codecsfalse: Auto Negotiation
h323Codecs M Vector<String> H323 Codec ListsipCodecAssign M Boolean true: Assign SIP Codecs
false: Auto NegotiationsipCodecs M Vector<String> SIP Codec ListforwardSignalRewriteE164GroupEnable
O Boolean true: Enable ForwardSignal Rewritefalse: Disable ForwardSignal Rewrite
forwardSignalRewriteE164Group
O String 255 Forward Signal RewriteE164 Group
softswitchName M String Soft Switch Name
62
2.13Delete Mapping Gatewayhttp://VOSIP/external/server/DeleteGatewayMapping
Request FormatParameter M/O Type Length Descriptionname M String Mapping Gateway Name
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
63
2.14Get Online Mapping Gatewayhttp://VOSIP/external/server/GetGatewayMappingOnline
Request FormatParameter M/O Type Length Descriptionnames O String [] Gateway Name
Null: AllsoftswitchName O String Soft Switch Name
Null: All
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoGatewayMappingOnlines
O InfoGatewayMappingOnline[]
Online Mapping GatewayInformation
InfoGatewayMappingOnline FormatParameter M/O Type Length Descriptionid M Integer Mapping Gateway IDname M String Mapping Gateway NamecurrentCall M Integer Current Callcapacity M Integer Line Limitasr M double Average Success Ratioacd M Long Average Call DurationremoteIps M String IP list, use comma to
separatenatIp O String NAT AddresslocalIp M String Register IPregisterTime M Long Register Time (UTC)
0: Static GatewayupdateTime M Long Last Update Time (UTC)
64
0: Static GatewaykeepTime M Long Online Time (Second)
0: Static GatewaycryptoType M Integer Encryption Type
0: No Encryption1: RC4
softswitchName M String Soft Switch NamesoftswitchIp M String Soft Switch IP
65
2.15Create Routing Gatewayhttp://VOSIP/external/server/CreateGatewayRouting
Request FormatParameter M/O Type Length Descriptionname M String 64 Routing Gateway Nameprefix O String Gateway PrefixprefixStyle O Integer Prefix Mode
0: Terminal1: Continual
password O String Gateway PasswordDefault: Random Create
customerPassword O String Self Service PasswordgatewayGroups O String Gateway Groupscapacity O Integer Line LimitlockType O Integer Lock Type
0: No Lock3: Lock AllDefault: 0
priority O Integer PriorityregisterType O Integer Register Type
0: Static1: Dynamic2: Register
remoteIp O String 64 IPrtpForwardType O Integer Media Proxy
0: Auto1: Enable2: DisableDefault: 0
encrypt O Boolean true: Encryptfalse: No Encrypt
66
protocol O Integer Protocol0: H3231: SIP
signalPort O Integer Signaling PortH323 Default: 1720SIP Default: 5060
localIp O String 64 Local IPBlank: Auto
mediaCheckDirection O Integer RTP Interrupt DetectionMode0: No Detect1: Detect whether VOS hassent RTP to Remote2: Detect whether VOS hasreceived Remote RTP3: Detect Both Side's RTPDefault: 0
maxCallDurationLower O Integer -1: Use System Parameter0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter0: No limit
calleeE164Restrict O Integer Callee Limit0: No Limit1: Limit Callee is Phone2: Limit Callee not Phone
callerE164CheckEnable O Boolean true: Enable Caller Checkfalse: Disable CallerCheck
callerE164CheckCity O Boolean true: Enable Caller CityCheckfalse: Disable Caller CityCheck
callerE164CheckMobile O Boolean true: Enable Caller Mobile
67
Checkfalse: Disable Caller MobileCheck
callerE164CheckOther O Boolean true: Enable Caller OtherCheckfalse: Disable Caller OtherCheck
calleeE164CheckEnable O Boolean true: Enable Callee Checkfalse: Disable CalleeCheck
calleeE164CheckCity O Boolean true: Enable Callee CityCheckfalse: Disable Callee CityCheck
calleeE164CheckMobile O Boolean true: Enable Callee MobileCheckfalse: Disable Callee MobileCheck
calleeE164CheckOther O Boolean true: Enable Callee OtherCheckfalse: Disable Callee OtherCheck
callinCallerPrefixesAllow O Boolean true: EnablecallinCallerPrefixesfalse: DisablecallinCallerPrefixes
callinCallerPrefixes O String 65535 Caller Prefixes ListcallinCalleePrefixesAllow O Boolean true: Enable
callinCalleePrefixesfalse: DisablecallinCalleePrefixes
callinCalleePrefixes O String 65535 Callee Prefixes ListcallinForwardPrefixesAllow O Boolean true: Enable
68
callinForwardPrefixessettingsfalse: DisablecallinForwardPrefixessettings
callinForwardPrefixes O String 65535 Call in forward prefixessettings
rewriteRulesInCaller O String 65535 Caller Rewrite RulerewriteRulesInCallee O String 65535 Callee Rewrite RulerewriteRulesInMobileAreaAllow
O Boolean true: EnablerewriteRulesInMobileAreafalse: DisablerewriteRulesInMobileArea
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite RulesSettings, separate bycomma
timeoutSetup O Integer H323 Setup Timeout(Unit:Second)0: Use System Parameter
timeoutCallProceeding O Integer H323 CallProceedingTimeout(Unit: Second)0: Use System Parameter
timeoutCallProceedingOlc O Integer H323 CallProceedinginclude Open LogicalChannel Timeout(Unit:Second)0: Use System Parameter
timeoutAlerting O Integer H323 AlertingTimeout(Unit: Second)0: Use System Parameter
timeoutInvite O Integer SIP Invite Timeout(Unit:Second)0: Use System Parameter
69
timeoutTrying O Integer SIP Trying Timeout(Unit:Second)0: Use System Parameter
timeoutSessionProgressSdp
O Integer SIP SessionProgressinclude SDP Timeout(Unit:Second)0: Use System Parameter
timeoutSessionProgress O Integer SIP SessionProgressTimeout(Unit: Second)0: Use System Parameter
timeoutRinging O Integer SIP Ring Timeout(Unit:Second)0: Use System Parameter
denyCallerCalleeAllow O Boolean true: EnabledenyCallerCalleefalse: DisabledenyCallerCallee
denyCallerCallee O String 65535 Format: [<Caller>:<Callee>[,<Caller>:<Callee>]…]e.g.: 025: 010,021: 023
denySameCityCodesAllow O Boolean true: EnabledenySameCityCodesSettingfalse: DisabledenySameCityCodesSetting
denySameCityCodes O String 65535 Deny Same City CodesSettings, use comma toseparate
checkMobileAreaAllow O Boolean true: EnablecheckMobileArea Settingsfalse: DisablecheckMobileArea Settings
70
checkMobileArea O String 65535 Mobile Area Settings, usecomma to separate
stopSwitchAfterOlc O Integer Stop Switch Gateway AfterOpen Logical Channel0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterSdp O Integer Stop Switch Gateway AfterReceived SDP0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterRtpStart O Integer Stop Switch Gateway AfterReceived RTP0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterUserBusy O Integer Stop Switch Gateway AfterReceived User Busy0: Use System Parameter1: Disable2: EnableDefault: 0
switchUntilConnect O Integer Switch Gateway UntilConnect0: Use System Parameter1: Disable2: EnableDefault: 0
sipResponseAddressMethod
O Integer SIP Response Address0: Response to Request
71
Address1: Response to Request IPuse port from Via
sipRequestAddressMethod O Integer SIP Request Address0: To Original Address1: To Original IP and Portfrom Contact2: To Contact
dtmfSendMethodH323 O Integer 0: Auto10: RFC283320: H.245 alphanumeric30: H.245 signal40: Q.931 keypad60: Off
dtmfSendMethodSIP O Integer 0: Auto10: RFC283350: SIP Info60: Off
dtmfReceiveMethod O Integer 0: All10: RFC283320: Signaling30: Off
dtmfSendPayloadTypeH323
O Integer Payload Type for H323DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMFSend
dtmfReceivePayloadType O Integer Payload Type for DTMFReceive
q931NumberingPlan O Integer Q931NumberingPlan-1: Use System Parameter0: UnknownPlan1: ISDNPlan3: DataPlan4: TelexPlan
72
8: NationalStandardPlan9: PrivatePlan15: ReservedPlan
q931NumberType O Integer Q931NumberType-1: Use System Parameter0: UnknownType1: InternationalType2: NationalType3: NetworkSpecificType4: SubscriberType6: AbbreviatedType7: ReservedType
q931PresentationIndicator O Integer Q931PresentationIndicator-1: Use System Parameter0: Presentation allowed1: Presentation restricted2: Number not available dueto interworking3: Reserved4: None
q931ScreeningIndicator O Integer Q931ScreeningIndicator-1: Use System Parameter0: User-provided, notscreened1: User-provided, verifiedand passed2: User-provided, verifiedand failed3: Network provided4: None
clearingAccount O String 64 Clearing Account Nameh323FastStart O Boolean true: Enable H323 fast start
false: Disable H323 faststart
73
h323H245Tunneling O Boolean true: Enable H323 H245tunnelingfalse: Disable H323 H245tunneling
h323H245InSetup O Boolean true: Enable H323 H245 inSetupfalse: Disable H323 H245 inSetup
h323T38 O Boolean true: Enable H323 T38false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer(RFC4028)false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100relfalse: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38false: Disable SIP T38
sipDisplay O Boolean true: Include Displayfalse: Exclude Display
sipRemotePartyId O Boolean true: IncludeRemotePartyIdfalse: ExcludeRemotePartyId
sipPrivacy O Integer 0: None1: Pass through2: id
sipPPreferredIdentity O Integer 0: None1: Pass through2: Caller number
sipPAssertedIdentity O Integer 0: None1: Pass through2: Caller number
groupE164Change O Boolean true: Enable Group E164
74
Changefalse: Disable Group E164Change
callerAllowLength O Integer Mask of Caller AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
calleeAllowLength O Integer Mask of Callee AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
callerLimitE164GroupsAllow
O Boolean true: AllowcallerLimitE164Groupsfalse: ForbiddencallerLimitE164Groups
callerLimitE164Groups O String 255 Caller List, separate bycomma
calleeLimitE164GroupsAllow
O Boolean true: AllowcalleeLimitE164Groupsfalse: ForbiddencalleeLimitE164Groups
calleeLimitE164Groups O String 255 Callee List, separate bycomma
h323G729SendMode O Integer H323 G729 NegotiationMode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729
75
or G729a as G729 andG729a
sipG729SendMode O Integer SIP G729 Negotiation Mode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729Annexb O Integer G729 annexb0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
sipG723Annexa O Integer G723 annexa0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecsfalse: Auto Negotiation
h323Codecs O Vector<String> H323 Codec ListsipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto NegotiationsipCodecs O Vector<String> SIP Codec ListfeerateRestrict O Boolean true: Check Callee Fee
Ratefalse: No Check
76
leastCostRouting O Boolean (feerateRestrict must betrue)true: Onfalse: Off
minProfitPercentEnable O Boolean Enable Min Profit PercentminProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second RatemaxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, setthis value as 0.01
enablePhoneDisplay O Boolean true: Use phone displaynumber as callerfalse: Use phone number ascaller
clearingAccountUseCalloutE164
O Boolean true: Use Callee afterrewrite as ClearingAccountfalse: Use Callee beforerewrite as ClearingAccount
softswitchName O String 64 Soft Switch NameforwardSignalRewriteE164GroupEnable
O Boolean true: Enable ForwardSignal Rewritefalse: Disable ForwardSignal Rewrite
forwardSignalRewriteE164Group
O String 255 Forward Signal RewriteE164 Group
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Code
77
exception O String Error Information
78
2.16Modify Routing Gatewayhttp://VOSIP/external/server/ModifyGatewayRouting
Request FormatParameter M/O Type Length Descriptionname M String 64 Routing Gateway Nameprefix O String Gateway PrefixprefixStyle O Integer Prefix Mode
0: Terminal1: Continual
password O String Gateway PasswordDefault: Random Create
customerPassword O String Self Service PasswordgatewayGroups O String Gateway Groupscapacity O Integer Line LimitlockType O Integer Lock Type
0: No Lock3: Lock AllDefault: 0
priority O Integer PriorityregisterType O Integer Register Type
0: Static1: Dynamic2: Register
remoteIp O String 64 IPrtpForwardType O Integer Media Proxy
0: Auto1: Enable2: DisableDefault: 0
encrypt O Boolean true: Encryptfalse: No Encrypt
79
protocol O Integer Protocol0: H3231: SIP
signalPort O Integer Signaling PortH323 Default: 1720SIP Default: 5060
localIp O String 64 Local IPBlank: Auto
mediaCheckDirection O Integer RTP Interrupt DetectionMode0: No Detect1: Detect whether VOS hassent RTP to Remote2: Detect whether VOS hasreceived Remote RTP3: Detect Both Side's RTPDefault: 0
maxCallDurationLower O Integer -1: Use System Parameter0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter0: No limit
calleeE164Restrict O Integer Callee Limit0: No Limit1: Limit Callee is Phone2: Limit Callee not Phone
callerE164CheckEnable O Boolean true: Enable Caller Checkfalse: Disable CallerCheck
callerE164CheckCity O Boolean true: Enable Caller CityCheckfalse: Disable Caller CityCheck
callerE164CheckMobile O Boolean true: Enable Caller Mobile
80
Checkfalse: Disable Caller MobileCheck
callerE164CheckOther O Boolean true: Enable Caller OtherCheckfalse: Disable Caller OtherCheck
calleeE164CheckEnable O Boolean true: Enable Callee Checkfalse: Disable CalleeCheck
calleeE164CheckCity O Boolean true: Enable Callee CityCheckfalse: Disable Callee CityCheck
calleeE164CheckMobile O Boolean true: Enable Callee MobileCheckfalse: Disable Callee MobileCheck
calleeE164CheckOther O Boolean true: Enable Callee OtherCheckfalse: Disable Callee OtherCheck
callinCallerPrefixesAllow O Boolean true: EnablecallinCallerPrefixesfalse: DisablecallinCallerPrefixes
callinCallerPrefixes O String 65535 Caller Prefixes ListcallinCalleePrefixesAllow O Boolean true: Enable
callinCalleePrefixesfalse: DisablecallinCalleePrefixes
callinCalleePrefixes O String 65535 Callee Prefixes ListcallinForwardPrefixesAllow O Boolean true: Enable
81
callinForwardPrefixessettingsfalse: DisablecallinForwardPrefixessettings
callinForwardPrefixes O String 65535 Call in forward prefixessettings
rewriteRulesInCaller O String 65535 Caller Rewrite RulerewriteRulesInCallee O String 65535 Callee Rewrite RulerewriteRulesInMobileAreaAllow
O Boolean true: EnablerewriteRulesInMobileAreafalse: DisablerewriteRulesInMobileArea
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite RulesSettings, separate bycomma
timeoutSetup O Integer H323 Setup Timeout(Unit:Second)0: Use System Parameter
timeoutCallProceeding O Integer H323 CallProceedingTimeout(Unit: Second)0: Use System Parameter
timeoutCallProceedingOlc O Integer H323 CallProceedinginclude Open LogicalChannel Timeout(Unit:Second)0: Use System Parameter
timeoutAlerting O Integer H323 AlertingTimeout(Unit: Second)0: Use System Parameter
timeoutInvite O Integer SIP Invite Timeout(Unit:Second)0: Use System Parameter
82
timeoutTrying O Integer SIP Trying Timeout(Unit:Second)0: Use System Parameter
timeoutSessionProgressSdp
O Integer SIP SessionProgressinclude SDP Timeout(Unit:Second)0: Use System Parameter
timeoutSessionProgress O Integer SIP SessionProgressTimeout(Unit: Second)0: Use System Parameter
timeoutRinging O Integer SIP Ring Timeout(Unit:Second)0: Use System Parameter
denyCallerCalleeAllow O Boolean true: EnabledenyCallerCalleefalse: DisabledenyCallerCallee
denyCallerCallee O String 65535 Format: [<Caller>:<Callee>[,<Caller>:<Callee>]…]e.g.: 025: 010,021: 023
denySameCityCodesAllow O Boolean true: EnabledenySameCityCodesSettingfalse: DisabledenySameCityCodesSetting
denySameCityCodes O String 65535 Deny Same City CodesSettings, use comma toseparate
checkMobileAreaAllow O Boolean true: EnablecheckMobileArea Settingsfalse: DisablecheckMobileArea Settings
83
checkMobileArea O String 65535 Mobile Area Settings, usecomma to separate
stopSwitchAfterOlc O Integer Stop Switch Gateway AfterOpen Logical Channel0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterSdp O Integer Stop Switch Gateway AfterReceived SDP0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterRtpStart O Integer Stop Switch Gateway AfterReceived RTP0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterUserBusy O Integer Stop Switch Gateway AfterReceived User Busy0: Use System Parameter1: Disable2: EnableDefault: 0
switchUntilConnect O Integer Switch Gateway UntilConnect0: Use System Parameter1: Disable2: EnableDefault: 0
sipResponseAddressMethod
O Integer SIP Response Address0: Response to Request
84
Address1: Response to Request IPuse port from Via
sipRequestAddressMethod O Integer SIP Request Address0: To Original Address1: To Original IP and Portfrom Contact2: To Contact
dtmfSendMethodH323 O Integer 0: Auto10: RFC283320: H.245 alphanumeric30: H.245 signal40: Q.931 keypad60: Off
dtmfSendMethodSIP O Integer 0: Auto10: RFC283350: SIP Info60: Off
dtmfReceiveMethod O Integer 0: All10: RFC283320: Signaling30: Off
dtmfSendPayloadTypeH323
O Integer Payload Type for H323DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMFSend
dtmfReceivePayloadType O Integer Payload Type for DTMFReceive
q931NumberingPlan O Integer Q931NumberingPlan-1: Use System Parameter0: UnknownPlan1: ISDNPlan3: DataPlan4: TelexPlan
85
8: NationalStandardPlan9: PrivatePlan15: ReservedPlan
q931NumberType O Integer Q931NumberType-1: Use System Parameter0: UnknownType1: InternationalType2: NationalType3: NetworkSpecificType4: SubscriberType6: AbbreviatedType7: ReservedType
q931PresentationIndicator O Integer Q931PresentationIndicator-1: Use System Parameter0: Presentation allowed1: Presentation restricted2: Number not available dueto interworking3: Reserved4: None
q931ScreeningIndicator O Integer Q931ScreeningIndicator-1: Use System Parameter0: User-provided, notscreened1: User-provided, verifiedand passed2: User-provided, verifiedand failed3: Network provided4: None
clearingAccount O String 64 Clearing Account Nameh323FastStart O Boolean true: Enable H323 fast start
false: Disable H323 faststart
86
h323H245Tunneling O Boolean true: Enable H323 H245tunnelingfalse: Disable H323 H245tunneling
h323H245InSetup O Boolean true: Enable H323 H245 inSetupfalse: Disable H323 H245 inSetup
h323T38 O Boolean true: Enable H323 T38false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer(RFC4028)false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100relfalse: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38false: Disable SIP T38
sipDisplay O Boolean true: Include Displayfalse: Exclude Display
sipRemotePartyId O Boolean true: IncludeRemotePartyIdfalse: ExcludeRemotePartyId
sipPrivacy O Integer 0: None1: Pass through2: id
sipPPreferredIdentity O Integer 0: None1: Pass through2: Caller number
sipPAssertedIdentity O Integer 0: None1: Pass through2: Caller number
groupE164Change O Boolean true: Enable Group E164
87
Changefalse: Disable Group E164Change
callerAllowLength O Integer Mask of Caller AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
calleeAllowLength O Integer Mask of Callee AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
callerLimitE164GroupsAllow
O Boolean true: AllowcallerLimitE164Groupsfalse: ForbiddencallerLimitE164Groups
callerLimitE164Groups O String 255 Caller List, separate bycomma
calleeLimitE164GroupsAllow
O Boolean true: AllowcalleeLimitE164Groupsfalse: ForbiddencalleeLimitE164Groups
calleeLimitE164Groups O String 255 Callee List, separate bycomma
h323G729SendMode O Integer H323 G729 NegotiationMode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729
88
or G729a as G729 andG729a
sipG729SendMode O Integer SIP G729 Negotiation Mode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729Annexb O Integer G729 annexb0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
sipG723Annexa O Integer G723 annexa0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecsfalse: Auto Negotiation
h323Codecs O Vector<String> H323 Codec ListsipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto NegotiationsipCodecs O Vector<String> SIP Codec ListfeerateRestrict O Boolean true: Check Callee Fee
Ratefalse: No Check
89
leastCostRouting O Boolean (feerateRestrict must betrue)true: Onfalse: Off
minProfitPercentEnable O Boolean Enable Min Profit PercentminProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second RatemaxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, setthis value as 0.01
enablePhoneDisplay O Boolean true: Use phone displaynumber as callerfalse: Use phone number ascaller
clearingAccountUseCalloutE164
O Boolean true: Use Callee afterrewrite as Clearing Accountfalse: Use Callee beforerewrite as Clearing Account
softswitchName O String 64 Soft Switch NameforwardSignalRewriteE164GroupEnable
O Boolean true: Enable ForwardSignal Rewritefalse: Disable ForwardSignal Rewrite
forwardSignalRewriteE164Group
O String 255 Forward Signal RewriteE164 Group
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
90
2.17Delete Routing Gatewayhttp://VOSIP/external/server/DeleteGatewayRouting
Request FormatParameter M/O Type Length Descriptionname M String Routing Gateway Name
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
91
2.18Get Routing Gatewayhttp://VOSIP/external/server/GetGatewayRouting
Request FormatParameter M/O Type Length Descriptionnames M String [] Gateway Name
Null: All
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoGatewayRoutings O InfoGatewayRouting [] Routing Gateway
Information
InfoGatewayRouting FormatParameter M/O Type Length Descriptionname M String 64 Routing Gateway Nameprefix M String Gateway PrefixprefixStyle M Integer Prefix Mode
0: Terminal1: Continual
password M String Gateway PasswordDefault: Random Create
customerPassword M String Self Service PasswordgatewayGroups M String Gateway Groupscapacity M Integer Line LimitlockType M Integer Lock Type
0: No Lock3: Lock AllDefault: 0
priority M Integer Priority
92
registerType M Integer Register Type0: Static1: Dynamic2: Register
remoteIp M String 64 IPrtpForwardType M Integer Media Proxy
0: Auto1: Enable2: DisableDefault: 0
encrypt M Boolean true: Encryptfalse: No Encrypt
protocol M Integer Protocol0: H3231: SIP
signalPort M Integer Signaling PortH323 Default: 1720SIP Default: 5060
localIp M String 64 Local IPBlank: Auto
mediaCheckDirection M Integer RTP Interrupt DetectionMode0: No Detect1: Detect whether VOS hassent RTP to Remote2: Detect whether VOS hasreceived Remote RTP3: Detect Both Side's RTPDefault: 0
maxCallDurationLower M Integer -1: Use System Parameter0: No limit
maxCallDurationUpper M Integer -1: Use System Parameter0: No limit
93
calleeE164Restrict M Integer Callee Limit0: No Limit1: Limit Callee is Phone2: Limit Callee not Phone
callerE164CheckEnable M Boolean true: Enable Caller Checkfalse: Disable CallerCheck
callerE164CheckCity M Boolean true: Enable Caller CityCheckfalse: Disable Caller CityCheck
callerE164CheckMobile M Boolean true: Enable Caller MobileCheckfalse: Disable Caller MobileCheck
callerE164CheckOther M Boolean true: Enable Caller OtherCheckfalse: Disable Caller OtherCheck
calleeE164CheckEnable M Boolean true: Enable Callee Checkfalse: Disable CalleeCheck
calleeE164CheckCity M Boolean true: Enable Callee CityCheckfalse: Disable Callee CityCheck
calleeE164CheckMobile M Boolean true: Enable Callee MobileCheckfalse: Disable Callee MobileCheck
calleeE164CheckOther M Boolean true: Enable Callee OtherCheckfalse: Disable Callee OtherCheck
94
callinCallerPrefixesAllow M Boolean true: EnablecallinCallerPrefixesfalse: DisablecallinCallerPrefixes
callinCallerPrefixes M String 65535 Caller Prefixes ListcallinCalleePrefixesAllow M Boolean true: Enable
callinCalleePrefixesfalse: DisablecallinCalleePrefixes
callinCalleePrefixes M String 65535 Callee Prefixes ListrewriteRulesInCaller M String 65535 Caller Rewrite RulerewriteRulesInCallee M String 65535 Callee Rewrite RulerewriteRulesInMobileAreaAllow
M Boolean true: EnablerewriteRulesInMobileAreafalse: DisablerewriteRulesInMobileArea
rewriteRulesInMobileArea M String 65535 Mobile Area Rewrite RulesSettings, separate bycomma
timeoutSetup M Integer H323 Setup Timeout(Unit:Second)0: Use System Parameter
timeoutCallProceeding M Integer H323 CallProceedingTimeout(Unit: Second)0: Use System Parameter
timeoutCallProceedingOlc M Integer H323 CallProceedinginclude Open LogicalChannel Timeout(Unit:Second)0: Use System Parameter
timeoutAlerting M Integer H323 AlertingTimeout(Unit: Second)0: Use System Parameter
95
timeoutInvite M Integer SIP Invite Timeout(Unit:Second)0: Use System Parameter
timeoutTrying M Integer SIP Trying Timeout(Unit:Second)0: Use System Parameter
timeoutSessionProgressSdp
M Integer SIP SessionProgressinclude SDP Timeout(Unit:Second)0: Use System Parameter
timeoutSessionProgress M Integer SIP SessionProgressTimeout(Unit: Second)0: Use System Parameter
timeoutRinging M Integer SIP Ring Timeout(Unit:Second)0: Use System Parameter
denyCallerCalleeAllow M Boolean true: EnabledenyCallerCalleefalse: DisabledenyCallerCallee
denyCallerCallee M String 65535 Format: [<Caller>:<Callee>[,<Caller>:<Callee>]…]e.g.: 025: 010,021: 023
denySameCityCodesAllow M Boolean true: EnabledenySameCityCodesSettingfalse: DisabledenySameCityCodesSetting
denySameCityCodes M String 65535 Deny Same City CodesSettings, use comma toseparate
96
checkMobileAreaAllow M Boolean true: EnablecheckMobileArea Settingsfalse: DisablecheckMobileArea Settings
checkMobileArea M String 65535 Mobile Area Settings, usecomma to separate
stopSwitchAfterOlc M Integer Stop Switch Gateway AfterOpen Logical Channel0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterSdp M Integer Stop Switch Gateway AfterReceived SDP0: Use System Parameter1: Disable2: EnableDefault: 0
stopSwitchAfterRtpStart M Integer Stop Switch Gateway AfterReceived RTP0: Use System Parameter1: Disable2: EnableDefault: 0
switchUntilConnect M Integer Switch Gateway UntilConnect0: Use System Parameter1: Disable2: EnableDefault: 0
sipResponseAddressMethod
M Integer SIP Response Address0: Response to RequestAddress1: Response to Request IP
97
use port from ViasipRequestAddressMethod M Integer SIP Request Address
0: To Original Address1: To Original IP and Portfrom Contact2: To Contact
dtmfSendMethodH323 M Integer 0: Auto10: RFC283320: H.245 alphanumeric30: H.245 signal40: Q.931 keypad60: Off
dtmfSendMethodSIP M Integer 0: Auto10: RFC283350: SIP Info60: Off
dtmfReceiveMethod M Integer 0: All10: RFC283320: Signaling30: Off
dtmfSendPayloadTypeH323
M Integer Payload Type for H323DTMF Send
dtmfSendPayloadTypeSIP M Integer Payload Type for SIP DTMFSend
dtmfReceivePayloadType M Integer Payload Type for DTMFReceive
q931NumberingPlan M Integer Q931NumberingPlan-1: Use System Parameter0: UnknownPlan1: ISDNPlan3: DataPlan4: TelexPlan8: NationalStandardPlan9: PrivatePlan
98
15: ReservedPlanq931NumberType M Integer Q931NumberType
-1: Use System Parameter0: UnknownType1: InternationalType2: NationalType3: NetworkSpecificType4: SubscriberType6: AbbreviatedType7: ReservedType
q931PresentationIndicator M Integer Q931PresentationIndicator-1: Use System Parameter0: Presentation allowed1: Presentation restricted2: Number not available dueto interworking3: Reserved4: None
q931ScreeningIndicator M Integer Q931ScreeningIndicator-1: Use System Parameter0: User-provided, notscreened1: User-provided, verifiedand passed2: User-provided, verifiedand failed3: Network provided4: None
clearingAccount M String 64 Clearing Account Nameh323FastStart M Boolean true: Enable H323 fast start
false: Disable H323 faststart
h323H245Tunneling M Boolean true: Enable H323 H245tunneling
99
false: Disable H323 H245tunneling
h323H245InSetup M Boolean true: Enable H323 H245 inSetupfalse: Disable H323 H245 inSetup
h323T38 M Boolean true: Enable H323 T38false: Disable H323 T38
sipTimer M Boolean true: Enable SIP Timer(RFC4028)false: Diable SIP Timer
sip100Rel M Boolean true: Enable SIP 100relfalse: Disable SIP 100rel
sipT38 M Boolean true: Enable SIP T38false: Disable SIP T38
sipDisplay M Boolean true: Include Displayfalse: Exclude Display
sipRemotePartyId M Boolean true: IncludeRemotePartyIdfalse: ExcludeRemotePartyId
sipPPreferredIdentity M Boolean true: IncludeP-Preferred-Identityfalse: ExcludeP-Preferred-Identity
sipPAssertedIdentity M Boolean true: IncludeP-Asserted-Identityfalse: ExcludeP-Asserted-Identity
groupE164Change M Boolean true: Enable Group E164Changefalse: Disable Group E164Change
100
callerAllowLength M Integer Mask of Caller AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
calleeAllowLength M Integer Mask of Callee AllowLength0: Allow All Length1<<x: Allow Length is x(x < 32)
callerLimitE164GroupsAllow
M Boolean true: AllowcallerLimitE164Groupsfalse: ForbiddencallerLimitE164Groups
callerLimitE164Groups M String 255 Caller List, separate bycomma
calleeLimitE164GroupsAllow
M Boolean true: AllowcalleeLimitE164Groupsfalse: ForbiddencalleeLimitE164Groups
calleeLimitE164Groups M String 255 Callee List, separate bycomma
h323G729SendMode M Integer H323 G729 NegotiationMode0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729SendMode M Integer SIP G729 Negotiation Mode
101
0: Auto, keep original G729codec1: G729, treat G729a orG729 as G7292: G729a, treat G729a orG729 as G729a3: G729&G729a, treat G729or G729a as G729 andG729a
sipG729Annexb M Integer G729 annexb0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
sipG723Annexa M Integer G723 annexa0: Auto1: annex=yes2: annex=no3: no annex4: transmit annex
h323CodecAssign M Boolean true: Assign H323 Codecsfalse: Auto Negotiation
h323Codecs M Vector<String> H323 Codec ListsipCodecAssign M Boolean true: Assign SIP Codecs
false: Auto NegotiationsipCodecs M Vector<String> SIP Codec ListfeerateRestrict M Boolean true: Check Callee Fee
Ratefalse: No Check
leastCostRouting M Boolean (feerateRestrict must betrue)true: Onfalse: Off
102
minProfitPercent M Integer (feerateRestrict must betrue)-1: No limitRange: -1-9999Default: -1
enablePhoneDisplay M Boolean true: Use phone displaynumber as callerfalse: Use phone number ascaller
clearingAccountUseCalloutE164
M Boolean true: Use Callee afterrewrite as Clearing Accountfalse: Use Callee beforerewrite as Clearing Account
softswitchName O String 64 Soft Switch NameforwardSignalRewriteE164GroupEnable
O Boolean true: Enable ForwardSignal Rewritefalse: Disable ForwardSignal Rewrite
forwardSignalRewriteE164Group
O String 255 Forward Signal RewriteE164 Group
103
2.19Get Online Routing Gatewayhttp://VOSIP/external/server/GetGatewayRoutingOnline
Request FormatParameter M/O Type Length Descriptionnames O String [] Gateway Name
Null: AllsoftswitchName O String Soft Switch Name
Null: All
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoGatewayRoutingOnlines O InfoGatewayRoutingOnline
[]Online Routing GatewayInformation
InfoGatewayRoutingOnline FormatParameter M/O Type Length Descriptionid M Integer Routing Gateway IDname M String Routing Gateway Nameprefix M String Routing Gateway PrefixcurrentCall M Integer Current Callcapacity M Integer Line Limitasr M double Average Success Ratioacd M Long Average Call DurationremoteIp M String IP list, use comma to
separatenatIp O String NAT AddresslocalIp M String Register IPregisterTime M Long Register Time (UTC)
0: Static Gateway
104
updateTime M Long Last Update Time (UTC)0: Static Gateway
keepTime M Long Online Time (Second)0: Static Gateway
cryptoType M Integer Encryption Type0: No Encryption1: RC4
registerName O String Register NamesoftswitchName M String Soft Switch NamesoftswitchIp M String Soft Switch IP
105
2.20Get Current Callhttp://VOSIP/external/server/GetCurrentCall
Frequently use this function may cause performance become lower.Request Format
Parameter M/O Type Length DescriptioncallerE164s O String [] CallercalleeE164s O String [] Callee
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoCurrentCalls O InfoCurrentCall [] Current Call Information
InfoCurrentCall FormatParameter M/O Type Length DescriptioncallerE164 M String CallercalleeE164 M String CalleecallerGatewayId M String Caller GatewaycalleeGatewayId M String Callee GatewayconnectedTime M Long Connected Time (UTC)keepTime M Long Above 0: Duration (Unit:
Million Second)-1: Setup-2: CallProceeding-3: CallProceeding(RTP)-4: Progress-5: Alerting-6: Connect-7: Invite-8: Trying
106
-9: SessionProgress-10: SessionProgress(SDP)-11: Ringing-12: Ok-13: Release-14: Transfering-15: TransferOk-16: TransferFailed-17: TransferCancel
callCodec M String Call CodeccallerCodec M String Caller CodeccalleeCodec M String Callee CodeccallerRtpIp M String Caller RTP InformationcalleeRtpIp M String Callee RTP InformationcallerReceiveDtmf M Integer Caller Receive DTMF Mode
0: Auto10: RFC283320: H.245 alphanumeric30: H.245 signal40: Q.931 keypad50: SIP Info60: Off
callerSendDtmf M Integer See callerReceiveDtmfcalleeReceiveDtmf M Integer See callerReceiveDtmfcalleeSendDtmf M Integer See callerReceiveDtmfcallerInfoRtpFlowAudio M InfoRtpFlow Caller Audio InformationcalleeInfoRtpFlowAudio M InfoRtpFlow Callee Audio InformationcallerInfoRtpFlowVideo M InfoRtpFlow Caller Video InformationcalleeInfoRtpFlowVideo M InfoRtpFlow Callee Video InformationcallerTerminal M String Caller Device NamecalleeTerminal M String Callee Device NamecallerCryptoType M Integer Caller Encryption Type
0: No Encryption
107
1: RC4calleeCryptoType M Integer Callee Encryption Type
0: No Encryption1: RC4
callId M Integer Call ID
InfoRtpFlow FormatParameter M/O Type Length DescriptionrtpPackets M Integer Receive PacketsrtpBytes M Integer Receive BytesrtpDuration M Long Duration
(Unit: Micro Second)
108
2.21Payhttp://VOSIP/external/server/Pay
Request FormatParameter M/O Type Length DescriptionownerName M String 64 NameownerType M Integer Type
2: Account6: Phone11: Active Phone Card25: Binded E16444: Mapping Gateway
money M double Amountmemo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoPay O InfoPay Pay Information
InfoPay FormatParameter M/O Type Length Descriptionaccount M String 64 Account Namemoney M double BalancevalidTime M Long Valid Time (UTC)payMoney M double Amount
109
2.22Create Suitehttp://VOSIP/external/server/CreateSuite
Request FormatParameter M/O Type Length Descriptionname M String 64 Suite NamerentPeriod M Integer Rent PeriodrentType M Integer Rent Type
0: Day1: Month2: Year
rentFee M double Rent FeegiftMoney M double Gift MoneyinfoGiftTimes O InfoGiftTime [] Gift Timememo O String Memo
InfoGiftTime FormatParameter M/O Type Length Descriptionprefix M String 65535 Area Prefix, separate by
commastartTime M Integer Start Time
(Seconds from 0:00)Default: 0Range: 0-86400
endTime M Integer Stop Time(Seconds from 0:00)Default: 0Range: 0-86400
giftTime M Integer Gift Time (Unit: second)billingTime M Integer Billing Periodmemo O String 255 Memo
110
Response FormatParameter M/O Type Length DescriptionretCode M Integer 0 Response Codeexception O String Error Informationid O Integer Suite Id
111
2.23Delete Suitehttp://VOSIP/external/server/DeleteSuite
Request FormatParameter M/O Type Length Descriptionid M Integer Suite Idforce O Integer 0: Normal delete, check
dependence1: Force delete, removedependence
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
112
2.24Get Suitehttp://VOSIP/external/server/GetSuite
Request FormatParameter M/O Type Length Descriptionids O Integer [] Suite Id List
Null: All
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoSuites O InfoSuite [] Suite Information
InfoSuite FormatParameter M/O Type Length Descriptionid M Integer Suite Idname M String Suite NamerentPeriod M Integer Rent PeriodrentType M Integer Rent Type
0: Day1: Month2: Year
rentFee M double Rent FeegiftMoney M double Gift MoneyinfoGiftTimes O InfoGiftTime [] Gift Timememo O String Memo
113
2.25Create Suite Orderhttp://VOSIP/external/server/CreateSuiteOrder
Request FormatParameter M/O Type Length DescriptionownerName M String 64 NameownerType M Integer Type
2: Account6: Phone
suiteId M Integer Suite IdavailableTime M Long Available Time
(UTC, Server Time Zone)0: Current Day 0:00
expireTime O Long Expire Time(UTC, Server Time Zone)Null: No Limit9223372036854775807: NoLimit
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Informationid O Integer Suite Order Id, If success
114
2.26Modify Suite Orderhttp://VOSIP/external/server/ModifySuiteOrder
Request FormatParameter M/O Type Length Descriptionid M Integer 64 Suite Order IdexpireTime O Long Expire Time
(UTC, Server Time Zone)Null: No Limit9223372036854775807: NoLimit
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
115
2.27Delete Suite Orderhttp://VOSIP/external/server/DeleteSuiteOrder
Request FormatParameter M/O Type Length Descriptionid M Integer Suite Order Id
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
116
2.28Get Suite Orderhttp://VOSIP/external/server/GetSuiteOrder
Request FormatParameter M/O Type Length DescriptionownerName M String 64 NameownerType M Integer Type
2: Account6: Phone
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoSuiteOrders O InfoSuiteOrder [] Suite Order Information
InfoSuiteOrder FormatParameter M/O Type Length Descriptionid M Integer Suite Order IdsuiteId M Integer Suite IdavailableTime M Long Available Time
(UTC, Server Time Zone)expireTime M Long Expire Time
(UTC, Server Time Zone)9223372036854775807: NoLimit
117
2.29Get Current Suitehttp://VOSIP/external/server/GetCurrentSuite
Request FormatParameter M/O Type Length DescriptionownerName M String 64 NameownerType M Integer Type
2: Account6: Phone
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoCurrentSuites O InfoCurrentSuite [] Suite Order Information
InfoCurrentSuite FormatParameter M/O Type Length Descriptionid M Integer Current Suite IdsuiteId M Integer Suite IdsuiteOrderId M Integer Suite Order IdrentPeriod M Integer Rent PeriodrentType M Integer Rent Type
0: Day1: Month2: Year
rentFee M double Rent FeegiftMoney M double Gift MoneyinfoGiftTimes O InfoGiftTime [] Gift Timememo O String Memo
118
2.30Delete Current Suitehttp://VOSIP/external/server/DeleteCurrentSuite
Request FormatParameter M/O Type Length Descriptionid M Integer 123 Current Suite Id
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
119
2.31Create Active Phone Cardhttp://VOSIP/external/server/CreateActivePhoneCard
Request FormatParameter M/O Type Length Descriptionpin M String 64 Card Numberaccount M String 64 Card Accountpassword O String 64 Card PassworddisplayE164 O String 64 Display NumberbindLimit O Integer Bind Number Limit
Null: No Limitmemo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Informationpassword O Integer Request without password,
system will generateautomatically.
120
2.32Modify Active Phone Cardhttp://VOSIP/external/server/ModifyActivePhoneCard
Request FormatParameter M/O Type Length Descriptionpin M String 64 Card Numberaccount O String 64 Card Accountpassword O String 64 Card PassworddisplayE164 O String 64 Display NumberbindLimit O Integer Bind Number Limit
Null: No Limitmemo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
121
2.33Delete Active Phone Cardhttp://VOSIP/external/server/DeleteActivePhoneCard
Request FormatParameter M/O Type Length Descriptionpin M String 64 Card Number
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
122
2.34Get Active Phone Cardhttp://VOSIP/external/server/GetActivePhoneCard
Request FormatParameter M/O Type Length Descriptionpins O String [] Card Number Listaccounts O String [] Account List
One of parameters is needed at least.
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoActivePhoneCards O InfoActivePhoneCard [] Active Phone Card
Information
InfoActivePhoneCard FormatParameter M/O Type Length Descriptionpin M String 64 Card Numberaccount M String 64 Card Accountpassword M String 64 Card PassworddisplayE164 M String 64 Display NumberbindLimit M Integer Bind Number Limit
Null: No LimitactiveTime M Long Active Time (UTC)memo M String 255 Memo
123
2.35Create Binded E164http://VOSIP/external/server/CreateBindedE164
Request FormatParameter M/O Type Length Descriptione164 M String 64 Bind Numberpin M String 64 Card NumberdisplayE164 O String 64 Display NumberrewriteRulesOutCallee O String 65535 Call Out Rewrite Rulelanguage O String 64 Languagememo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
124
2.36Modify Binded E164http://VOSIP/external/server/ModifyBindedE164
Request FormatParameter M/O Type Length Descriptione164 M String 64 Bind Numberpin O String 64 Card NumberdisplayE164 O String 64 Display NumberrewriteRulesOutCallee O String 65535 Call Out Rewrite Rulelanguage O String 64 Languagememo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
125
2.37Delete Binded E164http://VOSIP/external/server/DeleteBindedE164
Request FormatParameter M/O Type Length Descriptione164 M String 64 Bind Number
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
126
2.38Get Binded E164http://VOSIP/external/server/GetBindedE164
Request FormatParameter M/O Type Length Descriptione164s O String [] Binded Number Listpin O String 64 Card Numberaccount O String 64 Account
One of parameters is needed at least.
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoBindedE164s O InfoBindedE164 [] Binded Number Information
InfoBindedE164 FormatParameter M/O Type Length Descriptione164 M String 64 Binded Numberpin M String 64 Card Numberaccount M String 64 AccountdisplayE164 M String 64 Display NumberrewriteRulesOutCallee M String 65535 Call Out Rewrite RulebindTime M Long Bind Time (UTC)language M String 64 Languagememo M String 255 Memo
127
2.39Get Fee Rate Grouphttp://VOSIP/external/server/GetFeeRateGroup
Request FormatParameter M/O Type Length Descriptionnames O String [] Fee Rate Group List
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoFeeRateGroups O InfoFeeRateGroup [] Fee Rate Group Information
InfoFeeRateGroup FormatParameter M/O Type Length Descriptionname M String 64 Fee Rate Group Namememo M String 64 Memo
128
2.40Create Fee Rate Grouphttp://VOSIP/external/server/CreateFeeRateGroup
Request FormatParameter M/O Type Length Descriptionname M String 64 Fee Rate Group NamefakeMinute O Integer Equivalent Time to 60
Seconds for Calling Cardmemo O String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
129
2.41Modify Fee Rate Grouphttp://VOSIP/external/server/ModifyFeeRateGroup
Request FormatParameter M/O Type Length Descriptionname M String 64 Fee Rate Group NamefakeMinute O Integer Equivalent Time to 60
Seconds for Calling Cardmemo O String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
130
2.42Delete Fee Rate Grouphttp://VOSIP/external/server/DeleteFeeRateGroup
Request FormatParameter M/O Type Length Descriptionname M String 64 Fee Rate Group Name
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
131
2.43Get Fee Ratehttp://VOSIP/external/server/GetFeeRate
Request FormatParameter M/O Type Length DescriptionfeeRateGroup M String 64 Fee Rate GroupareaCodes O String [] Area Code
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoFeeRates O InfoFeeRate [] Fee Rate Information
InfoFeeRate FormatParameter M/O Type Length DescriptionfeePrefix M String 64 Rate PrefixareaCode M String 64 Area Prefixtype M Integer Rate Type
1: Net2: Local4: Domestic5: International
areaName M String 64 Area NameinfoFeeRateSections M InfoFeeRateSection [] Section Ratefee M double Billing Rateperiod M Integer Billing CyclelockType M Integer Lock Type
0: No Lock1: Lock
ivrFee M double Billing Rate for Calling CardivrPeriod M Integer Billing Cycle for Calling
132
Card Prompt
InfoFeeRateSection FormatParameter M/O Type Length Descriptionfee M double Money Amounttime M Integer Charged Durationposition M Integer Serial Number
133
2.44Get E164 Converthttp://VOSIP/external/server/GetE164Convert
Request FormatParameter M/O Type Length Descriptionaccount O String 64 Account Numbere164 O String 64 Phone Number
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoE164Converts O InfoE164Convert [] E164 Convert Information
InfoE164Convert FormatParameter M/O Type Length Descriptionaccount M String Account Namee164 M String Phone NumbermappingGatewayCallerE164
M String Mapping Gateway Caller
routingGatewayCalleeE164 M String Routing Gateway Calleememo M String Memo
134
2.45Get Pay Historyhttp://VOSIP/external/server/GetPayHistory
Request FormatParameter M/O Type Length Descriptionaccount O String 64 Account NumberagentAccount O String 64 Agent Account NumberbeginTime M String Begin Time
Format:yyyyMMddHHmmss
endTime M String End TimeFormat:yyyyMMddHHmmss
One of parameters is needed at least.
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoPayHistorys O InfoPayHistory[] Pay History Information
InfoPayHistory FormatParameter M/O Type Length Descriptionaccount M String Account Namefee M double Money Amounttype M Integer Type
0: Payment1: Credit2: Create Account3: Make Zero
payType M Integer Pay Type0: Cash
135
2: Phone Card5: Other
customerMoney M double Account Balance After PaypayTime M Long Pay Time (UTC)
136
2.46Get Cdrhttp://VOSIP/external/server/GetCdr
Request FormatParameter M/O Type Length Descriptionaccounts M String [] 64 Account Number ListcallerE164 O String 64 CallercalleeE164 O String 64 CalleecallerGateway O String 64 Caller GatewaycalleeGateway O String 64 Callee GatewaybeginTime M String Begin Time
Format: yyyyMMddendTime M String End Time
Format: yyyyMMdd
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoCdrs O InfoCdr [] CDR Information
InfoCdr FormatParameter M/O Type Length DescriptioncallerE164 M String Billing CallercallerAccessE164 M String Access CallercallerProductId M String Caller Device NamecallerToGatewayE164 M String Call Out CallercallerGateway M String Caller Gatewaycallerip M String Caller IPcalleeE164 M String Billing CalleecalleeAccessE164 M String Access CalleecalleeProductId M String Callee Device Name
137
calleeToGatewayE164 M String Call Out CalleecalleeGateway M String Callee Gatewaycalleeip M String Calle IPstart M Long Start Time (UTC)stop M Long Stop Time (UTC)holdTime M Integer Call Duration (Second)feeTime M Integer Fee Time (Second)fee M double FeefeePrefix M String Billing PrefixsuiteFee M double Suite FeesuiteFeeTime M Integer Suite Gift Time (Second)agentFee M double Agent FeeagentFeeTime M Integer Agent Fee Time (Second)agentFeePrefix M String Agent Billing PrefixagentSuiteFee M double Agent Suite FeeagentSuiteFeeTime M Integer Agent Gift Time (Second)callLevel M Integer Call Level
1: Net2: Local4: Domestic5: International
account M String Account NumberaccountName M String Account NameagentAccount M String Agent Account NumberagentName M String Agent Account NameendDirection M Integer Hangup Side
0: Caller1: Caller2: Server
endReason M Integer End ReasoncalleeBilling M Integer Billing
0: Caller Billing1: Callee Billing
138
2: External BillingbillingMode M Integer Billing Mode
0: By Phone Account1: By Mapping GatewayAccount2: By Binded NumberAccount3: By Active Phone CardAccount
139
2.47Get Customer Fee Reporthttp://VOSIP/external/server/GetReportCustomerFee
Request FormatParameter M/O Type Length Descriptionaccounts M String [] Account Number Listperiod M Integer Statistical Cycle (Day)
-2: By MonthbeginTime M String Begin Time
Format: yyyyMMddendTime M String End Time
Format: yyyyMMdd
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoReportCustomerFees O InfoReportCustomerFee [] Customer Fee Report
Information
InfoReportCustomerFee FormatParameter M/O Type Length DescriptionbeginTime M Long Begin Time (UTC)endTime M Long End Time (UTC)account M String Account NumberaccountName M String Account NamecdrCount M Long Total CDRtotalFee M double Total FeetotalTime M Long Total Time (Second)totalSuiteFee M double Total Suite FeetotalSuiteFeeTime M Long Total Suite Fee Time
(Second)
140
netFee M double Total Net FeenetTime M Long Total Net Fee Time
(Second)netCount M Integer Total Net CDRlocalFee M double Total Local FeelocalTime M Long Total Local Fee Time
(Second)localCount M Integer Total Local CDRdomesticFee M double Total Domestic FeedomesticTime M Long Total Domestic Fee Time
(Second)domesticCount M Integer Total Domestic CDRinternationalFee M double Total International FeeinternationalTime M Long Total International Fee Time
(Second)internationalCount M Integer Total International CDR
141
2.48Get Phone Fee Reporthttp://VOSIP/external/server/GetReportPhoneFee
Request FormatParameter M/O Type Length Descriptionaccounts M String 64 Account Numbere164s O String [] Phone Number Listperiod M Integer Statistical Cycle (Day)
-2: By MonthbeginTime M String Begin Time
Format: yyyyMMddendTime M String End Time
Format: yyyyMMdd
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoReportPhoneFees O InfoReportPhoneFee [] Phone Fee Report
Information
InfoReportPhoneFee FormatParameter M/O Type Length DescriptionbeginTime M Long Begin Time (UTC)endTime M Long End Time (UTC)e164 M String Phone NumbercalleeBilling M Integer 0: Caller Billing
1: Callee Billingaccount M String Account NumberaccountName M String Account NameagentAccount M String Agent AccountcdrCount M Long Total CDR
142
totalFee M double Total FeetotalTime M Long Total Time (Second)totalSuiteFee M double Total Suite FeetotalSuiteFeeTime M Long Total Suite Fee Time
(Second)netFee M double Total Net FeenetTime M Long Total Net Fee Time
(Second)netCount M Integer Total Net CDRlocalFee M double Total Local FeelocalTime M Long Total Local Fee Time
(Second)localCount M Integer Total Local CDRdomesticFee M double Total Domestic FeedomesticTime M Long Total Domestic Fee Time
(Second)domesticCount M Integer Total Domestic CDRinternationalFee M double Total International FeeinternationalTime M Long Total International Fee Time
(Second)internationalCount M Integer Total International CDR
143
2.49Get Customer Location Fee Reporthttp://VOSIP/external/server/GetReportCustomerLocationFee
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account NumberareaCode O String 64 Area Prefixperiod M Integer Statistical Cycle (Day)
-2: By MonthbeginTime M String Begin Time
Format: yyyyMMddendTime M String End Time
Format: yyyyMMdd
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoReportCustomerLocationFees
O InfoReportCustomerLocationFee []
Customer Location FeeReport Information
InfoReportCustomerLocationFee FormatParameter M/O Type Length DescriptionbeginTime M Long Begin Time (UTC)endTime M Long End Time (UTC)areaCode M String Area PrefixareaName M String Area Nameaccount M String Account NumberaccountName M String Account NameagentAccount M String Agent AccountcdrCount M Long Total CDRtotalFee M double Total Fee
144
totalTime M Long Total Local Fee Time(Second)
totalSuiteFee M double Total Suite FeetotalSuiteFeeTime M Long Total Suite Fee Time
(Second)
145
2.50Create CDRhttp://VOSIP/external/server/CreateCdr
Request FormatParameter M/O Type Length DescriptionbillingMode M Integer Billing Mode
0: By callerE164’s PhoneAccount1: By callerGatewayId’sMapping Gateway Account2: By callerE164’s BindedNumber Account3: By callerE164’s ActivePhone Card Account
account O String Billing AccountNull: Choose By BillingMode
callerE164 O String 64 CallercalleeE164 O String 64 CalleecallerIp O String 64 Caller IPcallerGatewayId O String 64 Caller GatewaycallerProductId O String 64 Caller Device NamecallerToGatewayE164 O String 64 Call Out CallercalleeIp O String 64 Callee IPcalleeGatewayId O String 64 Callee GatewaycalleeProductId O String 64 Callee Device NamecalleeToGatewayE164 O String 64 Call Out CalleestartTime O Long Begin Time (UTC)
Null: Use Server CurrentTime
stopTime O Long End Time (UTC)Null: Use startTime
146
billingTime M Integer Billing Time (Calculate bycalleeE164’s billingperiod)
endDirection O Integer Hangup Side0: Caller1: Caller2: Server
endReason O Integer End ReasonflowNo O Long -1: Create by System
>=0: Use the number asprimary key, if conflict willnot billing
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
147
2.51Get Customer Phone Bookhttp://VOSIP/external/server/GetCustomerPhoneBook
Request FormatParameter M/O Type Length Descriptionaccount O String 64 Account Numbere164 O String 64 Phone Number
Response FormatParameter M/O Type Length DescriptionretCode M Integer 0 Response Codeexception O String Error InformationinfoCustomerPhoneBooks O InfoCustomerPhoneBook [] Customer Phone Book
Information
InfoCustomerPhoneBook FormatParameter M/O Type Length Descriptione164 M String 64 Phone NumbershortE164s M String[] Short Number Listname M String Namedepartment M String DepartmentdeviceType M Integer Device Type
0: None1: Mobile2: Phone3: IP Phone
addressType M Integer Address Type0: None1: Office2: Home
type M Integer Type0: User Create
148
1: Auto SavelastUpdateTime M Long Last Update Time (UTC)memo M String Memo
149
2.52Create Customer Phone Bookhttp://VOSIP/external/server/CreateCustomerPhoneBook
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account Numbere164 M String 64 Phone Numberoverwrite O Boolean true: if number exists, over
write the old onefalse: if number exists, showerror
shortE164s O String[] Short Number Listname O String 64 Namedepartment O String 64 DepartmentdeviceType O Integer Device Type
0: None1: Mobile2: Phone3: IP Phone
addressType O Integer Address Type0: None1: Office2: Home
type O Integer Type0: User Create1: Auto Save
memo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
150
2.53Modify Customer Phone Bookhttp://VOSIP/external/server/ModifyCustomerPhoneBook
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account Numbere164 M String 64 Phone NumbernewE164 O String 64 New Phone NumbershortE164s O String[] Short Number Listname O String 64 Namedepartment O String 64 DepartmentdeviceType O Integer Device Type
0: None1: Mobile2: Phone3: IP Phone
addressType O Integer Address Type0: None1: Office2: Home
type O Integer Type0: User Create1: Auto Save
memo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
151
2.54Delete Customer Phone Bookhttp://VOSIP/external/server/DeleteCustomerPhoneBook
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account Numbere164s M String[] 64 Phone Number List
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
152
2.55Get Soft Switchhttp://VOSIP/external/server/GetSoftSwitch
Request FormatParameter M/O Type Length Description
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoSoftSwitches O InfoSoftSwitch [] Soft Switch Information
InfoSoftSwitch FormatParameter M/O Type Length Descriptionname M String Soft Switch Nameidentification M String Soft Switch IDcreateTime M Long Create Time (UTC)accessTime O Long Access Time (UTC)accessAddress O String Access IPmemo M String Memo
153
2.56Get Performancehttp://VOSIP/external/server/GetPerformance
Request FormatParameter M/O Type Length Description
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoPerformance O InfoPerformance Performance Information
InfoPerformance FormatParameter M/O Type Length DescriptioncallSize M Integer Current CallcdrQueueSize M Integer CDR Queue Size
154
2.57Pay By Phone Cardhttp://VOSIP/external/server/PayByPhoneCard
Request FormatParameter M/O Type Length DescriptionownerName M String 64 NameownerType M Integer Type
2: Account6: Phone11: Active Phone Card25: Binded E16444: Mapping Gateway
pin M String Card Numberpassword O String Card Password
Null: Check Pin Onlymemo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoPay O InfoPay Pay Information
155
2.58Phone Card Activehttp://VOSIP/external/server/PhoneCardActive
Request FormatParameter M/O Type Length Descriptionpin M String Card Numberpassword O String Card Password
Null: Check Pin OnlybindedE164 O String 64 Binded Number
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
156
2.59Callbackhttp://VOSIP/external/server/CallBack
Request FormatParameter M/O Type Length DescriptioncallerE164 M String Caller (Input by User)calleeE164s M String Callee (Use "," to separate
numbers)accessE164 M String Access Number (Number of
phone, which providescallback service.)
accessE164Password M String Access Password (Phone'spassword)
callbackBillingE164 O String Call Back Charge NumbercallbackBillingPassword O String Call Back Charge PasswordcalloutBillingE164 O String Callout Charge NumbercalloutBillingPassword O String Callout Charge Password
Additional Description
Audio service is decided by accessE164. If password is set, system will do verify.
Callback Billing
First Line Billing Mode1.Access Number’s Phone: Use accessE164’s Phone Account2.In-use Phone Card: Order: callbackBillingE164’s Binded Number Account, callbackBillingE164’s Active Phone Card Account3.Binded Number|Active Phonecard|Platform’s Phone|Access Number’s Phone: Order: callbackBillingE164’s Binded Number Account,
callbackBillingE164’s Active Phone Card Account, callbackBillingE164’s Phone Account, accessE164’s Phone Account4.Platform Phone: Use callbackBillingE164’s Phone Account
Second Line Billing Mode
157
1.Access Number’s Phone: Use accessE164’s Phone Account2.In-use Phone Card: Order: calloutBillingE164’s Binded Number Account, calloutBillingE164’s Active Phone Card Account3.Platform Phone: Use calloutBillingE164’s Phone Account
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
158
2.60Play Audiohttp://VOSIP/external/server/PlayAudio
Request FormatParameter M/O Type Length Descriptionaudioes M String Audio List, separate by
commalanguage O String Default: Use accessE164’s
languagecallee M String CalleeaccessE164 M String Access Number (Number of
phone, which providescallback service.)
accessE164Password M String Access Password (Phone'spassword)
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
159
2.61Get Available Timehttp://VOSIP/external/server/GetAvailableTime
Request FormatParameter M/O Type Length DescriptionbillingName M String Billing NamebillingMode M Integer 0: Phone
1: Mapping Gateway2: Binded Number3: Phone Card4: Use phone card first, thenmapping gateway
calleeE164 M String Callee NumbercalleeEndpointType O Integer 0: Phone
1: Mapping GatewayroutingGateway O String 64 Routing Gateway NamecalleeToGatewayE164 O String 64 Number after rewrite by
routing gateway(Used when routinggateway check remainmoney of clearing account)
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationInfoAvailableTime O InfoAvailableTime Available Time Information
InfoAvailableTime FormatParameter M/O Type Length Descriptionaccount O String Account NumberaccountName O String Account Name
160
accountMoney O Double Account Balance (ExcludeSuite's gift money)
timeRemain M Integer >0: Remain Time<0: End Reason
timeRemainRoutingGateway
O Integer >0: Routing Gateway'sRemain Time<0: Routing Gateway's EndReason
161
2.62Get IVR Second Available Timehttp://VOSIP/external/server/GetIvrSecondAvailableTime
Request FormatParameter M/O Type Length DescriptionbillingName M String Billing NamebillingMode M Integer 0: Phone
1: Active Phone Card2: Auto, Binded Number >Phone Card Number >Phone Number3: Caller's Phone
calleeE164 M String Callee NumbermergeBillingType O Integer 0: No merge
1: merge access billing tosecond line2: merge caller billing tosecond line
mergeE164 O String 64 Merge NumberfirstE164 O String 64 First line's calleefirstConnectTime O Long First line's connect time
(UTC)firstStopTime O Long First line's stop time (UTC)
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoIvrSecondAvailableTime O InfoIvrSecondAvailableTime Available Time Information
InfoIvrSecondAvailableTime FormatParameter M/O Type Length Description
162
account O String Account NumberaccountName O String Account NameaccountMoney O Double Account Balance (Exclude
Suite's gift money)timeRemain M Integer >0: Remain Time
<0: End Reason
163
2.63Get Consumptionhttp://VOSIP/external/server/GetConsumption
Request FormatParameter M/O Type Length Descriptionaccount O String 64 Account NumberagentAccount O String 64 Agent Account NumberbeginTime M String Format:
yyyyMMddHHmmssendTime M String Format:
yyyyMMddHHmmssOne of "account" or "agentAccount" is needed.
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoConsumptions O InfoConsumption[] Consumption Information
InfoConsumption FormatParameter M/O Type Length Descriptionaccount M String Account Numbermoney M Double Account ConsumptioncustomerMoney M Double Account Balancetype M Integer 0: Suite Rent
1: Phone Month Rent2: Phone UnderConsumption3: Suite UnderConsumption
consumptionName M Integer Sourcetime M Long Time (UTC)
164
2.64Get All Customershttp://VOSIP/external/server/GetAllCustomers
Request FormatParameter M/O Type Length Description
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Informationaccounts O String[] Account List
165
2.65Reserve CalleeE164http://VOSIP/external/server/ReserveCalleeE164
Request FormatParameter M/O Type Length DescriptioncallerE164 M String Caller NumbercalleeE164 M String Callee NumberaccessE164 M String Access Number (Number of
phone, which providescallback service.)
accessE164Password M String Access Password (Phone'spassword)
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
166
2.66Create LimitedE164http://VOSIP/external/server/CreateLimitedE164
Request FormatParameter M/O Type Length DescriptionlimitE164GroupName M String 255 LimitedE164 group nameinfoLimitE164s M InfoLimitE164 [] LimitedE164 group list
InfoLimitE164 formatParameter M/O Type Length Descriptione164 M String 64 Numbermemo O String 255 Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
167
2.67Create IvrAudiohttp://VOSIP/external/server/CreateIvrAudio
Request FormatParameter M/O Type Length Descriptiontype M Integer Audio Type
0:public audio1:internal audio2:polyphonic ringtone3:ippbx audio4:direct/callback audio5:valuadded audio6:alarm prompt audio7:voice mail audio
name M String Audio namelanguage O String LanguageivrServiceName O String Ivr service namememo O String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Informationid O Integer Ivr audio identification
168
2.68Modify IvrAudiohttp://VOSIP/external/server/ModifyIvrAudio
Request FormatParameter M/O Type Length Descriptionid M Integer Ivr audio identificationlanguage O String LanguageivrServiceName O String Ivr service namememo O String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
169
2.69Delete IvrAudiohttp://VOSIP/external/server/DeleteIvrAudio
Request FormatParameter M/O Type Length Descriptionid M Integer Ivr audio identification
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
170
2.70 Get IvrAudiohttp://VOSIP/external/server/GetIvrAudio
Request FormatParameter M/O Type Length Descriptiontype M Integer Audio Type
0:public audio1:internal audio2:polyphonic ringtone3:ippbx audio4:direct/callback audio5:valuadded audio6:alarm prompt audio7:voice mail audio
ids O Integer Ivr audio identification list
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoIvrAudios O InfoIvrAudio [] Ivr audio list
InfoIvrAduio FormatParameter M/O Type Length Descriptionid M int vr audio identificationtype M Integer Audio Type
0:public audio1:internal audio2:polyphonic ringtone3:ippbx audio4:direct/callback audio
171
5:valuadded audio6:alarm prompt audio7:voice mail audio
name M String Audio namelanguage O String LanguageivrServiceName O String Ivr service namesize M Integer Memory sizememo O String Memo
172
2.71 Modify IvrAudio Datahttp://VOSIP/external/server/ModifyIvrAudioData
Request FormatParameter M/O Type Length Descriptionid M Integer Ivr audio identificationdata M String Wav file, the byte stream
should be converted tohexadecimal stringFile format:PCM_SIGNED 8000.0 Hz,
16 bit, mono, 2bytes/frame,little-endian
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
173
2.72Create E164Converthttp://VOSIP/external/server/CreateE164Convert
Request FormatParameter M/O Type Length DescriptionmappingGatewayCallerE164
M String Mapping gateway comingcaller
e164 M String Phone numberroutingGatewayCalleeE164 M String Routing gateway outbound
numbermemo M String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Informationid O Integer Identification
174
2.73Modify E164Converthttp://VOSIP/external/server/ModifyE164Convert
Request FormatParameter M/O Type Length Descriptionid M Integer IdentificationmappingGatewayCallerE164
O String Mapping gateway comingcaller
routingGatewayCalleeE164 O String Routing gateway outboundnumber
memo O String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
175
2.74Delete E164Converthttp://VOSIP/external/server/DeleteE164Convert
Request FormatParameter M/O Type Length Descriptionid M Integer Identification
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
176
2.75Disconnect Current Callhttp://VOSIP/external/server/DisconnectCurrentCall
Request FormatParameter M/O Type Length DescriptionCallIds M Integer Call Id
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
177
2.76GetAllPhoneOnlinehttp://VOSIP/external/server/GetAllPhoneOnline
Request FormatParameter M/O Type Length Description
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationE164s O String[] All phone online list
178
2.77DeleteLimitE164http://VOSIP/external/server/DeleteLimitE164
Request FormatParameter M/O Type Length DescriptionlimitE164GroupName M String 255 LimitE164GroupNamee164s M String [] Number list
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
179
2.78Get Phone Cardhttp://VOSIP/external/server/GetPhoneCard
Request FormatParameter M/O Type Length Descriptionpin M String [] 255 Card NumberPassword O String Password
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoPhoneCards O InfoPhoneCard [] Phone Card
Information
InfoPhoneCard FormatParameter M/O Type Length Descriptionmoney M double Money amountlimitMoney M double Overdraft limitedbitsOfConfig M int Fuction
1<<1:Create account1<<2:Create account andactive phone card1<<3: Create account andphone number1<<4:Recharge1<<5:Replace accountbilling rate group1<<6:Package joined inaccount package order1<<7:Money charged intoaccount balance
180
feeRateGroup M String Group nameexpireTime M Long Exprie time(UTC)usedTime O Long Used time(UTC)usedAccount O String Used accountagentAccount M String Agent AccountsuiteNames M String [] Suite name listmemo M String Memo
181
2.79Create Alarmhttp://VOSIP/external/server/CreateAlarm
Request FormatParameter M/O Type Length Descriptionname M String 255 告警名称
level Integer Level0:General1:Minor2:Major3:Critical
value O Double Default:0x7fffffff(32-bitinteger)
alarmInfo O String Alarm informationstartTime O Long Alarm start time(UTC) )
stopTime O Long Alarm stop time(UTC)upper O Double Upper value
Range:0x8000000~0x7fffffff(32-bitinteger)
lower O Double Lower valueRange:0x8000000~0x7fffffff(32-bitinteger)
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
182
2.80CreateMediaBlockIphttp://VOSIP/external/server/ CreateMediaBlockIp
Request FormatParameter M/O Type Length Descriptionip M String 255 Ip addressmemo O String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
183
2.81DeleteMediaBlockIphttp://VOSIP/external/server/DeleteMediaBlockIp
Request FormatParameter M/O Type Length Descriptionip M String 255 Ip addressmemo O String Memo
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error Information
184
2.82GetAlarmCurrenthttp://VOSIP/external/server/GetAlarmCurrent
Request FormatParameter M/O Type Length Description
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Codeexception O String Error InformationinfoAlarmCurrents O InfoAlarmCurrent Current alarm list
InfoAlarmCurrentFormatParameter M/O Type Length Descriptionid M int Alarm idtype M int Alarm type
20000:Routing ASR20001:RoutingACD20002:routing concurrencydecline20003:CPU20004:Memory20005:Harddisk20006:Pending CDR20007:Account Balance20009:Package receive20010:Bytes receive20011:Package transmit20012:Bytes transmit20013:MappingASR20014:MappingACD20015:Mapping
185
concurrency decline20016:Converstion time20017:Database20018:Process terminated20019:Standby enable20020:Illegal call20021:Clock deviation20022:Routing concurrencyrise20023:Mappingconcurrency rise20026:Mac limited20027: Master synchronizestatus20028: Slave synchronizestatus
level M int Level0:General1:Minor2:Major3:Critica
name M String Alarm namestartTime M long Alarm start time(UTC)stopTime O Long Alarm stop time(UTC)value M double Alarm valueupper O Double Alarm upper valuelower O Double Alarm lower valueconfirmUser O String Confirm userconfirmTime O Long Confirm time(UTC)memo M String Memo
186
3.Send RequestSend Request use HTTP+JSON, address can be configured.
3.1IVR Request Push DTMF InformationInterface Name: PushDtmfInfoRequest Format
Parameter M/O Type Length DescriptionflowNo M Long Call IDcallerE164 M String 64 CallercalleeE164 M String 64 CalleeaccessE164 M String 64 Access NumbermenuName M String 64 Menu Namedtmf M String 64 DTMF Information
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Code
(Define by externalsystem, system willexecute menu defined byresponse code.If no response, defaultmenu will be executed.)
exception O String Error InformationaudioNames O String [] Audio List
187
3.2IVR Request Push DTMF Information 2Interface Name: PushDtmfInfos
Request FormatParameter M/O Type Length DescriptionflowNo M Long Call IdcallerE164 M String 64 CallercalleeE164 M String 64 CalleeaccessE164 M String 64 Access NumberinfoDtmfs M InfoDtmf [] DTMF Information
InfoDtmf FormatParameter M/O Type Length DescriptionmenuName M String 64 Menu Namedtmf M String 64 DTMF
Response FormatParameter M/O Type Length DescriptionretCode M Integer Response Code
(Define by externalsystem, system willexecute menu defined byresponse code.If no response, defaultmenu will be executed.)
exception O String Error InformationaudioNames O String [] Audio List
188
3.3Phone Online/offline ReportInterface Name: PhoneOnline
Request FormatParameter M/O Type Length Descriptione164 M String 64 Phone numberdids M String[] Did listonline M boolean True: Phone Online
false: Phone OfflineeventTime M long Time of eventlocalIp M String Local IplocalPort M int Local portremoteIp M String Remote ipproductId M String Device name
Response FormatParameter M/O Type Length DescriptionretCode M Integer
189
3.4Call State ReportInterface Name: CallStateReport
Request FormatParameter M/O Type Length DescriptioncallId M integer 64 Call idetificationcallState M integer Call state
-1: Setup-2: CallProceeding-3: CallProceeding(RTP-4: Progress-5: Alerting-6: Connet-7: Invite-8: Trying-9: SessionProgress-10:SessionProgress(SDP)-11:Ringing-12:Ok-13: Release-18: Call authentication
eventTime M long Time of eventcallerE164 M String CallercalleeE164 M String CalleecallerGatewayId O String Name of caller gatewaycalleeGatewayId O String Name of callee gatewaycallerIp M String Caller ipcalleeIp M String Callee ipcallerLocalIp M String Caller local ipcalleeLocalIp M String Callee local ip
Response Format
190
Parameter M/O Type Length DescriptionretCode M Integer
191
3.5Customer Money ChangeInterface Name: CustomerMoneyChange
Request FormatParameter M/O Type Length Descriptionaccount M String 64 Account idmoney M double Account balance
Response FormatParameter M/O Type Length DescriptionretCode M Integer
192
3.6Current Alarm ReportInterface Name: AlarmCurrentReport
Request FormatParameter M/O Type Length DescriptioninfoAlarmCurrents M InfoAlarmCurrent [] Current alrm list,
Response FormatParameter M/O Type Length DescriptionretCode M Integer
top related