30 JSON Objects
30.1 SoftwareVersion
30.1.1 SoftwareVersion Field Description
-
versionMajor
Type: Integer
-
versionMinor
Type: Integer
-
versionRelease
Type: Integer
30.1.2 SoftwareVersion JSON Schema
30.2 AddUserData
30.2.1 AddUserData Field Description
-
displayName
The displayed name of the new user.
Type: String
-
emailAddress
The email address of the new user.
Type: String
-
enabled
Determines if the new user should be enabled. Disabled user cannot login.
Type: Boolean
-
ldapAuthentications
Add LDAP users here to link this user to LDAP users.
Type: Array of LdapUserJson
-
name
Type: String
-
ldapAuthorityId
Type: String
-
-
ldapLogin
Defines if the user should be able to login with LDAP credentials.
Type: Boolean
-
localPassword
The password for local authentication.
Type: String
-
localUsername
The username for local authentication.
Type: String
-
loginLocally
Defines if the user should be able to login with a local username and password.
Type: Boolean
-
passwordChange
Define whether and, if so, when the password has to be changed.
Type: PasswordChange
Possible values:
-
NOT_NECESSARY
-
REQUIERED
-
RECOMMENDED
-
-
roleIds
Add roles for this user to determine the permissions.
Type: Array of String
30.2.2 AddUserData JSON Schema
30.3 CustomUserOptions
30.3.1 CustomUserOptions Field Description
-
blockedUntil
Type: Date
-
displayName
Type: String
-
emailAddress
Type: String
-
enabled
Type: Boolean
-
failedLogins
Type: Integer
-
id
Type: String
-
lastFailedLogin
Type: Date
-
lastLogin
Type: Date
-
ldapUsers
Type: Array of LdapUserJson
-
name
Type: String
-
ldapAuthorityId
Type: String
-
-
local
Type: LocalUser (section 30.48)
-
localUserName
Type: String
-
localV0
Type: LocalV0User (section 30.49)
-
roleBuiltIns
Type: String
-
roles
Type: Array of String
30.3.2 CustomUserOptions JSON Schema
30.4 Role
30.4.1 Role Field Description
-
displayName
The displayname of the role..
Type: String
-
id
A unique identifier for the role.
Type: String
-
permissions
The permission that users with this role have.
Type: Permissions
30.4.2 Role JSON Schema
30.5 TracingOptionsJson
30.5.1 TracingOptionsJson Field Description
-
selection
Selects how tracing records will be stored.
Type: TracingSelection
Possible values:
-
FILE
Single file, no size limit.
-
SPLIT
Rolling files of limited size.
-
-
traceActive
Type: Boolean
-
options
Type: TracingFileOptions
-
count
Determines how many trace files will be kept. Only for selection=SPLIT
Type: Integer
-
flags
Possible values: TRIO_FLAG_MARKED (only trace sessions that are marked for tracing) and TRIO_FLAG_IGNORE_HIGH_VOLUME_MESSAGES (removes high-volume trace messages) seperated by '|'
Type: String
-
size
Determines the maximum size for trace files. Only for selection=SPLIT
Type: Integer
-
30.5.2 TracingOptionsJson JSON Schema
30.6 License
30.6.1 License Field Description
-
status
Type: LicenseStatus
Possible values:
-
CONFIGURED
License is configured but is not active yet.
-
ACTIVE
License is active.
-
SIGNATURE
Signature is invalid.
-
PRODUCT
License belongs to a different product.
-
APPLICATION
License belongs to a different application
-
SYSTEM_ID
System ID does not exist
-
VALID_FROM
License is not valid yet.
-
VALID_UNTIL
License is expired.
-
SUS_UNTIL
Software Update Service (SUS) is expired.
-
INVALIDATED
License is invalidated by another license.
-
MUTEX
This license or another license which is invalidated by this license is bound to another process.
-
-
identifier
The identifier for this license.
Type: String
-
name
Type: String
-
validFrom
The time this license is valid from onwards.
Type: Date
-
validUntil
The time when this license expires.
Type: Date
-
softwareUpdateServiceUntil
The time this license will be renewed.
Type: Date
-
requiredSystemIds
A list of system IDs that were given on license activation this license is bound to.
Type: String
-
invalidatedLicences
The amount of invalidated licenses.
Type: String
-
products
The products this license is meant for.
Type: String
-
facilities
The facilities this license is active for
Type: Array of LicenseFacility (section 30.51)
-
constaints
The constraints for this license.
Type: String
30.6.2 License JSON Schema
30.7 ImportLodData
30.7.1 ImportLodData Field Description
-
companyName
If the LOD key has already been used to generate a license using a different licensing device, please confirm that you are eligible for requesting a new license and provide the name of your company.
Type: String
-
emailAddress
An additional copy of the generated license will be sent to the given e-mail address.
Type: String
-
licensingDevice
Each license must be bound to a certain device already installed in your system. The list of devices available for licensing can be requested via section 6.3.Please specify the devices system ID that should be used to bind the new license to.
Type: String
-
lodKey
The LOD key that was supplied together with the product.
Type: String
30.7.2 ImportLodData JSON Schema
30.8 AddSystemProfile
30.8.1 AddSystemProfile Field Description
-
sipTransport
Create a SIP transport object or select an existing one.
Type: AddSystemSipTransport (section 30.55)
-
createNewNetworkController
Create new network controller or select an existing one.
Type: Boolean
-
networkControllerDisplayName
The display name of the newly created network controller.
Type: String
-
networkControllerInterface
The interface of the newly created network controller.
Type: String
-
networkControllerIpVersion
The IP version of the newly created network controller.
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
networkControllerIpAddress
The IP address of the newly created network controller.
Type: String
-
enableReverseDnsLookup
Specify whether reverse DNS lookup is enabled for the newly created network controller.
Type: Boolean
-
networkControllerId
In case no new network controller is created, this value must be provided.
Type: String
-
udpTcpPort
The UDP/TCP Port.
Type: Integer
-
tlsPort
The TLS Port.
Type: Integer
-
udpPortRange
Restricts the udp port range
Type: PortRange (section 30.56)
-
tcpPortRange
Restricts the tcp port range
Type: PortRange (section 30.56)
-
sipInterconnection
Type: SipInterconnection
Possible values:
-
REGISTRAR
The node provides a registration server (registrar) at which the remote station must register.
-
REGISTRATION
The node registers at a remote station as a client. In this case the remote station has to provide a registrar.
-
TRUNK
The node uses SIP trunking to interconnect with the remote station. In this way, full dial stringranges can be linked at once.
-
-
remoteSipDomain
Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.
Type: RemoteSipDomain (section 30.57)
-
localSipDomain
Optionally you can choose the local SIP domain. The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls).
Type: String
-
activateClientAuthentication
Activate client authentication. These authentication settings determine how the node authenticate to a remote station.
Type: Boolean
-
clientCredentials
Credentials for client authentication.
Type: SipCredentials (section 30.35)
-
activateServerAuthentication
Activate server authentication. These authentication settings determine how a remote station has to authenticate to anynode. They will be stored in a User Directory.
Type: Boolean
-
serverCredentials
Credentials for server authentication
Type: SipCredentials (section 30.35)
-
registrarUri
The node will register as a client at a remote station. Select the necessary settings for this registration.
Type: String
-
addressOfRecord
User Part of Address-Of-Record for registration.
Type: String
-
sipRegistrar
Dial string matching condition that determines which calls are to be forwarded to the registered remote stations.
Type: TelMatch (section 30.58)
-
srvProxyDomain
The proxy address for nodes that are using an SRV loadbalancer.
Type: String
-
useNetworkPeerWhitelist
Type: Boolean
-
includeRemoteSipDomainInWhitelist
Include the remote SIP domain in the whitelist.
Type: Boolean
-
includeSipRegistrarInWhitelist
Include the SIP registrar in the whitelist.
Type: Boolean
-
includeOwnSubnetInWhitelist
Include the own subnet in the whitelist.
Type: Boolean
-
networkPeerWhitelist
Type: Array of NetworkPeerWhitelistEntry
-
dnsLookup
Additional protocol prefixes.
Type: Array of String
-
host
The hostname or ip address.
Type: String
-
ipVersion
If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
subnetPrefixLength
Type: Integer
-
-
allowOnlyNegotiatedPeersForRtpRtcp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
sipNodeNetworkPeerWhitelist
Network peer whitelist for filtering of incoming calls. Only applies when creating a shared SIP transport or using an existing SIP transport.
Type: AddSystemSipNodeWhitelist (section 30.59)
-
incomingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
routingDomains
Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.
Type: Array of String
-
displayName
Enter a meaningful name for your new node. The name is arbitrary. You will use it to uniquely identify this node later during configuration.
Type: String
-
createNewTeamsCarrierNode
Whether to create a new Teams carrier node or use an existing one. If an existing one is used, the value eamsCarrierNodeId" must be given.
Type: Boolean
-
teamsCarrierNodeId
Select an existing MS Teams carrier node to share the Microsoft Teams Connectivity.
Type: String
-
createNewMsOperatorConnectNode
Whether to create a new Microsoft Teams Connectivity or use an existing one. If an existing one is used, the value "msOperatorConnectNodeId" must be given.
Type: Boolean
-
msOperatorConnectNodeId
Select an existing Node to share the Microsoft Teams Connectivity.
Type: String
-
tenantId
The tenant ID is mandatory if you want to setup multiple Microsoft Operator Connect nodes, using a single SBC FQDN.
Type: String
-
sbcFqdn
Determine the name for the FQDN of the SBC.
Type: String
-
tenantFqdn
Enter the tenant FQDN for the desired customer.
Type: String
-
region
Type: AddSystemRegion
Possible values:
-
North America
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
EMEA
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
Australia
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
APAC
For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.
-
LATAM
For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.
-
China
For the profile Zoom Phone Premise Peering.
-
Japan
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
-
xGooglePbxTrunkSecretKey
The X-Google-Pbx-Trunk-Secret-Key. Only used for the Google Voice profile.
Type: String
30.8.2 AddSystemProfile JSON Schema
30.9 AddProviderProfile
30.9.1 AddProviderProfile Field Description
-
deutscheTelekomNumberExtensionRange
Number Extension Range for seperating incomming calls. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.
Type: TelMatchExtensionRange (section 30.62)
-
createNewDeutscheTelekomSipTrunk
Create new Deutsche Telekom Sip Trunk or select an existing one. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.
Type: Boolean
-
deutscheTelekomSipTrunkId
In case no new Deutsche Telekom SipTrunk is created, this value must be given. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile
Type: String
-
createNewNetworkController
Create new network controller or select an existing one.
Type: Boolean
-
networkControllerDisplayName
The display name of the newly created network controller.
Type: String
-
networkControllerInterface
The interface of the newly created network controller.
Type: String
-
networkControllerIpVersion
The IP version of the newly created network controller.
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
networkControllerIpAddress
The IP address of the newly created network controller.
Type: String
-
enableReverseDnsLookup
Specify whether reverse DNS lookup is enabled for the newly created network controller.
Type: Boolean
-
networkControllerId
In case no new network controller is created, this value must be given.
Type: String
-
udpTcpPort
The UDP/TCP Port.
Type: Integer
-
tlsPort
The TLS port.
Type: Integer
-
udpPortRange
The UDP port range.
Type: PortRange (section 30.56)
-
tcpPortRange
The TCP port range.
Type: PortRange (section 30.56)
-
activateNatTraversal
When anynode is located behind a NAT gateway you can determine how this gateway can be traversed. Please ensure that the gateway is configured accordingly.
Type: Boolean
-
externalHost
External Host or IP Address
Type: String
-
natDeviceHasFixedPortMapping
In the NAT device (firewall/router) a fixed port mapping is defined.
Type: Boolean
-
fixedUdpTcpPort
Map the UDP/TCP Port to this.
Type: Integer
-
fixedTlsPort
Map the TLS Port to this.
Type: Integer
-
fixedUdpPortRangeStart
Map dynamic UDP Ports to this.
Type: Integer
-
fixedTcpPortRangeStart
Map dynamic TCP Ports to this.
Type: Integer
-
nodeViaSipTrunking
true
The node uses SIP trunking to interconnect with the remote station. In this way, full dial string ranges can be linked at once.
false
The node registers at a remote station as a client. In this case the remote station has to provide a registrar.
Type: Boolean
-
remoteSipDomain
Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.
Type: RemoteSipDomain (section 30.57)
-
localSipDomain
The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls.
Type: String
-
activateClientAuthentication
Activate client authentication. These authentication settings determine how the node authenticate to a remote station.
Type: Boolean
-
credentials
Client SIP User Name and Password.
Type: SipUserCredentials (section 30.63)
-
registrarUri
The node will register as a client at a remote station. Select the necessary settings for this registration.
Type: String
-
addressOfRecord
User Part of Address-Of-Record for registration.
Type: String
-
proxyUri
Optional proxy server. Outgoing calls will be forwarded to this proxy. The specified value must begin with "sip:".
Type: String
-
primaryProxyUri
Deprecated use "proxyUri" instead.
Primary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".
Type: String
-
defineAssertedUri
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: Boolean
-
assertedUriHost
Mandatory, if the URI is not based on the registrar uri or proxy uri.
Type: String
-
assertedUri
User Part of Asserted-URI.
Type: String
-
useNetworkPeerWhitelist
If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.
Type: Boolean
-
includeRemoteSipDomainInWhitelist
Whether to include the remote SIP domain in the whitelist.
Type: Boolean
-
includeSipRegistrarInWhitelist
Whether to include the SIP registrar in the whitelist.
Type: Boolean
-
includeProxyInWhitelist
Whether to include the configured proxy in the whitelist.
Type: Boolean
-
networkPeerWhitelist
The whitelist.
Type: Array of NetworkPeerWhitelistEntry
-
dnsLookup
Additional protocol prefixes.
Type: Array of String
-
host
The hostname or ip address.
Type: String
-
ipVersion
If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
subnetPrefixLength
Type: Integer
-
-
allowOnlyNegotiatedPeersForRtpRtcp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
incomingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
region
Only for the profile Speedcom AG - Speedvoice
Type: AddProviderRegion
Possible values:
-
Schweiz
For the profile Speedcom AG - Speedvoice.
-
Liechtenstein
For the profile Speedcom AG - Speedvoice.
-
sipcall CH
For the profile sipcall.
-
sipcall AT
For the profile sipcall.
-
-
telstra1thTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the first trunk group.
Type: TelstraNthTrunkOptions (section 30.64)
-
telstra2ndTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the second trunk group.
Type: TelstraNthTrunkOptions (section 30.64)
-
routingDomains
Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.
Type: Array of String
-
displayName
Type: String
30.9.2 AddProviderProfile JSON Schema
30.10 AddSipPhoneRegistrarProfile
30.10.1 AddSipPhoneRegistrarProfile Field Description
-
createNewNetworkController
Create new network controller or select an existing one.
Type: Boolean
-
networkControllerDisplayName
The display name of the newly created network controller.
Type: String
-
networkControllerInterface
The interface of the newly created network controller.
Type: String
-
networkControllerIpVersion
The IP version of the newly created network controller.
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
networkControllerIpAddress
The IP address of the newly created network controller.
Type: String
-
enableReverseDnsLookup
Specify whether reverse DNS lookup is enabled for the newly created network controller.
Type: Boolean
-
networkControllerId
In case no new network controller is created, this value must be given.
Type: String
-
udpTcpPort
The UDP/TCP Port.
Type: Integer
-
tlsPort
The TLS port.
Type: Integer
-
udpPortRange
The UDP port range.
Type: PortRange (section 30.56)
-
tcpPortRange
The TCP port range.
Type: PortRange (section 30.56)
-
sipPhoneRegistrarDirectoryId
The identifiert of the directory that determines how SIP phones authenticate.
Type: String
-
useNetworkPeerWhitelist
If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.
Type: Boolean
-
includeOwnSubnetInWhitelist
Whether to include the own subnet in the whitelist.
Type: Boolean
-
networkPeerWhitelist
The whitelist.
Type: Array of NetworkPeerWhitelistEntry
-
dnsLookup
Additional protocol prefixes.
Type: Array of String
-
host
The hostname or ip address.
Type: String
-
ipVersion
If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
subnetPrefixLength
Type: Integer
-
-
allowOnlyNegotiatedPeersForRtpRtcp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
incomingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
routingDomains
Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.
Type: Array of String
-
displayName
Type: String
30.10.2 AddSipPhoneRegistrarProfile JSON Schema
30.11 SipNodeTransportConnection
30.11.1 SipNodeTransportConnection Field Description
-
matchingCondition
The matching condition is used to filter for which calls the transport connection will be used.
Type: TelMatch (section 30.58)
-
transportConnectionId
The id of the transport connection
Type: String
30.11.2 SipNodeTransportConnection JSON Schema
30.12 NetworkPeerWhitelistEntry
30.12.1 NetworkPeerWhitelistEntry Field Description
-
dnsLookup
Additional protocol prefixes.
Type: Array of String
-
host
The hostname or ip address.
Type: String
-
ipVersion
If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
subnetPrefixLength
Type: Integer
30.12.2 NetworkPeerWhitelistEntry JSON Schema
30.13 ActiveSessionsFilter
30.13.1 ActiveSessionsFilter Field Description
-
count
Limits the amount of sessions that will be returned by the request.
Type: Integer
-
nodeFilter
The name of the incoming or outgoing node of the sessions that will be returned by the request.
Type: String
-
routeFilter
The name of the route of the sessions that will be returned by the request.
Type: String
-
numberFilter
The number of the caller or callee of the sessions that will be returned by the request.
Type: String
-
numberFilterMode
Determines how the number is matched with the "numberFilter".
Type: NumberFilterMode
Possible values:
-
equal
-
startswith
-
endswith
-
contains
-
30.13.2 ActiveSessionsFilter JSON Schema
30.14 DialStringRewriting
30.14.1 DialStringRewriting Field Description
-
displayName
Set up a name that helps you identify this object.
Type: String
-
id
Type: String
-
rules
Type: Array of DialStringRewrite (section 30.15)
30.14.2 DialStringRewriting JSON Schema
30.15 DialStringRewrite
The available fields for DialStringRewrite objects depend on the selected rewriteType. The fields for each type are:
-
prefixAndSuffix
-
prefix
-
suffix
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
wildcardPattern
-
wildcardPattern
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
addExt
-
addExtTrailingDigits
-
-
matchAndModify
-
matchType
-
rewriteSegments
-
-
matchAndBranch
-
matchType
-
rewriteSegments
-
branchRewrites
-
branchElseRewrites
-
-
available for all types:
-
skipFurtherRules
-
applyToAllDialStrings
-
applyToSourceDialString
-
applyToDestinationDialString
-
applyTo
-
comment
-
-
available for all types excluding cutExtensionNumber and addExt:
-
matchTags
-
tagRewrite
-
case
-
clearDisplayName
-
displayName
-
30.15.1 DialStringRewrite Field Description
-
rewriteType
Type of dial string rewrite
Type: RewriteTypeJson
Possible values:
-
prefixAndSuffix
-
wildcardPattern
-
cutExtensionNumber
-
addExt
-
matchAndModify
-
matchAndBranch
-
-
matchType
If the selected rewriteType allows to select the matchType additional fields are available for the DialStringRewrite object. The available fields for each matchType are:
-
prefixSuffix
-
prefix
-
suffix
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
dialStringList
-
matchDialStringList
-
-
structuralPattern
-
structuralPattern
-
-
wildcardPattern
-
wildcardPattern
-
deleteLeadingCharacters
-
deleteTrailingCharacters
-
addPrefix
-
addSuffix
-
-
extensionRange
-
matchExtensionRange
-
Type: TelMatchTypeJson
Possible values:
-
anything
-
never
-
list
-
prefixSuffix
-
dialStringList
-
structuralPattern
-
wildcardPattern
-
extensionRange
-
-
prefix
The rewrite rule will only match dial strings that begin with the prefix you specify here.
Type: String
-
suffix
The rewrite rule will only match dial strings that end with the suffix you specify here.
Type: String
-
wildcardPattern
Matches any dial string from a list of eligible dial strings.
Type: String
-
matchDirectory
Matches any dial string from a list of eligible dial strings.
Type: Array of String
-
matchExtensionRange
Type: TelMatchExtensionRange (section 30.62)
-
structuralPattern
The rewrite rule will only match dial strings according to the pattern you specify.
Type: Array of MatchPatternSegment (section 30.66)
-
deleteLeadingCharacters
This parameter controls the number of characters that anynode will remove from the beginning of the dial string.
Type: Integer
-
deleteTrailingCharacters
This parameter controls the number of characters that anynode will remove from the end of the dial string.
Type: Integer
-
addPrefix
This parameter controls which prefix anynode will append to the dial string.
Type: String
-
addSuffix
This parameter controls which suffix anynode will append to the dial string.
Type: String
-
displayName
The display name of the dial string can be modified with this value.
Type: String
-
addExtTrailingDigits
The amount of traling digits that will be added to the ";ext" parameter.
Type: int
-
rewriteSegments
This setting determines how the rewritten dial string is structured.
Type: Array of TelRewriteSegment (section 30.67)
-
branchRewrites
Rewrites that are processed if the dial string matches the condition.
Type: Array of DialStringRewrite (section 30.15)
-
branchElseRewrites
Rewrites that are processed if the dial string does not match the condition.
Type: Array of DialStringRewrite (section 30.15)
-
matchTags
Use this option to control which tag (or set of tags) needs to be present for this rewrite rule to apply.
Type: TagMatch (section 30.68)
-
tagRewrite
Use this option to control which changes to the set of tags carried along with the dial string anynode performs when this rewrite rule is aplied.
Type: TagRewrite (section 30.69)
-
applyTo
You can choose the dial strings to which the dial string rewrite rules should be applied.
Type: Array of TelRewriteAddressContextsJson
Possible values:
-
unspecified
-
sessionSource
-
sessionAsserted
-
sessionDestination
-
sessionConnected
-
sessionElin
-
sessionRedirectHistory
-
sessionTransferrer
-
reasonRedirection
-
reasonSelected
-
mwiSource
-
mwiDestination
-
-
applyToAllDialStrings
Apply the rewrite rules to all dial strings.
Type: Boolean
-
applyToDestinationDialString
Apply the rewrite rules to the destination dial string.
Type: Boolean
-
applyToSourceDialString
Apply the rewrite rules to the source dial string.
Type: Boolean
-
skipFurtherRules
If the condition matches the dial string, all further rewrite rules will be skipped.
Type: Boolean
-
skipRulesBelow
If the condition matches the dial string, skip succeeding rewrite rules.
Type: Boolean
-
clearDisplayName
If the display name of the dial string should be removed.
Type: Boolean
-
case
Any comparisions on dial strings are case-sensitive. Use this parameter to transform the dial strings in the respective case.
Type: RewriteCaseJson
Possible values:
-
lowercase
-
uppercase
-
casefold
-
-
comment
A display name for this dial string rewrite rule to identify it later on.
Type: String
-
index
Type: Integer
30.15.2 DialStringRewrite JSON Schema
30.16 TelIdent
30.16.1 TelIdent Field Description
-
sdpMLineAddress
The IP address of the media channel that is established on a SIP call.
Type: String
-
sdpMLinePort
The port of the media channel that is established on a SIP call.
Type: Integer
-
sdpOrigin
The origin field of SDP messages.
Type: String
-
sipCallId
The SIP Call-ID of the SIP call
Type: String
-
sipLocalTag
The local(from anynodes perspective) SIP tag of a SIP call.
Type: String
-
sipRemoteTag
The remote(from anynodes perspective) SIP tag of a SIP call.
Type: String
-
sipUserAgentDialog
anynode specific identifier for a SIP user-agent dialog.
Type: String
30.16.2 TelIdent JSON Schema
30.17 SetMuteRequestDataJson
30.17.1 SetMuteRequestDataJson Field Description
-
identifier
Type: String
-
mute
Type: Boolean
30.17.2 SetMuteRequestDataJson JSON Schema
30.18 AnynodeConfigState
30.18.1 AnynodeConfigState Field Description
-
committed
Indicates if all changes to the configuration are committed.
Type: Boolean
30.18.2 AnynodeConfigState JSON Schema
30.19 BackupExportOptions
30.19.1 BackupExportOptions Field Description
-
includedData
Determines which components will be included in the backup. The default value includes 'ANYNODE_CONFIG', 'MEDIA_FILES', 'HTTP_SERVER_FILES', 'FRONTEND_CONFIG', 'MONITOR_CONFIG'
Type: Array of ConfigurationBackupIncludededDataSelection
Possible values:
-
ANYNODE_CONFIG
The configuration of anynode.
-
MEDIA_FILES
Audio files from the anynode configuration. Can only be exported with the anynode configuration.
-
HTTP_SERVER_FILES
Static files uploaded to HTTP server from the anynode configuration. Can only be exported with the anynode configuration.
-
FRONTEND_CONFIG
The configuration of the anynode frontend.
-
RECORDINGS
Recorded sessions. To export this the initiating user needs the permission to access media recordings.
-
MONITOR_CONFIG
The configuration of the anynode monitor.
-
CALL_HISTORY
The internal call history. Can only be exported with the anynode monitor configuration.
-
EVENT_LOG
The internal event log. Can only be exported with the anynode monitor configuration.
-
MESSAGE_HISTORY
The internal signaling message history. Can only be exported with the anynode monitor configuration.
-
-
encryptData
Determines if the exported backup will be encrypted.
Type: Boolean
-
password
The password if encryption is enabled. Mandatory if "encryptData=true".
Type: String
30.19.2 BackupExportOptions JSON Schema
30.20 MaintenanceMode
30.20.1 MaintenanceMode Field Description
-
modeActive
Indicates if the maintenance mode should be activated or deactivated.
Type: Boolean
30.20.2 MaintenanceMode JSON Schema
30.21 MediaRecording
30.21.1 MediaRecording Field Description
-
mediaRecordingActive
Type: Boolean
30.21.2 MediaRecording JSON Schema
30.22 MsTeamsSbaOptions
30.22.1 MsTeamsSbaOptions Field Description
-
fingerprint
The trusted certificate fingerprint source. This needs to be the fingerprint of the Teams node, that is using the SBA service.
Type: MsTeamsSbaFingerprint
-
source
Determines the source of the fingerprint.
Type: FingerprintSource
Possible values:
-
NONE
-
CUSTOM
-
MS_TEAMS_NODE
-
-
value
The fingerprint for "source"="CUSTOM"
Type: String
-
msTeamsNodeId
Only for "source"="MS_TEAMS_NODE". The id of the Teams node, that uses the certificate. The fingerprint will be extracted automatically.
Type: String
-
-
identity
The identity / FQDN of the SBA
Type: String
-
tenantId
Directory (tenant) ID
Type: String
-
application
Application (client) ID
Type: String
-
secret
Application (client) secrect
Type: String
-
log
Settings for the SBA log.
Type: MsTeamsSbaLog (section 30.25)
-
certificate
The certificate for the SBA service
Type: CryCertificate (section 30.70)
-
ipAddress
The IP address for the SBA service. It is recommended to choose a local IP address.
Type: String
-
privateKey
The private key for the SBA service
Type: CryPrivateKey (section 30.71)
30.22.2 MsTeamsSbaOptions JSON Schema
30.23 MsTeamsSbaStatus
30.23.1 MsTeamsSbaStatus Field Description
-
state
Type: MsTeamsSbaDiagnosticsServiceState (section 30.72)
-
enalbed
This value specifies if the SBA configuration services are enabled on this anynode instance.
Type: boolean
-
readOnly
This value will be true if writing operation to the SBA service are disabled on this anynode instance.
Type: boolean
-
sbaServiceStatus
This is the current status of the SBA service.
Type: SbaServiceDiagnosticState (section 30.73)
-
lastSbaServiceStatusRequestState
This is the state of the last HTTP request to the SBA service.
Type: SbaHttpRequestState (section 30.74)
30.23.2 MsTeamsSbaStatus JSON Schema
30.24 MsTeamsSbaFingerprint
30.24.1 MsTeamsSbaFingerprint Field Description
-
source
Determines the source of the fingerprint.
Type: FingerprintSource
Possible values:
-
NONE
-
CUSTOM
-
MS_TEAMS_NODE
-
-
value
The fingerprint for "source"="CUSTOM"
Type: String
-
msTeamsNodeId
Only for "source"="MS_TEAMS_NODE". The id of the Teams node, that uses the certificate. The fingerprint will be extracted automatically.
Type: String
30.24.2 MsTeamsSbaFingerprint JSON Schema
30.25 MsTeamsSbaLog
30.25.1 MsTeamsSbaLog Field Description
-
directory
The directory where log files should be stored.
Type: String
-
level
The log level
Type: MsTeamsSbaLogLevel
Possible values:
-
TRACE
-
DEBUG
-
INFO
-
WARN
-
ERROR
-
FATAL
-
-
maxArchiveFiles
The maximum amount of log files that will be stored.
Type: Integer
30.25.2 MsTeamsSbaLog JSON Schema
30.26 HotStandbyOptions
30.26.1 HotStandbyOptions Field Description
-
mainSystem
The options for the main system
Type: HotStandbyMainSystemOptions (section 30.76)
-
standbySystem
The options for the standby system
Type: HotStandbyStandbySystemOptions (section 30.77)
30.26.2 HotStandbyOptions JSON Schema
30.27 AddHotStandbyResponse
30.27.1 AddHotStandbyResponse Field Description
-
hotStandbyId
Type: String
-
ipcClientId
Type: String
-
networkControllerId
Type: String
-
networkSecurityProfileId
Type: String
30.27.2 AddHotStandbyResponse JSON Schema
30.28 HotStandbyStatus
30.28.1 HotStandbyStatus Field Description
-
handoverPossible
Type: Boolean
-
linkStatus
Type: HotStandbyLinkStatus (section 30.78)
-
mainEnabled
Type: Boolean
-
mainLinkActive
Type: Boolean
-
mainRoleStatus
Type: HotStandbyMainRoleStatus (section 30.79)
-
mainSetEnabledPossible
Type: Boolean
-
mainStatus
Type: HotStandbyMainSystemStatus (section 30.80)
-
onlyImmediateRoleChangePossible
Type: Boolean
-
recoveryPossible
Type: Boolean
-
standbyEnabled
Type: Boolean
-
standbyLinkActive
Type: Boolean
-
standbyRoleStatus
Type: HotStandbyStandbyRoleStatus (section 30.81)
-
standbySetEnabledPossible
Type: Boolean
-
standbyStatus
Type: HotStandbyStandbySystemStatus (section 30.82)
30.28.2 HotStandbyStatus JSON Schema
30.29 CreateConditionsOptions
30.29.1 CreateConditionsOptions Field Description
-
createIsMainSystemCondition
Create a condition that determines whether the current system is the main system in an active/passive failover scenario.
Type: boolean
-
createIsNotSystemIntentToBecomeActiveCondition
Create a condition that determines whether the current system does not intend to take the active role in an active/passive failover scenario.
Type: boolean
-
createIsStandbySystemCondition
Create a condition that determines whether the current system is the standby system in an active/passive failover scenario.
Type: boolean
-
createIsSystemActiveCondition
Create a condition that determines whether the current system has the active role in an active/passive failover scenario.
Type: boolean
-
createIsSystemIntentToBecomeActiveCondition
Create a condition that determines whether the current system intends to take the active role in an active/passive failover scenario.
Type: boolean
-
createIsSystemNotActiveCondition
Create a condition that determines whether the current system has not the active role in an active/passive failover scenario.
Type: boolean
30.29.2 CreateConditionsOptions JSON Schema
30.30 StandardTransportConnection
30.30.1 StandardTransportConnection Field Description
-
assertedAddress
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: AssertedUri2
-
displayName
The desired display name.
Type: String
-
iri
The desired URI.
Type: String
-
-
authenticationEnabled
Whether authentication should be enabled or not. This value only applies if a registration is given.
Type: Boolean
-
conditionId
Optional operational condition. This transport connection is only operational as long as this condition is true.
Type: String
-
credentials
Credentials to be used for authentication. This value only applies if "authenticationEnabled" is set to true.
Type: SipCredentials (section 30.35)
-
proxy
The proxy to be used.
Type: TransportConnectionProxy (section 30.83)
-
registration
The registration to be used.
Type: TransportConnectionRegistration
-
addressOfRecord
Address-Of-Record (to be registered URI)
Type: String
-
sipDomain
SIP Domain (Registrar)
Type: String
-
30.30.2 StandardTransportConnection JSON Schema
30.31 PlainTransportConnection
30.31.1 PlainTransportConnection Field Description
-
uri
Define your own URI. This URI can serve as the basis for special SIP headers (e.g. From header) in the case of outgoing calls.
Type: SipbnAddress (section 30.84)
-
assertedUri
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: SipbnAddress (section 30.84)
-
properties
General properties
Type: Array of PlainTransportConnectionProperties
Possible values:
-
FLOW
Establish a fixed transport flow
-
FLOW_PRIVATE
The transport flow is private and is only available for this route. (Only works if "FLOW" is selected)
-
OPTIONS
Send OPTIONS packets to check whether the transport connection is operational.
-
OPTIONS_LOAD
Send OPTIONS packets and if possible (which means that the remote station is an anynode) then use the OPTIONS packets to determine the load of the remote station.
-
OPTIONS_DOWN_ONLY
Send OPTIONS packets only if the remote station is not operational.
-
OPTIONS_FLOW_ADDRESS
Send OPTIONS packets according to 1TR119
-
LYNC_MASTER_DOMAIN_NAME
Check Skype for Business master domai
-
LYNC_INCOMING
Check incoming dialog offers in a Skype for Business specific way
-
-
initialRouteSet
The initial route set of this transport connection.
Type: Array of SipsnRoute (section 30.85)
-
sipTransport
The SIP transport object id for this transport connection.
Type: String
-
optionsErrorFlags
When an OPTIONS error occurs...
Type: Array of PlainTransportConnectionOptionsErrorFlag
Possible values:
-
DOWN
Change the state to non-operational
-
TERMINATE_INCOMING
Terminate incoming traffic
-
TERMINATE_OUTGOING
Terminate outgoing traffic
-
-
timeoutErrorFlags
In case of a timeout...
Type: Array of PlainTransportConnectionErrorFlag
Possible values:
-
DOWN
Change the state to non-operational.
-
FAILOVER
Perform failover to another transport connection, if possible.
-
TERMINATE_INCOMING
Terminate incoming traffic.
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
-
-
transportErrorFlags
In case of a transport error...
Type: Array of PlainTransportConnectionErrorFlag
Possible values:
-
DOWN
Change the state to non-operational.
-
FAILOVER
Perform failover to another transport connection, if possible.
-
TERMINATE_INCOMING
Terminate incoming traffic.
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
-
-
statusCodesErrorFlags
Transport connection behavior when receiving status codes.
Type: Array of TransportConnectionStatusCodeErrorFlags (section 30.86)
-
authentication
If the Plain Transport Connection to be created requires separate authentication data then this can be configured here.
Type: TransportConnectionAuthentication (section 30.87)
30.31.2 PlainTransportConnection JSON Schema
30.32 SipLoadBalancingTransportConnection
30.32.1 SipLoadBalancingTransportConnection Field Description
-
properties
Determines how the load will be balanced.
Type: Array of LoadBalancerProperties
Possible values:
-
FAILOVER
Activate failover operation mode.
-
SEQUENTIAL_FAILOVER
Select failover targets sequentially. Only works in combination with "FAILOVER".
-
REDIRECT_INVITE
Redirect INVITE requests.
-
REDIRECT_NOTIFY
Redirect NOTIFY requests.
-
REDIRECT_OPTIONS
Redirect OPTIONS requests.
-
REDIRECT_REFER
Redirect REFER requests.
-
REDIRECT_REGISTER
Redirect REGISTER requests.
-
-
targets
The load balancer target connections.
Type: Array of SipLoadBalancerTarget (section 30.88)
30.32.2 SipLoadBalancingTransportConnection JSON Schema
30.33 SipRegistrationAsTransportConnection
30.33.1 SipRegistrationAsTransportConnection Field Description
-
registrar
The IRI of the registrar, to which you want to register.
Type: String
-
authentication
The IRI of the registrar, to which you want to register.
Type: TransportConnectionAuthentication (section 30.87)
-
aorUri
The address-of-record specifies who is to be registered.
Type: SipbnAddress (section 30.84)
-
assertedUri
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: SipbnAddress (section 30.84)
-
sipUserAgentStackId
The id of the SIP user agent which should be used for the registration.
Type: String
-
innerTransportConnectionId
If desired, the registration can be established via a transport connection.
Type: String
30.33.2 SipRegistrationAsTransportConnection JSON Schema
30.34 SrvLoadBalancer
30.34.1 SrvLoadBalancer Field Description
-
sipTransportId
The SIP transport object id for this transport connection.
Type: String
-
domain
Type: String
-
transportProtocol
The transport protocol for the target transport connections.
Type: SrvLoadBalancerTransportProtocol
Possible values:
-
UDP
-
TCP
-
TLS
-
SCTP
-
SCTP_TLS
-
-
targetTemplateOptions
Template options for the target transport connections.
Type: SrvLoadBalancerTargetTemplate (section 30.89)
30.34.2 SrvLoadBalancer JSON Schema
30.35 SipCredentials
30.35.1 SipCredentials Field Description
-
authenticationProfileId
The identifier of a authentication profile. This can be set to use a existing authentication profile instead of creating a new one.
Type: String
-
directoryName
The identifier of the directory. This value only works in combination with "userIdentifier".
Type: String
-
password
This value only works in combination with "username".
Type: String
-
userIdentifier
The identifier of the user in a directory. This value only works in combination with "directoryName".
Type: String
-
username
This value only works in combination with "password".
Type: String
30.35.2 SipCredentials JSON Schema
30.36 Credentials
30.36.1 Credentials Field Description
-
password
The password. Only works in combination with "username".
Type: String
-
username
The username. Only works in combination with "password".
Type: String
30.36.2 Credentials JSON Schema
30.37 AssertedUri
30.37.1 AssertedUri Field Description
-
displayName
The desired display name.
Type: String
-
iri
The desired URI.
Type: String
30.37.2 AssertedUri JSON Schema
30.38 DirectoryInfo
30.38.1 DirectoryInfo Field Description
-
directoryType
Type: String
-
displayName
Type: String
-
id
Type: String
30.38.2 DirectoryInfo JSON Schema
30.39 StaticUserDirectory
30.39.1 StaticUserDirectory Field Description
-
displayName
The display name for this directory.
Type: String
-
userRecords
User data for this directory
Type: Array of StaticUserDirectoryUser (section 30.90)
30.39.2 StaticUserDirectory JSON Schema
30.40 Resources
30.40.1 Resources Field Description
-
cpu
Type: Integer
-
disk
Type: ResourcesMemory (section 30.91)
-
ram
Type: ResourcesMemory (section 30.91)
30.40.2 Resources JSON Schema
30.41 RequestRouter
30.41.1 RequestRouter Field Description
-
id
Type: String
-
forwardingMode
This setting determines how incoming sessions are forwarded.
Type: RequestRouterForwardingMode
Possible values:
-
BI_DIRECTIONAL
-
PRIMARY_TO_SECONDARY_EDGE
-
SECONDARY_TO_PRIMARY_EDGE
-
DISABLED
-
-
operationalStateConditionId
The id of the condition, that determines when the Request Router is operational.
Type: String
-
primarySideOptions
Type: RequestRouterSideOptions
-
sipTransportId
The id of the SIP transport object.
Type: String
-
transportConnectionId
The id of the transport connection object.
Type: String
-
-
secondarySideOptions
Type: RequestRouterSideOptions
-
sipTransportId
The id of the SIP transport object.
Type: String
-
transportConnectionId
The id of the transport connection object.
Type: String
-
30.41.2 RequestRouter JSON Schema
30.42 AddRoutingDomainOptions
30.42.1 AddRoutingDomainOptions Field Description
-
displayName
Type: String
-
sourceNodes
Type: Array of String
30.42.2 AddRoutingDomainOptions JSON Schema
30.43 GetRoutingDomainOptions
30.43.1 GetRoutingDomainOptions Field Description
-
displayName
Type: String
-
id
Type: String
-
routes
Type: Array of RoutingDomainRouteV0
-
displayName
Type: String
-
establishment
Only for "mode=establishment".
Type: RoutingDomainRouteEstablishmentV0 (section 30.92)
-
filters
Filters determine when this route will be used for incoming or outgoing calls.
Type: Array of RoutingDomainRouteFilter (section 30.93)
-
pathReplacement
Only for "mode=pathReplacement".
Type: RoutingDomainRoutePathReplacement (section 30.94)
-
supervisionId
The identifier of the supervision for this route.
Type: String
-
useRouteSupervision
This value determines if this route uses route supervision. If set to "true" the parameter "supervisionId" must be provided.
Type: Boolean
-
useUnconditionalRouting
This value determines if filters apply to this route.
Type: Boolean
-
-
sourceNodes
Type: Array of String
30.43.2 GetRoutingDomainOptions JSON Schema
30.44 RoutingDomainRoute
30.44.1 RoutingDomainRoute Field Description
-
displayName
Type: String
-
establishment
Only for "mode=establishment".
Type: RoutingDomainRouteEstablishment (section 30.95)
-
filters
Filters determine when this route will be used for incoming or outgoing calls.
Type: Array of RoutingDomainRouteFilter (section 30.93)
-
pathReplacement
Only for "mode=pathReplacement".
Type: RoutingDomainRoutePathReplacement (section 30.94)
-
supervisionId
The identifier of the supervision for this route.
Type: String
-
useRouteSupervision
This value determines if this route uses route supervision. If set to "true" the parameter "supervisionId" must be provided.
Type: Boolean
-
useUnconditionalRouting
This value determines if filters apply to this route.
Type: Boolean
30.44.2 RoutingDomainRoute JSON Schema
30.45 RoutingDomainRouteV0
30.45.1 RoutingDomainRouteV0 Field Description
-
displayName
Type: String
-
establishment
Only for "mode=establishment".
Type: RoutingDomainRouteEstablishmentV0 (section 30.92)
-
filters
Filters determine when this route will be used for incoming or outgoing calls.
Type: Array of RoutingDomainRouteFilter (section 30.93)
-
pathReplacement
Only for "mode=pathReplacement".
Type: RoutingDomainRoutePathReplacement (section 30.94)
-
supervisionId
The identifier of the supervision for this route.
Type: String
-
useRouteSupervision
This value determines if this route uses route supervision. If set to "true" the parameter "supervisionId" must be provided.
Type: Boolean
-
useUnconditionalRouting
This value determines if filters apply to this route.
Type: Boolean
30.45.2 RoutingDomainRouteV0 JSON Schema
30.46 AddRoutingForwardProfileOptions
30.46.1 AddRoutingForwardProfileOptions Field Description
-
announcementIncoming
Play an announcement at the incoming node.
Type: Boolean
-
announcementMediaSourceId
The id of the Announcement Media Source used as specified.
Type: String
-
announcementOutgoing
Play an announcement at the outgoing node.
Type: Boolean
-
displayName
The name shown in the anynode frontend.
Type: String
-
earlyMediaPassThrough
Specify whether early media should be already passed through during call setup.
Type: Boolean
-
id
The ID of this object.
Type: String
-
mediaMode
Type: MediaMode
Possible values:
-
TRANSCODING
-
BYPASS
-
PASSTHROUGH
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
-
-
mediaNegotiationForwarderId
The ID of the media negotiation forwarder object. This can be set to use an existing object instead of creating a new one.
Type: String
-
mediaRecorderId
The id of the Media Recorder used to record as specified.
Type: String
-
mediaTranscodingOptionsId
The ID of the media transcoding options object. This can be set to use an existing object instead of creating a new one.
Type: String
-
removeAnynodeFromSignalingPath
Type: Boolean
-
signalingForwardingFromCalledToCalling
Type: SignalingForwardingOptions (section 30.98)
-
signalingForwardingFromCallingToCalled
Type: SignalingForwardingOptions (section 30.98)
-
telephonyForwardingStackId
This value will be used instead of telephonyForwardingStack if the object is not complete. The id of a Telephony Forwarding is a collection of protocol specific settings which influence the way forwarding of signaling information or media data is going to take place.
Type: String
30.46.2 AddRoutingForwardProfileOptions JSON Schema
30.47 WebserverConnector
30.47.1 WebserverConnector Field Description
-
displayName
A name for this connector to identify it.
Type: String
-
httpMode
This option determines if HTTP or HTTPS is used to communicate with this connector.
Type: HttpMode
Possible values:
-
HTTP
-
HTTPS
-
-
httpRedirectorPort
An optional second port that can redirect HTTP requests to a HTTPS connector. Only works for "httpMode=HTTPS".
Type: Integer
-
id
The identifier of the webserver connector. Will be auto-generated when a connector is added.
Type: String
-
networkOptions
Type: WebserverConnectorNetworkOptions (section 30.99)
-
openPortOnDemand
If set to true the port will only be opened when necessary to fulfill the services.
Type: Boolean
-
port
The port that this connector will listen on.
Type: Integer
-
requestDomains
The list of available services for this connector.
Type: Array of WebserverConnectorRequestDomain
Possible values:
-
ACME
-
GUI
-
REST_API
-
-
tlsOptions
TLS specifc options. Only used for "httpMode=HTTPS"
Type: WebserverConnectorTlsOptions (section 30.100)
30.47.2 WebserverConnector JSON Schema
30.48 LocalUser
30.48.1 LocalUser Field Description
-
name
Type: String
30.48.2 LocalUser JSON Schema
30.49 LocalV0User
30.49.1 LocalV0User Field Description
-
name
Type: String
30.49.2 LocalV0User JSON Schema
30.50 LdapAuthority
30.50.1 LdapAuthority Field Description
-
displayName
Type: String
-
id
Type: String
30.50.2 LdapAuthority JSON Schema
30.51 LicenseFacility
30.51.1 LicenseFacility Field Description
-
name
Type: String
-
value
Type: Integer
30.51.2 LicenseFacility JSON Schema
30.52 SystemId
30.52.1 SystemId Field Description
-
displayName
Type: String
-
id
Type: String
30.52.2 SystemId JSON Schema
30.53 GetNodesNode
30.53.1 GetNodesNode Field Description
-
displayName
Type: String
-
id
Type: String
30.53.2 GetNodesNode JSON Schema
30.54 GetSystemsProfilesProfile
30.54.1 GetSystemsProfilesProfile Field Description
-
sipTransport
Create a SIP transport object or select an existing one.
Type: AddSystemSipTransport (section 30.55)
-
createNewNetworkController
Create new network controller or select an existing one.
Type: Boolean
-
networkControllerDisplayName
The display name of the newly created network controller.
Type: String
-
networkControllerInterface
The interface of the newly created network controller.
Type: String
-
networkControllerIpVersion
The IP version of the newly created network controller.
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
networkControllerIpAddress
The IP address of the newly created network controller.
Type: String
-
enableReverseDnsLookup
Specify whether reverse DNS lookup is enabled for the newly created network controller.
Type: Boolean
-
networkControllerId
In case no new network controller is created, this value must be provided.
Type: String
-
udpTcpPort
The UDP/TCP Port.
Type: Integer
-
tlsPort
The TLS Port.
Type: Integer
-
udpPortRange
Restricts the udp port range
Type: PortRange (section 30.56)
-
tcpPortRange
Restricts the tcp port range
Type: PortRange (section 30.56)
-
sipInterconnection
Type: SipInterconnection
Possible values:
-
REGISTRAR
The node provides a registration server (registrar) at which the remote station must register.
-
REGISTRATION
The node registers at a remote station as a client. In this case the remote station has to provide a registrar.
-
TRUNK
The node uses SIP trunking to interconnect with the remote station. In this way, full dial stringranges can be linked at once.
-
-
remoteSipDomain
Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.
Type: RemoteSipDomain (section 30.57)
-
localSipDomain
Optionally you can choose the local SIP domain. The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls).
Type: String
-
activateClientAuthentication
Activate client authentication. These authentication settings determine how the node authenticate to a remote station.
Type: Boolean
-
clientCredentials
Credentials for client authentication.
Type: SipCredentials (section 30.35)
-
activateServerAuthentication
Activate server authentication. These authentication settings determine how a remote station has to authenticate to anynode. They will be stored in a User Directory.
Type: Boolean
-
serverCredentials
Credentials for server authentication
Type: SipCredentials (section 30.35)
-
registrarUri
The node will register as a client at a remote station. Select the necessary settings for this registration.
Type: String
-
addressOfRecord
User Part of Address-Of-Record for registration.
Type: String
-
sipRegistrar
Dial string matching condition that determines which calls are to be forwarded to the registered remote stations.
Type: TelMatch (section 30.58)
-
srvProxyDomain
The proxy address for nodes that are using an SRV loadbalancer.
Type: String
-
useNetworkPeerWhitelist
Type: Boolean
-
includeRemoteSipDomainInWhitelist
Include the remote SIP domain in the whitelist.
Type: Boolean
-
includeSipRegistrarInWhitelist
Include the SIP registrar in the whitelist.
Type: Boolean
-
includeOwnSubnetInWhitelist
Include the own subnet in the whitelist.
Type: Boolean
-
networkPeerWhitelist
Type: Array of NetworkPeerWhitelistEntry
-
dnsLookup
Additional protocol prefixes.
Type: Array of String
-
host
The hostname or ip address.
Type: String
-
ipVersion
If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
subnetPrefixLength
Type: Integer
-
-
allowOnlyNegotiatedPeersForRtpRtcp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
sipNodeNetworkPeerWhitelist
Network peer whitelist for filtering of incoming calls. Only applies when creating a shared SIP transport or using an existing SIP transport.
Type: AddSystemSipNodeWhitelist (section 30.59)
-
incomingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
routingDomains
Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.
Type: Array of String
-
displayName
Enter a meaningful name for your new node. The name is arbitrary. You will use it to uniquely identify this node later during configuration.
Type: String
-
createNewTeamsCarrierNode
Whether to create a new Teams carrier node or use an existing one. If an existing one is used, the value eamsCarrierNodeId" must be given.
Type: Boolean
-
teamsCarrierNodeId
Select an existing MS Teams carrier node to share the Microsoft Teams Connectivity.
Type: String
-
createNewMsOperatorConnectNode
Whether to create a new Microsoft Teams Connectivity or use an existing one. If an existing one is used, the value "msOperatorConnectNodeId" must be given.
Type: Boolean
-
msOperatorConnectNodeId
Select an existing Node to share the Microsoft Teams Connectivity.
Type: String
-
tenantId
The tenant ID is mandatory if you want to setup multiple Microsoft Operator Connect nodes, using a single SBC FQDN.
Type: String
-
sbcFqdn
Determine the name for the FQDN of the SBC.
Type: String
-
tenantFqdn
Enter the tenant FQDN for the desired customer.
Type: String
-
region
Type: AddSystemRegion
Possible values:
-
North America
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
EMEA
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
Australia
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
APAC
For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.
-
LATAM
For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.
-
China
For the profile Zoom Phone Premise Peering.
-
Japan
For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.
-
-
xGooglePbxTrunkSecretKey
The X-Google-Pbx-Trunk-Secret-Key. Only used for the Google Voice profile.
Type: String
-
displayName
Type: String
-
id
Type: String
30.54.2 GetSystemsProfilesProfile JSON Schema
30.55 AddSystemSipTransport
30.55.1 AddSystemSipTransport Field Description
-
selection
Type: SipTransportSelection
Possible values:
-
USE_REFERENCE
-
CREATE_NEW
-
-
usedByOtherNodes
Determines if this node will be used as shared SIP transport. Only applies if "CREATE_NEW" is selected.
Type: Boolean
-
sharedSipTransportComment
A custom name for the shared SIP transport. Only applies if "usedByOtherNodes" is set to true and "CREATE_NEW" is selected.
Type: String
-
sipTransportId
The ID of an existing SIP transport, that will be used for this node. Only applies if "USE_REFERENCE" is selected.
Type: String
30.55.2 AddSystemSipTransport JSON Schema
30.56 PortRange
30.56.1 PortRange Field Description
-
firstPort
First port of the port range
Type: Integer
-
lastPort
Last port of the port range
Type: Integer
30.56.2 PortRange JSON Schema
30.57 RemoteSipDomain
30.57.1 RemoteSipDomain Field Description
-
host
Type: String
-
iri
Type: String
-
port
Type: Integer
-
transport
Type: RemoteSipDomainTransport
Possible values:
-
udp
-
tcp
-
tls
-
sctp
-
tls-sctp
-
30.57.2 RemoteSipDomain JSON Schema
30.58 TelMatch
30.58.1 TelMatch Field Description
-
directory
Mandatory for "type=DIRECTORY".
Type: Array of String
-
extensionRange
Mandatory for "type=EXTENSION_RANGE".
Type: TelMatchExtensionRange (section 30.62)
-
list
Mandatory for "type=LIST".
Type: TelMatchList (section 30.104)
-
plain
Mandatory for "type=PLAIN".
Type: TelMatchPlain
-
prefix
Prefix which must be present in the dial string.
Type: String
-
suffix
Suffix which must be present in the dial string.
Type: String
-
-
type
Type: TelMatchType
Possible values:
-
anything
-
never
-
list
-
prefixSuffix
-
dialStringList
-
structuralPattern
-
wildcardPattern
-
extensionRange
-
-
wildcardPattern
Mandatory for "type=WILDCARD".
Type: String
30.58.2 TelMatch JSON Schema
30.59 AddSystemSipNodeWhitelist
30.59.1 AddSystemSipNodeWhitelist Field Description
-
allowOnlyNegotiatedPeersForRtp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
entries
The list of whitelisted peers.
Type: Array of NetworkPeerWhitelistEntry (section 30.12)
30.59.2 AddSystemSipNodeWhitelist JSON Schema
30.60 AddNodeResult
30.60.1 AddNodeResult Field Description
-
displayName
Type: String
-
id
Type: String
30.60.2 AddNodeResult JSON Schema
30.61 GetProviderProfilesProfile
30.61.1 GetProviderProfilesProfile Field Description
-
deutscheTelekomNumberExtensionRange
Number Extension Range for seperating incomming calls. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.
Type: TelMatchExtensionRange (section 30.62)
-
createNewDeutscheTelekomSipTrunk
Create new Deutsche Telekom Sip Trunk or select an existing one. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.
Type: Boolean
-
deutscheTelekomSipTrunkId
In case no new Deutsche Telekom SipTrunk is created, this value must be given. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile
Type: String
-
createNewNetworkController
Create new network controller or select an existing one.
Type: Boolean
-
networkControllerDisplayName
The display name of the newly created network controller.
Type: String
-
networkControllerInterface
The interface of the newly created network controller.
Type: String
-
networkControllerIpVersion
The IP version of the newly created network controller.
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
networkControllerIpAddress
The IP address of the newly created network controller.
Type: String
-
enableReverseDnsLookup
Specify whether reverse DNS lookup is enabled for the newly created network controller.
Type: Boolean
-
networkControllerId
In case no new network controller is created, this value must be given.
Type: String
-
udpTcpPort
The UDP/TCP Port.
Type: Integer
-
tlsPort
The TLS port.
Type: Integer
-
udpPortRange
The UDP port range.
Type: PortRange (section 30.56)
-
tcpPortRange
The TCP port range.
Type: PortRange (section 30.56)
-
activateNatTraversal
When anynode is located behind a NAT gateway you can determine how this gateway can be traversed. Please ensure that the gateway is configured accordingly.
Type: Boolean
-
externalHost
External Host or IP Address
Type: String
-
natDeviceHasFixedPortMapping
In the NAT device (firewall/router) a fixed port mapping is defined.
Type: Boolean
-
fixedUdpTcpPort
Map the UDP/TCP Port to this.
Type: Integer
-
fixedTlsPort
Map the TLS Port to this.
Type: Integer
-
fixedUdpPortRangeStart
Map dynamic UDP Ports to this.
Type: Integer
-
fixedTcpPortRangeStart
Map dynamic TCP Ports to this.
Type: Integer
-
nodeViaSipTrunking
true
The node uses SIP trunking to interconnect with the remote station. In this way, full dial string ranges can be linked at once.
false
The node registers at a remote station as a client. In this case the remote station has to provide a registrar.
Type: Boolean
-
remoteSipDomain
Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.
Type: RemoteSipDomain (section 30.57)
-
localSipDomain
The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls.
Type: String
-
activateClientAuthentication
Activate client authentication. These authentication settings determine how the node authenticate to a remote station.
Type: Boolean
-
credentials
Client SIP User Name and Password.
Type: SipUserCredentials (section 30.63)
-
registrarUri
The node will register as a client at a remote station. Select the necessary settings for this registration.
Type: String
-
addressOfRecord
User Part of Address-Of-Record for registration.
Type: String
-
proxyUri
Optional proxy server. Outgoing calls will be forwarded to this proxy. The specified value must begin with "sip:".
Type: String
-
primaryProxyUri
Deprecated use "proxyUri" instead.
Primary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".
Type: String
-
defineAssertedUri
Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.
Type: Boolean
-
assertedUriHost
Mandatory, if the URI is not based on the registrar uri or proxy uri.
Type: String
-
assertedUri
User Part of Asserted-URI.
Type: String
-
useNetworkPeerWhitelist
If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.
Type: Boolean
-
includeRemoteSipDomainInWhitelist
Whether to include the remote SIP domain in the whitelist.
Type: Boolean
-
includeSipRegistrarInWhitelist
Whether to include the SIP registrar in the whitelist.
Type: Boolean
-
includeProxyInWhitelist
Whether to include the configured proxy in the whitelist.
Type: Boolean
-
networkPeerWhitelist
The whitelist.
Type: Array of NetworkPeerWhitelistEntry
-
dnsLookup
Additional protocol prefixes.
Type: Array of String
-
host
The hostname or ip address.
Type: String
-
ipVersion
If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)
Type: IpVersion
Possible values:
-
[Any Address Version]
-
IN_ADDRESS_VERSION_4
-
IN_ADDRESS_VERSION_6
-
-
subnetPrefixLength
Type: Integer
-
-
allowOnlyNegotiatedPeersForRtpRtcp
Allow only negotiated peers for RTP/RTCP.
Type: Boolean
-
incomingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 30.15)
-
region
Only for the profile Speedcom AG - Speedvoice
Type: AddProviderRegion
Possible values:
-
Schweiz
For the profile Speedcom AG - Speedvoice.
-
Liechtenstein
For the profile Speedcom AG - Speedvoice.
-
sipcall CH
For the profile sipcall.
-
sipcall AT
For the profile sipcall.
-
-
telstra1thTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the first trunk group.
Type: TelstraNthTrunkOptions (section 30.64)
-
telstra2ndTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the second trunk group.
Type: TelstraNthTrunkOptions (section 30.64)
-
routingDomains
Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.
Type: Array of String
-
displayName
Type: String
-
displayName
Type: String
-
id
Type: String
30.61.2 GetProviderProfilesProfile JSON Schema
30.62 TelMatchExtensionRange
30.62.1 TelMatchExtensionRange Field Description
-
firstExtension
Type: String
-
lastExtension
Type: String
-
trunk
Type: String
-
zeroExtend
Type: Boolean
30.62.2 TelMatchExtensionRange JSON Schema
30.63 SipUserCredentials
30.63.1 SipUserCredentials Field Description
-
username
The SIP username
Type: String
-
password
The SIP password
Type: String
30.63.2 SipUserCredentials JSON Schema
30.64 TelstraNthTrunkOptions
30.64.1 TelstraNthTrunkOptions Field Description
-
sipProxyIri
The uri of the SIP proxy server.
Type: String
-
registrarIri
The uri of the SIP registrar.
Type: String
-
aorUserName
The user part of the Address-Of-Record. The host part of the Address-Of-Record depends on the registrar uri.
Type: String
-
authenticationEnabled
Activates client authentication.
Type: Boolean
-
credentials
These authentication settings determine how the node authenticates to a remote station.
Type: SipUserCredentials (section 30.63)
30.64.2 TelstraNthTrunkOptions JSON Schema
30.65 CertificateListEntry
30.65.1 CertificateListEntry Field Description
-
issuer
Type: String
-
subject
Type: String
-
validFrom
Type: String
-
validUntil
Type: String
30.65.2 CertificateListEntry JSON Schema
30.66 MatchPatternSegment
30.66.1 MatchPatternSegment Field Description
-
comment
Type: String
-
digits
Must only contain numeric digits (0-9)
Type: String
-
greedyMatch
Type: Boolean
-
maxCount
Type: Integer
-
minCount
Type: Integer
-
text
Type: String
-
type
Type: TelMatchPatternSegmentType
Possible values:
-
anything
-
discard
-
digits
-
text
-
30.66.2 MatchPatternSegment JSON Schema
30.67 TelRewriteSegment
30.67.1 TelRewriteSegment Field Description
-
capture
Type: Integer
-
delLeading
Type: Integer
-
delTrailing
Type: Integer
-
keepLeading
Type: Integer
-
keepTrailing
Type: Integer
-
prefix
Type: String
-
suffix
Type: String
30.67.2 TelRewriteSegment JSON Schema
30.68 TagMatch
30.68.1 TagMatch Field Description
-
tagSet
Tags may only contain alphabetic and numeric characters and have to start with a lowercase character
Type: Array of String
-
type
The operator applied to the matched tags to determine the result of the TagMatch.
Type: TagMatchTye
Possible values:
-
or
-
xor
-
and
-
not
-
30.68.2 TagMatch JSON Schema
30.69 TagRewrite
30.69.1 TagRewrite Field Description
-
clearTags
Incicates if the existing tags should be removed.
Type: Boolean
-
operations
Type: Array of TagRewriteOperation (section 30.105)
30.69.2 TagRewrite JSON Schema
30.70 CryCertificate
30.70.1 CryCertificate Field Description
-
pem
The PEM of the certificate.
Type: String
30.70.2 CryCertificate JSON Schema
30.71 CryPrivateKey
30.71.1 CryPrivateKey Field Description
-
pem
The PEM of the private key.
Type: String
30.71.2 CryPrivateKey JSON Schema
30.72 MsTeamsSbaDiagnosticsServiceState
30.72.1 MsTeamsSbaDiagnosticsServiceState Field Description
-
DISABLED
Type: MsTeamsSbaDiagnosticsServiceState (section 30.72)
-
GETTING_DIAGNOSTICS_STATE
Type: MsTeamsSbaDiagnosticsServiceState (section 30.72)
-
GETTING_USERS
Type: MsTeamsSbaDiagnosticsServiceState (section 30.72)
-
IDLE
Type: MsTeamsSbaDiagnosticsServiceState (section 30.72)
30.72.2 MsTeamsSbaDiagnosticsServiceState JSON Schema
30.73 SbaServiceDiagnosticState
30.73.1 SbaServiceDiagnosticState Field Description
-
state
A short indicator for the overall state of the SBA services (i.e. "ok", "warning", "error").
Type: String
-
status
Additional information on the current status of the SBA services.
Type: String
30.73.2 SbaServiceDiagnosticState JSON Schema
30.74 SbaHttpRequestState
30.74.1 SbaHttpRequestState Field Description
-
executionTime
A timestamp from the last time the request was carried out.
Type: String
-
responseStatus
This is the HTTP response status of the last request to the SBA service.
Type: SbaHttpStatus (section 30.106)
-
responseError
This value is populated if an error occurs when requesting the state of the SBA service.
Type: String
30.74.2 SbaHttpRequestState JSON Schema
30.75 MsTeamsSbaUser
30.75.1 MsTeamsSbaUser Field Description
-
lastActiveTime
Type: String
-
lastSyncTime
Type: String
-
sipUri
Type: String
-
userId
Type: String
30.75.2 MsTeamsSbaUser JSON Schema
30.76 HotStandbyMainSystemOptions
30.76.1 HotStandbyMainSystemOptions Field Description
-
activeCondition
The id of the condition that determines when the main system assumes the active role. Leave empty to let the main system assume the active rule unconditionally.
Type: String
-
activeInMaintenanceMode
Determines if the system should assume the active role if the maintenance mode is "active".
Type: Boolean
-
disabledHere
Determines whether the main system part is enabled or disabled on this system.
Type: Boolean
-
handoverCondition
The id of the condition that determines when the main system hands over the active role to the standby system.
Type: String
-
handoverHoldTimeout
The handover hold timeout in milliseconds.
Type: Integer
-
ipcClientId
The id of the IPC Client object.
Type: String
-
linkActivityTimeout
The link standby timeout in milliseconds.
Type: Integer
-
linkPingInterval
The link ping interval in milliseconds.
Type: Integer
-
maxLinkRetryTimeout
The maximum link retry timeout in milliseconds.
Type: Integer
-
minLinkRetryTimeout
The minimum link retry timeout in milliseconds.
Type: Integer
-
recoveryCondition
The id of the condition that determines when the main system recovers the active role from the standby system. Only applies if the recovery mode is set to "CONDITIONALLY"
Type: String
-
recoveryHoldTimeout
The recovery hold timeout in milliseconds.
Type: Integer
-
recoveryMode
Determines when the main system recovers the active role from the standby system.
Type: AnStandbyMasterRecoveryMode
Possible values:
-
CONDITIONALLY
-
AS_SOON_AS_POSSIBLE
-
STANDBY_SYSTEM_INACTIVE
-
-
recoveryTimeout
The recovery timeout in milliseconds.
Type: Integer
-
replicationOptions
Type: HotStandbyReplicationOptions (section 30.107)
30.76.2 HotStandbyMainSystemOptions JSON Schema
30.77 HotStandbyStandbySystemOptions
30.77.1 HotStandbyStandbySystemOptions Field Description
-
activeCondition
The id of the condition that determines when the standby system assumes the active role.
Type: String
-
activeInMaintenanceMode
Determines if the standby system should assume the active role in maintenance mode.
Type: Boolean
-
disabledHere
Determines whether the standby system part is enabled or disabled on this system.
Type: Boolean
-
initialStandbyTimeout
The initial standby timeout in milliseconds
Type: Integer
-
recoveryCondition
The id of the condition that determines when the standby system permits recovery through the main system. If not set the standby system will allow recovery immediately when the main system attempts to.
Type: String
-
replicationOptions
Type: HotStandbyReplicationOptions (section 30.107)
30.77.2 HotStandbyStandbySystemOptions JSON Schema
30.78 HotStandbyLinkStatus
30.78.1 HotStandbyLinkStatus Field Description
-
ACTIVE
Type: HotStandbyLinkStatus (section 30.78)
-
DISABLED
Type: HotStandbyLinkStatus (section 30.78)
-
ERROR
Type: HotStandbyLinkStatus (section 30.78)
-
ESTABLISHING
Type: HotStandbyLinkStatus (section 30.78)
-
NOT_COMMITTED
Type: HotStandbyLinkStatus (section 30.78)
-
UNKNOWN
Type: HotStandbyLinkStatus (section 30.78)
30.78.2 HotStandbyLinkStatus JSON Schema
30.79 HotStandbyMainRoleStatus
30.79.1 HotStandbyMainRoleStatus Field Description
-
ACTIVE
Type: HotStandbyMainRoleStatus (section 30.79)
-
CONDITION
Type: HotStandbyMainRoleStatus (section 30.79)
-
HANDOVER_HOLD_OR_CONDITION
Type: HotStandbyMainRoleStatus (section 30.79)
-
INACTIVE
Type: HotStandbyMainRoleStatus (section 30.79)
-
RECOVERING
Type: HotStandbyMainRoleStatus (section 30.79)
-
RECOVERY_HOLD
Type: HotStandbyMainRoleStatus (section 30.79)
30.79.2 HotStandbyMainRoleStatus JSON Schema
30.80 HotStandbyMainSystemStatus
30.80.1 HotStandbyMainSystemStatus Field Description
-
ACTIVE
Type: HotStandbyMainSystemStatus (section 30.80)
-
NOT_COMMITTED
Type: HotStandbyMainSystemStatus (section 30.80)
-
OUT_OF_SERVICE
Type: HotStandbyMainSystemStatus (section 30.80)
-
STANDBY
Type: HotStandbyMainSystemStatus (section 30.80)
-
UNKNOWN
Type: HotStandbyMainSystemStatus (section 30.80)
30.80.2 HotStandbyMainSystemStatus JSON Schema
30.81 HotStandbyStandbyRoleStatus
30.81.1 HotStandbyStandbyRoleStatus Field Description
-
ACTIVE
Type: HotStandbyStandbyRoleStatus (section 30.81)
-
CONDITION
Type: HotStandbyStandbyRoleStatus (section 30.81)
-
INACTIVE
Type: HotStandbyStandbyRoleStatus (section 30.81)
-
RECOVERY_CONDITION
Type: HotStandbyStandbyRoleStatus (section 30.81)
30.81.2 HotStandbyStandbyRoleStatus JSON Schema
30.82 HotStandbyStandbySystemStatus
30.82.1 HotStandbyStandbySystemStatus Field Description
-
ACTIVE
Type: HotStandbyStandbySystemStatus (section 30.82)
-
NOT_COMMITTED
Type: HotStandbyStandbySystemStatus (section 30.82)
-
OUT_OF_SERVICE
Type: HotStandbyStandbySystemStatus (section 30.82)
-
STANDBY
Type: HotStandbyStandbySystemStatus (section 30.82)
-
UNKNOWN
Type: HotStandbyStandbySystemStatus (section 30.82)
30.82.2 HotStandbyStandbySystemStatus JSON Schema
30.83 TransportConnectionProxy
30.83.1 TransportConnectionProxy Field Description
-
flow
Whether a transport flow should be established. A flow is a kind of fixed virtual channel through which the entire SIP signaling takes place.
Type: Boolean
-
iri
Optional Proxy-URI. Otherwise, the remote SIP domain is used.
Type: String
-
omitInitialRouteSet
Omit the initial route set.
Type: Boolean
-
options
Send OPTIONS packets and if possible (which means that the remote station is an anynode then use the OPTIONS packets to determine the load of the remote station.
Type: Boolean
-
optionsNextHop
OPTIONS packets must be answered by the next hop.
Type: Boolean
30.83.2 TransportConnectionProxy JSON Schema
30.84 SipbnAddress
30.84.1 SipbnAddress Field Description
-
iri
The IRI for this address.
Type: String
-
displayName
The display name for this address.
Type: String
30.84.2 SipbnAddress JSON Schema
30.85 SipsnRoute
30.85.1 SipsnRoute Field Description
-
iri
The URI of this route.
Type: String
30.85.2 SipsnRoute JSON Schema
30.86 TransportConnectionStatusCodeErrorFlags
30.86.1 TransportConnectionStatusCodeErrorFlags Field Description
-
statusCode
These status codes can be listed individually or as a range (e.g.: 486, 501-503).
Type: String
-
errorHandling
The flags determine the behavior if the status codes occur.
Type: Array of TransportConnectionStatusCodeErrorFlag (section 30.108)
30.86.2 TransportConnectionStatusCodeErrorFlags JSON Schema
30.87 TransportConnectionAuthentication
30.87.1 TransportConnectionAuthentication Field Description
-
authenticationProfileId
The identifier of a authentication profile. This can be set to use a existing authentication profile instead of creating a new one.
Type: String
-
password
This value only works in combination with "username".
Type: String
-
username
This value only works in combination with "password".
Type: String
30.87.2 TransportConnectionAuthentication JSON Schema
30.88 SipLoadBalancerTarget
30.88.1 SipLoadBalancerTarget Field Description
-
routeId
The id of the target transport connection.
Type: String
-
targetIriFlags
Specifies how certain parts of the SIP request IRI should be treated on redirection.
Type: Array of SipLoadBalancerTargetIriFlag
Possible values:
-
USER_INFO
Transfer user info part of original request IRI to new target IRI (e.g. alice@).
-
USER_PARAMETER
Transfer user parameter of original request IRI to new target IRI (e.g. "user=phone"). Only Works together with "USER_INFO".
-
-
defaultLoad
The default load that is assumed if no load can determined.
Type: SipLoadBalancerDefaultLoad (section 30.109)
30.88.2 SipLoadBalancerTarget JSON Schema
30.89 SrvLoadBalancerTargetTemplate
30.89.1 SrvLoadBalancerTargetTemplate Field Description
-
properties
General properties
Type: Array of PlainTransportConnectionProperties
Possible values:
-
FLOW
Establish a fixed transport flow
-
FLOW_PRIVATE
The transport flow is private and is only available for this route. (Only works if "FLOW" is selected)
-
OPTIONS
Send OPTIONS packets to check whether the transport connection is operational.
-
OPTIONS_LOAD
Send OPTIONS packets and if possible (which means that the remote station is an anynode) then use the OPTIONS packets to determine the load of the remote station.
-
OPTIONS_DOWN_ONLY
Send OPTIONS packets only if the remote station is not operational.
-
OPTIONS_FLOW_ADDRESS
Send OPTIONS packets according to 1TR119
-
LYNC_MASTER_DOMAIN_NAME
Check Skype for Business master domai
-
LYNC_INCOMING
Check incoming dialog offers in a Skype for Business specific way
-
-
optionsErrorFlags
When an OPTIONS error occurs...
Type: Array of PlainTransportConnectionOptionsErrorFlag
Possible values:
-
DOWN
Change the state to non-operational
-
TERMINATE_INCOMING
Terminate incoming traffic
-
TERMINATE_OUTGOING
Terminate outgoing traffic
-
-
timeoutErrorFlags
In case of a timeout...
Type: Array of PlainTransportConnectionErrorFlag
Possible values:
-
DOWN
Change the state to non-operational.
-
FAILOVER
Perform failover to another transport connection, if possible.
-
TERMINATE_INCOMING
Terminate incoming traffic.
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
-
-
transportErrorFlags
In case of a transport error...
Type: Array of PlainTransportConnectionErrorFlag
Possible values:
-
DOWN
Change the state to non-operational.
-
FAILOVER
Perform failover to another transport connection, if possible.
-
TERMINATE_INCOMING
Terminate incoming traffic.
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
-
-
statusCodesErrorFlags
Transport connection behavior when receiving status codes.
Type: Array of TransportConnectionStatusCodeErrorFlags (section 30.86)
30.89.2 SrvLoadBalancerTargetTemplate JSON Schema
30.90 StaticUserDirectoryUser
30.90.1 StaticUserDirectoryUser Field Description
-
applicationRecords
Application specifc data depending on the use case of this directory.
Type: StaticUserDirectoryUserApplications (section 30.110)
-
displayName
The display name that is used to identify the user in the directory later on.
Type: String
30.90.2 StaticUserDirectoryUser JSON Schema
30.91 ResourcesMemory
30.91.1 ResourcesMemory Field Description
-
total
Type: long
-
used
Type: long
30.91.2 ResourcesMemory JSON Schema
30.92 RoutingDomainRouteEstablishmentV0
30.92.1 RoutingDomainRouteEstablishmentV0 Field Description
-
adjustRoutingForwardProfileSettings
Only for "routingForwardProfileSelection=CREATE_NEW". If set to true the handling of media channels can be modified.
Type: Boolean
-
assertedDialStringRewriting
Only for "type=ROUTE".
Type: Array of RoutingTelRewrite (section 30.111)
-
destinationDialStringRewriting
Only for "type=ROUTE" or "type=REDIRECT".
Type: Array of RoutingTelRewrite (section 30.111)
-
destinationNodeId
The identifier of the destination node. This is mandatory for the value "type=ROUTE".
Type: String
-
elinDialStringRewriting
Only for "type=ROUTE".
Type: Array of RoutingTelRewrite (section 30.111)
-
parallelCallDialStringDirectoryId
Only for ype=ESTABLISH_PARALLEL". The identifier of the directory to determine dial strings for parallel calls.
Type: String
-
parallelCalls
Only for ype=ESTABLISH_PARALLEL". A list of dial strings for parallel calls.
Type: Array of String
-
rejectStatus
Only for "type=REJECT".
Type: RouteRejectStatus
Possible values:
-
SUCCESS
Success.
-
DIAL_STRING
Erroneous dial string, user not found, no route, etc.
-
NETWORK_PERMISSION
No permission.
-
NETWORK_CONGESTION
A network congestion.
-
NETWORK_EQUIPMENT
Device error.
-
USER_BUSY
User busy.
-
USER_REDIRECTED
Redirected.
-
USER_NOT_RESPONDING
No reaction.
-
USER_NOT_SELECTED
A different user received the call.
-
USER_REJECTED
Rejected
-
USER_TERMINATED
Terminated
-
MEDIA_NEGOTIATION
Media negotiation error.
-
ERROR
Generic error
-
DOMAIN_SPECIFIC_0
Domain specific 0
-
DOMAIN_SPECIFIC_1
Domain specific 1
-
DOMAIN_SPECIFIC_2
Domain specific 2
-
DOMAIN_SPECIFIC_3
Domain specific 3
-
DOMAIN_SPECIFIC_4
Domain specific 4
-
DOMAIN_SPECIFIC_5
Domain specific 5
-
DOMAIN_SPECIFIC_6
Domain specific 6
-
DOMAIN_SPECIFIC_7
Domain specific 7
-
DOMAIN_SPECIFIC_8
Domain specific 8
-
DOMAIN_SPECIFIC_9
Domain specific 9
-
DOMAIN_SPECIFIC_10
Domain specific 10
-
DOMAIN_SPECIFIC_11
Domain specific 11
-
DOMAIN_SPECIFIC_12
Domain specific 12
-
DOMAIN_SPECIFIC_13
Domain specific 13
-
DOMAIN_SPECIFIC_14
Domain specific 14
-
DOMAIN_SPECIFIC_15
Domain specific 15
-
DOMAIN_SPECIFIC_16
Domain specific 16
-
DOMAIN_SPECIFIC_17
Domain specific 17
-
DOMAIN_SPECIFIC_18
Domain specific 18
-
DOMAIN_SPECIFIC_19
Domain specific 19
-
-
routingForwardProfileDisplayName
Only for "routingForwardProfileSelection=CREATE_NEW". The display name for the new routing forward profile.
Type: String
-
routingForwardProfileId
Only for "routingForwardProfileSelection=USE_REFERENCE". The identifier of the routing forward profile.
Type: String
-
routingForwardProfileMode
Only for "adjustRoutingForwardProfileSettings=true". This is the media channel handling mode.
Type: RoutingForwardProfileMode
Possible values:
-
PASSTHROUGH
While anynode will stay in the media data path between the two connected SIP entities it will not exert control over media transmission or transcoding.
-
TRANSCODING
anynode will control the way media will be transferred. In this case the media will be transcoded if necessary.The transcoding uses the codecs that are configured in the Media Negotiation of a respective Node and that are additionally negotiated with the connected SIP entity.
-
BYPASS
anynode will remove itself from the media data path between two connected SIP entities by forwarding raw and essentially unfiltered SDP data.
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
This mode is a combination of passthrough and bypass modes. While RTP/SRTP and T.38/UDPTL based communication will take place over anynode additional communication channels can be negotiated by the connected SIP entities.
-
-
routingForwardProfileSelection
Only for "type=ROUTE". An Routing forward profile can be added for this route.
Type: RoutingDomainRoutingForwardProfileSelection
Possible values:
-
CREATE_NEW
Create a new profile.
-
USE_REFERENCE
Use an existing profile.
-
-
skipIfNodeNotOperational
If set to "true" this route will be skipped if the destination node is not operational.
Type: Boolean
-
sourceDialStringRewriting
Only for "type=ROUTE".
Type: Array of RoutingTelRewrite (section 30.111)
-
transferrerDialStringRewriting
Only for "type=ROUTE".
Type: Array of RoutingTelRewrite (section 30.111)
-
type
This is the type of action which is executed after the route filter was passed.
Type: RoutingDomainRouteEstablishmentType
Possible values:
-
ROUTE
Route call
-
IGNORE
Ignore call
-
REJECT
Reject call
-
REDIRECT
Redirect call
-
ESTABLISH_PARALLEL
Establish parallel calls
-
30.92.2 RoutingDomainRouteEstablishmentV0 JSON Schema
30.93 RoutingDomainRouteFilter
30.93.1 RoutingDomainRouteFilter Field Description
-
assertedDialString
You can specify a required structure of the asserted dial string.
Type: Array of TelMatch (section 30.58)
-
conditionId
A condition can be selected. Only if this condition is met, this route is taken.
Type: String
-
destinationDialString
You can specify a required structure of the destination dial string.
Type: Array of TelMatch (section 30.58)
-
firstDiversionDialString
You can specify a required structure of the first diversion dial string
Type: Array of TelMatch (section 30.58)
-
lastDiversionDialString
You can specify a required structure of the last diversion dial string
Type: Array of TelMatch (section 30.58)
-
lookupDirectories
If a lookup directory is selected then the dial string must be included in the directory.
Type: RoutingDomainRouteLookupDirectories (section 30.112)
-
sourceDialString
You can specify a required structure of the source dial string.
Type: Array of TelMatch (section 30.58)
-
sourceNodeIds
Optionally you can restrict the set of source nodes which are used for this route. Otherwise, all nodes are accepted.
Type: Array of String
-
transferrerDialString
You can specify a required structure of the transferrer dial string
Type: Array of TelMatch (section 30.58)
30.93.2 RoutingDomainRouteFilter JSON Schema
30.94 RoutingDomainRoutePathReplacement
30.94.1 RoutingDomainRoutePathReplacement Field Description
-
adjustAcceptNewForwarderDomain
Type: Boolean
-
routingForwardProfileDisplayName
Only for "routingForwardProfileSelection=CREATE_NEW". The display name for the new routing forward profile.
Type: String
-
routingForwardProfileSelection
Only for "type=REPLACE". An Routing forward profile can added for this route.
Type: RoutingDomainRoutingForwardProfileSelection
Possible values:
-
CREATE_NEW
Create a new profile.
-
USE_REFERENCE
Use an existing profile.
-
-
type
The action that is carried out if the route filter matches.
Type: RoutePathReplacementType
Possible values:
-
REPLACE
-
REJECT
-
30.94.2 RoutingDomainRoutePathReplacement JSON Schema
30.95 RoutingDomainRouteEstablishment
30.95.1 RoutingDomainRouteEstablishment Field Description
-
destinationDialStringRewriting
Only for "type=REDIRECT".
Type: Array of RoutingTelRewrite (section 30.111)
-
parallelCallDialStringDirectoryId
Only for ype=ESTABLISH_PARALLEL". The identifier of the directory to determine dial strings for parallel calls.
Type: String
-
parallelCalls
Only for ype=ESTABLISH_PARALLEL". A list of dial strings for parallel calls.
Type: Array of String
-
rejectStatus
Only for "type=REJECT".
Type: RouteRejectStatus
Possible values:
-
SUCCESS
Success.
-
DIAL_STRING
Erroneous dial string, user not found, no route, etc.
-
NETWORK_PERMISSION
No permission.
-
NETWORK_CONGESTION
A network congestion.
-
NETWORK_EQUIPMENT
Device error.
-
USER_BUSY
User busy.
-
USER_REDIRECTED
Redirected.
-
USER_NOT_RESPONDING
No reaction.
-
USER_NOT_SELECTED
A different user received the call.
-
USER_REJECTED
Rejected
-
USER_TERMINATED
Terminated
-
MEDIA_NEGOTIATION
Media negotiation error.
-
ERROR
Generic error
-
DOMAIN_SPECIFIC_0
Domain specific 0
-
DOMAIN_SPECIFIC_1
Domain specific 1
-
DOMAIN_SPECIFIC_2
Domain specific 2
-
DOMAIN_SPECIFIC_3
Domain specific 3
-
DOMAIN_SPECIFIC_4
Domain specific 4
-
DOMAIN_SPECIFIC_5
Domain specific 5
-
DOMAIN_SPECIFIC_6
Domain specific 6
-
DOMAIN_SPECIFIC_7
Domain specific 7
-
DOMAIN_SPECIFIC_8
Domain specific 8
-
DOMAIN_SPECIFIC_9
Domain specific 9
-
DOMAIN_SPECIFIC_10
Domain specific 10
-
DOMAIN_SPECIFIC_11
Domain specific 11
-
DOMAIN_SPECIFIC_12
Domain specific 12
-
DOMAIN_SPECIFIC_13
Domain specific 13
-
DOMAIN_SPECIFIC_14
Domain specific 14
-
DOMAIN_SPECIFIC_15
Domain specific 15
-
DOMAIN_SPECIFIC_16
Domain specific 16
-
DOMAIN_SPECIFIC_17
Domain specific 17
-
DOMAIN_SPECIFIC_18
Domain specific 18
-
DOMAIN_SPECIFIC_19
Domain specific 19
-
-
routingTargets
Only for "type=ROUTE". This is a list of nodes that this route directs to. It can be specified which node is used based on the call status.
Type: Array of RoutingDomainRouteEstablishAccept (section 30.113)
-
skipIfNodeNotOperational
If set to "true" this route will be skipped if the destination node is not operational.
Type: Boolean
-
type
This is the type of action which is executed after the route filter was passed.
Type: RoutingDomainRouteEstablishmentType
Possible values:
-
ROUTE
Route call
-
IGNORE
Ignore call
-
REJECT
Reject call
-
REDIRECT
Redirect call
-
ESTABLISH_PARALLEL
Establish parallel calls
-
30.95.2 RoutingDomainRouteEstablishment JSON Schema
30.96 String
30.96.1 String Field Description
-
CASE_INSENSITIVE_ORDER
Type: Comparator
30.96.2 String JSON Schema
30.97 RoutingForwardProfile
30.97.1 RoutingForwardProfile Field Description
-
announcementIncoming
Play an announcement at the incoming node.
Type: Boolean
-
announcementMediaSourceId
The id of the Announcement Media Source used as specified.
Type: String
-
announcementOutgoing
Play an announcement at the outgoing node.
Type: Boolean
-
displayName
Display name of the object.
Type: String
-
earlyMediaPassThrough
Specify whether early media should be already passed through during call setup.
Type: Boolean
-
id
Identifier of the object.
Type: String
-
mediaRecorderId
The id of the Media Recorder used to record as specified.
Type: String
-
removeAnynodeFromSignalingPath
Type: Boolean
-
telephonyForwardingStack
A Telephony Forwarding is a collection of protocol specific settings which influence the way forwarding of signaling information or media data is going to take place.
Type: TelephonyForwarding (section 30.114)
-
telephonyForwardingStackId
This value will be used instead of telephonyForwardingStack if the object is not complete. The id of a Telephony Forwarding is a collection of protocol specific settings which influence the way forwarding of signaling information or media data is going to take place.
Type: String
30.97.2 RoutingForwardProfile JSON Schema
30.98 SignalingForwardingOptions
30.98.1 SignalingForwardingOptions Field Description
-
ACTIVE_APPARENT_STATE
Type: Boolean
-
ADDRESS
Type: Boolean
-
ASSERTED_ADDRESS
Type: Boolean
-
DESTINATION_ADDRESS
Type: Boolean
-
DESTINATION_USER
Type: Boolean
-
END_REASON
Type: Boolean
-
HOLD
Type: Boolean
-
MWI_REQUEST_SIP_DESTINATION_ADDRESS
Type: Boolean
-
MWI_REQUEST_SIP_SOURCE_ADDRESS
Type: Boolean
-
MWI_RESPONSE_REASON
Type: Boolean
-
MWI_RESPONSE_SIP_REASON
Type: Boolean
-
NOTIFY_SIP_INFO
Type: Boolean
-
PRIORITY
Type: Boolean
-
PROCEEDING
Type: Boolean
-
PROCEEDING_RINGING
Type: Boolean
-
REDIRECT_HISTORY
Type: Boolean
-
RINGING
Type: Boolean
-
SIP_ADDRESS
Type: Boolean
-
SIP_ASSERTED_ADDRESS
Type: Boolean
-
SIP_DESTINATION_ADDRESS
Type: Boolean
-
SIP_END_REASON
Type: Boolean
-
SIP_HEADER_CALL_INFO
Type: Boolean
-
SIP_HEADER_DIVERSION
Type: Boolean
-
SIP_HEADER_HISTORY_INFO
Type: Boolean
-
SIP_HEADER_ORGANIZATION
Type: Boolean
-
SIP_HEADER_PRIORITY
Type: Boolean
-
SIP_HEADER_PRIVACY
Type: Boolean
-
SIP_HEADER_P_ASSERTED_IDENTITY
Type: Boolean
-
SIP_HEADER_P_CALLED_PARTY_ID
Type: Boolean
-
SIP_HEADER_REFERRED_BY
Type: Boolean
-
SIP_HEADER_REMOTE_PARTY_ID
Type: Boolean
-
SIP_HEADER_SERVER
Type: Boolean
-
SIP_HEADER_SUBJECT
Type: Boolean
-
SIP_HEADER_USER_AGENT
Type: Boolean
-
SIP_MSFT_GEOLOCATION
Type: Boolean
-
SIP_PRIORITY
Type: Boolean
-
SIP_PRIVACY
Type: Boolean
-
SIP_REDIRECT_HISTORY
Type: Boolean
-
SIP_REFERRER_ADDRESS
Type: Boolean
-
SIP_SIPSNX_HEADER_P_ACCESS_NETWORK_INFO
Type: Boolean
-
SIP_SIPSNX_HEADER_P_RECORDING_FROM
Type: Boolean
-
SIP_SIPSNX_HEADER_P_RECORDING_TAPPED
Type: Boolean
-
SIP_SIPSNX_HEADER_P_RECORDING_TO
Type: Boolean
-
TRANSFERRER_ADDRESS
Type: Boolean
-
USER
Type: Boolean
-
notifySipInfoFilters
Type: Array of NotifySipInfoFilter (section 30.115)
-
profile
Type: SignalingForwardingOptionsProfile
Possible values:
-
STANDARD
-
FULL
-
30.98.2 SignalingForwardingOptions JSON Schema
30.99 WebserverConnectorNetworkOptions
30.99.1 WebserverConnectorNetworkOptions Field Description
-
interfaceIdentifier
The identifier of the network interface. Use section 28.1 to get the list of network interfaces available. Leave empty to select an interface automatically.
Type: String
-
ipAddress
The IP address that this connector will listen on.
Type: String
-
ipVersion
The IP address version that should be used.
Type: IpVersion
Possible values:
-
IPv4
-
IPv6
-
30.99.2 WebserverConnectorNetworkOptions JSON Schema
30.100 WebserverConnectorTlsOptions
30.100.1 WebserverConnectorTlsOptions Field Description
-
protocols
The list of TLS protocols that this connector will support.
Type: Array of TlsProtocol
Possible values:
-
TLSv1
-
TLSv1_1
-
TLSv1_2
-
TLSv1_3
-
-
privateKey
The private key of the server certificate.
Type: CryPrivateKey (section 30.71)
-
certificate
The server certificate.
Type: CryCertificate (section 30.70)
-
extraCertificates
Additional chain certificates that are needed for clients to validate the server certificate.
Type: Array of CryCertificate (section 30.70)
-
demandClientCertificate
If set to true the web server will request and validate certificates from clients.
Type: Boolean
-
hostnameVerification
If set to true the clients hostname must match the hostname in the clients certificate. Only used for "demandClientCertificate=true".
Type: Boolean
-
trustedCertificates
The list of trusted certificates for client authentication. Only used for "demandClientCertificate=true".
Type: Array of CryCertificate (section 30.70)
30.100.2 WebserverConnectorTlsOptions JSON Schema
30.101 Backend
30.101.1 Backend Field Description
-
displayName
Type: String
-
id
Type: String
30.101.2 Backend JSON Schema
30.102 NetworkInterface
30.102.1 NetworkInterface Field Description
-
displayName
Type: String
-
id
Type: String
30.102.2 NetworkInterface JSON Schema
30.103 NetworkController
30.103.1 NetworkController Field Description
-
displayName
Type: String
-
id
Type: String
-
interface
Type: String
30.103.2 NetworkController JSON Schema
30.104 TelMatchList
30.104.1 TelMatchList Field Description
-
matches
Type: Array of TelMatch (section 30.58)
-
operator
The operator applied to the results of the "matches".
Type: TelMatchListOperator
Possible values:
-
OR
-
XOR
-
AND
-
NOT
-
30.104.2 TelMatchList JSON Schema
30.105 TagRewriteOperation
30.105.1 TagRewriteOperation Field Description
-
type
Indicates which rewrite operation will be carried out on the tag.
Type: TagRewriteOperationType
Possible values:
-
add
-
delete
-
keep
-
-
tag
Tags may only contain alphabetic and numeric characters and have to start with a lowercase character
Type: String
30.105.2 TagRewriteOperation JSON Schema
30.106 SbaHttpStatus
30.106.1 SbaHttpStatus Field Description
-
statusCode
Type: Integer
-
statusLine
Type: String
30.106.2 SbaHttpStatus JSON Schema
30.107 HotStandbyReplicationOptions
30.107.1 HotStandbyReplicationOptions Field Description
-
systemIdentifiers
The list of backend ids that this system will be enabled on if "systemIdentifiersEnabled" is set to true.
Type: Array of String
-
systemIdentifiersEnabled
Allows the restriction of backends that this system will be enabled on.
Type: Boolean
30.107.2 HotStandbyReplicationOptions JSON Schema
30.108 TransportConnectionStatusCodeErrorFlag
30.108.1 TransportConnectionStatusCodeErrorFlag Field Description
-
DOWN
Change the state to non-operational.
Type: TransportConnectionStatusCodeErrorFlag (section 30.108)
-
DOWN_RETRY_AFTER
Change the state to non-operational if the response message contains a Retry-After header.
Type: TransportConnectionStatusCodeErrorFlag (section 30.108)
-
FAILOVER
Perform failover to another transport connection, if possible.
Type: TransportConnectionStatusCodeErrorFlag (section 30.108)
-
TERMINATE_INCOMING
Terminate incoming traffic.
Type: TransportConnectionStatusCodeErrorFlag (section 30.108)
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
Type: TransportConnectionStatusCodeErrorFlag (section 30.108)
30.108.2 TransportConnectionStatusCodeErrorFlag JSON Schema
30.109 SipLoadBalancerDefaultLoad
30.109.1 SipLoadBalancerDefaultLoad Field Description
-
HIGH
Type: SipLoadBalancerDefaultLoad (section 30.109)
-
LOW
Type: SipLoadBalancerDefaultLoad (section 30.109)
-
MEDIUM
Type: SipLoadBalancerDefaultLoad (section 30.109)
30.109.2 SipLoadBalancerDefaultLoad JSON Schema
30.110 StaticUserDirectoryUserApplications
30.110.1 StaticUserDirectoryUserApplications Field Description
-
associatedProvisioningDevices
Options for associated provisioning devices.
Type: Array of ProvisioningUserAssociatedDevice (section 30.116)
-
policy
Telephony policy settings for this user.
Type: SipPolicyUserData (section 30.117)
-
sipCredentials
Options for SIP authentication
Type: Credentials (section 30.36)
-
sipRegistrar
SIP registrar information.
Type: SipRegistrarUserData (section 30.118)
-
webrtc
WebRTC dial string and client authentication information.
Type: WebRtcUserData (section 30.119)
30.110.2 StaticUserDirectoryUserApplications JSON Schema
30.111 RoutingTelRewrite
30.111.1 RoutingTelRewrite Field Description
-
delLeading
How many of the leading characters will be deleted.
Type: Integer
-
delTrailing
How many of the trailing characters will be deleted.
Type: Integer
-
keepLeading
Keep aditional leading characters of the matched part. This happens before the removal of leading characters.
Type: Integer
-
keepTrailing
Keep aditional trailing characters of the matched part. This happens before the removal of trailing characters.
Type: Integer
-
matchedPart
The matched part of the dial string that will be rewritten. Setting this to 0 will select the whole dial string.
Type: Integer
-
prefix
Adds a prefix to the dial string
Type: String
-
source
This determines which dial string will be rewritten.
Type: RoutingTelRewriteSource
Possible values:
-
MOST_APPROPRIATE
-
FIRST_DIVERSION
-
LAST_DIVERSION
-
SOURCE
-
DESTINATION
-
TRANSFERRER
-
-
suffix
Adds a suffix to the dial string
Type: String
30.111.2 RoutingTelRewrite JSON Schema
30.112 RoutingDomainRouteLookupDirectories
30.112.1 RoutingDomainRouteLookupDirectories Field Description
-
assertedUriDirectoryId
The identifier of the directory to lookup the asserted dial string
Type: String
-
destinationDialStringDirectoryId
The identifier of the directory to lookup the destination dial string
Type: String
-
firstDiversionNumberDirectoryId
The identifier of the directory to lookup the first diversion dial string
Type: String
-
lastDiversionNumberDirectoryId
The identifier of the directory to lookup the last diversion dial string
Type: String
-
sourceDialStringDirectoryId
The identifier of the directory to lookup the source dial string
Type: String
-
transferrerDialStringDirectoryId
The identifier of the directory to lookup the transferrer dial string
Type: String
30.112.2 RoutingDomainRouteLookupDirectories JSON Schema
30.113 RoutingDomainRouteEstablishAccept
30.113.1 RoutingDomainRouteEstablishAccept Field Description
-
destinationNodeId
The identifier of the destination node. For a list of all nodes use section 7.1.
Type: String
-
routingForwardProfileSelection
This value determines if an existing routing forward profile is used or if a new one will be created.
Type: RoutingDomainRoutingForwardProfileSelection
Possible values:
-
CREATE_NEW
Create a new profile.
-
USE_REFERENCE
Use an existing profile.
-
-
routingForwardProfileId
The identifier of the routing forward profile. For a list of all routing forward profiles use section 26.1.
Type: String
-
routingForwardProfileDisplayName
Only for "routingForwardProfileSelection=CREATE_NEW". This is the custom display name for a new routing forward profile. If left empty a display name will be generated from the name of the selected node.
Type: String
-
routingForwardProfileMode
This is the media channel handling mode for the media negotiation forwarder that is referenced by the routing forward profile. This will be applied to a newly created routing forward profile.
Type: RoutingForwardProfileMode
Possible values:
-
PASSTHROUGH
While anynode will stay in the media data path between the two connected SIP entities it will not exert control over media transmission or transcoding.
-
TRANSCODING
anynode will control the way media will be transferred. In this case the media will be transcoded if necessary.The transcoding uses the codecs that are configured in the Media Negotiation of a respective Node and that are additionally negotiated with the connected SIP entity.
-
BYPASS
anynode will remove itself from the media data path between two connected SIP entities by forwarding raw and essentially unfiltered SDP data.
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
This mode is a combination of passthrough and bypass modes. While RTP/SRTP and T.38/UDPTL based communication will take place over anynode additional communication channels can be negotiated by the connected SIP entities.
-
-
adjustRoutingForwardProfileSettings
If this is set to "true" the "routingForwardProfileMode" will be applied to the selected existing routing forward profile.
Type: boolean
-
sourceDialStringRewriting
Optional rewriting rules for the source dial string.
Type: Array of RoutingTelRewrite (section 30.111)
-
assertedDialStringRewriting
Optional rewriting rules for the asserted dial string.
Type: Array of RoutingTelRewrite (section 30.111)
-
destinationDialStringRewriting
Optional rewriting rules for the destination dial string.
Type: Array of RoutingTelRewrite (section 30.111)
-
transferrerDialStringRewriting
Optional rewriting rules for the transferrer dial string.
Type: Array of RoutingTelRewrite (section 30.111)
-
elinDialStringRewriting
Optional rewriting rules for the ELIN dial string.
Type: Array of RoutingTelRewrite (section 30.111)
-
failoverStatusMatch
If the call to this node would end with one of the statuses in this list, the next configured node will be used instead.
Type: RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch (section 30.120)
30.113.2 RoutingDomainRouteEstablishAccept JSON Schema
30.114 TelephonyForwarding
30.114.1 TelephonyForwarding Field Description
-
mediaNegotiationForwarder
Type: MediaNegotiationForwarder (section 30.121)
-
mediaNegotiationForwarderId
Type: String
-
signalingForwardingFromCalledToCalling
Type: SignalingForwardingOptions (section 30.98)
-
signalingForwardingFromCallingToCalled
Type: SignalingForwardingOptions (section 30.98)
30.114.2 TelephonyForwarding JSON Schema
30.115 NotifySipInfoFilter
30.115.1 NotifySipInfoFilter Field Description
-
maxContentLength
Type: Integer
-
mimeContentTypeName
Type: String
30.115.2 NotifySipInfoFilter JSON Schema
30.116 ProvisioningUserAssociatedDevice
30.116.1 ProvisioningUserAssociatedDevice Field Description
-
aorUserName
User part of the address-of-record from the SIP device that registers.
Type: String
-
deviceId
The MAC address of the device.
Type: String
-
staticVariables
Static variables for the use in device templates.
Type: ProvisioningStaticVariableTable (section 30.122)
-
subId
The sub ID can be used to select sub-devices that are all listed under the same MAC address.
Type: String
30.116.2 ProvisioningUserAssociatedDevice JSON Schema
30.117 SipPolicyUserData
30.117.1 SipPolicyUserData Field Description
-
rewriteTableIncoming
Dial string rewriting rules for incoming messages.
Type: Array of DialStringRewrite (section 30.15)
-
rewriteTableOutgoing
Dial string rewriting rules for outgoing messages.
Type: Array of DialStringRewrite (section 30.15)
-
sippgIncoming
SIP privacy settings for incoming messages.
Type: SipPolicyPrivacyOptions (section 30.123)
-
sippgOutgoing
SIP privacy settings for outgoing messages.
Type: SipPolicyPrivacyOptions (section 30.123)
30.117.2 SipPolicyUserData JSON Schema
30.118 SipRegistrarUserData
30.118.1 SipRegistrarUserData Field Description
-
dialStrings
SIP node registrar dial string settings.
Type: Array of SipRegistrarUserDialStrings (section 30.124)
-
failover
SIP node registrar failover settings.
Type: SipRegistrarUserFailover (section 30.125)
30.118.2 SipRegistrarUserData JSON Schema
30.119 WebRtcUserData
30.119.1 WebRtcUserData Field Description
-
address
The address of the WebRTC user.
Type: TelAddress (section 30.126)
-
credentials
The credentials of the WebRTC user.
Type: Credentials (section 30.36)
30.119.2 WebRtcUserData JSON Schema
30.120 RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch
30.120.1 RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch Field Description
-
sipStatusCodes
Accepts individual SIP status codes (e.g., 404) or ranges (e.g., 400-412), separated by commas.
Type: String
-
telStatusList
If the call to this node would end with one of the statuses in this list, the next configured node will be used instead.
Type: Array of TelStatusNoSuccess (section 30.127)
30.120.2 RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch JSON Schema
30.121 MediaNegotiationForwarder
30.121.1 MediaNegotiationForwarder Field Description
-
displayName
The name shown in the anynode frontend.
Type: String
-
id
The id of this object.
Type: String
-
mediaMode
Type: MediaMode
Possible values:
-
TRANSCODING
-
BYPASS
-
PASSTHROUGH
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
-
-
mediaTranscodingOptions
The Media Transcoding Options to be used.
Type: MediaTranscodingOptions (section 30.128)
-
mediaTranscodingOptionsId
This value will be used instead of mediaTranscodingOptions, if the object cannot be found. Id of the media transcoding options object to be used.
Type: String
30.121.2 MediaNegotiationForwarder JSON Schema
30.122 ProvisioningStaticVariableTable
This JSON object can contain any key value combination if the value is a string.
30.122.1 ProvisioningStaticVariableTable JSON Schema
30.123 SipPolicyPrivacyOptions
30.123.1 SipPolicyPrivacyOptions Field Description
-
enforce
Enforced privacy functions.
Type: Array of SipPrivacyServicesHeaderValue
Possible values:
-
RFC3323_USER
user (RFC 3323)
-
RFC3323_SESSION
session (RFC 3323)
-
RFC3325_ID
id (RFC 3325)
-
RFC7044_HISTORY
history (RFC 7044)
-
-
include
Privacy functions to be included.
Type: Array of SipPrivacyServicesHeaderValue
Possible values:
-
RFC3323_USER
user (RFC 3323)
-
RFC3323_SESSION
session (RFC 3323)
-
RFC3325_ID
id (RFC 3325)
-
RFC7044_HISTORY
history (RFC 7044)
-
-
passthrough
Passed through privacy functions.
Type: Array of SipPrivacyServicesHeaderValue
Possible values:
-
RFC3323_USER
user (RFC 3323)
-
RFC3323_SESSION
session (RFC 3323)
-
RFC3325_ID
id (RFC 3325)
-
RFC7044_HISTORY
history (RFC 7044)
-
-
permit
Allowed privacy functions when requested.
Type: Array of SipPrivacyServicesHeaderValue
Possible values:
-
RFC3323_USER
user (RFC 3323)
-
RFC3323_SESSION
session (RFC 3323)
-
RFC3325_ID
id (RFC 3325)
-
RFC7044_HISTORY
history (RFC 7044)
-
30.123.2 SipPolicyPrivacyOptions JSON Schema
30.124 SipRegistrarUserDialStrings
30.124.1 SipRegistrarUserDialStrings Field Description
-
aorMatch
Through this matching condition detemines the structure of the user part of the address-of-record of a registration.
Type: TelMatch (section 30.58)
-
addresses
The user can be reached at all of this dial strings.
Type: Array of TelAddress (section 30.126)
-
matches
The user can be reached at all dial strings that pass the filters in this list.
Type: Array of TelMatch (section 30.58)
30.124.2 SipRegistrarUserDialStrings JSON Schema
30.125 SipRegistrarUserFailover
30.125.1 SipRegistrarUserFailover Field Description
-
groupIdentifier
The group identifier can be used to group registrations (also from different users) into a failover group
Type: String
-
statusCodes
Apply failover if the previous call failed with one of the following SIP status codes. These status codes can be listed individually or as a range (e.g.: 486, 501-503).
Type: String
30.125.2 SipRegistrarUserFailover JSON Schema
30.126 TelAddress
30.126.1 TelAddress Field Description
-
dialString
The dial string
Type: String
-
displayName
The display name
Type: String
-
tagSet
Tags may only contain alphabetic and numeric characters and have to start with a lowercase character
Type: Array of String
30.126.2 TelAddress JSON Schema
30.127 TelStatusNoSuccess
30.127.1 TelStatusNoSuccess Field Description
-
DIAL_STRING
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_0
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_1
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_10
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_11
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_12
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_13
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_14
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_15
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_16
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_17
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_18
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_19
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_2
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_3
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_4
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_5
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_6
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_7
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_8
Type: TelStatusNoSuccess (section 30.127)
-
DOMAIN_SPECIFIC_9
Type: TelStatusNoSuccess (section 30.127)
-
ERROR
Type: TelStatusNoSuccess (section 30.127)
-
MEDIA_NEGOTIATION
Type: TelStatusNoSuccess (section 30.127)
-
NETWORK_CONGESTION
Type: TelStatusNoSuccess (section 30.127)
-
NETWORK_EQUIPMENT
Type: TelStatusNoSuccess (section 30.127)
-
NETWORK_PERMISSION
Type: TelStatusNoSuccess (section 30.127)
-
USER_BUSY
Type: TelStatusNoSuccess (section 30.127)
-
USER_NOT_RESPONDING
Type: TelStatusNoSuccess (section 30.127)
-
USER_NOT_SELECTED
Type: TelStatusNoSuccess (section 30.127)
-
USER_REDIRECTED
Type: TelStatusNoSuccess (section 30.127)
-
USER_REJECTED
Type: TelStatusNoSuccess (section 30.127)
-
USER_TERMINATED
Type: TelStatusNoSuccess (section 30.127)
30.127.2 TelStatusNoSuccess JSON Schema
30.128 MediaTranscodingOptions
30.128.1 MediaTranscodingOptions Field Description
-
displayName
The name shown in the anynode frontend.
Type: String
-
id
The id of this object.
Type: String