Make Your own VOS3000 Web Application or Mobile Application by Using this API, But Be Careful About Security.

We will not be Liable for Security or Data Loss.

VOS3000 Web Interface

For Third Party

Version 2.1.7.0

2017

Please Stay Tuned at VOS3000.Com for Updates, Thanks

Make Your own VOS3000 Web Application or Mobile Application by Using this API, But Be Careful About Security. We will not be Liable for Security or Data Loss.

Download Link: http://www.vos3000.com/downloads.php

Please Stay Tuned at VOS3000.Com for Updates, Thanks

Make Your own VOS3000 Web Application or Mobile Application by Using this API, But Be Careful About Security. We will not be Liable for Security or Data Loss.

Contents

1 Descriptions ......................................................................................................................................................................................................................................... 1
2 Receive Request ................................................................................................................................................................................................................................... 2
2.1 Create Customer .......................................................................................................................................................................................................................... 2
2.2 Modify Customer ......................................................................................................................................................................................................................... 5
2.3 Delete Customer .......................................................................................................................................................................................................................... 7
2.4 Get Customer ............................................................................................................................................................................................................................... 8
2.5 Create Phone .............................................................................................................................................................................................................................. 10
2.6 Modify Phone ............................................................................................................................................................................................................................ 22
2.7 Delete Phone .............................................................................................................................................................................................................................. 24
2.8 Get Phone................................................................................................................................................................................................................................... 25
2.9 Get Online Phone ....................................................................................................................................................................................................................... 28
2.10 Create Gateway Mapping .......................................................................................................................................................................................................... 29
2.11 Modify Mapping Gateway ......................................................................................................................................................................................................... 40
2.12 Get Mapping Gateway ............................................................................................................................................................................................................... 51
2.13 Delete Mapping Gateway .......................................................................................................................................................................................................... 62
2.14 Get Online Mapping Gateway ................................................................................................................................................................................................... 63
2.15 Create Routing Gateway ............................................................................................................................................................................................................ 65
2.16 Modify Routing Gateway .......................................................................................................................................................................................................... 78
2.17 Delete Routing Gateway ............................................................................................................................................................................................................ 90
2.18 Get Routing Gateway................................................................................................................................................................................................................. 91
2.19 Get Online Routing Gateway ................................................................................................................................................................................................... 103
2.20 Get Current Call ....................................................................................................................................................................................................................... 105
2.21 Pay ........................................................................................................................................................................................................................................... 108
2.22 Create Suite .............................................................................................................................................................................................................................. 109
2.23 Delete Suite .............................................................................................................................................................................................................................. 111
2.24 Get Suite .................................................................................................................................................................................................................................. 112
2.25 Create Suite Order ................................................................................................................................................................................................................... 113
2.26 Modify Suite Order .................................................................................................................................................................................................................. 114
2.27 Delete Suite Order ................................................................................................................................................................................................................... 115
2.28 Get Suite Order ........................................................................................................................................................................................................................ 116

Please Stay Tuned at VOS3000.Com for Updates, Thanks

Make Your own VOS3000 Web Application or Mobile Application by Using this API, But Be Careful About Security. We will not be Liable for Security or Data Loss.

2.29 Get Current Suite ..................................................................................................................................................................................................................... 117

2.30 Delete Current Suite................................................................................................................................................................................................................. 118
2.31 Create Active Phone Card........................................................................................................................................................................................................ 119
2.32 Modify Active Phone Card ...................................................................................................................................................................................................... 120
2.33 Delete Active Phone Card ........................................................................................................................................................................................................ 121
2.34 Get Active Phone Card ............................................................................................................................................................................................................ 122
2.35 Create Binded E164 ................................................................................................................................................................................................................. 123
2.36 Modify Binded E164................................................................................................................................................................................................................ 124
2.37 Delete Binded E164 ................................................................................................................................................................................................................. 125
2.38 Get Binded E164 ...................................................................................................................................................................................................................... 126
2.39 Get Fee Rate Group ................................................................................................................................................................................................................. 127
2.40 Create Fee Rate Group ............................................................................................................................................................................................................. 128
2.41 Modify Fee Rate Group ........................................................................................................................................................................................................... 129
2.42 Delete Fee Rate Group ............................................................................................................................................................................................................. 130
2.43 Get Fee Rate ............................................................................................................................................................................................................................. 131
2.44 Get E164 Convert .................................................................................................................................................................................................................... 133
2.45 Get Pay History ........................................................................................................................................................................................................................ 134
2.46 Get Cdr ..................................................................................................................................................................................................................................... 136
2.47 Get Customer Fee Report ......................................................................................................................................................................................................... 139
2.48 Get Phone Fee Report .............................................................................................................................................................................................................. 141
2.49 Get Customer Location Fee Report ......................................................................................................................................................................................... 143
2.50 Create CDR .............................................................................................................................................................................................................................. 145
2.51 Get Customer Phone Book....................................................................................................................................................................................................... 147
2.52 Create Customer Phone Book .................................................................................................................................................................................................. 149
2.53 Modify Customer Phone Book ................................................................................................................................................................................................ 150
2.54 Delete Customer Phone Book .................................................................................................................................................................................................. 151
2.55 Get Soft Switch ........................................................................................................................................................................................................................ 152
2.56 Get Performance ...................................................................................................................................................................................................................... 153
2.57 Pay By Phone Card .................................................................................................................................................................................................................. 154
2.58 Phone Card Active ................................................................................................................................................................................................................... 155
2.59 Callback ................................................................................................................................................................................................................................... 156
2.60 Play Audio ............................................................................................................................................................................................................................... 158
2.61 Get Available Time .................................................................................................................................................................................................................. 159
2.62 Get IVR Second Available Time ............................................................................................................................................................................................. 161

Please Stay Tuned at VOS3000.Com for Updates, Thanks

Make Your own VOS3000 Web Application or Mobile Application by Using this API, But Be Careful About Security. We will not be Liable for Security or Data Loss.

2.63 Get Consumption ..................................................................................................................................................................................................................... 163

2.64 Get All Customers .................................................................................................................................................................................................................... 164
2.65 Reserve CalleeE164 ................................................................................................................................................................................................................. 165
2.66 Create LimitedE164 ................................................................................................................................................................................................................. 166
2.67 Create IvrAudio ....................................................................................................................................................................................................................... 167
2.68 Modify IvrAudio ...................................................................................................................................................................................................................... 168
2.69 Delete IvrAudio ....................................................................................................................................................................................................................... 169
2.70 Get IvrAudio ............................................................................................................................................................................................................................ 170
2.71 Modify IvrAudio Data ............................................................................................................................................................................................................. 172
2.72 Create E164Convert ................................................................................................................................................................................................................. 173
2.73 Modify E164Convert ............................................................................................................................................................................................................... 174
2.74 Delete E164Convert ................................................................................................................................................................................................................. 175
2.75 Disconnect Current Call ........................................................................................................................................................................................................... 176
2.76 GetAllPhoneOnline .................................................................................................................................................................................................................. 177
2.77 DeleteLimitE164 ...................................................................................................................................................................................................................... 178
2.78 Get Phone Card ........................................................................................................................................................................................................................ 179
2.79 Create Alarm ............................................................................................................................................................................................................................ 181
2.80 CreateMediaBlockIp ................................................................................................................................................................................................................ 182
2.81 DeleteMediaBlockIp ................................................................................................................................................................................................................ 183
2.82 GetAlarmCurrent ..................................................................................................................................................................................................................... 184
3 Send Request.................................................................................................................................................................................................................................... 186
3.1 IVR Request Push DTMF Information .................................................................................................................................................................................... 186
3.2 IVR Request Push DTMF Information 2 ................................................................................................................................................................................. 187
3.3 Phone Online/offline Report .................................................................................................................................................................................................... 188
3.4 Call State Report ...................................................................................................................................................................................................................... 189
3.5 Customer Money Change ......................................................................................................................................................................................................... 191
3.6 Current Alarm Report .............................................................................................................................................................................................................. 192

Please Stay Tuned at VOS3000.Com for Updates, Thanks

1Descriptions
This document describes the interface of VOS3000 for third party developers. Interfaces described in this document and the final interpretation.

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 means
this parameter is invalid.
(VOS3000.Com)

1
2Receive Request
2.1 Create Customer
http://VOSIP/external/server/CreateCustomer

Request Format
Parameter M/O Type Length Description
account M String 64 Account Number
name O String 64 Account Name
money O Double For Create Account Only
Default: 0
limitMoney O Double Overdraft Limit
Default: 0
feeRateGroup O String 64 Billing Fee Rate Group
Name
(Do not support "Use Lower
Rate")
type O Integer Account Type
0: General Account
1: Phone Card
2: Clearing Account
Default: 0
lockType O Integer Lock Type
0: Normal
1: Locked
Default: 0
agentAccount O String 64 Agent
phoneBookLimit O Integer Phone Book Number Limit
Default: 0
validTime O Long Account Valid Time (UTC
Time)
Default: 0 (Set by System
Parameter)

2
memo O String 255 Memo
infoCustomerAdditional O InfoCustomerAdditional Additional Information

InfoCustomerAdditional Format
Parameter M/O Type Length Description
cardType O Integer Certification Type
0: ID Card
1: Passport
2: Officer ID
3: Employee ID
4: Student ID
5: Others
Default: 0
cardNumber O String Certification Number
address O String Detailed Address
postCode O String Post Code
linkMan O String Contact
telephone O String Phone Number
fax O String Fax
email O String Email
emailCc O String CC
emailBcc O String BCC
reportType O Integer Report Sending Type
0: None
1: Daily
2: Weekly
3: Monthly
Default: 0
companyName O String Company Name
bank O String Bank Account

Response Format
Parameter M/O Type Length Description

3
retCode M Integer Response Code
exception O String Error Information

4
2.2 Modify Customer
http://VOSIP/external/server/ModifyCustomer

Request Format
Parameter M/O Type Length Description
account M String 64 Account Number
name O String 64 Account Name
limitMoney O Double Overdraft Limit
Default: 0
feeRateGroup O String 64 Billing Fee Rate Group
Name
(Do not support "Use Lower
Rate")
type O Integer Account Type
0: General Account
1: Phone Card
2: Clearing Account
Default: 0
lockType O Integer Lock Type
0: Normal
1: Locked
Default: 0
agentAccount O String 64 Agent
phoneBookLimit O Integer Phone Book Number Limit
Default: 0
validTime O Long Account Valid Time (UTC
Time)
Default: 0 (Set by System
Parameter)
memo O String 255 Memo
infoCustomerAdditional O InfoCustomerAdditional Additional Information

5
Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

6
2.3 Delete Customer
http://VOSIP/external/server/DeleteCustomer

Request Format
Parameter M/O Type Length Description
account M String 64 Account Number

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

7
2.4 Get Customer
http://VOSIP/external/server/GetCustomer

Request Format
Parameter M/O Type Length Description
accounts O String[] Account List
e164s O String[] E164 List
One of parameters is needed at least.

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoCustomers O InfoCustomer[] Customer Information

InfoCustomer Format
Parameter M/O Type Length Description
account M String 64 Account Number
name M String 64 Account Name
money M double Balance
limitMoney M double Over Draft
feeRateGroup M String 64 Billing Fee Rate
Blank: no fee rate group
type M Integer Account Type
0: General Account
1: Phone Card
2: Clearing Account
lockType M Integer Lock Type
0: Normal
1: Locked
agentAccount M String 64 Agent Account
Blank: no agent

8
phoneBookLimit M Integer Phone Book Number Limit
startTime M Long Customer Create Time
validTime M Long Customer Expire Time
todayConsumption M double Today Consumption
memo M String 255 Memo
infoCustomerAdditional M InfoCustomerAdditional Customer Additional
Information

9
2.5 Create Phone
http://VOSIP/external/server/CreatePhone

Request Format
Parameter M/O Type Length Description
autoCreateAccount M Boolean Create Phone and Account
e164 M String 64 Phone Number
password O String 32 Phone Password
displayNumber O String 64 Display Number
lockType O Integer Lock Type
0: No Lock
1: Lock Call Out
2: Lock Call In
3: Lock All
callLevel O Integer Call Level
1: Net
2: Local
4: Domestic
5: International
feerateGroup O String 255 Fee Rate Group
monthlyMoneyMinimum O Double Monthly Minimum
Consumption
monthlyMoneyMaximum O Double Monthly Maximum
Consumption
monthlyRentFee O Double Monthly Rent Fee
rewriteRulesOutCallee O String 65535 Call Out Callee Rewrite
Rule
rewriteRulesInCallee O String 65535 Call In Callee Rewrite Rule
rewriteRulesInCaller O String 65535 Call In Caller Rewrite Rule
routingGatewayGroupsAllo O Boolean true: Allow Selected
w Gateway Group
false: Forbidden Selected

10
Gateway Group
routingGatewayGroups O String 255 Routing Gateway Group
Name
Blank for All
account O String 64 Phone’s Account
equipment O String 64 Phone’s Soft Switch
Blank for All
calleeBilling O Boolean true: Enable
false: Disable
customerPassword O String 32 Web Query Password
lineCallIn O Integer Call In Number Limit
lineCallOut O Integer Call Out Number Limit
lineCapacity O Integer Total Number Limit
phonebookLimit O Integer Phone Book Number Limit
callerLimitE164GroupsAllo O Boolean true: Allow Selected
w Caller Group
false: Forbidden Selected
Caller Group
callerLimitE164Groups O String 255 Caller Limit E164 Groups
Blank for All
calleeLimitE164Allow O Boolean true: Allow Selected
Callee Group
false: Forbidden Selected
Gallee Group
calleeLimitE164Groups O String 255 Callee Limit E164 Groups
Blank for All
memo O String 255 Memo
infoPhoneValueAdded O InfoPhoneValueAdded Value Added Settings
infoPhoneAdditional O InfoPhoneAdditional Additional Settings

InfoPhoneValueAdded Format
Parameter M/O Type Length Description

11
callerIdDisplay O Boolean true: Enable
false: Disable
callTransfer O Boolean true: Enable
false: Disable
doNotDisturb O Boolean true: Enable
false: Disable
periodForwarding O Boolean true: Enable
false: Disable
infoPhoneValueAddedPerio O InfoPhoneValueAddedPerio Period Forward Settings
dForwardings dForwarding[]
unconditionalForward O Boolean true: Enable
false: Disable
unconditionalForwardE164 O InfoPhoneValueAddedForw Unconditional Forward
ardE164 Settings
noAnswerForward O Boolean true: Enable
false: Disable
noAnswerForwardE164 O InfoPhoneValueAddedForw No Answer Forward
ardE164 Settings
offlineForward O Boolean true: Enable
false: Disable
offlineForwardE164 O InfoPhoneValueAddedForw Off Line Forward Settings
ardE164
busyForward O Boolean true: Enable
false: Disable
busyForwardE164 O InfoPhoneValueAddedForw Busy Forward Settings
ardE164
colorRing O Boolean true: Enable
false: Disable
remoteColorRingPassthrou O Boolean true: Enable
gh false: Disable
colorRingName O String 64 Color Ring Name
unableToConnectVoicePro O Integer Prompt for Unable Connect
mpts 0: Default

12
1: On
2: Off
callRemainingTimePrompts O Integer Prompt for Remain Time
0: Default
1: On
2: Off
balanceNotEnoughAlarm O Integer Prompt for Balance
0: Default
1: Money Left
2: Time Left
3: Off
voiceMail O Boolean true: Enable
false: Disable
voiceMailCheckPassword O Boolean true: Enable
false: Disable
voiceMailMaxNumber O Integer Voice Mail Number
-1: Set by System
Parameter
voiceMailExpireDay O Integer Voice Mail Expire Day
-1: Set by System
Parameter
voiceMailAudioType O Integer 0: Default
1: Customized

InfoPhoneValueAddedPeriodForwarding Format
Parameter M/O Type Length Description
weekOfDay O String 32 0: Sunday
1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday

13
Blank: 0,1,2,3,4,5,6
beginSecondInDay O Integer Start Time
(Seconds from 0:00)
Default: 0
Range: 0-86400
endSecondInDay O Integer Stop Time
(Seconds from 0:00)
Default: 0
Range: 0-86400
forwardE164 O InfoPhoneValueAddedForw Forward E164 Settings
ardE164

InfoPhoneValueAddedForwardE164 Format
Parameter M/O Type Length Description
forwardMethod O Integer Forwarding Mode
0: Sequence
1: Poll
3: Random
Default: 0
alertSecond O Integer Ringing Duration
Unit: Seconds, no use for
last number.
Default: -1, use default
value
e164 O String 255 Forward Number, use
comma to separate

InfoPhoneAdditional Format
Parameter M/O Type Length Description

registerType O Integer Register Type

0: Static
1: Dynamic
2: Mapping Gateway

14
protocol O Integer Protocol
0: H323
1: SIP
ip O String 32 IP for Static Register
port O Integer Port for Static Register
localIp O String Local IP for Static
Register
rtpRelay O Integer Media Proxy
0: Auto
1: Enable
2: Disable
Default: 0
rtpInterruptDetection O Integer RTP Interrupt Detection
Mode
0: No Detect
1: Detect whether VOS has
sent RTP to Remote
2: Detect whether VOS has
received Remote RTP
3: Detect Both Side's RTP
Default: 0
callDurationLimit O Integer Conversation Limitation,
Unit: Seconds
-1: Use System Parameter
0: No limit
Default: -1
callTransferBillingMethod O Integer Call Transfer Billing Mode
0: Callee
1: Caller
useCallerPhoneDisplay O Integer Use Phone Display Number
0: Use System Parameter
1: On
2: Off
Default: 0

15
noBillingToPhone O Integer No billing, when the other
side is phone
0: Use System Parameter
1: On
2: Off
Default: 0
displayCallerShortNumber O Boolean true: On
false: Off
useRoutingGatewayNotOnli O Integer If phone is offline, try
ne routing gateway
0: Use System Parameter
1: On
2: Off
Default: 0
minProfitPercentEnable O Boolean Enable Min Profit Percent
minProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%
Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second Rate
maxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, set
this value as 0.01
firstRoutingPolicy O Integer First Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
secondRoutingPolicy O Integer Second Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
sipAuthenticationMethod O Integer SIP Call Authentication
Mode
0: IP

16
1: IP and Port
2: Password
sipRemoteAlertingMethod O Integer Remote Ring Back Mode
0: Default
1: d183+SDP
2: 180+SDP
sipTimerSupport O Boolean true: Enable Timer
(RFC4028)
false: Disable Timer
sip100RelSupport O Boolean true: Enable 100rel
false: Disable 100rel
sipT38Support O Boolean true: Enable t38
false: Disable t38
sipPrivacySupport O Boolean true: Enable Privacy
false: Omit Privacy
sipPrivacy O Integer 0: None
1: Pass through
2: id
sipPPreferredIdentity O Integer 0: None
1: Pass through
2: Caller number
sipPAssertedIdentity O Integer 0: None
1: Pass through
2: Caller number
dtmfReceiveMethod O Integer DTMF Receive
0: All
10: RFC2833
20: Signaling
30: Off
dtmfSIPSendMethod O Integer SIP DTMF Send
0: Auto
10: RFC2833
50: SIP INFO

17
60: Off
sipCodecAssign O Boolean true: Specify SIP Codec
false: Auto Negotiation
sipCodecs O String [] Codec:
audio/AMR
audio/DVI4
audio/G722
audio/G723
audio/G726-16
audio/G726-24
audio/G726-32
audio/G726-40
audio/G728
audio/G729
audio/G729D
audio/G729E
audio/GSM
audio/GSM-EFR
audio/iLBC
audio/L8
audio/L16
audio/LPC
audio/MPA
audio/parityfec
audio/PCMA
audio/PCMU
audio/QCELP
audio/RED
audio/VDVI
audio/Speex
audio/Speex-FEC
audio/Speex-Wideband
audio/Speex-Wideband-FE
C

18
audio/SILK
video/BT656
video/CelB
video/JPEG
video/H261
video/H263
video/H263-1998
video/H263-2000
video/H264
video/MPV
video/MP2T
video/MP1S
video/MP2P
video/parityfec
video/RED
video/BMPEG
video/nv
video/VP8

ivrEquipmentType O Integer Equipment Type

-1: None
1: Direct/Callback
2: IP PBX
3: Value Added
ivrServiceName O String Service Name
ivrCallbackBillingMode O Integer Callback First Line
Billing
0: Access Number’ Phone
1: In-use Phone Card
2: Auto
(Order: Binded Number,
Active Phone Card, Phone,
Access Number’s Phone)
3: Phone

19
ivrCallbackMergeBillingMod O Integer Callback Second Line
e Billing Mode
0: None
1: Add to Access Number
Rate
2: Add to Caller Rate
ivrDirectMergeBillingMode O Integer Direct Second Line Billing
Mode
0: None
1: Add to Access Number
Rate
2: Add to Caller Rate
ivrSecondBillingMode O Integer Second Line Billing Mode
0: Access Number’s Phone
1: In-use Phone Card
3: Phone
ivrCallbackBillingSecordNot O Boolean true: Billing on access
ConnectedOnAccessE164 number, if second line not
connected
ivrCallbackBillingSecordCo O Boolean true: Billing on second line
nnectedOnSecondAccount account, if second line
connected
ivrAccessVerifyActivePhone O Boolean true: Caller Number Verify
Card Active Phone Card
ivrAccessVerifyBindedE164 O Boolean true: Caller Number Verify
Binded Number
ivrAccessVerifyCallerE164P O Boolean true: Caller Number Verify
hone Phone
ivrAccessVerifyAccessE164 O Boolean true: Callee Number Verify
Phone Access Number Account
ivrEnablePhoneSetting O Boolean true: Enable
false: Disable
lrnEnable O Boolean Enable LRN Query

20
lrnEatPrefixLength O Integer Omit prefix length
lrnFailureAction O Integer 0: Reject the call
1: Use original number
lrnInterstateBillingPrefix O String Billing Prefix for different
area
lrnUndeterminedBillingPrefi O String Billing Prefix for unknown
x area

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
password O String If no password, system will
generate one automatically.

21
2.6 Modify Phone
http://VOSIP/external/server/ModifyPhone

Request Format
Parameter M/O Type Length Description
e164 M String 64 Phone Number
password O String 32 Phone Password
displayNumber O String 64 Display Number
lockType O Integer Lock Type
0: No Lock
1: Lock Call Out
2: Lock Call In
3: Lock All
callLevel O Integer Call Level
1: Net
2: Local
4: Domestic
5: International
feerateGroup O String 255 Fee Rate Group
monthlyMoneyMinimum O Double Monthly Minimum
Consumption
monthlyMoneyMaximum O Double Monthly Maximum
Consumption
monthlyRentFee O Double Monthly Rent Fee
rewriteRulesOutCallee O String 65535 Call Out Callee Rewrite
Rule
rewriteRulesInCallee O String 65535 Call In Callee Rewrite Rule
rewriteRulesInCaller O String 65535 Call In Caller Rewrite Rule
routingGatewayGroupsAllo O Boolean true: Allow Selected
w Gateway Group
false: Forbidden Selected
Gateway Group

22
routingGatewayGroups O String 255 Routing Gateway Group
Name
Blank for All
account O String 64 Phone’s Account
equipment O String 64 Phone’s Soft Switch
Blank for All
calleeBilling O Boolean true: Enable
false: Disable
customerPassword O String 32 Web Query Password
lineCallIn O Integer Call In Number Limit
lineCallOut O Integer Call Out Number Limit
lineCapacity O Integer Total Number Limit
phonebookLimit O Integer Phone Book Number Limit
callerLimitE164GroupsAllo O Boolean true: Allow Selected
w Caller Group
false: Forbidden Selected
Caller Group
callerLimitE164Groups O String 255 Caller Limit E164 Groups
Blank for All
calleeLimitE164Allow O Boolean true: Allow Selected
Callee Group
false: Forbidden Selected
Gallee Group
calleeLimitE164Groups O String 255 Callee Limit E164 Groups
Blank for All
memo O String 255 Memo
infoPhoneValueAdded O InfoPhoneValueAdded Value Added Settings
infoPhoneAdditional O InfoPhoneAdditional Additional Settings

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

23
2.7 Delete Phone
http://VOSIP/external/server/DeletePhone

Request Format
Parameter M/O Type Length Description
e164 M String 64 Phone Number

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

24
2.8 Get Phone
http://VOSIP/external/server/GetPhone

Request Format
Parameter M/O Type Length Description
e164s O String [] E164 List
accounts O String [] Account List
One of parameters is needed at least.

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoPhones O InfoPhone [] Phone Information

InfoPhone Format
Parameter M/O Type Length Description
e164 M String 64 Phone Number
password O String 32 Phone Password
displayNumber O String 64 Display Number
lockType O Integer Lock Type
0: No Lock
1: Lock Call Out
2: Lock Call In
3: Lock All
callLevel O Integer Call Level
1: Net
2: Local
4: Domestic
5: International
feerateGroup O String 255 Fee Rate Group
monthlyMoneyMinimum O Double Monthly Minimum

25
Consumption
monthlyMoneyMaximum O Double Monthly Maximum
Consumption
monthlyRentFee O Double Monthly Rent Fee
rewriteRulesOutCallee O String 65535 Call Out Callee Rewrite
Rule
rewriteRulesInCallee O String 65535 Call In Callee Rewrite Rule
routingGatewayGroupsAllo O Boolean true: Allow Selected
w Gateway Group
false: Forbidden Selected
Gateway Group
routingGatewayGroups O String 255 Routing Gateway Group
Name
Blank for All
account O String 64 Phone’s Account
equipment O String 64 Phone’s Soft Switch
Blank for All
calleeBilling O Boolean true: Enable
false: Disable
customerPassword O String 32 Web Query Password
lineCallIn O Integer Call In Number Limit
lineCallOut O Integer Call Out Number Limit
lineCapacity O Integer Total Number Limit
phonebookLimit O Integer Phone Book Number Limit
callerLimitE164GroupsAllo O Boolean true: Allow Selected
w Caller Group
false: Forbidden Selected
Caller Group
callerLimitE164Groups O String 255 Caller Limit E164 Groups
Blank for All
calleeLimitE164Allow O Boolean true: Allow Selected
Callee Group
false: Forbidden Selected

26
Gallee Group
calleeLimitE164Groups O String 255 Callee Limit E164 Groups
Blank for All
memo O String 255 Memo
infoPhoneValueAdded O InfoPhoneValueAdded Value Added Settings
infoPhoneAdditional O InfoPhoneAdditional Additional Settings

27
2.9 Get Online Phone
http://VOSIP/external/server/GetPhoneOnline

Request Format
Parameter M/O Type Length Description
e164s M String [] E164 List

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoPhoneOnlines O InfoPhoneOnline [] Online Phone Information

InfoPhoneOnline Format
Parameter M/O Type Length Description
e164 M String 64 Phone Number
currentCall M Integer Current Call
remoteIp M String Remote IP
localIp M String Local IP
registerTime M Long Register Time (UTC)
updateTime M Long Update Time (UTC)
protocol M Integer Protocol Type
0: H323
1: SIP
cryptoType M Integer Encryption Type
0: No Encryption
1: RC4
productId M String Device Name

28
2.10 Create Gateway Mapping
http://VOSIP/external/server/CreateGatewayMapping

Request Format
Parameter M/O Type Length Description
name M String 64 Mapping Gateway Name
password O String 64 Register Password
lockType O Integer Lock Type
0: No Lock
3: Lock All
callLevel O Integer Call Level
1: Net
2: Local
4: Domestic
5: International
capacity O Integer Line Limit
priority O Integer Priority
gatewayGroups O String 65535 Gateway Groups, use
comma to separate
routingGatewayGroupsAllo O Boolean true: Allow
w false: Forbidden
routingGatewayGroups O String 65535 Routing Gateway Groups
Blank: All
registerType O Integer Register Type
0: Static
1: Dynamic
remoteIps O String 65535 IP list, use comma to
separate
callerE164CheckEnable O Boolean true: Enable Caller Check
false: Disable Caller
Check
callerE164CheckCity O Boolean true: Enable Caller City
Check

29
false: Disable Caller City
Check
callerE164CheckMobile O Boolean true: Enable Caller Mobile
Check
false: Disable Caller Mobile
Check
callerE164CheckOther O Boolean true: Enable Caller Other
Check
false: Disable Caller Other
Check
calleeE164CheckEnable O Boolean true: Enable Callee Check
false: Disable Callee
Check
calleeE164CheckCity O Boolean true: Enable Callee City
Check
false: Disable Callee City
Check
calleeE164CheckMobile O Boolean true: Enable Callee Mobile
Check
false: Disable Callee Mobile
Check
calleeE164CheckOther O Boolean true: Enable Callee Other
Check
false: Disable Callee Other
Check
customerPassword O String Web Query Password
rtpForwardType O Integer Media Proxy
0: Auto
1: Enable
2: Disable
Default: 0
mediaCheckDirection O Integer RTP Interrupt Detection
Mode

30
0: No Detect
1: Detect whether VOS has
sent RTP to Remote
2: Detect whether VOS has
received Remote RTP
3: Detect Both Side's RTP
Default: 0
calleeE164Restrict O Integer Callee Limit
0: No Limit
1: Limit Callee is Phone
2: Limit Callee not Phone
maxCallDurationLower O Integer -1: Use System Parameter
0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter
0: No limit
allowPhoneBilling O Boolean Billing on Phone Account, If
caller matches phone
number
allowBindedE164Billing O Boolean Billing on Binded E164
Account, If caller matches
binded e164
enablePhoneSetting O Boolean Use phone settings when
caller matches phone
number
denySameCityCodesAllow O Boolean true: Enable
denySameCityCodes
Setting
false: Disable
denySameCityCodes
Setting
denySameCityCodes O String 65535 Deny Same City Codes
Settings, use comma to
separate

31
checkMobileAreaAllow O Boolean true: Enable
checkMobileArea Settings
false: Disable
checkMobileArea Settings
checkMobileArea O String 65535 Mobile Area Settings, use
comma to separate
calloutCalleePrefixesAllow O Boolean true: Enable
calloutCalleePrefixes
Settings
false: Disable
calloutCalleePrefixes
Settings
calloutCalleePrefixes O String 65535 Callout Callee Prefixes
Settings
calloutCallerPrefixesAllow O Boolean true: Enable
calloutCallerPrefixes
Settings
false: Disable
calloutCallerPrefixes
Settings
calloutCallerPrefixes O String 65535 Callout Caller Prefixes
Settings
rewriteRulesOutCallee O String 65535 Callee Rewrite Rule
rewriteRulesOutCaller O String 65535 Caller Rewrite Rule
rewriteRulesInMobileAreaAl O Boolean true: Enable
low rewriteRulesInMobileArea
Settings
false: Disable
rewriteRulesInMobileArea
Settings
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite Rules
Settings, separate by
comma

32
timeoutCallProceeding O Integer Unit: Second
-1: Use System Parameter
0: No limit
sipResponseAddressMetho O Integer SIP Response Address
d 0: Response to Request
Address
1: Response to Request IP
use port from Via
sipRequestAddressMethod O Integer SIP Request Address
0: To Original Address
1: To Original IP and Port
from Contact
2: To Contact
dtmfSendMethodH323 O Integer 0: Auto
10: RFC2833
20: H.245 alphanumeric
30: H.245 signal
40: Q.931 keypad
60: Off
dtmfSendMethodSIP O Integer 0: Auto
10: RFC2833
50: SIP Info
60: Off
dtmfReceiveMethod O Integer 0: All
10: RFC2833
20: Signaling
30: Off
dtmfSendPayloadTypeH32 O Integer Payload Type for H323
3 DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMF
Send
dtmfReceivePayloadType O Integer Payload Type for DTMF
Receive

33
q931ProgressIndicator O Integer -1: Auto
0: Off
1:
ProgressNotEndToEndISD
N
2:
ProgressDestinationNonIS
DN
3: ProgressOriginNotISDN
4:
ProgressReturnedToISDN
5: ProgressServiceChange
8:
ProgressInbandInformation
Available
account O String Billing Account
callTimeoutQ931CauseValu O Integer H323 Cause Replace
e 0: No Replace
Above 0: Refer to RFC
callTimeoutSIPCode O Integer SIP Cause Replace
0: No Replace
Above 0: Refer to RFC
sipRemoteRingSignal O Integer SIP Remote Ring Signal
0: Auto
1: 183+SDP
2: 180+SDP
sipCalleeE164Domain O Integer SIP Callee
0: Use field To
1: Use field Invite
sipCallerE164Domain O Integer SIP Caller
0: Use field From
1: Use field RemotePartId
2: Use field Display
h323CalleeE164Domain O Integer H323 Callee

34
0: Use field
CalledPartyNumber
1: Use field
DestinationAddress
h323CallerE164Domain O Integer H323 Caller
0: Use field
CallingPartyNumber
1: Use field SourceAddress
2: Use field Display
memo O String Memo
sipAuthenticationMethod O Integer SIP Call Authentication
Mode
0: IP
1: IP and Port
2: Password
h323FastStart O Boolean true: Enable H323 fast start
false: Disable H323 fast
start
h323H245Tunneling O Boolean true: Enable H323 H245
tunneling
false: Disable H323 H245
tunneling
h323H245InSetup O Boolean true: Enable H323 H245 in
Setup
false: Disable H323 H245 in
Setup
h323AutoCallProceeding O Boolean true: Enable H323 send
response after receive call
request
false: Disable H323 send
response after receive call
request
h323CallProceedingFromSI O Boolean Caller is H323, Callee is SIP
PTrying true: convert trying to

35
CallProceeding
false: no convert
h323AlertingFromSIP183Sd O Boolean Caller is H323, Callee is SIP
p true: convert Alerting to
CallProceeding
false: no convert
h323T38 O Boolean true: Enable H323 T38
false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer
(RFC4028)
false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100rel
false: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38
false: Disable SIP T38
sipDisplay O Boolean true: Include Display
false: Exclude Display
sipRemotePartyId O Boolean true: Include
RemotePartyId
false: Exclude
RemotePartyId
sipPrivacySupport O Boolean true: Enable privacy
false: Omit privacy
groupE164Change O Boolean true: Enable Group E164
Change
false: Disable Group E164
Change
callerAllowLength O Integer Mask of Caller Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
calleeAllowLength O Integer Mask of Callee Allow

36
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
callerLimitE164GroupsAllo O Boolean true: Allow
w callerLimitE164Groups
false: Forbidden
callerLimitE164Groups
callerLimitE164Groups O String Caller List, separate by
comma
calleeLimitE164GroupsAllo O Boolean true: Allow
w calleeLimitE164Groups
false: Forbidden
calleeLimitE164Groups
calleeLimitE164Groups O String Callee List, separate by
comma
minProfitPercentEnable O Boolean Enable Min Profit Percent
minProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%
Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second Rate
maxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, set
this value as 0.01
firstRoutePolicy O Integer First Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
secondRoutePolicy O Integer Second Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
h323G729SendMode O Integer H323 G729 Negotiation

37
Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729SendMode O Integer SIP G729 Negotiation Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729Annexb O Integer G729 annexb
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
sipG723Annexa O Integer G723 annexa
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecs
false: Auto Negotiation

38
h323Codecs O Vector<String> H323 Codec List
sipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto Negotiation
sipCodecs O Vector<String> SIP Codec List
forwardSignalRewriteE164 O Boolean true: Enable Forward
GroupEnable Signal Rewrite
false: Disable Forward
Signal Rewrite
forwardSignalRewriteE164 O String 255 Forward Signal Rewrite
Group E164 Group
lrnEnable O Boolean Enable LRN Query
lrnEatPrefixLength O Integer Omit prefix length
lrnFailureAction O Integer 0: Reject the call
1: Use original number
lrnInterstateBillingPrefix O String Billing Prefix for different
area
lrnUndeterminedBillingPrefi O String Billing Prefix for unknown
x area

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

39
2.11 Modify Mapping Gateway
http://VOSIP/external/server/ModifyGatewayMapping

Request Format
Parameter M/O Type Length Description
name M String 64 Mapping Gateway Name
password O String 64 Register Password
lockType O Integer Lock Type
0: No Lock
3: Lock All
callLevel O Integer Call Level
1: Net
2: Local
4: Domestic
5: International
capacity O Integer Line Limit
priority O Integer Priority
gatewayGroups O String 65535 Gateway Groups, use
comma to separate
routingGatewayGroupsAllo O Boolean true: Allow
w false: Forbidden
routingGatewayGroups O String 65535 Routing Gateway Groups
Blank: All
registerType O Integer Register Type
0: Static
1: Dynamic
remoteIps O String 65535 IP list, use comma to
separate
callerE164CheckEnable O Boolean true: Enable Caller Check
false: Disable Caller
Check
callerE164CheckCity O Boolean true: Enable Caller City
Check

40
false: Disable Caller City
Check
callerE164CheckMobile O Boolean true: Enable Caller Mobile
Check
false: Disable Caller Mobile
Check
callerE164CheckOther O Boolean true: Enable Caller Other
Check
false: Disable Caller Other
Check
calleeE164CheckEnable O Boolean true: Enable Callee Check
false: Disable Callee
Check
calleeE164CheckCity O Boolean true: Enable Callee City
Check
false: Disable Callee City
Check
calleeE164CheckMobile O Boolean true: Enable Callee Mobile
Check
false: Disable Callee Mobile
Check
calleeE164CheckOther O Boolean true: Enable Callee Other
Check
false: Disable Callee Other
Check
customerPassword O String Web Query Password
rtpForwardType O Integer Media Proxy
0: Auto
1: Enable
2: Disable
Default: 0
mediaCheckDirection O Integer RTP Interrupt Detection
Mode

41
0: No Detect
1: Detect whether VOS has
sent RTP to Remote
2: Detect whether VOS has
received Remote RTP
3: Detect Both Side's RTP
Default: 0
calleeE164Restrict O Integer Callee Limit
0: No Limit
1: Limit Callee is Phone
2: Limit Callee not Phone
maxCallDurationLower O Integer -1: Use System Parameter
0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter
0: No limit
allowPhoneBilling O Boolean Billing on Phone Account, If
caller matches phone
number
allowBindedE164Billing O Boolean Billing on Binded E164
Account, If caller matches
binded e164
enablePhoneSetting O Boolean Use phone settings when
caller matches phone
number
denySameCityCodesAllow O Boolean true: Enable
denySameCityCodes
Setting
false: Disable
denySameCityCodes
Setting
denySameCityCodes O String 65535 Deny Same City Codes
Settings, use comma to
separate

42
checkMobileAreaAllow O Boolean true: Enable
checkMobileArea Settings
false: Disable
checkMobileArea Settings
checkMobileArea O String 65535 Mobile Area Settings, use
comma to separate
calloutCalleePrefixesAllow O Boolean true: Enable
calloutCalleePrefixes
Settings
false: Disable
calloutCalleePrefixes
Settings
calloutCalleePrefixes O String 65535 Callout Callee Prefixes
Settings
calloutCallerPrefixesAllow O Boolean true: Enable
calloutCallerPrefixes
Settings
false: Disable
calloutCallerPrefixes
Settings
calloutCallerPrefixes O String 65535 Callout Caller Prefixes
Settings
rewriteRulesOutCallee O String 65535 Callee Rewrite Rule
rewriteRulesOutCaller O String 65535 Caller Rewrite Rule
rewriteRulesInMobileAreaAl O Boolean true: Enable
low rewriteRulesInMobileArea
Settings
false: Disable
rewriteRulesInMobileArea
Settings
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite Rules
Settings, separate by
comma

43
timeoutCallProceeding O Integer Unit: Second
-1: Use System Parameter
0: No limit
sipResponseAddressMetho O Integer SIP Response Address
d 0: Response to Request
Address
1: Response to Request IP
use port from Via
sipRequestAddressMethod O Integer SIP Request Address
0: To Original Address
1: To Original IP and Port
from Contact
2: To Contact
dtmfSendMethodH323 O Integer 0: Auto
10: RFC2833
20: H.245 alphanumeric
30: H.245 signal
40: Q.931 keypad
60: Off
dtmfSendMethodSIP O Integer 0: Auto
10: RFC2833
50: SIP Info
60: Off
dtmfReceiveMethod O Integer 0: All
10: RFC2833
20: Signaling
30: Off
dtmfSendPayloadTypeH32 O Integer Payload Type for H323
3 DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMF
Send
dtmfReceivePayloadType O Integer Payload Type for DTMF
Receive

44
q931ProgressIndicator O Integer -1: Auto
0: Off
1:
ProgressNotEndToEndISD
N
2:
ProgressDestinationNonIS
DN
3: ProgressOriginNotISDN
4:
ProgressReturnedToISDN
5: ProgressServiceChange
8:
ProgressInbandInformation
Available
account O String Billing Account
callTimeoutQ931CauseValu O Integer H323 Cause Replace
e 0: No Replace
Above 0: Refer to RFC
callTimeoutSIPCode O Integer SIP Cause Replace
0: No Replace
Above 0: Refer to RFC
sipRemoteRingSignal O Integer SIP Remote Ring Signal
0: Auto
1: 183+SDP
2: 180+SDP
sipCalleeE164Domain O Integer SIP Callee
0: Use field To
1: Use field Invite
sipCallerE164Domain O Integer SIP Caller
0: Use field From
1: Use field RemotePartId
2: Use field Display
h323CalleeE164Domain O Integer H323 Callee

45
0: Use field
CalledPartyNumber
1: Use field
DestinationAddress
h323CallerE164Domain O Integer H323 Caller
0: Use field
CallingPartyNumber
1: Use field SourceAddress
2: Use field Display
memo O String Memo
sipAuthenticationMethod O Integer SIP Call Authentication
Mode
0: IP
1: IP and Port
2: Password
h323FastStart O Boolean true: Enable H323 fast start
false: Disable H323 fast
start
h323H245Tunneling O Boolean true: Enable H323 H245
tunneling
false: Disable H323 H245
tunneling
h323H245InSetup O Boolean true: Enable H323 H245 in
Setup
false: Disable H323 H245 in
Setup
h323AutoCallProceeding O Boolean true: Enable H323 send
response after receive call
request
false: Disable H323 send
response after receive call
request
h323CallProceedingFromSI O Boolean Caller is H323, Callee is SIP
PTrying true: convert trying to

46
CallProceeding
false: no convert
h323AlertingFromSIP183Sd O Boolean Caller is H323, Callee is SIP
p true: convert Alerting to
CallProceeding
false: no convert
h323T38 O Boolean true: Enable H323 T38
false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer
(RFC4028)
false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100rel
false: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38
false: Disable SIP T38
sipDisplay O Boolean true: Include Display
false: Exclude Display
sipRemotePartyId O Boolean true: Include
RemotePartyId
false: Exclude
RemotePartyId
sipPrivacySupport O Boolean true: Enable Privacy
false: Omit Privacy
groupE164Change O Boolean true: Enable Group E164
Change
false: Disable Group E164
Change
callerAllowLength O Integer Mask of Caller Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
calleeAllowLength O Integer Mask of Callee Allow

47
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
callerLimitE164GroupsAllo O Boolean true: Allow
w callerLimitE164Groups
false: Forbidden
callerLimitE164Groups
callerLimitE164Groups O String Caller List, separate by
comma
calleeLimitE164GroupsAllo O Boolean true: Allow
w calleeLimitE164Groups
false: Forbidden
calleeLimitE164Groups
calleeLimitE164Groups O String Callee List, separate by
comma
minProfitPercentEnable O Boolean Enable Min Profit Percent
minProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%
Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second Rate
maxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, set
this value as 0.01
firstRoutePolicy O Integer First Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
secondRoutePolicy O Integer Second Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
h323G729SendMode O Integer H323 G729 Negotiation

48
Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729SendMode O Integer SIP G729 Negotiation Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729Annexb O Integer G729 annexb
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
sipG723Annexa O Integer G723 annexa
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecs
false: Auto Negotiation

49
h323Codecs O Vector<String> H323 Codec List
sipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto Negotiation
sipCodecs O Vector<String> SIP Codec List
forwardSignalRewriteE164 M Boolean true: Enable Forward
GroupEnable Signal Rewrite
false: Disable Forward
Signal Rewrite
forwardSignalRewriteE164 M String 255 Forward Signal Rewrite
Group E164 Group
lrnEnable O Boolean Enable LRN Query
lrnEatPrefixLength O Integer Omit prefix length
lrnFailureAction O Integer 0: Reject the call
1: Use original number
lrnInterstateBillingPrefix O String Billing Prefix for different
area
lrnUndeterminedBillingPrefi O String Billing Prefix for unknown
x area

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

50
2.12 Get Mapping Gateway
http://VOSIP/external/server/GetGatewayMapping

Request Format
Parameter M/O Type Length Description
names M String [] Gateway Name
Blank: All

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoGatewayMappings O InfoGatewayMapping [] Gateway Information

InfoGatewayMapping Format
Parameter M/O Type Length Description
name M String 64 Mapping Gateway Name
lockType M Integer Lock Type
0: No Lock
3: Lock All
callLevel M Integer Call Level
1: Net
2: Local
4: Domestic
5: International
capacity M Integer Line Limit
priority M Integer Priority
gatewayGroups M String 65535 Gateway Groups, use
comma to separate
routingGatewayGroupsAllo M Boolean true: Allow
w false: Forbidden
routingGatewayGroups M String 65535 Routing Gateway Groups

51
Blank: All
registerType M Integer Register Type
0: Static
1: Dynamic
remoteIps M String 65535 IP list, use comma to
separate
callerE164CheckEnable M Boolean true: Enable Caller Check
false: Disable Caller
Check
callerE164CheckCity M Boolean true: Enable Caller City
Check
false: Disable Caller City
Check
callerE164CheckMobile M Boolean true: Enable Caller Mobile
Check
false: Disable Caller Mobile
Check
callerE164CheckOther M Boolean true: Enable Caller Other
Check
false: Disable Caller Other
Check
calleeE164CheckEnable M Boolean true: Enable Callee Check
false: Disable Callee
Check
calleeE164CheckCity M Boolean true: Enable Callee City
Check
false: Disable Callee City
Check
calleeE164CheckMobile M Boolean true: Enable Callee Mobile
Check
false: Disable Callee Mobile
Check
calleeE164CheckOther M Boolean true: Enable Callee Other

52
Check
false: Disable Callee Other
Check
rtpForwardType M Integer Media Proxy
0: Auto
1: Enable
2: Disable
Default: 0
mediaCheckDirection M Integer RTP Interrupt Detection
Mode
0: No Detect
1: Detect whether VOS has
sent RTP to Remote
2: Detect whether VOS has
received Remote RTP
3: Detect Both Side's RTP
Default: 0
calleeE164Restrict M Integer Callee Limit
0: No Limit
1: Limit Callee is Phone
2: Limit Callee not Phone
maxCallDurationLower M Integer -1: Use System Parameter
0: No limit
maxCallDurationUpper M Integer -1: Use System Parameter
0: No limit
allowPhoneBilling M Boolean Billing on Phone Account, If
caller matches phone
number
allowBindedE164Billing M Boolean Billing on Binded E164
Account, If caller matches
binded e164
enablePhoneSetting M Boolean Use phone settings when
caller matches phone
number

53
denySameCityCodesAllow M Boolean true: Enable
denySameCityCodes
Setting
false: Disable
denySameCityCodes
Setting
denySameCityCodes M String 65535 Deny Same City Codes
Settings, use comma to
separate
checkMobileAreaAllow M Boolean true: Enable
checkMobileArea Settings
false: Disable
checkMobileArea Settings
checkMobileArea M String 65535 Mobile Area Settings, use
comma to separate
calloutCalleePrefixesAllow M Boolean true: Enable
calloutCalleePrefixes
Settings
false: Disable
calloutCalleePrefixes
Settings
calloutCalleePrefixes M String 65535 Callout Callee Prefixes
Settings
calloutCallerPrefixesAllow M Boolean true: Enable
calloutCallerPrefixes
Settings
false: Disable
calloutCallerPrefixes
Settings
calloutCallerPrefixes M String 65535 Callout Caller Prefixes
Settings
rewriteRulesOutCallee M String 65535 Callee Rewrite Rule
rewriteRulesOutCaller M String 65535 Caller Rewrite Rule

54
rewriteRulesInMobileAreaAl M Boolean true: Enable
low rewriteRulesInMobileArea
Settings
false: Disable
rewriteRulesInMobileArea
Settings
rewriteRulesInMobileArea M String 65535 Mobile Area Rewrite Rules
Settings, separate by
comma
timeoutCallProceeding M Integer Unit: Second
-1: Use System Parameter
0: No limit
sipResponseAddressMetho M Integer SIP Response Address
d 0: Response to Request
Address
1: Response to Request IP
use port from Via
sipRequestAddressMethod M Integer SIP Request Address
0: To Original Address
1: To Original IP and Port
from Contact
2: To Contact
dtmfSendMethodH323 M Integer 0: Auto
10: RFC2833
20: H.245 alphanumeric
30: H.245 signal
40: Q.931 keypad
60: Off
dtmfSendMethodSIP M Integer 0: Auto
10: RFC2833
50: SIP Info
60: Off
dtmfReceiveMethod M Integer 0: All
10: RFC2833

55
20: Signaling
30: Off
dtmfSendPayloadTypeH32 M Integer Payload Type for H323
3 DTMF Send
dtmfSendPayloadTypeSIP M Integer Payload Type for SIP DTMF
Send
dtmfReceivePayloadType M Integer Payload Type for DTMF
Receive
q931ProgressIndicator M Integer -1: Auto
0: Off
1:
ProgressNotEndToEndISD
N
2:
ProgressDestinationNonIS
DN
3: ProgressOriginNotISDN
4:
ProgressReturnedToISDN
5: ProgressServiceChange
8:
ProgressInbandInformation
Available
account M String Billing Account
callTimeoutQ931CauseValu M Integer H323 Cause Replace
e 0: No Replace
Above 0: Refer to RFC
callTimeoutSIPCode M Integer SIP Cause Replace
0: No Replace
Above 0: Refer to RFC
sipRemoteRingSignal M Integer SIP Remote Ring Signal
0: Auto
1: 183+SDP
2: 180+SDP

56
sipCalleeE164Domain M Integer SIP Callee
0: Use field To
1: Use field Invite
sipCallerE164Domain M Integer SIP Caller
0: Use field From
1: Use field RemotePartId
2: Use field Display
h323CalleeE164Domain M Integer H323 Callee
0: Use field
CalledPartyNumber
1: Use field
DestinationAddress
h323CallerE164Domain M Integer H323 Caller
0: Use field
CallingPartyNumber
1: Use field SourceAddress
2: Use field Display
memo M String Memo
sipAuthenticationMethod M Integer SIP Call Authentication
Mode
0: IP
1: IP and Port
2: Password
h323FastStart M Boolean true: Enable H323 fast start
false: Disable H323 fast
start
h323H245Tunneling M Boolean true: Enable H323 H245
tunneling
false: Disable H323 H245
tunneling
h323H245InSetup M Boolean true: Enable H323 H245 in
Setup
false: Disable H323 H245 in
Setup

57
h323AutoCallProceeding M Boolean true: Enable H323 send
response after receive call
request
false: Disable H323 send
response after receive call
request
h323CallProceedingFromSI M Boolean Caller is H323, Callee is SIP
PTrying true: convert trying to
CallProceeding
false: no convert
h323AlertingFromSIP183Sd M Boolean Caller is H323, Callee is SIP
p true: convert Alerting to
CallProceeding
false: no convert
h323T38 M Boolean true: Enable H323 T38
false: Disable H323 T38
sipTimer M Boolean true: Enable SIP Timer
(RFC4028)
false: Diable SIP Timer
sip100Rel M Boolean true: Enable SIP 100rel
false: Disable SIP 100rel
sipT38 M Boolean true: Enable SIP T38
false: Disable SIP T38
sipDisplay M Boolean true: Include Display
false: Exclude Display
sipRemotePartyId M Boolean true: Include
RemotePartyId
false: Exclude
RemotePartyId
sipPPreferredIdentity M Boolean true: Include
P-Preferred-Identity
false: Exclude
P-Preferred-Identity

58
sipPAssertedIdentity M Boolean true: Include
P-Asserted-Identity
false: Exclude
P-Asserted-Identity
groupE164Change M Boolean true: Enable Group E164
Change
false: Disable Group E164
Change
callerAllowLength M Integer Mask of Caller Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
calleeAllowLength M Integer Mask of Callee Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
callerLimitE164GroupsAllo M Boolean true: Allow
w callerLimitE164Groups
false: Forbidden
callerLimitE164Groups
callerLimitE164Groups M String Caller List, separate by
comma
calleeLimitE164GroupsAllo M Boolean true: Allow
w calleeLimitE164Groups
false: Forbidden
calleeLimitE164Groups
calleeLimitE164Groups M String Callee List, separate by
comma
minProfitPercent M Integer Lowest Profit Rate Limit
-1: No limit
Range: -1-9999
Default: -1

59
firstRoutePolicy M Integer First Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
secondRoutePolicy M Integer Second Routing Strategy
0: None
1: ASR
2: Lowest Rate per Second
h323G729SendMode M Integer H323 G729 Negotiation
Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729SendMode M Integer SIP G729 Negotiation Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729Annexb M Integer G729 annexb
0: Auto
1: annex=yes
2: annex=no
3: no annex

60
4: transmit annex
sipG723Annexa M Integer G723 annexa
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
h323CodecAssign M Boolean true: Assign H323 Codecs
false: Auto Negotiation
h323Codecs M Vector<String> H323 Codec List
sipCodecAssign M Boolean true: Assign SIP Codecs
false: Auto Negotiation
sipCodecs M Vector<String> SIP Codec List
forwardSignalRewriteE164 O Boolean true: Enable Forward
GroupEnable Signal Rewrite
false: Disable Forward
Signal Rewrite
forwardSignalRewriteE164 O String 255 Forward Signal Rewrite
Group E164 Group
softswitchName M String Soft Switch Name

61
2.13 Delete Mapping Gateway
http://VOSIP/external/server/DeleteGatewayMapping

Request Format
Parameter M/O Type Length Description
name M String Mapping Gateway Name

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

62
2.14 Get Online Mapping Gateway
http://VOSIP/external/server/GetGatewayMappingOnline

Request Format
Parameter M/O Type Length Description
names O String [] Gateway Name
Null: All
softswitchName O String Soft Switch Name
Null: All

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoGatewayMappingOnline O InfoGatewayMappingOnline Online Mapping Gateway
s [] Information

InfoGatewayMappingOnline Format
Parameter M/O Type Length Description
id M Integer Mapping Gateway ID
name M String Mapping Gateway Name
currentCall M Integer Current Call
capacity M Integer Line Limit
asr M double Average Success Ratio
acd M Long Average Call Duration
remoteIps M String IP list, use comma to
separate
natIp O String NAT Address
localIp M String Register IP
registerTime M Long Register Time (UTC)
0: Static Gateway
updateTime M Long Last Update Time (UTC)

63
0: Static Gateway
keepTime M Long Online Time (Second)
0: Static Gateway
cryptoType M Integer Encryption Type
0: No Encryption
1: RC4
softswitchName M String Soft Switch Name
softswitchIp M String Soft Switch IP

64
2.15 Create Routing Gateway
http://VOSIP/external/server/CreateGatewayRouting

Request Format
Parameter M/O Type Length Description
name M String 64 Routing Gateway Name
prefix O String Gateway Prefix
prefixStyle O Integer Prefix Mode
0: Terminal
1: Continual
password O String Gateway Password
Default: Random Create
customerPassword O String Self Service Password
gatewayGroups O String Gateway Groups
capacity O Integer Line Limit
lockType O Integer Lock Type
0: No Lock
3: Lock All
Default: 0
priority O Integer Priority
registerType O Integer Register Type
0: Static
1: Dynamic
2: Register
remoteIp O String 64 IP
rtpForwardType O Integer Media Proxy
0: Auto
1: Enable
2: Disable
Default: 0
encrypt O Boolean true: Encrypt
false: No Encrypt

65
protocol O Integer Protocol
0: H323
1: SIP
signalPort O Integer Signaling Port
H323 Default: 1720
SIP Default: 5060
localIp O String 64 Local IP
Blank: Auto
mediaCheckDirection O Integer RTP Interrupt Detection
Mode
0: No Detect
1: Detect whether VOS has
sent RTP to Remote
2: Detect whether VOS has
received Remote RTP
3: Detect Both Side's RTP
Default: 0
maxCallDurationLower O Integer -1: Use System Parameter
0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter
0: No limit
calleeE164Restrict O Integer Callee Limit
0: No Limit
1: Limit Callee is Phone
2: Limit Callee not Phone
callerE164CheckEnable O Boolean true: Enable Caller Check
false: Disable Caller
Check
callerE164CheckCity O Boolean true: Enable Caller City
Check
false: Disable Caller City
Check
callerE164CheckMobile O Boolean true: Enable Caller Mobile

66
Check
false: Disable Caller Mobile
Check
callerE164CheckOther O Boolean true: Enable Caller Other
Check
false: Disable Caller Other
Check
calleeE164CheckEnable O Boolean true: Enable Callee Check
false: Disable Callee
Check
calleeE164CheckCity O Boolean true: Enable Callee City
Check
false: Disable Callee City
Check
calleeE164CheckMobile O Boolean true: Enable Callee Mobile
Check
false: Disable Callee Mobile
Check
calleeE164CheckOther O Boolean true: Enable Callee Other
Check
false: Disable Callee Other
Check
callinCallerPrefixesAllow O Boolean true: Enable
callinCallerPrefixes
false: Disable
callinCallerPrefixes
callinCallerPrefixes O String 65535 Caller Prefixes List
callinCalleePrefixesAllow O Boolean true: Enable
callinCalleePrefixes
false: Disable
callinCalleePrefixes
callinCalleePrefixes O String 65535 Callee Prefixes List
callinForwardPrefixesAllow O Boolean true: Enable

67
callinForwardPrefixes
settings
false: Disable
callinForwardPrefixes
settings
callinForwardPrefixes O String 65535 Call in forward prefixes
settings
rewriteRulesInCaller O String 65535 Caller Rewrite Rule
rewriteRulesInCallee O String 65535 Callee Rewrite Rule
rewriteRulesInMobileAreaAl O Boolean true: Enable
low rewriteRulesInMobileArea
false: Disable
rewriteRulesInMobileArea
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite Rules
Settings, separate by
comma
timeoutSetup O Integer H323 Setup Timeout(Unit:
Second)
0: Use System Parameter
timeoutCallProceeding O Integer H323 CallProceeding
Timeout(Unit: Second)
0: Use System Parameter
timeoutCallProceedingOlc O Integer H323 CallProceeding
include Open Logical
Channel Timeout(Unit:
Second)
0: Use System Parameter
timeoutAlerting O Integer H323 Alerting
Timeout(Unit: Second)
0: Use System Parameter
timeoutInvite O Integer SIP Invite Timeout(Unit:
Second)
0: Use System Parameter

68
timeoutTrying O Integer SIP Trying Timeout(Unit:
Second)
0: Use System Parameter
timeoutSessionProgressSd O Integer SIP SessionProgress
p include SDP Timeout(Unit:
Second)
0: Use System Parameter
timeoutSessionProgress O Integer SIP SessionProgress
Timeout(Unit: Second)
0: Use System Parameter
timeoutRinging O Integer SIP Ring Timeout(Unit:
Second)
0: Use System Parameter
denyCallerCalleeAllow O Boolean true: Enable
denyCallerCallee
false: Disable
denyCallerCallee
denyCallerCallee O String 65535 Format: [<Caller>:
<Callee>[,<Caller>:
<Callee>]…]
e.g.: 025: 010,021: 023
denySameCityCodesAllow O Boolean true: Enable
denySameCityCodes
Setting
false: Disable
denySameCityCodes
Setting
denySameCityCodes O String 65535 Deny Same City Codes
Settings, use comma to
separate
checkMobileAreaAllow O Boolean true: Enable
checkMobileArea Settings
false: Disable
checkMobileArea Settings

69
checkMobileArea O String 65535 Mobile Area Settings, use
comma to separate
stopSwitchAfterOlc O Integer Stop Switch Gateway After
Open Logical Channel
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterSdp O Integer Stop Switch Gateway After
Received SDP
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterRtpStart O Integer Stop Switch Gateway After
Received RTP
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterUserBusy O Integer Stop Switch Gateway After
Received User Busy
0: Use System Parameter
1: Disable
2: Enable
Default: 0
switchUntilConnect O Integer Switch Gateway Until
Connect
0: Use System Parameter
1: Disable
2: Enable
Default: 0
sipResponseAddressMetho O Integer SIP Response Address
d 0: Response to Request

70
Address
1: Response to Request IP
use port from Via
sipRequestAddressMethod O Integer SIP Request Address
0: To Original Address
1: To Original IP and Port
from Contact
2: To Contact
dtmfSendMethodH323 O Integer 0: Auto
10: RFC2833
20: H.245 alphanumeric
30: H.245 signal
40: Q.931 keypad
60: Off
dtmfSendMethodSIP O Integer 0: Auto
10: RFC2833
50: SIP Info
60: Off
dtmfReceiveMethod O Integer 0: All
10: RFC2833
20: Signaling
30: Off
dtmfSendPayloadTypeH32 O Integer Payload Type for H323
3 DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMF
Send
dtmfReceivePayloadType O Integer Payload Type for DTMF
Receive
q931NumberingPlan O Integer Q931NumberingPlan
-1: Use System Parameter
0: UnknownPlan
1: ISDNPlan
3: DataPlan
4: TelexPlan

71
8: NationalStandardPlan
9: PrivatePlan
15: ReservedPlan
q931NumberType O Integer Q931NumberType
-1: Use System Parameter
0: UnknownType
1: InternationalType
2: NationalType
3: NetworkSpecificType
4: SubscriberType
6: AbbreviatedType
7: ReservedType
q931PresentationIndicator O Integer Q931PresentationIndicator
-1: Use System Parameter
0: Presentation allowed
1: Presentation restricted
2: Number not available due
to interworking
3: Reserved
4: None
q931ScreeningIndicator O Integer Q931ScreeningIndicator
-1: Use System Parameter
0: User-provided, not
screened
1: User-provided, verified
and passed
2: User-provided, verified
and failed
3: Network provided
4: None
clearingAccount O String 64 Clearing Account Name
h323FastStart O Boolean true: Enable H323 fast start
false: Disable H323 fast
start

72
h323H245Tunneling O Boolean true: Enable H323 H245
tunneling
false: Disable H323 H245
tunneling
h323H245InSetup O Boolean true: Enable H323 H245 in
Setup
false: Disable H323 H245 in
Setup
h323T38 O Boolean true: Enable H323 T38
false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer
(RFC4028)
false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100rel
false: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38
false: Disable SIP T38
sipDisplay O Boolean true: Include Display
false: Exclude Display
sipRemotePartyId O Boolean true: Include
RemotePartyId
false: Exclude
RemotePartyId
sipPrivacy O Integer 0: None
1: Pass through
2: id
sipPPreferredIdentity O Integer 0: None
1: Pass through
2: Caller number
sipPAssertedIdentity O Integer 0: None
1: Pass through
2: Caller number
groupE164Change O Boolean true: Enable Group E164

73
Change
false: Disable Group E164
Change
callerAllowLength O Integer Mask of Caller Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
calleeAllowLength O Integer Mask of Callee Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
callerLimitE164GroupsAllo O Boolean true: Allow
w callerLimitE164Groups
false: Forbidden
callerLimitE164Groups
callerLimitE164Groups O String 255 Caller List, separate by
comma
calleeLimitE164GroupsAllo O Boolean true: Allow
w calleeLimitE164Groups
false: Forbidden
calleeLimitE164Groups
calleeLimitE164Groups O String 255 Callee List, separate by
comma
h323G729SendMode O Integer H323 G729 Negotiation
Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729

74
or G729a as G729 and
G729a
sipG729SendMode O Integer SIP G729 Negotiation Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729Annexb O Integer G729 annexb
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
sipG723Annexa O Integer G723 annexa
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecs
false: Auto Negotiation
h323Codecs O Vector<String> H323 Codec List
sipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto Negotiation
sipCodecs O Vector<String> SIP Codec List
feerateRestrict O Boolean true: Check Callee Fee
Rate
false: No Check

75
leastCostRouting O Boolean (feerateRestrict must be
true)
true: On
false: Off
minProfitPercentEnable O Boolean Enable Min Profit Percent
minProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%
Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second Rate
maxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, set
this value as 0.01
enablePhoneDisplay O Boolean true: Use phone display
number as caller
false: Use phone number as
caller
clearingAccountUseCallout O Boolean true: Use Callee after
E164 rewrite as Clearing
Account
false: Use Callee before
rewrite as Clearing
Account
softswitchName O String 64 Soft Switch Name
forwardSignalRewriteE164 O Boolean true: Enable Forward
GroupEnable Signal Rewrite
false: Disable Forward
Signal Rewrite
forwardSignalRewriteE164 O String 255 Forward Signal Rewrite
Group E164 Group

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code

76
exception O String Error Information

77
2.16 Modify Routing Gateway
http://VOSIP/external/server/ModifyGatewayRouting

Request Format
Parameter M/O Type Length Description
name M String 64 Routing Gateway Name
prefix O String Gateway Prefix
prefixStyle O Integer Prefix Mode
0: Terminal
1: Continual
password O String Gateway Password
Default: Random Create
customerPassword O String Self Service Password
gatewayGroups O String Gateway Groups
capacity O Integer Line Limit
lockType O Integer Lock Type
0: No Lock
3: Lock All
Default: 0
priority O Integer Priority
registerType O Integer Register Type
0: Static
1: Dynamic
2: Register
remoteIp O String 64 IP
rtpForwardType O Integer Media Proxy
0: Auto
1: Enable
2: Disable
Default: 0
encrypt O Boolean true: Encrypt
false: No Encrypt

78
protocol O Integer Protocol
0: H323
1: SIP
signalPort O Integer Signaling Port
H323 Default: 1720
SIP Default: 5060
localIp O String 64 Local IP
Blank: Auto
mediaCheckDirection O Integer RTP Interrupt Detection
Mode
0: No Detect
1: Detect whether VOS has
sent RTP to Remote
2: Detect whether VOS has
received Remote RTP
3: Detect Both Side's RTP
Default: 0
maxCallDurationLower O Integer -1: Use System Parameter
0: No limit
maxCallDurationUpper O Integer -1: Use System Parameter
0: No limit
calleeE164Restrict O Integer Callee Limit
0: No Limit
1: Limit Callee is Phone
2: Limit Callee not Phone
callerE164CheckEnable O Boolean true: Enable Caller Check
false: Disable Caller
Check
callerE164CheckCity O Boolean true: Enable Caller City
Check
false: Disable Caller City
Check
callerE164CheckMobile O Boolean true: Enable Caller Mobile

79
Check
false: Disable Caller Mobile
Check
callerE164CheckOther O Boolean true: Enable Caller Other
Check
false: Disable Caller Other
Check
calleeE164CheckEnable O Boolean true: Enable Callee Check
false: Disable Callee
Check
calleeE164CheckCity O Boolean true: Enable Callee City
Check
false: Disable Callee City
Check
calleeE164CheckMobile O Boolean true: Enable Callee Mobile
Check
false: Disable Callee Mobile
Check
calleeE164CheckOther O Boolean true: Enable Callee Other
Check
false: Disable Callee Other
Check
callinCallerPrefixesAllow O Boolean true: Enable
callinCallerPrefixes
false: Disable
callinCallerPrefixes
callinCallerPrefixes O String 65535 Caller Prefixes List
callinCalleePrefixesAllow O Boolean true: Enable
callinCalleePrefixes
false: Disable
callinCalleePrefixes
callinCalleePrefixes O String 65535 Callee Prefixes List
callinForwardPrefixesAllow O Boolean true: Enable

80
callinForwardPrefixes
settings
false: Disable
callinForwardPrefixes
settings
callinForwardPrefixes O String 65535 Call in forward prefixes
settings
rewriteRulesInCaller O String 65535 Caller Rewrite Rule
rewriteRulesInCallee O String 65535 Callee Rewrite Rule
rewriteRulesInMobileAreaAl O Boolean true: Enable
low rewriteRulesInMobileArea
false: Disable
rewriteRulesInMobileArea
rewriteRulesInMobileArea O String 65535 Mobile Area Rewrite Rules
Settings, separate by
comma
timeoutSetup O Integer H323 Setup Timeout(Unit:
Second)
0: Use System Parameter
timeoutCallProceeding O Integer H323 CallProceeding
Timeout(Unit: Second)
0: Use System Parameter
timeoutCallProceedingOlc O Integer H323 CallProceeding
include Open Logical
Channel Timeout(Unit:
Second)
0: Use System Parameter
timeoutAlerting O Integer H323 Alerting
Timeout(Unit: Second)
0: Use System Parameter
timeoutInvite O Integer SIP Invite Timeout(Unit:
Second)
0: Use System Parameter

81
timeoutTrying O Integer SIP Trying Timeout(Unit:
Second)
0: Use System Parameter
timeoutSessionProgressSd O Integer SIP SessionProgress
p include SDP Timeout(Unit:
Second)
0: Use System Parameter
timeoutSessionProgress O Integer SIP SessionProgress
Timeout(Unit: Second)
0: Use System Parameter
timeoutRinging O Integer SIP Ring Timeout(Unit:
Second)
0: Use System Parameter
denyCallerCalleeAllow O Boolean true: Enable
denyCallerCallee
false: Disable
denyCallerCallee
denyCallerCallee O String 65535 Format: [<Caller>:
<Callee>[,<Caller>:
<Callee>]…]
e.g.: 025: 010,021: 023
denySameCityCodesAllow O Boolean true: Enable
denySameCityCodes
Setting
false: Disable
denySameCityCodes
Setting
denySameCityCodes O String 65535 Deny Same City Codes
Settings, use comma to
separate
checkMobileAreaAllow O Boolean true: Enable
checkMobileArea Settings
false: Disable
checkMobileArea Settings

82
checkMobileArea O String 65535 Mobile Area Settings, use
comma to separate
stopSwitchAfterOlc O Integer Stop Switch Gateway After
Open Logical Channel
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterSdp O Integer Stop Switch Gateway After
Received SDP
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterRtpStart O Integer Stop Switch Gateway After
Received RTP
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterUserBusy O Integer Stop Switch Gateway After
Received User Busy
0: Use System Parameter
1: Disable
2: Enable
Default: 0
switchUntilConnect O Integer Switch Gateway Until
Connect
0: Use System Parameter
1: Disable
2: Enable
Default: 0
sipResponseAddressMetho O Integer SIP Response Address
d 0: Response to Request

83
Address
1: Response to Request IP
use port from Via
sipRequestAddressMethod O Integer SIP Request Address
0: To Original Address
1: To Original IP and Port
from Contact
2: To Contact
dtmfSendMethodH323 O Integer 0: Auto
10: RFC2833
20: H.245 alphanumeric
30: H.245 signal
40: Q.931 keypad
60: Off
dtmfSendMethodSIP O Integer 0: Auto
10: RFC2833
50: SIP Info
60: Off
dtmfReceiveMethod O Integer 0: All
10: RFC2833
20: Signaling
30: Off
dtmfSendPayloadTypeH32 O Integer Payload Type for H323
3 DTMF Send
dtmfSendPayloadTypeSIP O Integer Payload Type for SIP DTMF
Send
dtmfReceivePayloadType O Integer Payload Type for DTMF
Receive
q931NumberingPlan O Integer Q931NumberingPlan
-1: Use System Parameter
0: UnknownPlan
1: ISDNPlan
3: DataPlan
4: TelexPlan

84
8: NationalStandardPlan
9: PrivatePlan
15: ReservedPlan
q931NumberType O Integer Q931NumberType
-1: Use System Parameter
0: UnknownType
1: InternationalType
2: NationalType
3: NetworkSpecificType
4: SubscriberType
6: AbbreviatedType
7: ReservedType
q931PresentationIndicator O Integer Q931PresentationIndicator
-1: Use System Parameter
0: Presentation allowed
1: Presentation restricted
2: Number not available due
to interworking
3: Reserved
4: None
q931ScreeningIndicator O Integer Q931ScreeningIndicator
-1: Use System Parameter
0: User-provided, not
screened
1: User-provided, verified
and passed
2: User-provided, verified
and failed
3: Network provided
4: None
clearingAccount O String 64 Clearing Account Name
h323FastStart O Boolean true: Enable H323 fast start
false: Disable H323 fast
start

85
h323H245Tunneling O Boolean true: Enable H323 H245
tunneling
false: Disable H323 H245
tunneling
h323H245InSetup O Boolean true: Enable H323 H245 in
Setup
false: Disable H323 H245 in
Setup
h323T38 O Boolean true: Enable H323 T38
false: Disable H323 T38
sipTimer O Boolean true: Enable SIP Timer
(RFC4028)
false: Diable SIP Timer
sip100Rel O Boolean true: Enable SIP 100rel
false: Disable SIP 100rel
sipT38 O Boolean true: Enable SIP T38
false: Disable SIP T38
sipDisplay O Boolean true: Include Display
false: Exclude Display
sipRemotePartyId O Boolean true: Include
RemotePartyId
false: Exclude
RemotePartyId
sipPrivacy O Integer 0: None
1: Pass through
2: id
sipPPreferredIdentity O Integer 0: None
1: Pass through
2: Caller number
sipPAssertedIdentity O Integer 0: None
1: Pass through
2: Caller number
groupE164Change O Boolean true: Enable Group E164

86
Change
false: Disable Group E164
Change
callerAllowLength O Integer Mask of Caller Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
calleeAllowLength O Integer Mask of Callee Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
callerLimitE164GroupsAllo O Boolean true: Allow
w callerLimitE164Groups
false: Forbidden
callerLimitE164Groups
callerLimitE164Groups O String 255 Caller List, separate by
comma
calleeLimitE164GroupsAllo O Boolean true: Allow
w calleeLimitE164Groups
false: Forbidden
calleeLimitE164Groups
calleeLimitE164Groups O String 255 Callee List, separate by
comma
h323G729SendMode O Integer H323 G729 Negotiation
Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729

87
or G729a as G729 and
G729a
sipG729SendMode O Integer SIP G729 Negotiation Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729Annexb O Integer G729 annexb
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
sipG723Annexa O Integer G723 annexa
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
h323CodecAssign O Boolean true: Assign H323 Codecs
false: Auto Negotiation
h323Codecs O Vector<String> H323 Codec List
sipCodecAssign O Boolean true: Assign SIP Codecs
false: Auto Negotiation
sipCodecs O Vector<String> SIP Codec List
feerateRestrict O Boolean true: Check Callee Fee
Rate
false: No Check

88
leastCostRouting O Boolean (feerateRestrict must be
true)
true: On
false: Off
minProfitPercentEnable O Boolean Enable Min Profit Percent
minProfitPercent O Integer Min Profit Rate
e.g. 10 means 10%
Range: -10000 to 10000
maxSecondRatesEnable O Boolean Enable Max Second Rate
maxSecondRates O Integer Max Second Rates
e.g. if minute rate is 0.6, set
this value as 0.01
enablePhoneDisplay O Boolean true: Use phone display
number as caller
false: Use phone number as
caller
clearingAccountUseCallout O Boolean true: Use Callee after
E164 rewrite as Clearing Account
false: Use Callee before
rewrite as Clearing Account
softswitchName O String 64 Soft Switch Name
forwardSignalRewriteE164 O Boolean true: Enable Forward
GroupEnable Signal Rewrite
false: Disable Forward
Signal Rewrite
forwardSignalRewriteE164 O String 255 Forward Signal Rewrite
Group E164 Group

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

89
2.17 Delete Routing Gateway
http://VOSIP/external/server/DeleteGatewayRouting

Request Format
Parameter M/O Type Length Description
name M String Routing Gateway Name

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

90
2.18 Get Routing Gateway
http://VOSIP/external/server/GetGatewayRouting

Request Format
Parameter M/O Type Length Description
names M String [] Gateway Name
Null: All

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoGatewayRoutings O InfoGatewayRouting [] Routing Gateway
Information

InfoGatewayRouting Format
Parameter M/O Type Length Description
name M String 64 Routing Gateway Name
prefix M String Gateway Prefix
prefixStyle M Integer Prefix Mode
0: Terminal
1: Continual
password M String Gateway Password
Default: Random Create
customerPassword M String Self Service Password
gatewayGroups M String Gateway Groups
capacity M Integer Line Limit
lockType M Integer Lock Type
0: No Lock
3: Lock All
Default: 0
priority M Integer Priority

91
registerType M Integer Register Type
0: Static
1: Dynamic
2: Register
remoteIp M String 64 IP
rtpForwardType M Integer Media Proxy
0: Auto
1: Enable
2: Disable
Default: 0
encrypt M Boolean true: Encrypt
false: No Encrypt
protocol M Integer Protocol
0: H323
1: SIP
signalPort M Integer Signaling Port
H323 Default: 1720
SIP Default: 5060
localIp M String 64 Local IP
Blank: Auto
mediaCheckDirection M Integer RTP Interrupt Detection
Mode
0: No Detect
1: Detect whether VOS has
sent RTP to Remote
2: Detect whether VOS has
received Remote RTP
3: Detect Both Side's RTP
Default: 0
maxCallDurationLower M Integer -1: Use System Parameter
0: No limit
maxCallDurationUpper M Integer -1: Use System Parameter
0: No limit

92
calleeE164Restrict M Integer Callee Limit
0: No Limit
1: Limit Callee is Phone
2: Limit Callee not Phone
callerE164CheckEnable M Boolean true: Enable Caller Check
false: Disable Caller
Check
callerE164CheckCity M Boolean true: Enable Caller City
Check
false: Disable Caller City
Check
callerE164CheckMobile M Boolean true: Enable Caller Mobile
Check
false: Disable Caller Mobile
Check
callerE164CheckOther M Boolean true: Enable Caller Other
Check
false: Disable Caller Other
Check
calleeE164CheckEnable M Boolean true: Enable Callee Check
false: Disable Callee
Check
calleeE164CheckCity M Boolean true: Enable Callee City
Check
false: Disable Callee City
Check
calleeE164CheckMobile M Boolean true: Enable Callee Mobile
Check
false: Disable Callee Mobile
Check
calleeE164CheckOther M Boolean true: Enable Callee Other
Check
false: Disable Callee Other
Check

93
callinCallerPrefixesAllow M Boolean true: Enable
callinCallerPrefixes
false: Disable
callinCallerPrefixes
callinCallerPrefixes M String 65535 Caller Prefixes List
callinCalleePrefixesAllow M Boolean true: Enable
callinCalleePrefixes
false: Disable
callinCalleePrefixes
callinCalleePrefixes M String 65535 Callee Prefixes List
rewriteRulesInCaller M String 65535 Caller Rewrite Rule
rewriteRulesInCallee M String 65535 Callee Rewrite Rule
rewriteRulesInMobileAreaAl M Boolean true: Enable
low rewriteRulesInMobileArea
false: Disable
rewriteRulesInMobileArea
rewriteRulesInMobileArea M String 65535 Mobile Area Rewrite Rules
Settings, separate by
comma
timeoutSetup M Integer H323 Setup Timeout(Unit:
Second)
0: Use System Parameter
timeoutCallProceeding M Integer H323 CallProceeding
Timeout(Unit: Second)
0: Use System Parameter
timeoutCallProceedingOlc M Integer H323 CallProceeding
include Open Logical
Channel Timeout(Unit:
Second)
0: Use System Parameter
timeoutAlerting M Integer H323 Alerting
Timeout(Unit: Second)
0: Use System Parameter

94
timeoutInvite M Integer SIP Invite Timeout(Unit:
Second)
0: Use System Parameter
timeoutTrying M Integer SIP Trying Timeout(Unit:
Second)
0: Use System Parameter
timeoutSessionProgressSd M Integer SIP SessionProgress
p include SDP Timeout(Unit:
Second)
0: Use System Parameter
timeoutSessionProgress M Integer SIP SessionProgress
Timeout(Unit: Second)
0: Use System Parameter
timeoutRinging M Integer SIP Ring Timeout(Unit:
Second)
0: Use System Parameter
denyCallerCalleeAllow M Boolean true: Enable
denyCallerCallee
false: Disable
denyCallerCallee
denyCallerCallee M String 65535 Format: [<Caller>:
<Callee>[,<Caller>:
<Callee>]…]
e.g.: 025: 010,021: 023
denySameCityCodesAllow M Boolean true: Enable
denySameCityCodes
Setting
false: Disable
denySameCityCodes
Setting
denySameCityCodes M String 65535 Deny Same City Codes
Settings, use comma to
separate

95
checkMobileAreaAllow M Boolean true: Enable
checkMobileArea Settings
false: Disable
checkMobileArea Settings
checkMobileArea M String 65535 Mobile Area Settings, use
comma to separate
stopSwitchAfterOlc M Integer Stop Switch Gateway After
Open Logical Channel
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterSdp M Integer Stop Switch Gateway After
Received SDP
0: Use System Parameter
1: Disable
2: Enable
Default: 0
stopSwitchAfterRtpStart M Integer Stop Switch Gateway After
Received RTP
0: Use System Parameter
1: Disable
2: Enable
Default: 0
switchUntilConnect M Integer Switch Gateway Until
Connect
0: Use System Parameter
1: Disable
2: Enable
Default: 0
sipResponseAddressMetho M Integer SIP Response Address
d 0: Response to Request
Address
1: Response to Request IP

96
use port from Via
sipRequestAddressMethod M Integer SIP Request Address
0: To Original Address
1: To Original IP and Port
from Contact
2: To Contact
dtmfSendMethodH323 M Integer 0: Auto
10: RFC2833
20: H.245 alphanumeric
30: H.245 signal
40: Q.931 keypad
60: Off
dtmfSendMethodSIP M Integer 0: Auto
10: RFC2833
50: SIP Info
60: Off
dtmfReceiveMethod M Integer 0: All
10: RFC2833
20: Signaling
30: Off
dtmfSendPayloadTypeH32 M Integer Payload Type for H323
3 DTMF Send
dtmfSendPayloadTypeSIP M Integer Payload Type for SIP DTMF
Send
dtmfReceivePayloadType M Integer Payload Type for DTMF
Receive
q931NumberingPlan M Integer Q931NumberingPlan
-1: Use System Parameter
0: UnknownPlan
1: ISDNPlan
3: DataPlan
4: TelexPlan
8: NationalStandardPlan
9: PrivatePlan

97
15: ReservedPlan
q931NumberType M Integer Q931NumberType
-1: Use System Parameter
0: UnknownType
1: InternationalType
2: NationalType
3: NetworkSpecificType
4: SubscriberType
6: AbbreviatedType
7: ReservedType
q931PresentationIndicator M Integer Q931PresentationIndicator
-1: Use System Parameter
0: Presentation allowed
1: Presentation restricted
2: Number not available due
to interworking
3: Reserved
4: None
q931ScreeningIndicator M Integer Q931ScreeningIndicator
-1: Use System Parameter
0: User-provided, not
screened
1: User-provided, verified
and passed
2: User-provided, verified
and failed
3: Network provided
4: None
clearingAccount M String 64 Clearing Account Name
h323FastStart M Boolean true: Enable H323 fast start
false: Disable H323 fast
start
h323H245Tunneling M Boolean true: Enable H323 H245
tunneling

98
false: Disable H323 H245
tunneling
h323H245InSetup M Boolean true: Enable H323 H245 in
Setup
false: Disable H323 H245 in
Setup
h323T38 M Boolean true: Enable H323 T38
false: Disable H323 T38
sipTimer M Boolean true: Enable SIP Timer
(RFC4028)
false: Diable SIP Timer
sip100Rel M Boolean true: Enable SIP 100rel
false: Disable SIP 100rel
sipT38 M Boolean true: Enable SIP T38
false: Disable SIP T38
sipDisplay M Boolean true: Include Display
false: Exclude Display
sipRemotePartyId M Boolean true: Include
RemotePartyId
false: Exclude
RemotePartyId
sipPPreferredIdentity M Boolean true: Include
P-Preferred-Identity
false: Exclude
P-Preferred-Identity
sipPAssertedIdentity M Boolean true: Include
P-Asserted-Identity
false: Exclude
P-Asserted-Identity
groupE164Change M Boolean true: Enable Group E164
Change
false: Disable Group E164
Change

99
callerAllowLength M Integer Mask of Caller Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
calleeAllowLength M Integer Mask of Callee Allow
Length
0: Allow All Length
1<<x: Allow Length is x
(x < 32)
callerLimitE164GroupsAllo M Boolean true: Allow
w callerLimitE164Groups
false: Forbidden
callerLimitE164Groups
callerLimitE164Groups M String 255 Caller List, separate by
comma
calleeLimitE164GroupsAllo M Boolean true: Allow
w calleeLimitE164Groups
false: Forbidden
calleeLimitE164Groups
calleeLimitE164Groups M String 255 Callee List, separate by
comma
h323G729SendMode M Integer H323 G729 Negotiation
Mode
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729SendMode M Integer SIP G729 Negotiation Mode

100
0: Auto, keep original G729
codec
1: G729, treat G729a or
G729 as G729
2: G729a, treat G729a or
G729 as G729a
3: G729&G729a, treat G729
or G729a as G729 and
G729a
sipG729Annexb M Integer G729 annexb
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
sipG723Annexa M Integer G723 annexa
0: Auto
1: annex=yes
2: annex=no
3: no annex
4: transmit annex
h323CodecAssign M Boolean true: Assign H323 Codecs
false: Auto Negotiation
h323Codecs M Vector<String> H323 Codec List
sipCodecAssign M Boolean true: Assign SIP Codecs
false: Auto Negotiation
sipCodecs M Vector<String> SIP Codec List
feerateRestrict M Boolean true: Check Callee Fee
Rate
false: No Check
leastCostRouting M Boolean (feerateRestrict must be
true)
true: On
false: Off

101
minProfitPercent M Integer (feerateRestrict must be
true)
-1: No limit
Range: -1-9999
Default: -1
enablePhoneDisplay M Boolean true: Use phone display
number as caller
false: Use phone number as
caller
clearingAccountUseCallout M Boolean true: Use Callee after
E164 rewrite as Clearing Account
false: Use Callee before
rewrite as Clearing Account
softswitchName O String 64 Soft Switch Name
forwardSignalRewriteE164 O Boolean true: Enable Forward
GroupEnable Signal Rewrite
false: Disable Forward
Signal Rewrite
forwardSignalRewriteE164 O String 255 Forward Signal Rewrite
Group E164 Group

102
2.19 Get Online Routing Gateway
http://VOSIP/external/server/GetGatewayRoutingOnline

Request Format
Parameter M/O Type Length Description
names O String [] Gateway Name
Null: All
softswitchName O String Soft Switch Name
Null: All

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoGatewayRoutingOnlines O InfoGatewayRoutingOnline Online Routing Gateway
[] Information

InfoGatewayRoutingOnline Format
Parameter M/O Type Length Description
id M Integer Routing Gateway ID
name M String Routing Gateway Name
prefix M String Routing Gateway Prefix
currentCall M Integer Current Call
capacity M Integer Line Limit
asr M double Average Success Ratio
acd M Long Average Call Duration
remoteIp M String IP list, use comma to
separate
natIp O String NAT Address
localIp M String Register IP
registerTime M Long Register Time (UTC)
0: Static Gateway

103
updateTime M Long Last Update Time (UTC)
0: Static Gateway
keepTime M Long Online Time (Second)
0: Static Gateway
cryptoType M Integer Encryption Type
0: No Encryption
1: RC4
registerName O String Register Name
softswitchName M String Soft Switch Name
softswitchIp M String Soft Switch IP

104
2.20 Get Current Call
http://VOSIP/external/server/GetCurrentCall

Frequently use this function may cause performance become lower.

Request Format
Parameter M/O Type Length Description
callerE164s O String [] Caller
calleeE164s O String [] Callee

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoCurrentCalls O InfoCurrentCall [] Current Call Information

InfoCurrentCall Format
Parameter M/O Type Length Description
callerE164 M String Caller
calleeE164 M String Callee
callerGatewayId M String Caller Gateway
calleeGatewayId M String Callee Gateway
connectedTime 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

105
-9: SessionProgress
-10: SessionProgress(SDP)
-11: Ringing
-12: Ok
-13: Release
-14: Transfering
-15: TransferOk
-16: TransferFailed
-17: TransferCancel
callCodec M String Call Codec
callerCodec M String Caller Codec
calleeCodec M String Callee Codec
callerRtpIp M String Caller RTP Information
calleeRtpIp M String Callee RTP Information
callerReceiveDtmf M Integer Caller Receive DTMF Mode
0: Auto
10: RFC2833
20: H.245 alphanumeric
30: H.245 signal
40: Q.931 keypad
50: SIP Info
60: Off
callerSendDtmf M Integer See callerReceiveDtmf
calleeReceiveDtmf M Integer See callerReceiveDtmf
calleeSendDtmf M Integer See callerReceiveDtmf
callerInfoRtpFlowAudio M InfoRtpFlow Caller Audio Information
calleeInfoRtpFlowAudio M InfoRtpFlow Callee Audio Information
callerInfoRtpFlowVideo M InfoRtpFlow Caller Video Information
calleeInfoRtpFlowVideo M InfoRtpFlow Callee Video Information
callerTerminal M String Caller Device Name
calleeTerminal M String Callee Device Name
callerCryptoType M Integer Caller Encryption Type
0: No Encryption

106
1: RC4
calleeCryptoType M Integer Callee Encryption Type
0: No Encryption
1: RC4
callId M Integer Call ID

InfoRtpFlow Format
Parameter M/O Type Length Description
rtpPackets M Integer Receive Packets
rtpBytes M Integer Receive Bytes
rtpDuration M Long Duration
(Unit: Micro Second)

107
2.21 Pay
http://VOSIP/external/server/Pay

Request Format
Parameter M/O Type Length Description
ownerName M String 64 Name
ownerType M Integer Type
2: Account
6: Phone
11: Active Phone Card
25: Binded E164
44: Mapping Gateway
money M double Amount
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoPay O InfoPay Pay Information

InfoPay Format
Parameter M/O Type Length Description
account M String 64 Account Name
money M double Balance
validTime M Long Valid Time (UTC)
payMoney M double Amount

108
2.22 Create Suite
http://VOSIP/external/server/CreateSuite

Request Format
Parameter M/O Type Length Description
name M String 64 Suite Name
rentPeriod M Integer Rent Period
rentType M Integer Rent Type
0: Day
1: Month
2: Year
rentFee M double Rent Fee
giftMoney M double Gift Money
infoGiftTimes O InfoGiftTime [] Gift Time
memo O String Memo

InfoGiftTime Format
Parameter M/O Type Length Description
prefix M String 65535 Area Prefix, separate by
comma
startTime M Integer Start Time
(Seconds from 0:00)
Default: 0
Range: 0-86400
endTime M Integer Stop Time
(Seconds from 0:00)
Default: 0
Range: 0-86400
giftTime M Integer Gift Time (Unit: second)
billingTime M Integer Billing Period
memo O String 255 Memo

109
Response Format
Parameter M/O Type Length Description
retCode M Integer 0 Response Code
exception O String Error Information
id O Integer Suite Id

110
2.23 Delete Suite
http://VOSIP/external/server/DeleteSuite

Request Format
Parameter M/O Type Length Description
id M Integer Suite Id
force O Integer 0: Normal delete, check
dependence
1: Force delete, remove
dependence

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

111
2.24 Get Suite
http://VOSIP/external/server/GetSuite

Request Format
Parameter M/O Type Length Description
ids O Integer [] Suite Id List
Null: All

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoSuites O InfoSuite [] Suite Information

InfoSuite Format
Parameter M/O Type Length Description
id M Integer Suite Id
name M String Suite Name
rentPeriod M Integer Rent Period
rentType M Integer Rent Type
0: Day
1: Month
2: Year
rentFee M double Rent Fee
giftMoney M double Gift Money
infoGiftTimes O InfoGiftTime [] Gift Time
memo O String Memo

112
2.25 Create Suite Order
http://VOSIP/external/server/CreateSuiteOrder

Request Format
Parameter M/O Type Length Description
ownerName M String 64 Name
ownerType M Integer Type
2: Account
6: Phone
suiteId M Integer Suite Id
availableTime M Long Available Time
(UTC, Server Time Zone)
0: Current Day 0:00
expireTime O Long Expire Time
(UTC, Server Time Zone)
Null: No Limit
9223372036854775807: No
Limit

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
id O Integer Suite Order Id, If success

113
2.26 Modify Suite Order
http://VOSIP/external/server/ModifySuiteOrder

Request Format
Parameter M/O Type Length Description
id M Integer 64 Suite Order Id
expireTime O Long Expire Time
(UTC, Server Time Zone)
Null: No Limit
9223372036854775807: No
Limit

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

114
2.27 Delete Suite Order
http://VOSIP/external/server/DeleteSuiteOrder

Request Format
Parameter M/O Type Length Description
id M Integer Suite Order Id

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

115
2.28 Get Suite Order
http://VOSIP/external/server/GetSuiteOrder

Request Format
Parameter M/O Type Length Description
ownerName M String 64 Name
ownerType M Integer Type
2: Account
6: Phone

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoSuiteOrders O InfoSuiteOrder [] Suite Order Information

InfoSuiteOrder Format
Parameter M/O Type Length Description
id M Integer Suite Order Id
suiteId M Integer Suite Id
availableTime M Long Available Time
(UTC, Server Time Zone)
expireTime M Long Expire Time
(UTC, Server Time Zone)
9223372036854775807: No
Limit

116
2.29 Get Current Suite
http://VOSIP/external/server/GetCurrentSuite

Request Format
Parameter M/O Type Length Description
ownerName M String 64 Name
ownerType M Integer Type
2: Account
6: Phone

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoCurrentSuites O InfoCurrentSuite [] Suite Order Information

InfoCurrentSuite Format
Parameter M/O Type Length Description
id M Integer Current Suite Id
suiteId M Integer Suite Id
suiteOrderId M Integer Suite Order Id
rentPeriod M Integer Rent Period
rentType M Integer Rent Type
0: Day
1: Month
2: Year
rentFee M double Rent Fee
giftMoney M double Gift Money
infoGiftTimes O InfoGiftTime [] Gift Time
memo O String Memo

117
2.30 Delete Current Suite
http://VOSIP/external/server/DeleteCurrentSuite

Request Format
Parameter M/O Type Length Description
id M Integer 123 Current Suite Id

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

118
2.31 Create Active Phone Card
http://VOSIP/external/server/CreateActivePhoneCard

Request Format
Parameter M/O Type Length Description
pin M String 64 Card Number
account M String 64 Card Account
password O String 64 Card Password
displayE164 O String 64 Display Number
bindLimit O Integer Bind Number Limit
Null: No Limit
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
password O Integer Request without password,
system will generate
automatically.

119
2.32 Modify Active Phone Card
http://VOSIP/external/server/ModifyActivePhoneCard

Request Format
Parameter M/O Type Length Description
pin M String 64 Card Number
account O String 64 Card Account
password O String 64 Card Password
displayE164 O String 64 Display Number
bindLimit O Integer Bind Number Limit
Null: No Limit
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

120
2.33 Delete Active Phone Card
http://VOSIP/external/server/DeleteActivePhoneCard

Request Format
Parameter M/O Type Length Description
pin M String 64 Card Number

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

121
2.34 Get Active Phone Card
http://VOSIP/external/server/GetActivePhoneCard

Request Format
Parameter M/O Type Length Description
pins O String [] Card Number List
accounts O String [] Account List
One of parameters is needed at least.

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoActivePhoneCards O InfoActivePhoneCard [] Active Phone Card
Information

InfoActivePhoneCard Format
Parameter M/O Type Length Description
pin M String 64 Card Number
account M String 64 Card Account
password M String 64 Card Password
displayE164 M String 64 Display Number
bindLimit M Integer Bind Number Limit
Null: No Limit
activeTime M Long Active Time (UTC)
memo M String 255 Memo

122
2.35 Create Binded E164
http://VOSIP/external/server/CreateBindedE164

Request Format
Parameter M/O Type Length Description
e164 M String 64 Bind Number
pin M String 64 Card Number
displayE164 O String 64 Display Number
rewriteRulesOutCallee O String 65535 Call Out Rewrite Rule
language O String 64 Language
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

123
2.36 Modify Binded E164
http://VOSIP/external/server/ModifyBindedE164

Request Format
Parameter M/O Type Length Description
e164 M String 64 Bind Number
pin O String 64 Card Number
displayE164 O String 64 Display Number
rewriteRulesOutCallee O String 65535 Call Out Rewrite Rule
language O String 64 Language
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

124
2.37 Delete Binded E164
http://VOSIP/external/server/DeleteBindedE164

Request Format
Parameter M/O Type Length Description
e164 M String 64 Bind Number

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

125
2.38 Get Binded E164
http://VOSIP/external/server/GetBindedE164

Request Format
Parameter M/O Type Length Description
e164s O String [] Binded Number List
pin O String 64 Card Number
account O String 64 Account
One of parameters is needed at least.

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoBindedE164s O InfoBindedE164 [] Binded Number Information

InfoBindedE164 Format
Parameter M/O Type Length Description
e164 M String 64 Binded Number
pin M String 64 Card Number
account M String 64 Account
displayE164 M String 64 Display Number
rewriteRulesOutCallee M String 65535 Call Out Rewrite Rule
bindTime M Long Bind Time (UTC)
language M String 64 Language
memo M String 255 Memo

126
2.39 Get Fee Rate Group
http://VOSIP/external/server/GetFeeRateGroup

Request Format
Parameter M/O Type Length Description
names O String [] Fee Rate Group List

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoFeeRateGroups O InfoFeeRateGroup [] Fee Rate Group Information

InfoFeeRateGroup Format
Parameter M/O Type Length Description
name M String 64 Fee Rate Group Name
memo M String 64 Memo

127
2.40 Create Fee Rate Group
http://VOSIP/external/server/CreateFeeRateGroup

Request Format
Parameter M/O Type Length Description
name M String 64 Fee Rate Group Name
fakeMinute O Integer Equivalent Time to 60
Seconds for Calling Card
memo O String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

128
2.41 Modify Fee Rate Group
http://VOSIP/external/server/ModifyFeeRateGroup

Request Format
Parameter M/O Type Length Description
name M String 64 Fee Rate Group Name
fakeMinute O Integer Equivalent Time to 60
Seconds for Calling Card
memo O String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

129
2.42 Delete Fee Rate Group
http://VOSIP/external/server/DeleteFeeRateGroup

Request Format
Parameter M/O Type Length Description
name M String 64 Fee Rate Group Name

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

130
2.43 Get Fee Rate
http://VOSIP/external/server/GetFeeRate

Request Format
Parameter M/O Type Length Description
feeRateGroup M String 64 Fee Rate Group
areaCodes O String [] Area Code

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoFeeRates O InfoFeeRate [] Fee Rate Information

InfoFeeRate Format
Parameter M/O Type Length Description
feePrefix M String 64 Rate Prefix
areaCode M String 64 Area Prefix
type M Integer Rate Type
1: Net
2: Local
4: Domestic
5: International
areaName M String 64 Area Name
infoFeeRateSections M InfoFeeRateSection [] Section Rate
fee M double Billing Rate
period M Integer Billing Cycle
lockType M Integer Lock Type
0: No Lock
1: Lock
ivrFee M double Billing Rate for Calling Card
ivrPeriod M Integer Billing Cycle for Calling

131
Card Prompt

InfoFeeRateSection Format
Parameter M/O Type Length Description
fee M double Money Amount
time M Integer Charged Duration
position M Integer Serial Number

132
2.44 Get E164 Convert
http://VOSIP/external/server/GetE164Convert

Request Format
Parameter M/O Type Length Description
account O String 64 Account Number
e164 O String 64 Phone Number

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoE164Converts O InfoE164Convert [] E164 Convert Information

InfoE164Convert Format
Parameter M/O Type Length Description
account M String Account Name
e164 M String Phone Number
mappingGatewayCallerE16 M String Mapping Gateway Caller
4
routingGatewayCalleeE164 M String Routing Gateway Callee
memo M String Memo

133
2.45 Get Pay History
http://VOSIP/external/server/GetPayHistory

Request Format
Parameter M/O Type Length Description
account O String 64 Account Number
agentAccount O String 64 Agent Account Number
beginTime M String Begin Time
Format:
yyyyMMddHHmmss
endTime M String End Time
Format:
yyyyMMddHHmmss
One of parameters is needed at least.

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoPayHistorys O InfoPayHistory[] Pay History Information

InfoPayHistory Format
Parameter M/O Type Length Description
account M String Account Name
fee M double Money Amount
type M Integer Type
0: Payment
1: Credit
2: Create Account
3: Make Zero
payType M Integer Pay Type
0: Cash

134
2: Phone Card
5: Other
customerMoney M double Account Balance After Pay
payTime M Long Pay Time (UTC)

135
2.46 Get Cdr
http://VOSIP/external/server/GetCdr

Request Format
Parameter M/O Type Length Description
accounts M String [] 64 Account Number List
callerE164 O String 64 Caller
calleeE164 O String 64 Callee
callerGateway O String 64 Caller Gateway
calleeGateway O String 64 Callee Gateway
beginTime M String Begin Time
Format: yyyyMMdd
endTime M String End Time
Format: yyyyMMdd

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoCdrs O InfoCdr [] CDR Information

InfoCdr Format
Parameter M/O Type Length Description
callerE164 M String Billing Caller
callerAccessE164 M String Access Caller
callerProductId M String Caller Device Name
callerToGatewayE164 M String Call Out Caller
callerGateway M String Caller Gateway
callerip M String Caller IP
calleeE164 M String Billing Callee
calleeAccessE164 M String Access Callee
calleeProductId M String Callee Device Name

136
calleeToGatewayE164 M String Call Out Callee
calleeGateway M String Callee Gateway
calleeip M String Calle IP
start 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 Fee
feePrefix M String Billing Prefix
suiteFee M double Suite Fee
suiteFeeTime M Integer Suite Gift Time (Second)
agentFee M double Agent Fee
agentFeeTime M Integer Agent Fee Time (Second)
agentFeePrefix M String Agent Billing Prefix
agentSuiteFee M double Agent Suite Fee
agentSuiteFeeTime M Integer Agent Gift Time (Second)
callLevel M Integer Call Level
1: Net
2: Local
4: Domestic
5: International
account M String Account Number
accountName M String Account Name
agentAccount M String Agent Account Number
agentName M String Agent Account Name
endDirection M Integer Hangup Side
0: Caller
1: Caller
2: Server
endReason M Integer End Reason
calleeBilling M Integer Billing
0: Caller Billing
1: Callee Billing

137
2: External Billing
billingMode M Integer Billing Mode
0: By Phone Account
1: By Mapping Gateway
Account
2: By Binded Number
Account
3: By Active Phone Card
Account

138
2.47 Get Customer Fee Report
http://VOSIP/external/server/GetReportCustomerFee

Request Format
Parameter M/O Type Length Description
accounts M String [] Account Number List
period M Integer Statistical Cycle (Day)
-2: By Month
beginTime M String Begin Time
Format: yyyyMMdd
endTime M String End Time
Format: yyyyMMdd

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoReportCustomerFees O InfoReportCustomerFee [] Customer Fee Report
Information

InfoReportCustomerFee Format
Parameter M/O Type Length Description
beginTime M Long Begin Time (UTC)
endTime M Long End Time (UTC)
account M String Account Number
accountName M String Account Name
cdrCount M Long Total CDR
totalFee M double Total Fee
totalTime M Long Total Time (Second)
totalSuiteFee M double Total Suite Fee
totalSuiteFeeTime M Long Total Suite Fee Time
(Second)

139
netFee M double Total Net Fee
netTime M Long Total Net Fee Time
(Second)
netCount M Integer Total Net CDR
localFee M double Total Local Fee
localTime M Long Total Local Fee Time
(Second)
localCount M Integer Total Local CDR
domesticFee M double Total Domestic Fee
domesticTime M Long Total Domestic Fee Time
(Second)
domesticCount M Integer Total Domestic CDR
internationalFee M double Total International Fee
internationalTime M Long Total International Fee Time
(Second)
internationalCount M Integer Total International CDR

140
2.48 Get Phone Fee Report
http://VOSIP/external/server/GetReportPhoneFee

Request Format
Parameter M/O Type Length Description
accounts M String 64 Account Number
e164s O String [] Phone Number List
period M Integer Statistical Cycle (Day)
-2: By Month
beginTime M String Begin Time
Format: yyyyMMdd
endTime M String End Time
Format: yyyyMMdd

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoReportPhoneFees O InfoReportPhoneFee [] Phone Fee Report
Information

InfoReportPhoneFee Format
Parameter M/O Type Length Description
beginTime M Long Begin Time (UTC)
endTime M Long End Time (UTC)
e164 M String Phone Number
calleeBilling M Integer 0: Caller Billing
1: Callee Billing
account M String Account Number
accountName M String Account Name
agentAccount M String Agent Account
cdrCount M Long Total CDR

141
totalFee M double Total Fee
totalTime M Long Total Time (Second)
totalSuiteFee M double Total Suite Fee
totalSuiteFeeTime M Long Total Suite Fee Time
(Second)
netFee M double Total Net Fee
netTime M Long Total Net Fee Time
(Second)
netCount M Integer Total Net CDR
localFee M double Total Local Fee
localTime M Long Total Local Fee Time
(Second)
localCount M Integer Total Local CDR
domesticFee M double Total Domestic Fee
domesticTime M Long Total Domestic Fee Time
(Second)
domesticCount M Integer Total Domestic CDR
internationalFee M double Total International Fee
internationalTime M Long Total International Fee Time
(Second)
internationalCount M Integer Total International CDR

142
2.49 Get Customer Location Fee Report
http://VOSIP/external/server/GetReportCustomerLocationFee

Request Format
Parameter M/O Type Length Description
account M String 64 Account Number
areaCode O String 64 Area Prefix
period M Integer Statistical Cycle (Day)
-2: By Month
beginTime M String Begin Time
Format: yyyyMMdd
endTime M String End Time
Format: yyyyMMdd

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoReportCustomerLocatio O InfoReportCustomerLocatio Customer Location Fee
nFees nFee [] Report Information

InfoReportCustomerLocationFee Format
Parameter M/O Type Length Description
beginTime M Long Begin Time (UTC)
endTime M Long End Time (UTC)
areaCode M String Area Prefix
areaName M String Area Name
account M String Account Number
accountName M String Account Name
agentAccount M String Agent Account
cdrCount M Long Total CDR
totalFee M double Total Fee

143
totalTime M Long Total Local Fee Time
(Second)
totalSuiteFee M double Total Suite Fee
totalSuiteFeeTime M Long Total Suite Fee Time
(Second)

144
2.50 Create CDR
http://VOSIP/external/server/CreateCdr

Request Format
Parameter M/O Type Length Description
billingMode M Integer Billing Mode
0: By callerE164’s Phone
Account
1: By callerGatewayId’s
Mapping Gateway Account
2: By callerE164’s Binded
Number Account
3: By callerE164’s Active
Phone Card Account
account O String Billing Account
Null: Choose By Billing
Mode
callerE164 O String 64 Caller
calleeE164 O String 64 Callee
callerIp O String 64 Caller IP
callerGatewayId O String 64 Caller Gateway
callerProductId O String 64 Caller Device Name
callerToGatewayE164 O String 64 Call Out Caller
calleeIp O String 64 Callee IP
calleeGatewayId O String 64 Callee Gateway
calleeProductId O String 64 Callee Device Name
calleeToGatewayE164 O String 64 Call Out Callee
startTime O Long Begin Time (UTC)
Null: Use Server Current
Time
stopTime O Long End Time (UTC)
Null: Use startTime

145
billingTime M Integer Billing Time (Calculate by
calleeE164’s billing
period)
endDirection O Integer Hangup Side
0: Caller
1: Caller
2: Server
endReason O Integer End Reason
flowNo O Long -1: Create by System
>=0: Use the number as
primary key, if conflict will
not billing

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

146
2.51 Get Customer Phone Book
http://VOSIP/external/server/GetCustomerPhoneBook

Request Format
Parameter M/O Type Length Description
account O String 64 Account Number
e164 O String 64 Phone Number

Response Format
Parameter M/O Type Length Description
retCode M Integer 0 Response Code
exception O String Error Information
infoCustomerPhoneBooks O InfoCustomerPhoneBook [] Customer Phone Book
Information

InfoCustomerPhoneBook Format
Parameter M/O Type Length Description
e164 M String 64 Phone Number
shortE164s M String[] Short Number List
name M String Name
department M String Department
deviceType M Integer Device Type
0: None
1: Mobile
2: Phone
3: IP Phone
addressType M Integer Address Type
0: None
1: Office
2: Home
type M Integer Type
0: User Create

147
1: Auto Save
lastUpdateTime M Long Last Update Time (UTC)
memo M String Memo

148
2.52 Create Customer Phone Book
http://VOSIP/external/server/CreateCustomerPhoneBook

Request Format
Parameter M/O Type Length Description
account M String 64 Account Number
e164 M String 64 Phone Number
overwrite O Boolean true: if number exists, over
write the old one
false: if number exists, show
error
shortE164s O String[] Short Number List
name O String 64 Name
department O String 64 Department
deviceType O Integer Device Type
0: None
1: Mobile
2: Phone
3: IP Phone
addressType O Integer Address Type
0: None
1: Office
2: Home
type O Integer Type
0: User Create
1: Auto Save
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

149
2.53 Modify Customer Phone Book
http://VOSIP/external/server/ModifyCustomerPhoneBook

Request Format
Parameter M/O Type Length Description
account M String 64 Account Number
e164 M String 64 Phone Number
newE164 O String 64 New Phone Number
shortE164s O String[] Short Number List
name O String 64 Name
department O String 64 Department
deviceType O Integer Device Type
0: None
1: Mobile
2: Phone
3: IP Phone
addressType O Integer Address Type
0: None
1: Office
2: Home
type O Integer Type
0: User Create
1: Auto Save
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

150
2.54 Delete Customer Phone Book
http://VOSIP/external/server/DeleteCustomerPhoneBook

Request Format
Parameter M/O Type Length Description
account M String 64 Account Number
e164s M String[] 64 Phone Number List

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

151
2.55 Get Soft Switch
http://VOSIP/external/server/GetSoftSwitch

Request Format
Parameter M/O Type Length Description

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoSoftSwitches O InfoSoftSwitch [] Soft Switch Information

InfoSoftSwitch Format
Parameter M/O Type Length Description
name M String Soft Switch Name
identification M String Soft Switch ID
createTime M Long Create Time (UTC)
accessTime O Long Access Time (UTC)
accessAddress O String Access IP
memo M String Memo

152
2.56 Get Performance
http://VOSIP/external/server/GetPerformance

Request Format
Parameter M/O Type Length Description

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoPerformance O InfoPerformance Performance Information

InfoPerformance Format
Parameter M/O Type Length Description
callSize M Integer Current Call
cdrQueueSize M Integer CDR Queue Size

153
2.57 Pay By Phone Card
http://VOSIP/external/server/PayByPhoneCard

Request Format
Parameter M/O Type Length Description
ownerName M String 64 Name
ownerType M Integer Type
2: Account
6: Phone
11: Active Phone Card
25: Binded E164
44: Mapping Gateway
pin M String Card Number
password O String Card Password
Null: Check Pin Only
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoPay O InfoPay Pay Information

154
2.58 Phone Card Active
http://VOSIP/external/server/PhoneCardActive

Request Format
Parameter M/O Type Length Description
pin M String Card Number
password O String Card Password
Null: Check Pin Only
bindedE164 O String 64 Binded Number

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

155
2.59 Callback
http://VOSIP/external/server/CallBack

Request Format
Parameter M/O Type Length Description
callerE164 M String Caller (Input by User)
calleeE164s M String Callee (Use "," to separate
numbers)
accessE164 M String Access Number (Number of
phone, which provides
callback service.)
accessE164Password M String Access Password (Phone's
password)
callbackBillingE164 O String Call Back Charge Number
callbackBillingPassword O String Call Back Charge Password
calloutBillingE164 O String Callout Charge Number
calloutBillingPassword 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 Mode

1. Access Number’s Phone: Use accessE164’s Phone Account
2. In-use Phone Card: Order: callbackBillingE164’s Binded Number Account, callbackBillingE164’s Active Phone Card Account
3.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 Account
4.Platform Phone: Use callbackBillingE164’s Phone Account

Second Line Billing Mode

156
1. Access Number’s Phone: Use accessE164’s Phone Account
2. In-use Phone Card: Order: calloutBillingE164’s Binded Number Account, calloutBillingE164’s Active Phone Card Account
3.Platform Phone: Use calloutBillingE164’s Phone Account

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

157
2.60 Play Audio
http://VOSIP/external/server/PlayAudio

Request Format
Parameter M/O Type Length Description
audioes M String Audio List, separate by
comma
language O String Default: Use accessE164’s
language
callee M String Callee
accessE164 M String Access Number (Number of
phone, which provides
callback service.)
accessE164Password M String Access Password (Phone's
password)

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

158
2.61 Get Available Time
http://VOSIP/external/server/GetAvailableTime

Request Format
Parameter M/O Type Length Description
billingName M String Billing Name
billingMode M Integer 0: Phone
1: Mapping Gateway
2: Binded Number
3: Phone Card
4: Use phone card first, then
mapping gateway
calleeE164 M String Callee Number
calleeEndpointType O Integer 0: Phone
1: Mapping Gateway
routingGateway O String 64 Routing Gateway Name
calleeToGatewayE164 O String 64 Number after rewrite by
routing gateway
(Used when routing
gateway check remain
money of clearing account)

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
InfoAvailableTime O InfoAvailableTime Available Time Information

InfoAvailableTime Format
Parameter M/O Type Length Description
account O String Account Number
accountName O String Account Name

159
accountMoney O Double Account Balance (Exclude
Suite's gift money)
timeRemain M Integer >0: Remain Time
<0: End Reason
timeRemainRoutingGatewa O Integer >0: Routing Gateway's
y Remain Time
<0: Routing Gateway's End
Reason

160
2.62 Get IVR Second Available Time
http://VOSIP/external/server/GetIvrSecondAvailableTime

Request Format
Parameter M/O Type Length Description
billingName M String Billing Name
billingMode M Integer 0: Phone
1: Active Phone Card
2: Auto, Binded Number >
Phone Card Number >
Phone Number
3: Caller's Phone
calleeE164 M String Callee Number
mergeBillingType O Integer 0: No merge
1: merge access billing to
second line
2: merge caller billing to
second line
mergeE164 O String 64 Merge Number
firstE164 O String 64 First line's callee
firstConnectTime O Long First line's connect time
(UTC)
firstStopTime O Long First line's stop time (UTC)

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoIvrSecondAvailableTime O InfoIvrSecondAvailableTime Available Time Information

InfoIvrSecondAvailableTime Format
Parameter M/O Type Length Description

161
account O String Account Number
accountName O String Account Name
accountMoney O Double Account Balance (Exclude
Suite's gift money)
timeRemain M Integer >0: Remain Time
<0: End Reason

162
2.63 Get Consumption
http://VOSIP/external/server/GetConsumption

Request Format
Parameter M/O Type Length Description
account O String 64 Account Number
agentAccount O String 64 Agent Account Number
beginTime M String Format:
yyyyMMddHHmmss
endTime M String Format:
yyyyMMddHHmmss
One of "account" or "agentAccount" is needed.

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoConsumptions O InfoConsumption[] Consumption Information

InfoConsumption Format
Parameter M/O Type Length Description
account M String Account Number
money M Double Account Consumption
customerMoney M Double Account Balance
type M Integer 0: Suite Rent
1: Phone Month Rent
2: Phone Under
Consumption
3: Suite Under
Consumption
consumptionName M Integer Source
time M Long Time (UTC)

163
2.64 Get All Customers
http://VOSIP/external/server/GetAllCustomers

Request Format
Parameter M/O Type Length Description

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
accounts O String[] Account List

164
2.65 Reserve CalleeE164
http://VOSIP/external/server/ReserveCalleeE164

Request Format
Parameter M/O Type Length Description
callerE164 M String Caller Number
calleeE164 M String Callee Number
accessE164 M String Access Number (Number of
phone, which provides
callback service.)
accessE164Password M String Access Password (Phone's
password)

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

165
2.66 Create LimitedE164
http://VOSIP/external/server/CreateLimitedE164

Request Format
Parameter M/O Type Length Description
limitE164GroupName M String 255 LimitedE164 group name
infoLimitE164s M InfoLimitE164 [] LimitedE164 group list
InfoLimitE164 format
Parameter M/O Type Length Description
e164 M String 64 Number
memo O String 255 Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

166
2.67 Create IvrAudio
http://VOSIP/external/server/CreateIvrAudio

Request Format
Parameter M/O Type Length Description
type M Integer Audio Type
0:public audio
1:internal audio
2:polyphonic ringtone
3:ippbx audio
4:direct/callback audio
5:valuadded audio
6:alarm prompt audio
7:voice mail audio
name M String Audio name
language O String Language
ivrServiceName O String Ivr service name
memo O String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
id O Integer Ivr audio identification

167
2.68 Modify IvrAudio
http://VOSIP/external/server/ModifyIvrAudio

Request Format
Parameter M/O Type Length Description
id M Integer Ivr audio identification
language O String Language
ivrServiceName O String Ivr service name
memo O String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

168
2.69 Delete IvrAudio
http://VOSIP/external/server/DeleteIvrAudio

Request Format
Parameter M/O Type Length Description
id M Integer Ivr audio identification

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

169
2.70 Get IvrAudio
http://VOSIP/external/server/GetIvrAudio

Request Format
Parameter M/O Type Length Description
type M Integer Audio Type
0:public audio
1:internal audio
2:polyphonic ringtone
3:ippbx audio
4:direct/callback audio
5:valuadded audio
6:alarm prompt audio
7:voice mail audio
ids O Integer Ivr audio identification list

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoIvrAudios O InfoIvrAudio [] Ivr audio list

InfoIvrAduio Format
Parameter M/O Type Length Description
id M int vr audio identification
type M Integer Audio Type
0:public audio
1:internal audio
2:polyphonic ringtone
3:ippbx audio
4:direct/callback audio

170
5:valuadded audio
6:alarm prompt audio
7:voice mail audio
name M String Audio name
language O String Language
ivrServiceName O String Ivr service name
size M Integer Memory size
memo O String Memo

171
2.71 Modify IvrAudio Data
http://VOSIP/external/server/ModifyIvrAudioData

Request Format
Parameter M/O Type Length Description
id M Integer Ivr audio identification
data M String Wav file, the byte stream
should be converted to
hexadecimal string
File format:
PCM_SIGNED 8000.0 Hz,
16 bit, mono, 2
bytes/frame,little-endian

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

172
2.72 Create E164Convert
http://VOSIP/external/server/CreateE164Convert

Request Format
Parameter M/O Type Length Description
mappingGatewayCallerE16 M String Mapping gateway coming
4 caller
e164 M String Phone number
routingGatewayCalleeE164 M String Routing gateway outbound
number
memo M String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
id O Integer Identification

173
2.73 Modify E164Convert
http://VOSIP/external/server/ModifyE164Convert

Request Format
Parameter M/O Type Length Description
id M Integer Identification
mappingGatewayCallerE16 O String Mapping gateway coming
4 caller
routingGatewayCalleeE164 O String Routing gateway outbound
number
memo O String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

174
2.74 Delete E164Convert
http://VOSIP/external/server/DeleteE164Convert

Request Format
Parameter M/O Type Length Description
id M Integer Identification

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

175
2.75 Disconnect Current Call
http://VOSIP/external/server/DisconnectCurrentCall

Request Format
Parameter M/O Type Length Description
CallIds M Integer Call Id

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

176
2.76 GetAllPhoneOnline
http://VOSIP/external/server/GetAllPhoneOnline

Request Format
Parameter M/O Type Length Description

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
E164s O String[] All phone online list

177
2.77 DeleteLimitE164
http://VOSIP/external/server/DeleteLimitE164

Request Format
Parameter M/O Type Length Description
limitE164GroupName M String 255 LimitE164GroupName
e164s M String [] Number list

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

178
2.78 Get Phone Card
http://VOSIP/external/server/GetPhoneCard

Request Format
Parameter M/O Type Length Description
pin M String [] 255 Card Number
Password O String Password

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoPhoneCards O InfoPhoneCard [] Phone Card
Information

InfoPhoneCard Format
Parameter M/O Type Length Description
money M double Money amount
limitMoney M double Overdraft limited
bitsOfConfig M int Fuction
1<<1:Create account
1<<2:Create account and
active phone card
1<<3: Create account and
phone number
1<<4:Recharge
1<<5:Replace account
billing rate group
1<<6:Package joined in
account package order
1<<7:Money charged into
account balance

179
feeRateGroup M String Group name
expireTime M Long Exprie time(UTC)
usedTime O Long Used time(UTC)
usedAccount O String Used account
agentAccount M String Agent Account
suiteNames M String [] Suite name list
memo M String Memo

180
2.79 Create Alarm
http://VOSIP/external/server/CreateAlarm

Request Format
Parameter M/O Type Length Description
name M String 255 告警名称
level Integer Level
0:General
1:Minor
2:Major
3:Critical
value O Double Default:0x7fffffff(32-bit
integer）
alarmInfo O String Alarm information
startTime O Long Alarm start time(UTC) ）
stopTime O Long Alarm stop time(UTC)
upper O Double Upper value
Range:
0x8000000 ～ 0x7fffffff(32-bit
integer）
lower O Double Lower value
Range:
0x8000000 ～ 0x7fffffff(32-bit
integer）

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

181
2.80 CreateMediaBlockIp
http://VOSIP/external/server/ CreateMediaBlockIp

Request Format
Parameter M/O Type Length Description
ip M String 255 Ip address
memo O String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

182
2.81 DeleteMediaBlockIp
http://VOSIP/external/server/DeleteMediaBlockIp

Request Format
Parameter M/O Type Length Description
ip M String 255 Ip address
memo O String Memo

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information

183
2.82 GetAlarmCurrent
http://VOSIP/external/server/GetAlarmCurrent

Request Format
Parameter M/O Type Length Description

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
exception O String Error Information
infoAlarmCurrents O InfoAlarmCurrent Current alarm list

InfoAlarmCurrentFormat
Parameter M/O Type Length Description
id M int Alarm id
type M int Alarm type
20000:Routing ASR
20001:RoutingACD
20002:routing concurrency
decline
20003:CPU
20004:Memory
20005:Harddisk
20006:Pending CDR
20007:Account Balance
20009:Package receive
20010:Bytes receive
20011:Package transmit
20012:Bytes transmit
20013:MappingASR
20014:MappingACD
20015:Mapping

184
concurrency decline
20016:Converstion time
20017:Database
20018:Process terminated
20019:Standby enable
20020:Illegal call
20021:Clock deviation
20022:Routing concurrency
rise
20023:Mapping
concurrency rise
20026:Mac limited
20027: Master synchronize
status
20028: Slave synchronize
status
level M int Level
0:General
1:Minor
2:Major
3:Critica
name M String Alarm name
startTime M long Alarm start time(UTC)
stopTime O Long Alarm stop time(UTC)
value M double Alarm value
upper O Double Alarm upper value
lower O Double Alarm lower value
confirmUser O String Confirm user
confirmTime O Long Confirm time(UTC)
memo M String Memo

185
3. Send Request
Send Request use HTTP+JSON, address can be configured.
3.1 IVR Request Push DTMF Information
Interface Name: PushDtmfInfo
Request Format
Parameter M/O Type Length Description
flowNo M Long Call ID
callerE164 M String 64 Caller
calleeE164 M String 64 Callee
accessE164 M String 64 Access Number
menuName M String 64 Menu Name
dtmf M String 64 DTMF Information

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
(Define by external
system, system will
execute menu defined by
response code.
If no response, default
menu will be executed.)
exception O String Error Information
audioNames O String [] Audio List

186
3.2 IVR Request Push DTMF Information 2
Interface Name: PushDtmfInfos

Request Format
Parameter M/O Type Length Description
flowNo M Long Call Id
callerE164 M String 64 Caller
calleeE164 M String 64 Callee
accessE164 M String 64 Access Number
infoDtmfs M InfoDtmf [] DTMF Information

InfoDtmf Format
Parameter M/O Type Length Description
menuName M String 64 Menu Name
dtmf M String 64 DTMF

Response Format
Parameter M/O Type Length Description
retCode M Integer Response Code
(Define by external
system, system will
execute menu defined by
response code.
If no response, default
menu will be executed.)
exception O String Error Information
audioNames O String [] Audio List

187
3.3 Phone Online/offline Report
Interface Name: PhoneOnline

Request Format
Parameter M/O Type Length Description
e164 M String 64 Phone number
dids M String[] Did list
online M boolean True: Phone Online
false: Phone Offline
eventTime M long Time of event
localIp M String Local Ip
localPort M int Local port
remoteIp M String Remote ip
productId M String Device name

Response Format
Parameter M/O Type Length Description
retCode M Integer

188
3.4 Call State Report
Interface Name: CallStateReport

Request Format
Parameter M/O Type Length Description
callId M integer 64 Call idetification
callState 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 event
callerE164 M String Caller
calleeE164 M String Callee
callerGatewayId O String Name of caller gateway
calleeGatewayId O String Name of callee gateway
callerIp M String Caller ip
calleeIp M String Callee ip
callerLocalIp M String Caller local ip
calleeLocalIp M String Callee local ip

Response Format

189
Parameter M/O Type Length Description
retCode M Integer

[Type here]
3.5 Customer Money Change
Interface Name: CustomerMoneyChange

Request Format
Parameter M/O Type Length Description
account M String 64 Account id
money M double Account balance

Response Format
Parameter M/O Type Length Description
retCode M Integer

[Type here]
3.6 Current Alarm Report
Interface Name: AlarmCurrentReport

Request Format
Parameter M/O Type Length Description
infoAlarmCurrents M InfoAlarmCurrent [] Current alrm list,

Response Format
Parameter M/O Type Length Description
retCode M Integer

[Type here]
Thank you very Much, Please stay Connected at
Our Blog: www.multahost.com/blog/ for more
Security updates, Manuals, Training Etc.

VOS3000 Web Apps, VOS3000 Mobile Apps Need Good Security Systems,
So please do it carefully, for more Help Contact with us and stay connected at our Blog.

[Type here]