27 JSON Objects
27.1 SoftwareVersion
27.1.1 SoftwareVersion Field Description
-
versionMajor
Type: Integer
-
versionMinor
Type: Integer
-
versionRelease
Type: Integer
27.1.2 SoftwareVersion JSON Schema
27.2 AddUserData
27.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
27.2.2 AddUserData JSON Schema
27.3 CustomUserOptions
27.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 27.39)
-
localUserName
Type: String
-
localV0
Type: LocalV0User (section 27.40)
-
roleBuiltIns
Type: String
-
roles
Type: Array of String
27.3.2 CustomUserOptions JSON Schema
27.4 Role
27.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
27.4.2 Role JSON Schema
27.5 TracingOptionsJson
27.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
-
27.5.2 TracingOptionsJson JSON Schema
27.6 License
27.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 27.42)
-
constaints
The constraints for this license.
Type: String
27.6.2 License JSON Schema
27.7 ImportLodData
27.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
27.7.2 ImportLodData JSON Schema
27.8 AddSystemProfile
27.8.1 AddSystemProfile 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 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 27.46)
-
tcpPortRange
Restricts the tcp port range
Type: PortRange (section 27.46)
-
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 27.47)
-
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 27.29)
-
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 27.29)
-
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 27.48)
-
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
-
incomingDialStringRewriteRules
Type: Array of DialStringRewrite (section 27.14)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 27.14)
-
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
27.8.2 AddSystemProfile JSON Schema
27.9 AddProviderProfile
27.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 27.51)
-
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 27.46)
-
tcpPortRange
The TCP port range.
Type: PortRange (section 27.46)
-
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 27.47)
-
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 27.52)
-
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
Primary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".
Type: String
-
secondaryProxyUri
Secondary 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 27.14)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 27.14)
-
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 27.53)
-
telstra2ndTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the second trunk group.
Type: TelstraNthTrunkOptions (section 27.53)
-
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
27.9.2 AddProviderProfile JSON Schema
27.10 AddSipPhoneRegistrarProfile
27.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 27.46)
-
tcpPortRange
The TCP port range.
Type: PortRange (section 27.46)
-
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 27.14)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 27.14)
-
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
27.10.2 AddSipPhoneRegistrarProfile JSON Schema
27.11 SipNodeTransportConnection
27.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 27.48)
-
transportConnectionId
The id of the transport connection
Type: String
27.11.2 SipNodeTransportConnection JSON Schema
27.12 NetworkPeerWhitelistEntry
27.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
27.12.2 NetworkPeerWhitelistEntry JSON Schema
27.13 DialStringRewriting
27.13.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 27.14)
27.13.2 DialStringRewriting JSON Schema
27.14 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
-
-
matchAndModify
-
matchType
-
rewriteSegments
-
-
matchAndBranch
-
matchType
-
rewriteSegments
-
branchRewrites
-
branchElseRewrites
-
-
available for all types:
-
skipFurtherRules
-
applyToAllDialStrings
-
applyToSourceDialString
-
applyToDestinationDialString
-
applyTo
-
comment
-
-
available for all types excluding cutExtensionNumber:
-
matchTags
-
tagRewrite
-
case
-
clearDisplayName
-
displayName
-
27.14.1 DialStringRewrite Field Description
-
rewriteType
Type of dial string rewrite
Type: RewriteTypeJson
Possible values:
-
prefixAndSuffix
-
wildcardPattern
-
cutExtensionNumber
-
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 27.51)
-
structuralPattern
The rewrite rule will only match dial strings according to the pattern you specify.
Type: Array of MatchPatternSegment (section 27.55)
-
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
-
rewriteSegments
This setting determines how the rewritten dial string is structured.
Type: Array of TelRewriteSegment (section 27.56)
-
branchRewrites
Rewrites that are processed if the dial string matches the condition.
Type: Array of DialStringRewrite (section 27.14)
-
branchElseRewrites
Rewrites that are processed if the dial string does not match the condition.
Type: Array of DialStringRewrite (section 27.14)
-
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 27.57)
-
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 27.58)
-
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
27.14.2 DialStringRewrite JSON Schema
27.15 TelIdent
27.15.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
27.15.2 TelIdent JSON Schema
27.16 AnynodeConfigState
27.16.1 AnynodeConfigState Field Description
-
committed
Indicates if all changes to the configuration are committed.
Type: Boolean
27.16.2 AnynodeConfigState JSON Schema
27.17 BackupExportOptions
27.17.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.
-
-
encryptData
Determines if the exported backup will be encrypted.
Type: Boolean
-
password
The password if encryption is enabled. Mandatory if "encryptData=true".
Type: String
27.17.2 BackupExportOptions JSON Schema
27.18 MaintenanceMode
27.18.1 MaintenanceMode Field Description
-
modeActive
Indicates if the maintenance mode should be activated or deactivated.
Type: Boolean
27.18.2 MaintenanceMode JSON Schema
27.19 MediaRecording
27.19.1 MediaRecording Field Description
-
mediaRecordingActive
Type: Boolean
27.19.2 MediaRecording JSON Schema
27.20 MsTeamsSbaOptions
27.20.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 27.23)
-
certificate
The certificate for the SBA service
Type: CryCertificate (section 27.59)
-
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 27.60)
27.20.2 MsTeamsSbaOptions JSON Schema
27.21 MsTeamsSbaStatus
27.21.1 MsTeamsSbaStatus Field Description
-
state
Type: String
-
status
Type: String
27.21.2 MsTeamsSbaStatus JSON Schema
27.22 MsTeamsSbaFingerprint
27.22.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
27.22.2 MsTeamsSbaFingerprint JSON Schema
27.23 MsTeamsSbaLog
27.23.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
27.23.2 MsTeamsSbaLog JSON Schema
27.24 StandardTransportConnection
27.24.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 27.29)
-
proxy
The proxy to be used.
Type: TransportConnectionProxy (section 27.62)
-
registration
The registration to be used.
Type: TransportConnectionRegistration
-
addressOfRecord
Address-Of-Record (to be registered URI)
Type: String
-
sipDomain
SIP Domain (Registrar)
Type: String
-
27.24.2 StandardTransportConnection JSON Schema
27.25 PlainTransportConnection
27.25.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 27.63)
-
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 27.63)
-
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 27.64)
-
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 27.65)
-
authentication
If the Plain Transport Connection to be created requires separate authentication data then this can be configured here.
Type: TransportConnectionAuthentication (section 27.66)
27.25.2 PlainTransportConnection JSON Schema
27.26 SipLoadBalancingTransportConnection
27.26.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 27.67)
27.26.2 SipLoadBalancingTransportConnection JSON Schema
27.27 SipRegistrationAsTransportConnection
27.27.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 27.66)
-
aorUri
The address-of-record specifies who is to be registered.
Type: SipbnAddress (section 27.63)
-
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 27.63)
-
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
27.27.2 SipRegistrationAsTransportConnection JSON Schema
27.28 SrvLoadBalancer
27.28.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 27.68)
27.28.2 SrvLoadBalancer JSON Schema
27.29 SipCredentials
27.29.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
27.29.2 SipCredentials JSON Schema
27.30 Credentials
27.30.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
27.30.2 Credentials JSON Schema
27.31 AssertedUri
27.31.1 AssertedUri Field Description
-
displayName
The desired display name.
Type: String
-
iri
The desired URI.
Type: String
27.31.2 AssertedUri JSON Schema
27.32 DirectoryInfo
27.32.1 DirectoryInfo Field Description
-
directoryType
Type: String
-
displayName
Type: String
-
id
Type: String
27.32.2 DirectoryInfo JSON Schema
27.33 StaticUserDirectory
27.33.1 StaticUserDirectory Field Description
-
displayName
The display name for this directory.
Type: String
-
userRecords
User data for this directory
Type: Array of StaticUserDirectoryUser (section 27.69)
27.33.2 StaticUserDirectory JSON Schema
27.34 Resources
27.34.1 Resources Field Description
-
cpu
Type: Integer
-
disk
Type: ResourcesMemory (section 27.70)
-
ram
Type: ResourcesMemory (section 27.70)
27.34.2 Resources JSON Schema
27.35 AddRoutingDomainOptions
27.35.1 AddRoutingDomainOptions Field Description
-
displayName
Type: String
-
sourceNodes
Type: Array of String
27.35.2 AddRoutingDomainOptions JSON Schema
27.36 GetRoutingDomainOptions
27.36.1 GetRoutingDomainOptions Field Description
-
displayName
Type: String
-
id
Type: String
-
routes
Type: Array of RoutingDomainRoute
-
displayName
Type: String
-
establishment
Only for "mode=establishment".
Type: RoutingDomainRouteEstablishment (section 27.71)
-
filters
Filters determine when this route will be used for incoming or outgoing calls.
Type: Array of RoutingDomainRouteFilter (section 27.72)
-
pathReplacement
Only for "mode=pathReplacement".
Type: RoutingDomainRoutePathReplacement (section 27.73)
-
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
27.36.2 GetRoutingDomainOptions JSON Schema
27.37 RoutingDomainRoute
27.37.1 RoutingDomainRoute Field Description
-
displayName
Type: String
-
establishment
Only for "mode=establishment".
Type: RoutingDomainRouteEstablishment (section 27.71)
-
filters
Filters determine when this route will be used for incoming or outgoing calls.
Type: Array of RoutingDomainRouteFilter (section 27.72)
-
pathReplacement
Only for "mode=pathReplacement".
Type: RoutingDomainRoutePathReplacement (section 27.73)
-
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
27.37.2 RoutingDomainRoute JSON Schema
27.38 AddRoutingForwardProfileOptions
27.38.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 27.76)
-
signalingForwardingFromCallingToCalled
Type: SignalingForwardingOptions (section 27.76)
-
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
27.38.2 AddRoutingForwardProfileOptions JSON Schema
27.39 LocalUser
27.39.1 LocalUser Field Description
-
name
Type: String
27.39.2 LocalUser JSON Schema
27.40 LocalV0User
27.40.1 LocalV0User Field Description
-
name
Type: String
27.40.2 LocalV0User JSON Schema
27.41 LdapAuthority
27.41.1 LdapAuthority Field Description
-
displayName
Type: String
-
id
Type: String
27.41.2 LdapAuthority JSON Schema
27.42 LicenseFacility
27.42.1 LicenseFacility Field Description
-
name
Type: String
-
value
Type: Integer
27.42.2 LicenseFacility JSON Schema
27.43 SystemId
27.43.1 SystemId Field Description
-
displayName
Type: String
-
id
Type: String
27.43.2 SystemId JSON Schema
27.44 GetNodesNode
27.44.1 GetNodesNode Field Description
-
displayName
Type: String
-
id
Type: String
27.44.2 GetNodesNode JSON Schema
27.45 GetSystemsProfilesProfile
27.45.1 GetSystemsProfilesProfile 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 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 27.46)
-
tcpPortRange
Restricts the tcp port range
Type: PortRange (section 27.46)
-
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 27.47)
-
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 27.29)
-
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 27.29)
-
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 27.48)
-
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
-
incomingDialStringRewriteRules
Type: Array of DialStringRewrite (section 27.14)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 27.14)
-
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
27.45.2 GetSystemsProfilesProfile JSON Schema
27.46 PortRange
27.46.1 PortRange Field Description
-
firstPort
First port of the port range
Type: Integer
-
lastPort
Last port of the port range
Type: Integer
27.46.2 PortRange JSON Schema
27.47 RemoteSipDomain
27.47.1 RemoteSipDomain Field Description
-
host
Type: String
-
iri
Type: String
-
port
Type: Integer
-
transport
Type: RemoteSipDomainTransport
Possible values:
-
udp
-
tcp
-
tls
-
sctp
-
tls-sctp
-
27.47.2 RemoteSipDomain JSON Schema
27.48 TelMatch
27.48.1 TelMatch Field Description
-
directory
Mandatory for "type=DIRECTORY".
Type: Array of String
-
extensionRange
Mandatory for "type=EXTENSION_RANGE".
Type: TelMatchExtensionRange (section 27.51)
-
list
Mandatory for "type=LIST".
Type: TelMatchList (section 27.80)
-
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
27.48.2 TelMatch JSON Schema
27.49 AddNodeResult
27.49.1 AddNodeResult Field Description
-
displayName
Type: String
-
id
Type: String
27.49.2 AddNodeResult JSON Schema
27.50 GetProviderProfilesProfile
27.50.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 27.51)
-
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 27.46)
-
tcpPortRange
The TCP port range.
Type: PortRange (section 27.46)
-
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 27.47)
-
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 27.52)
-
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
Primary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".
Type: String
-
secondaryProxyUri
Secondary 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 27.14)
-
outgoingDialStringRewriteRules
Type: Array of DialStringRewrite (section 27.14)
-
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 27.53)
-
telstra2ndTrunkGroup
Only for the Telstra EP (SIP Connect) profile. Connection options for the second trunk group.
Type: TelstraNthTrunkOptions (section 27.53)
-
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
27.50.2 GetProviderProfilesProfile JSON Schema
27.51 TelMatchExtensionRange
27.51.1 TelMatchExtensionRange Field Description
-
firstExtension
Type: String
-
lastExtension
Type: String
-
trunk
Type: String
-
zeroExtend
Type: Boolean
27.51.2 TelMatchExtensionRange JSON Schema
27.52 SipUserCredentials
27.52.1 SipUserCredentials Field Description
-
username
The SIP username
Type: String
-
password
The SIP password
Type: String
27.52.2 SipUserCredentials JSON Schema
27.53 TelstraNthTrunkOptions
27.53.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 27.52)
27.53.2 TelstraNthTrunkOptions JSON Schema
27.54 CertificateListEntry
27.54.1 CertificateListEntry Field Description
-
issuer
Type: String
-
subject
Type: String
-
validFrom
Type: String
-
validUntil
Type: String
27.54.2 CertificateListEntry JSON Schema
27.55 MatchPatternSegment
27.55.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
-
27.55.2 MatchPatternSegment JSON Schema
27.56 TelRewriteSegment
27.56.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
27.56.2 TelRewriteSegment JSON Schema
27.57 TagMatch
27.57.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
-
27.57.2 TagMatch JSON Schema
27.58 TagRewrite
27.58.1 TagRewrite Field Description
-
clearTags
Incicates if the existing tags should be removed.
Type: Boolean
-
operations
Type: Array of TagRewriteOperation (section 27.81)
27.58.2 TagRewrite JSON Schema
27.59 CryCertificate
27.59.1 CryCertificate Field Description
-
pem
The PEM of the certificate.
Type: String
27.59.2 CryCertificate JSON Schema
27.60 CryPrivateKey
27.60.1 CryPrivateKey Field Description
-
pem
The PEM of the private key.
Type: String
27.60.2 CryPrivateKey JSON Schema
27.61 MsTeamsSbaUser
27.61.1 MsTeamsSbaUser Field Description
-
lastActiveTime
Type: String
-
lastSyncTime
Type: String
-
sipUri
Type: String
-
userId
Type: String
27.61.2 MsTeamsSbaUser JSON Schema
27.62 TransportConnectionProxy
27.62.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
27.62.2 TransportConnectionProxy JSON Schema
27.63 SipbnAddress
27.63.1 SipbnAddress Field Description
-
iri
The IRI for this address.
Type: String
-
displayName
The display name for this address.
Type: String
27.63.2 SipbnAddress JSON Schema
27.64 SipsnRoute
27.64.1 SipsnRoute Field Description
-
iri
The URI of this route.
Type: String
27.64.2 SipsnRoute JSON Schema
27.65 TransportConnectionStatusCodeErrorFlags
27.65.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 27.82)
27.65.2 TransportConnectionStatusCodeErrorFlags JSON Schema
27.66 TransportConnectionAuthentication
27.66.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
27.66.2 TransportConnectionAuthentication JSON Schema
27.67 SipLoadBalancerTarget
27.67.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 27.83)
27.67.2 SipLoadBalancerTarget JSON Schema
27.68 SrvLoadBalancerTargetTemplate
27.68.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 27.65)
27.68.2 SrvLoadBalancerTargetTemplate JSON Schema
27.69 StaticUserDirectoryUser
27.69.1 StaticUserDirectoryUser Field Description
-
applicationRecords
Application specifc data depending on the use case of this directory.
Type: StaticUserDirectoryUserApplications (section 27.84)
-
displayName
The display name that is used to identify the user in the directory later on.
Type: String
27.69.2 StaticUserDirectoryUser JSON Schema
27.70 ResourcesMemory
27.70.1 ResourcesMemory Field Description
-
total
Type: long
-
used
Type: long
27.70.2 ResourcesMemory JSON Schema
27.71 RoutingDomainRouteEstablishment
27.71.1 RoutingDomainRouteEstablishment Field Description
-
adjustRoutingForwardProfileSettings
Only for "routingForwardProfileSelection=CREATE_NEW". If set to true the handling of media channels can be modified.
Type: Boolean
-
destinationDialStringRewriting
Only for "type=ROUTE".
Type: Array of RoutingTelRewrite (section 27.85)
-
destinationNodeId
The identifier of the destination node. This is mandatory for the value "type=ROUTE".
Type: String
-
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
-
TRANSCODING
-
BYPASS
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
-
-
routingForwardProfileSelection
Only for "type=ROUTE". 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.
-
NONE
Don't select a file.
-
-
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 27.85)
-
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
-
27.71.2 RoutingDomainRouteEstablishment JSON Schema
27.72 RoutingDomainRouteFilter
27.72.1 RoutingDomainRouteFilter Field Description
-
assertedDialString
You can specify a required structure of the asserted dial string.
Type: Array of TelMatch (section 27.48)
-
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 27.48)
-
firstDiversionDialString
You can specify a required structure of the first diversion dial string
Type: Array of TelMatch (section 27.48)
-
lastDiversionDialString
You can specify a required structure of the last diversion dial string
Type: Array of TelMatch (section 27.48)
-
lookupDirectories
If a lookup directory is selected then the dial string must be included in the directory.
Type: RoutingDomainRouteLookupDirectories (section 27.86)
-
sourceDialString
You can specify a required structure of the source dial string.
Type: Array of TelMatch (section 27.48)
-
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 27.48)
27.72.2 RoutingDomainRouteFilter JSON Schema
27.73 RoutingDomainRoutePathReplacement
27.73.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.
-
NONE
Don't select a file.
-
-
type
The action that is carried out if the route filter matches.
Type: RoutePathReplacementType
Possible values:
-
REPLACE
-
REJECT
-
27.73.2 RoutingDomainRoutePathReplacement JSON Schema
27.74 String
27.74.1 String Field Description
-
CASE_INSENSITIVE_ORDER
Type: Comparator
27.74.2 String JSON Schema
27.75 RoutingForwardProfile
27.75.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 27.87)
-
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
27.75.2 RoutingForwardProfile JSON Schema
27.76 SignalingForwardingOptions
27.76.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 27.88)
-
profile
Type: SignalingForwardingOptionsProfile
Possible values:
-
STANDARD
-
FULL
-
27.76.2 SignalingForwardingOptions JSON Schema
27.77 Backend
27.77.1 Backend Field Description
-
displayName
Type: String
-
id
Type: String
27.77.2 Backend JSON Schema
27.78 NetworkInterface
27.78.1 NetworkInterface Field Description
-
displayName
Type: String
-
id
Type: String
27.78.2 NetworkInterface JSON Schema
27.79 NetworkController
27.79.1 NetworkController Field Description
-
displayName
Type: String
-
id
Type: String
-
interface
Type: String
27.79.2 NetworkController JSON Schema
27.80 TelMatchList
27.80.1 TelMatchList Field Description
-
matches
Type: Array of TelMatch (section 27.48)
-
operator
The operator applied to the results of the "matches".
Type: TelMatchListOperator
Possible values:
-
OR
-
XOR
-
AND
-
NOT
-
27.80.2 TelMatchList JSON Schema
27.81 TagRewriteOperation
27.81.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
27.81.2 TagRewriteOperation JSON Schema
27.82 TransportConnectionStatusCodeErrorFlag
27.82.1 TransportConnectionStatusCodeErrorFlag Field Description
-
DOWN
Change the state to non-operational.
Type: TransportConnectionStatusCodeErrorFlag (section 27.82)
-
DOWN_RETRY_AFTER
Change the state to non-operational if the response message contains a Retry-After header.
Type: TransportConnectionStatusCodeErrorFlag (section 27.82)
-
FAILOVER
Perform failover to another transport connection, if possible.
Type: TransportConnectionStatusCodeErrorFlag (section 27.82)
-
TERMINATE_INCOMING
Terminate incoming traffic.
Type: TransportConnectionStatusCodeErrorFlag (section 27.82)
-
TERMINATE_OUTGOING
Terminate outgoing traffic.
Type: TransportConnectionStatusCodeErrorFlag (section 27.82)
27.82.2 TransportConnectionStatusCodeErrorFlag JSON Schema
27.83 SipLoadBalancerDefaultLoad
27.83.1 SipLoadBalancerDefaultLoad Field Description
-
HIGH
Type: SipLoadBalancerDefaultLoad (section 27.83)
-
LOW
Type: SipLoadBalancerDefaultLoad (section 27.83)
-
MEDIUM
Type: SipLoadBalancerDefaultLoad (section 27.83)
27.83.2 SipLoadBalancerDefaultLoad JSON Schema
27.84 StaticUserDirectoryUserApplications
27.84.1 StaticUserDirectoryUserApplications Field Description
-
associatedProvisioningDevices
Options for associated provisioning devices.
Type: Array of ProvisioningUserAssociatedDevice (section 27.89)
-
policy
Telephony policy settings for this user.
Type: SipPolicyUserData (section 27.90)
-
sipCredentials
Options for SIP authentication
Type: Credentials (section 27.30)
-
sipRegistrar
SIP registrar information.
Type: SipRegistrarUserData (section 27.91)
-
webrtc
WebRTC dial string and client authentication information.
Type: WebRtcUserData (section 27.92)
27.84.2 StaticUserDirectoryUserApplications JSON Schema
27.85 RoutingTelRewrite
27.85.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
27.85.2 RoutingTelRewrite JSON Schema
27.86 RoutingDomainRouteLookupDirectories
27.86.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
27.86.2 RoutingDomainRouteLookupDirectories JSON Schema
27.87 TelephonyForwarding
27.87.1 TelephonyForwarding Field Description
-
mediaNegotiationForwarder
Type: MediaNegotiationForwarder (section 27.93)
-
mediaNegotiationForwarderId
Type: String
-
signalingForwardingFromCalledToCalling
Type: SignalingForwardingOptions (section 27.76)
-
signalingForwardingFromCallingToCalled
Type: SignalingForwardingOptions (section 27.76)
27.87.2 TelephonyForwarding JSON Schema
27.88 NotifySipInfoFilter
27.88.1 NotifySipInfoFilter Field Description
-
maxContentLength
Type: Integer
-
mimeContentTypeName
Type: String
27.88.2 NotifySipInfoFilter JSON Schema
27.89 ProvisioningUserAssociatedDevice
27.89.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 27.94)
-
subId
The sub ID can be used to select sub-devices that are all listed under the same MAC address.
Type: String
27.89.2 ProvisioningUserAssociatedDevice JSON Schema
27.90 SipPolicyUserData
27.90.1 SipPolicyUserData Field Description
-
rewriteTableIncoming
Dial string rewriting rules for incoming messages.
Type: Array of DialStringRewrite (section 27.14)
-
rewriteTableOutgoing
Dial string rewriting rules for outgoing messages.
Type: Array of DialStringRewrite (section 27.14)
-
sippgIncoming
SIP privacy settings for incoming messages.
Type: SipPolicyPrivacyOptions (section 27.95)
-
sippgOutgoing
SIP privacy settings for outgoing messages.
Type: SipPolicyPrivacyOptions (section 27.95)
27.90.2 SipPolicyUserData JSON Schema
27.91 SipRegistrarUserData
27.91.1 SipRegistrarUserData Field Description
-
dialStrings
SIP node registrar dial string settings.
Type: Array of SipRegistrarUserDialStrings (section 27.96)
-
failover
SIP node registrar failover settings.
Type: SipRegistrarUserFailover (section 27.97)
27.91.2 SipRegistrarUserData JSON Schema
27.92 WebRtcUserData
27.92.1 WebRtcUserData Field Description
-
address
The address of the WebRTC user.
Type: TelAddress (section 27.98)
-
credentials
The credentials of the WebRTC user.
Type: Credentials (section 27.30)
27.92.2 WebRtcUserData JSON Schema
27.93 MediaNegotiationForwarder
27.93.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 27.99)
-
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
27.93.2 MediaNegotiationForwarder JSON Schema
27.94 ProvisioningStaticVariableTable
This JSON object can contain any key value combination if the value is a string.
27.94.1 ProvisioningStaticVariableTable JSON Schema
27.95 SipPolicyPrivacyOptions
27.95.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)
-
27.95.2 SipPolicyPrivacyOptions JSON Schema
27.96 SipRegistrarUserDialStrings
27.96.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 27.48)
-
addresses
The user can be reached at all of this dial strings.
Type: Array of TelAddress (section 27.98)
-
matches
The user can be reached at all dial strings that pass the filters in this list.
Type: Array of TelMatch (section 27.48)
27.96.2 SipRegistrarUserDialStrings JSON Schema
27.97 SipRegistrarUserFailover
27.97.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
27.97.2 SipRegistrarUserFailover JSON Schema
27.98 TelAddress
27.98.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
27.98.2 TelAddress JSON Schema
27.99 MediaTranscodingOptions
27.99.1 MediaTranscodingOptions Field Description
-
displayName
The name shown in the anynode frontend.
Type: String
-
id
The id of this object.
Type: String