29 JSON Objects

29.1 SoftwareVersion

29.1.1 SoftwareVersion Field Description

  • VersionMajor

    Type: Integer

  • VersionMinor

    Type: Integer

  • VersionRelease

    Type: Integer

29.1.2 SoftwareVersion Powershell class

class SoftwareVersion {
        [int] $VersionMajor
        [int] $VersionMinor
        [int] $VersionRelease
}

29.2 TracingOptionsJson

29.2.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

29.2.2 TracingOptionsJson Powershell class

class TracingOptionsJson {
        [string] $Selection
        [bool] $TraceActive
        [TracingFileOptions] $Options
}

29.3 TracingFileOptions

29.3.1 TracingFileOptions Field Description

  • 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

29.3.2 TracingFileOptions Powershell class

class TracingFileOptions {
        [int] $Count
        [string] $Flags
        [int] $Size
}

29.4 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

29.4.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 29.6

  • StructuralPattern

    The rewrite rule will only match dial strings according to the pattern you specify.

    Type: Array of MatchPatternSegment section 29.7

  • 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 29.8

  • BranchRewrites

    Rewrites that are processed if the dial string matches the condition.

    Type: Array of DialStringRewrite section 29.4

  • BranchElseRewrites

    Rewrites that are processed if the dial string does not match the condition.

    Type: Array of DialStringRewrite section 29.4

  • 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 29.9

  • 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 29.10

  • 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

29.4.2 DialStringRewrite Powershell class

class DialStringRewrite {
        [string] $RewriteType
        [string] $MatchType
        [string] $Prefix
        [string] $Suffix
        [string] $WildcardPattern
        [string[]] $MatchDirectory
        [TelMatchExtensionRange] $MatchExtensionRange
        [MatchPatternSegment[]] $StructuralPattern
        [int] $DeleteLeadingCharacters
        [int] $DeleteTrailingCharacters
        [string] $AddPrefix
        [string] $AddSuffix
        [string] $DisplayName
        $AddExtTrailingDigits
        [TelRewriteSegment[]] $RewriteSegments
        [DialStringRewrite[]] $BranchRewrites
        [DialStringRewrite[]] $BranchElseRewrites
        [TagMatch] $MatchTags
        [TagRewrite] $TagRewrite
        [string[]] $ApplyTo
        [bool] $ApplyToAllDialStrings
        [bool] $ApplyToDestinationDialString
        [bool] $ApplyToSourceDialString
        [bool] $SkipFurtherRules
        [bool] $SkipRulesBelow
        [bool] $ClearDisplayName
        [string] $Case
        [string] $Comment
        [int] $Index
}

29.5 DialStringRewriting

29.5.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 29.4

29.5.2 DialStringRewriting Powershell class

class DialStringRewriting {
        [string] $DisplayName
        [string] $Id
        [DialStringRewrite[]] $Rules
}

29.6 TelMatchExtensionRange

29.6.1 TelMatchExtensionRange Field Description

  • FirstExtension

    Type: String

  • LastExtension

    Type: String

  • Trunk

    Type: String

  • ZeroExtend

    Type: Boolean

29.6.2 TelMatchExtensionRange Powershell class

class TelMatchExtensionRange {
        [string] $FirstExtension
        [string] $LastExtension
        [string] $Trunk
        [bool] $ZeroExtend
}

29.7 MatchPatternSegment

29.7.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

29.7.2 MatchPatternSegment Powershell class

class MatchPatternSegment {
        [string] $Comment
        [string] $Digits
        [bool] $GreedyMatch
        [int] $MaxCount
        [int] $MinCount
        [string] $Text
        [string] $Type
}

29.8 TelRewriteSegment

29.8.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

29.8.2 TelRewriteSegment Powershell class

class TelRewriteSegment {
        [int] $Capture
        [int] $DelLeading
        [int] $DelTrailing
        [int] $KeepLeading
        [int] $KeepTrailing
        [string] $Prefix
        [string] $Suffix
}

29.9 TagMatch

29.9.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

29.9.2 TagMatch Powershell class

class TagMatch {
        [string[]] $TagSet
        [string] $Type
}

29.10 TagRewrite

29.10.1 TagRewrite Field Description

  • ClearTags

    Incicates if the existing tags should be removed.

    Type: Boolean

  • Operations

    Type: Array of TagRewriteOperation section 29.66

29.10.2 TagRewrite Powershell class

class TagRewrite {
        [bool] $ClearTags
        [TagRewriteOperation[]] $Operations
}

29.11 AnynodeConfigState

29.11.1 AnynodeConfigState Field Description

  • Committed

    Indicates if all changes to the configuration are committed.

    Type: Boolean

29.11.2 AnynodeConfigState Powershell class

class AnynodeConfigState {
        [bool] $Committed
}

29.12 License

29.12.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 29.67

  • Constaints

    The constraints for this license.

    Type: String

29.12.2 License Powershell class

class License {
        [string] $Status
        [string] $Identifier
        [string] $Name
        $ValidFrom
        $ValidUntil
        $SoftwareUpdateServiceUntil
        [string] $RequiredSystemIds
        [string] $InvalidatedLicences
        [string] $Products
        [LicenseFacility[]] $Facilities
        [string] $Constaints
}

29.13 MaintenanceMode

29.13.1 MaintenanceMode Field Description

  • ModeActive

    Indicates if the maintenance mode should be activated or deactivated.

    Type: Boolean

29.13.2 MaintenanceMode Powershell class

class MaintenanceMode {
        [bool] $ModeActive
}

29.14 LdapUserJson

29.14.1 LdapUserJson Field Description

  • Name

    Type: String

  • LdapAuthorityId

    Type: String

29.14.2 LdapUserJson Powershell class

class LdapUserJson {
        [string] $Name
        [string] $LdapAuthorityId
}

29.15 CustomUserOptions

29.15.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

  • Local

    Type: LocalUser section 29.69

  • LocalUserName

    Type: String

  • LocalV0

    Type: LocalV0User section 29.70

  • RoleBuiltIns

    Type: String

  • Roles

    Type: Array of String

29.15.2 CustomUserOptions Powershell class

class CustomUserOptions {
        $BlockedUntil
        [string] $DisplayName
        [string] $EmailAddress
        [bool] $Enabled
        [int] $FailedLogins
        [string] $Id
        $LastFailedLogin
        $LastLogin
        [LdapUserJson[]] $LdapUsers
        [LocalUser] $Local
        [string] $LocalUserName
        [LocalV0User] $LocalV0
        [string] $RoleBuiltIns
        [string[]] $Roles
}

29.16 Role

29.16.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

29.16.2 Role Powershell class

class Role {
        [string] $DisplayName
        [string] $Id
        [Permissions] $Permissions
}

29.17 Permissions

29.17.1 Permissions Powershell class

class Permissions {
}

29.18 MediaRecording

29.18.1 MediaRecording Field Description

  • MediaRecordingActive

    Type: Boolean

29.18.2 MediaRecording Powershell class

class MediaRecording {
        [bool] $MediaRecordingActive
}

29.19 MsTeamsSbaOptions

29.19.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

  • 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 29.21

  • Certificate

    The certificate for the SBA service

    Type: CryCertificate section 29.22

  • 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 29.23

29.19.2 MsTeamsSbaOptions Powershell class

class MsTeamsSbaOptions {
        [MsTeamsSbaFingerprint] $Fingerprint
        [string] $Identity
        [string] $TenantId
        [string] $Application
        [string] $Secret
        [MsTeamsSbaLog] $Log
        [CryCertificate] $Certificate
        [string] $IpAddress
        [CryPrivateKey] $PrivateKey
}

29.20 MsTeamsSbaFingerprint

29.20.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

29.20.2 MsTeamsSbaFingerprint Powershell class

class MsTeamsSbaFingerprint {
        [string] $Source
        [string] $Value
        [string] $MsTeamsNodeId
}

29.21 MsTeamsSbaLog

29.21.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

29.21.2 MsTeamsSbaLog Powershell class

class MsTeamsSbaLog {
        [string] $Directory
        [string] $Level
        [int] $MaxArchiveFiles
}

29.22 CryCertificate

29.22.1 CryCertificate Field Description

  • Pem

    The PEM of the certificate.

    Type: String

29.22.2 CryCertificate Powershell class

class CryCertificate {
        [string] $Pem
}

29.23 CryPrivateKey

29.23.1 CryPrivateKey Field Description

  • Pem

    The PEM of the private key.

    Type: String

29.23.2 CryPrivateKey Powershell class

class CryPrivateKey {
        [string] $Pem
}

29.24 MsTeamsSbaStatus

29.24.1 MsTeamsSbaStatus Field Description

  • State

    Type: MsTeamsSbaDiagnosticsServiceState section 29.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 29.73

  • LastSbaServiceStatusRequestState

    This is the state of the last HTTP request to the SBA service.

    Type: SbaHttpRequestState section 29.74

29.24.2 MsTeamsSbaStatus Powershell class

class MsTeamsSbaStatus {
        [string] $State
        $Enalbed
        $ReadOnly
        [SbaServiceDiagnosticState] $SbaServiceStatus
        [SbaHttpRequestState] $LastSbaServiceStatusRequestState
}

29.25 AddSystemSipTransport

29.25.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

29.25.2 AddSystemSipTransport Powershell class

class AddSystemSipTransport {
        [string] $Selection
        [bool] $UsedByOtherNodes
        [string] $SharedSipTransportComment
        [string] $SipTransportId
}

29.26 PortRange

29.26.1 PortRange Field Description

  • FirstPort

    First port of the port range

    Type: Integer

  • LastPort

    Last port of the port range

    Type: Integer

29.26.2 PortRange Powershell class

class PortRange {
        [int] $FirstPort
        [int] $LastPort
}

29.27 RemoteSipDomain

29.27.1 RemoteSipDomain Field Description

  • Host

    Type: String

  • Iri

    Type: String

  • Port

    Type: Integer

  • Transport

    Type: RemoteSipDomainTransport

    Possible values:

    • udp

    • tcp

    • tls

    • sctp

    • tls-sctp

29.27.2 RemoteSipDomain Powershell class

class RemoteSipDomain {
        [string] $Host
        [string] $Iri
        [int] $Port
        [string] $Transport
}

29.28 SipCredentials

29.28.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

29.28.2 SipCredentials Powershell class

class SipCredentials {
        [string] $AuthenticationProfileId
        [string] $DirectoryName
        [string] $Password
        [string] $UserIdentifier
        [string] $Username
}

29.29 TelMatch

29.29.1 TelMatch Field Description

  • Directory

    Mandatory for "type=DIRECTORY".

    Type: Array of String

  • ExtensionRange

    Mandatory for "type=EXTENSION_RANGE".

    Type: TelMatchExtensionRange section 29.6

  • List

    Mandatory for "type=LIST".

    Type: TelMatchList section 29.78

  • Plain

    Mandatory for "type=PLAIN".

    Type: TelMatchPlain

  • Type

    Type: TelMatchType

    Possible values:

    • anything

    • never

    • list

    • prefixSuffix

    • dialStringList

    • structuralPattern

    • wildcardPattern

    • extensionRange

  • WildcardPattern

    Mandatory for "type=WILDCARD".

    Type: String

29.29.2 TelMatch Powershell class

class TelMatch {
        [string[]] $Directory
        [TelMatchExtensionRange] $ExtensionRange
        [TelMatchList] $List
        [TelMatchPlain] $Plain
        [string] $Type
        [string] $WildcardPattern
}

29.30 NetworkPeerWhitelistEntry

29.30.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

29.30.2 NetworkPeerWhitelistEntry Powershell class

class NetworkPeerWhitelistEntry {
        [string[]] $DnsLookup
        [string] $Host
        [string] $IpVersion
        [int] $SubnetPrefixLength
}

29.31 AddSystemSipNodeWhitelist

29.31.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 29.30

29.31.2 AddSystemSipNodeWhitelist Powershell class

class AddSystemSipNodeWhitelist {
        [bool] $AllowOnlyNegotiatedPeersForRtp
        [NetworkPeerWhitelistEntry[]] $Entries
}

29.32 SipUserCredentials

29.32.1 SipUserCredentials Field Description

  • Username

    The SIP username

    Type: String

  • Password

    The SIP password

    Type: String

29.32.2 SipUserCredentials Powershell class

class SipUserCredentials {
        [string] $Username
        [string] $Password
}

29.33 TelstraNthTrunkOptions

29.33.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 29.32

29.33.2 TelstraNthTrunkOptions Powershell class

class TelstraNthTrunkOptions {
        [string] $SipProxyIri
        [string] $RegistrarIri
        [string] $AorUserName
        [bool] $AuthenticationEnabled
        [SipUserCredentials] $Credentials
}

29.34 SipNodeTransportConnection

29.34.1 SipNodeTransportConnection Field Description

  • MatchingCondition

    The matching condition is used to filter for which calls the transport connection will be used.

    Type: TelMatch section 29.29

  • TransportConnectionId

    The id of the transport connection

    Type: String

29.34.2 SipNodeTransportConnection Powershell class

class SipNodeTransportConnection {
        [TelMatch] $MatchingCondition
        [string] $TransportConnectionId
}

29.35 StandardTransportConnection

29.35.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

  • 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

  • AuthenticationPolicy

    Credentials to be used for authentication. This value only applies if "authenticationEnabled" is set to true.

    Type: SipCredentials section 29.28

  • Proxy

    The proxy to be used.

    Type: TransportConnectionProxy section 29.37

  • Registration

    The registration to be used.

    Type: TransportConnectionRegistration

29.35.2 StandardTransportConnection Powershell class

class StandardTransportConnection {
        [AssertedUri2] $AssertedAddress
        [bool] $AuthenticationEnabled
        [string] $ConditionId
        [SipCredentials] $AuthenticationPolicy
        [TransportConnectionProxy] $Proxy
        [TransportConnectionRegistration] $Registration
}

29.36 AssertedUri2

29.36.1 AssertedUri2 Field Description

  • AssertedDisplayName

    The desired display name.

    Type: String

  • AssertedURI

    The desired URI.

    Type: String

29.36.2 AssertedUri2 Powershell class

class AssertedUri2 {
        [string] $AssertedDisplayName
        [string] $AssertedURI
}

29.37 TransportConnectionProxy

29.37.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

29.37.2 TransportConnectionProxy Powershell class

class TransportConnectionProxy {
        [bool] $Flow
        [string] $Iri
        [bool] $OmitInitialRouteSet
        [bool] $Options
        [bool] $OptionsNextHop
}

29.38 TransportConnectionRegistration

29.38.1 TransportConnectionRegistration Field Description

  • AddressOfRecord

    Address-Of-Record (to be registered URI)

    Type: String

  • SipDomain

    SIP Domain (Registrar)

    Type: String

29.38.2 TransportConnectionRegistration Powershell class

class TransportConnectionRegistration {
        [string] $AddressOfRecord
        [string] $SipDomain
}

29.39 SipbnAddress

29.39.1 SipbnAddress Field Description

  • Iri

    The IRI for this address.

    Type: String

  • DisplayName

    The display name for this address.

    Type: String

29.39.2 SipbnAddress Powershell class

class SipbnAddress {
        [string] $Iri
        [string] $DisplayName
}

29.40 SipsnRoute

29.40.1 SipsnRoute Field Description

  • Iri

    The URI of this route.

    Type: String

29.40.2 SipsnRoute Powershell class

class SipsnRoute {
        [string] $Iri
}

29.41 TransportConnectionStatusCodeErrorFlags

29.41.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 29.83

29.41.2 TransportConnectionStatusCodeErrorFlags Powershell class

class TransportConnectionStatusCodeErrorFlags {
        [string] $StatusCode
        [TransportConnectionStatusCodeErrorFlag] $ErrorHandling
}

29.42 TransportConnectionAuthentication

29.42.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

29.42.2 TransportConnectionAuthentication Powershell class

class TransportConnectionAuthentication {
        [string] $AuthenticationProfileId
        [string] $Password
        [string] $Username
}

29.43 PlainTransportConnection

29.43.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 29.39

  • 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 29.39

  • 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 29.40

  • 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 29.41

  • Authentication

    If the Plain Transport Connection to be created requires separate authentication data then this can be configured here.

    Type: TransportConnectionAuthentication section 29.42

29.43.2 PlainTransportConnection Powershell class

class PlainTransportConnection {
        [SipbnAddressJson] $Uri
        [SipbnAddressJson] $AssertedUri
        [string[]] $Properties
        [SipsnRoute[]] $InitialRouteSet
        [string] $SipTransport
        [string[]] $OptionsErrorFlags
        [string[]] $TimeoutErrorFlags
        [string[]] $TransportErrorFlags
        [TransportConnectionStatusCodeErrorFlags[]] $StatusCodesErrorFlags
        [TransportConnectionAuthentication] $Authentication
}

29.44 SipLoadBalancerTarget

29.44.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 29.84

29.44.2 SipLoadBalancerTarget Powershell class

class SipLoadBalancerTarget {
        [string] $RouteId
        [string[]] $TargetIriFlags
        [string] $DefaultLoad
}

29.45 SipLoadBalancingTransportConnection

29.45.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 29.44

29.45.2 SipLoadBalancingTransportConnection Powershell class

class SipLoadBalancingTransportConnection {
        [string[]] $Properties
        [SipLoadBalancerTarget[]] $Targets
}

29.46 SipRegistrationAsTransportConnection

29.46.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 29.42

  • AorUri

    The address-of-record specifies who is to be registered.

    Type: SipbnAddress section 29.39

  • 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 29.39

  • 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

29.46.2 SipRegistrationAsTransportConnection Powershell class

class SipRegistrationAsTransportConnection {
        [string] $Registrar
        [TransportConnectionAuthentication] $Authentication
        [SipbnAddressJson] $AorUri
        [SipbnAddressJson] $AssertedUri
        [string] $SipUserAgentStackId
        [string] $InnerTransportConnectionId
}

29.47 SrvLoadBalancerTargetTemplate

29.47.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 29.41

29.47.2 SrvLoadBalancerTargetTemplate Powershell class

class SrvLoadBalancerTargetTemplate {
        [string[]] $Properties
        [string[]] $OptionsErrorFlags
        [string[]] $TimeoutErrorFlags
        [string[]] $TransportErrorFlags
        [TransportConnectionStatusCodeErrorFlags[]] $StatusCodesErrorFlags
}

29.48 SrvLoadBalancer

29.48.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 29.47

29.48.2 SrvLoadBalancer Powershell class

class SrvLoadBalancer {
        [string] $SipTransportId
        [string] $Domain
        [string] $TransportProtocol
        [SrvLoadBalancerTargetTemplate] $TargetTemplateOptions
}

29.49 AssertedUri

29.49.1 AssertedUri Field Description

  • AssertedDisplayName

    The desired display name.

    Type: String

  • URI

    The desired URI.

    Type: String

29.49.2 AssertedUri Powershell class

class AssertedUri {
        [string] $AssertedDisplayName
        [string] $URI
}

29.50 Resources

29.50.1 Resources Field Description

29.50.2 Resources Powershell class

class Resources {
        [int] $Cpu
        [ResourcesMemory] $Disk
        [ResourcesMemory] $Ram
}

29.51 RequestRouterSideOptions

29.51.1 RequestRouterSideOptions Field Description

  • SipTransportId

    The id of the SIP transport object.

    Type: String

  • TransportConnectionId

    The id of the transport connection object.

    Type: String

29.51.2 RequestRouterSideOptions Powershell class

class RequestRouterSideOptions {
        [string] $SipTransportId
        [string] $TransportConnectionId
}

29.52 GetRoutingDomainOptions

29.52.1 GetRoutingDomainOptions Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

  • Routes

    Type: Array of RoutingDomainRouteV0

  • SourceNodes

    Type: Array of String

29.52.2 GetRoutingDomainOptions Powershell class

class GetRoutingDomainOptions {
        [string] $DisplayName
        [string] $Id
        [RoutingDomainRouteV0] $Routes
        [String] $SourceNodes
}

29.53 RoutingDomainRouteEstablishment

29.53.1 RoutingDomainRouteEstablishment Field Description

  • DestinationDialStringRewriting

    Only for "type=REDIRECT".

    Type: Array of RoutingTelRewrite section 29.88

  • 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 29.89

  • 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

29.53.2 RoutingDomainRouteEstablishment Powershell class

class RoutingDomainRouteEstablishment {
        [RoutingTelRewrite[]] $DestinationDialStringRewriting
        [string] $ParallelCallDialStringDirectoryId
        [String] $ParallelCalls
        [string] $RejectStatus
        [RoutingDomainRouteEstablishAccept[]] $RoutingTargets
        [bool] $SkipIfNodeNotOperational
        [string] $Type
}

29.54 RoutingDomainRouteFilter

29.54.1 RoutingDomainRouteFilter Field Description

  • AssertedDialString

    You can specify a required structure of the asserted dial string.

    Type: Array of TelMatch section 29.29

  • 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 29.29

  • FirstDiversionDialString

    You can specify a required structure of the first diversion dial string

    Type: Array of TelMatch section 29.29

  • LastDiversionDialString

    You can specify a required structure of the last diversion dial string

    Type: Array of TelMatch section 29.29

  • LookupDirectories

    If a lookup directory is selected then the dial string must be included in the directory.

    Type: RoutingDomainRouteLookupDirectories section 29.90

  • SourceDialString

    You can specify a required structure of the source dial string.

    Type: Array of TelMatch section 29.29

  • 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 29.29

29.54.2 RoutingDomainRouteFilter Powershell class

class RoutingDomainRouteFilter {
        [TelMatch[]] $AssertedDialString
        [string] $ConditionId
        [TelMatch[]] $DestinationDialString
        [TelMatch[]] $FirstDiversionDialString
        [TelMatch[]] $LastDiversionDialString
        [RoutingDomainRouteLookupDirectories] $LookupDirectories
        [TelMatch[]] $SourceDialString
        [String] $SourceNodeIds
        [TelMatch[]] $TransferrerDialString
}

29.55 RoutingDomainRoutePathReplacement

29.55.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

29.55.2 RoutingDomainRoutePathReplacement Powershell class

class RoutingDomainRoutePathReplacement {
        [bool] $AdjustAcceptNewForwarderDomain
        [string] $RoutingForwardProfileDisplayName
        [string] $RoutingForwardProfileSelection
        [string] $Type
}

29.56 RoutingDomainRoute

29.56.1 RoutingDomainRoute Field Description

  • DisplayName

    Type: String

  • Establishment

    Only for "mode=establishment".

    Type: RoutingDomainRouteEstablishment section 29.53

  • Filters

    Filters determine when this route will be used for incoming or outgoing calls.

    Type: Array of RoutingDomainRouteFilter section 29.54

  • PathReplacement

    Only for "mode=pathReplacement".

    Type: RoutingDomainRoutePathReplacement section 29.55

  • 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

29.56.2 RoutingDomainRoute Powershell class

class RoutingDomainRoute {
        [string] $DisplayName
        [RoutingDomainRouteEstablishment] $Establishment
        [RoutingDomainRouteFilter] $Filters
        [RoutingDomainRoutePathReplacement] $PathReplacement
        [string] $SupervisionId
        [bool] $UseRouteSupervision
        [bool] $UseUnconditionalRouting
}

29.57 RoutingDomainRouteV0

29.57.1 RoutingDomainRouteV0 Field Description

  • DisplayName

    Type: String

  • Establishment

    Only for "mode=establishment".

    Type: RoutingDomainRouteEstablishmentV0 section 29.91

  • Filters

    Filters determine when this route will be used for incoming or outgoing calls.

    Type: Array of RoutingDomainRouteFilter section 29.54

  • PathReplacement

    Only for "mode=pathReplacement".

    Type: RoutingDomainRoutePathReplacement section 29.55

  • 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

29.57.2 RoutingDomainRouteV0 Powershell class

class RoutingDomainRouteV0 {
        [string] $DisplayName
        [RoutingDomainRouteEstablishmentV0] $Establishment
        [RoutingDomainRouteFilter] $Filters
        [RoutingDomainRoutePathReplacement] $PathReplacement
        [string] $SupervisionId
        [bool] $UseRouteSupervision
        [bool] $UseUnconditionalRouting
}

29.58 SignalingForwardingOptions

29.58.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 29.93

  • Profile

    Type: SignalingForwardingOptionsProfile

    Possible values:

    • STANDARD

    • FULL

29.58.2 SignalingForwardingOptions Powershell class

class SignalingForwardingOptions {
        [bool] $ACTIVE_APPARENT_STATE
        [bool] $ADDRESS
        [bool] $ASSERTED_ADDRESS
        [bool] $DESTINATION_ADDRESS
        [bool] $DESTINATION_USER
        [bool] $END_REASON
        [bool] $HOLD
        [bool] $MWI_REQUEST_SIP_DESTINATION_ADDRESS
        [bool] $MWI_REQUEST_SIP_SOURCE_ADDRESS
        [bool] $MWI_RESPONSE_REASON
        [bool] $MWI_RESPONSE_SIP_REASON
        [bool] $NOTIFY_SIP_INFO
        [bool] $PRIORITY
        [bool] $PROCEEDING
        [bool] $PROCEEDING_RINGING
        [bool] $REDIRECT_HISTORY
        [bool] $RINGING
        [bool] $SIP_ADDRESS
        [bool] $SIP_ASSERTED_ADDRESS
        [bool] $SIP_DESTINATION_ADDRESS
        [bool] $SIP_END_REASON
        [bool] $SIP_HEADER_CALL_INFO
        [bool] $SIP_HEADER_DIVERSION
        [bool] $SIP_HEADER_HISTORY_INFO
        [bool] $SIP_HEADER_ORGANIZATION
        [bool] $SIP_HEADER_PRIORITY
        [bool] $SIP_HEADER_PRIVACY
        [bool] $SIP_HEADER_P_ASSERTED_IDENTITY
        [bool] $SIP_HEADER_P_CALLED_PARTY_ID
        [bool] $SIP_HEADER_REFERRED_BY
        [bool] $SIP_HEADER_REMOTE_PARTY_ID
        [bool] $SIP_HEADER_SERVER
        [bool] $SIP_HEADER_SUBJECT
        [bool] $SIP_HEADER_USER_AGENT
        [bool] $SIP_MSFT_GEOLOCATION
        [bool] $SIP_PRIORITY
        [bool] $SIP_PRIVACY
        [bool] $SIP_REDIRECT_HISTORY
        [bool] $SIP_REFERRER_ADDRESS
        [bool] $SIP_SIPSNX_HEADER_P_ACCESS_NETWORK_INFO
        [bool] $SIP_SIPSNX_HEADER_P_RECORDING_FROM
        [bool] $SIP_SIPSNX_HEADER_P_RECORDING_TAPPED
        [bool] $SIP_SIPSNX_HEADER_P_RECORDING_TO
        [bool] $TRANSFERRER_ADDRESS
        [bool] $USER
        [NotifySipInfoFilter[]] $NotifySipInfoFilters
        [string] $Profile
}

29.59 WebserverConnectorNetworkOptions

29.59.1 WebserverConnectorNetworkOptions Field Description

  • InterfaceIdentifier

    The identifier of the network interface. Use section 22.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

29.59.2 WebserverConnectorNetworkOptions Powershell class

class WebserverConnectorNetworkOptions {
        [string] $InterfaceIdentifier
        [string] $IpAddress
        [string] $IpVersion
}

29.60 WebserverConnectorTlsOptions

29.60.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 29.23

  • Certificate

    The server certificate.

    Type: CryCertificate section 29.22

  • ExtraCertificates

    Additional chain certificates that are needed for clients to validate the server certificate.

    Type: Array of CryCertificate section 29.22

  • 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 29.22

29.60.2 WebserverConnectorTlsOptions Powershell class

class WebserverConnectorTlsOptions {
        [TlsProtocol] $Protocols
        [CryPrivateKey] $PrivateKey
        [CryCertificate] $Certificate
        [CryCertificate] $ExtraCertificates
        [bool] $DemandClientCertificate
        [bool] $HostnameVerification
        [CryCertificate] $TrustedCertificates
}

29.61 HotStandbyOptions

29.61.1 HotStandbyOptions Field Description

  • MainSystem

    The options for the main system

    Type: HotStandbyMainSystemOptions section 29.62

  • StandbySystem

    The options for the standby system

    Type: HotStandbyStandbySystemOptions section 29.63

29.61.2 HotStandbyOptions Powershell class

class HotStandbyOptions {
        [HotStandbyMainSystemOptions] $MainSystem
        [HotStandbyStandbySystemOptions] $StandbySystem
}

29.62 HotStandbyMainSystemOptions

29.62.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 29.99

29.62.2 HotStandbyMainSystemOptions Powershell class

class HotStandbyMainSystemOptions {
        [string] $ActiveCondition
        [bool] $ActiveInMaintenanceMode
        [bool] $DisabledHere
        [string] $HandoverCondition
        [int] $HandoverHoldTimeout
        [string] $IpcClientId
        [int] $LinkActivityTimeout
        [int] $LinkPingInterval
        [int] $MaxLinkRetryTimeout
        [int] $MinLinkRetryTimeout
        [string] $RecoveryCondition
        [int] $RecoveryHoldTimeout
        [string] $RecoveryMode
        [int] $RecoveryTimeout
        [HotStandbyReplicationOptions] $ReplicationOptions
}

29.63 HotStandbyStandbySystemOptions

29.63.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 29.99

29.63.2 HotStandbyStandbySystemOptions Powershell class

class HotStandbyStandbySystemOptions {
        [string] $ActiveCondition
        [bool] $ActiveInMaintenanceMode
        [bool] $DisabledHere
        [int] $InitialStandbyTimeout
        [string] $RecoveryCondition
        [HotStandbyReplicationOptions] $ReplicationOptions
}

29.64 AddHotStandbyResponse

29.64.1 AddHotStandbyResponse Field Description

  • HotStandbyId

    Type: String

  • IpcClientId

    Type: String

  • NetworkControllerId

    Type: String

  • NetworkSecurityProfileId

    Type: String

29.64.2 AddHotStandbyResponse Powershell class

class AddHotStandbyResponse {
        [string] $HotStandbyId
        [string] $IpcClientId
        [string] $NetworkControllerId
        [string] $NetworkSecurityProfileId
}

29.65 HotStandbyStatus

29.65.1 HotStandbyStatus Field Description

  • HandoverPossible

    Type: Boolean

  • LinkStatus

    Type: HotStandbyLinkStatus section 29.100

  • MainEnabled

    Type: Boolean

  • MainLinkActive

    Type: Boolean

  • MainRoleStatus

    Type: HotStandbyMainRoleStatus section 29.101

  • MainSetEnabledPossible

    Type: Boolean

  • MainStatus

    Type: HotStandbyMainSystemStatus section 29.102

  • OnlyImmediateRoleChangePossible

    Type: Boolean

  • RecoveryPossible

    Type: Boolean

  • StandbyEnabled

    Type: Boolean

  • StandbyLinkActive

    Type: Boolean

  • StandbyRoleStatus

    Type: HotStandbyStandbyRoleStatus section 29.103

  • StandbySetEnabledPossible

    Type: Boolean

  • StandbyStatus

    Type: HotStandbyStandbySystemStatus section 29.104

29.65.2 HotStandbyStatus Powershell class

class HotStandbyStatus {
        [bool] $HandoverPossible
        [string] $LinkStatus
        [bool] $MainEnabled
        [bool] $MainLinkActive
        [string] $MainRoleStatus
        [bool] $MainSetEnabledPossible
        [string] $MainStatus
        [bool] $OnlyImmediateRoleChangePossible
        [bool] $RecoveryPossible
        [bool] $StandbyEnabled
        [bool] $StandbyLinkActive
        [string] $StandbyRoleStatus
        [bool] $StandbySetEnabledPossible
        [string] $StandbyStatus
}

29.66 TagRewriteOperation

29.66.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

29.66.2 TagRewriteOperation Powershell class

class TagRewriteOperation {
        [string] $Type
        [string] $Tag
}

29.67 LicenseFacility

29.67.1 LicenseFacility Field Description

  • Name

    Type: String

  • Value

    Type: Integer

29.67.2 LicenseFacility Powershell class

class LicenseFacility {
        [string] $Name
        [int] $Value
}

29.68 SystemId

29.68.1 SystemId Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

29.68.2 SystemId Powershell class

class SystemId {
        [string] $DisplayName
        [string] $Id
}

29.69 LocalUser

29.69.1 LocalUser Field Description

  • Name

    Type: String

29.69.2 LocalUser Powershell class

class LocalUser {
        [string] $Name
}

29.70 LocalV0User

29.70.1 LocalV0User Field Description

  • Name

    Type: String

29.70.2 LocalV0User Powershell class

class LocalV0User {
        [string] $Name
}

29.71 LdapAuthority

29.71.1 LdapAuthority Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

29.71.2 LdapAuthority Powershell class

class LdapAuthority {
        [string] $DisplayName
        [string] $Id
}

29.72 MsTeamsSbaDiagnosticsServiceState

29.72.1 MsTeamsSbaDiagnosticsServiceState Field Description

  • DISABLED

    Type: MsTeamsSbaDiagnosticsServiceState section 29.72

  • GETTING_DIAGNOSTICS_STATE

    Type: MsTeamsSbaDiagnosticsServiceState section 29.72

  • GETTING_USERS

    Type: MsTeamsSbaDiagnosticsServiceState section 29.72

  • IDLE

    Type: MsTeamsSbaDiagnosticsServiceState section 29.72

29.72.2 MsTeamsSbaDiagnosticsServiceState Powershell class

enum MsTeamsSbaDiagnosticsServiceState {
        DISABLED
        GETTING_DIAGNOSTICS_STATE
        GETTING_USERS
        IDLE
}

29.73 SbaServiceDiagnosticState

29.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

29.73.2 SbaServiceDiagnosticState Powershell class

class SbaServiceDiagnosticState {
        [string] $State
        [string] $Status
}

29.74 SbaHttpRequestState

29.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 29.105

  • ResponseError

    This value is populated if an error occurs when requesting the state of the SBA service.

    Type: String

29.74.2 SbaHttpRequestState Powershell class

class SbaHttpRequestState {
        [string] $ExecutionTime
        [SbaHttpStatus] $ResponseStatus
        [string] $ResponseError
}

29.75 MsTeamsSbaUser

29.75.1 MsTeamsSbaUser Field Description

  • LastActiveTime

    Type: String

  • LastSyncTime

    Type: String

  • SipUri

    Type: String

  • UserId

    Type: String

29.75.2 MsTeamsSbaUser Powershell class

class MsTeamsSbaUser {
        [string] $LastActiveTime
        [string] $LastSyncTime
        [string] $SipUri
        [string] $UserId
}

29.76 GetNodesNode

29.76.1 GetNodesNode Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

29.76.2 GetNodesNode Powershell class

class GetNodesNode {
        [string] $DisplayName
        [string] $Id
}

29.77 GetSystemsProfilesProfile

29.77.1 GetSystemsProfilesProfile Field Description

  • SipTransport

    Create a SIP transport object or select an existing one.

    Type: AddSystemSipTransport section 29.25

  • 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 29.26

  • TcpPortRange

    Restricts the tcp port range

    Type: PortRange section 29.26

  • 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 29.27

  • 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 29.28

  • 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 29.28

  • 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 29.29

  • 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

  • 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 29.31

  • IncomingDialStringRewriteRules

    Type: Array of DialStringRewrite section 29.4

  • OutgoingDialStringRewriteRules

    Type: Array of DialStringRewrite section 29.4

  • 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

29.77.2 GetSystemsProfilesProfile Powershell class

class GetSystemsProfilesProfile {
        [AddSystemSipTransport] $SipTransport
        [bool] $CreateNewNetworkController
        [string] $NetworkControllerDisplayName
        [string] $NetworkControllerInterface
        [string] $NetworkControllerIpVersion
        [string] $NetworkControllerIpAddress
        [bool] $EnableReverseDnsLookup
        [string] $NetworkControllerId
        [int] $UdpTcpPort
        [int] $TlsPort
        [PortRange] $UdpPortRange
        [PortRange] $TcpPortRange
        [string] $SipInterconnection
        [RemoteSipDomain] $RemoteSipDomain
        [string] $LocalSipDomain
        [bool] $ActivateClientAuthentication
        [SipCredentials] $ClientCredentials
        [bool] $ActivateServerAuthentication
        [SipCredentials] $ServerCredentials
        [string] $RegistrarUri
        [string] $AddressOfRecord
        [TelMatch] $SipRegistrar
        [string] $SrvProxyDomain
        [bool] $UseNetworkPeerWhitelist
        [bool] $IncludeRemoteSipDomainInWhitelist
        [bool] $IncludeSipRegistrarInWhitelist
        [bool] $IncludeOwnSubnetInWhitelist
        [NetworkPeerWhitelistEntry[]] $NetworkPeerWhitelist
        [bool] $AllowOnlyNegotiatedPeersForRtpRtcp
        [AddSystemSipNodeWhitelist] $SipNodeNetworkPeerWhitelist
        [DialStringRewrite] $IncomingDialStringRewriteRules
        [DialStringRewrite] $OutgoingDialStringRewriteRules
        [string[]] $RoutingDomains
        [string] $DisplayName
        [bool] $CreateNewTeamsCarrierNode
        [string] $TeamsCarrierNodeId
        [bool] $CreateNewMsOperatorConnectNode
        [string] $MsOperatorConnectNodeId
        [string] $TenantId
        [string] $SbcFqdn
        [string] $TenantFqdn
        [string] $Region
        [string] $XGooglePbxTrunkSecretKey
        [string] $DisplayName
        [string] $Id
}

29.78 TelMatchList

29.78.1 TelMatchList Field Description

  • Matches

    Type: Array of TelMatch section 29.29

  • Operator

    The operator applied to the results of the "matches".

    Type: TelMatchListOperator

    Possible values:

    • OR

    • XOR

    • AND

    • NOT

29.78.2 TelMatchList Powershell class

class TelMatchList {
        [TelMatch[]] $Matches
        [string] $Operator
}

29.79 TelMatchPlain

29.79.1 TelMatchPlain Field Description

  • Prefix

    Prefix which must be present in the dial string.

    Type: String

  • Suffix

    Suffix which must be present in the dial string.

    Type: String

29.79.2 TelMatchPlain Powershell class

class TelMatchPlain {
        [string] $Prefix
        [string] $Suffix
}

29.80 AddNodeResult

29.80.1 AddNodeResult Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

29.80.2 AddNodeResult Powershell class

class AddNodeResult {
        [string] $DisplayName
        [string] $Id
}

29.81 GetProviderProfilesProfile

29.81.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 29.6

  • 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 29.26

  • TcpPortRange

    The TCP port range.

    Type: PortRange section 29.26

  • 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 29.27

  • 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

  • ClientCredentials

    Client SIP User Name and Password.

    Type: SipUserCredentials section 29.32

  • 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

  • AllowOnlyNegotiatedPeersForRtpRtcp

    Allow only negotiated peers for RTP/RTCP.

    Type: Boolean

  • IncomingDialStringRewriteRules

    Type: Array of DialStringRewrite section 29.4

  • OutgoingDialStringRewriteRules

    Type: Array of DialStringRewrite section 29.4

  • 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 29.33

  • Telstra2ndTrunkGroup

    Only for the Telstra EP (SIP Connect) profile. Connection options for the second trunk group.

    Type: TelstraNthTrunkOptions section 29.33

  • 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

29.81.2 GetProviderProfilesProfile Powershell class

class GetProviderProfilesProfile {
        [TelMatchExtensionRange] $DeutscheTelekomNumberExtensionRange
        [bool] $CreateNewDeutscheTelekomSipTrunk
        [string] $DeutscheTelekomSipTrunkId
        [bool] $CreateNewNetworkController
        [string] $NetworkControllerDisplayName
        [string] $NetworkControllerInterface
        [string] $NetworkControllerIpVersion
        [string] $NetworkControllerIpAddress
        [bool] $EnableReverseDnsLookup
        [string] $NetworkControllerId
        [int] $UdpTcpPort
        [int] $TlsPort
        [PortRange] $UdpPortRange
        [PortRange] $TcpPortRange
        [bool] $ActivateNatTraversal
        [string] $ExternalHost
        [bool] $NatDeviceHasFixedPortMapping
        [int] $FixedUdpTcpPort
        [int] $FixedTlsPort
        [int] $FixedUdpPortRangeStart
        [int] $FixedTcpPortRangeStart
        [bool] $NodeViaSipTrunking
        [RemoteSipDomain] $RemoteSipDomain
        [string] $LocalSipDomain
        [bool] $ActivateClientAuthentication
        [SipUserCredentials] $ClientCredentials
        [string] $RegistrarUri
        [string] $AddressOfRecord
        [string] $ProxyUri
        [string] $PrimaryProxyUri
        [bool] $DefineAssertedUri
        [string] $AssertedUriHost
        [string] $AssertedUri
        [bool] $UseNetworkPeerWhitelist
        [bool] $IncludeRemoteSipDomainInWhitelist
        [bool] $IncludeSipRegistrarInWhitelist
        [bool] $IncludeProxyInWhitelist
        [NetworkPeerWhitelistEntry] $NetworkPeerWhitelist
        [bool] $AllowOnlyNegotiatedPeersForRtpRtcp
        [DialStringRewrite] $IncomingDialStringRewriteRules
        [DialStringRewrite] $OutgoingDialStringRewriteRules
        [string] $Region
        [TelstraNthTrunkOptions] $Telstra1thTrunkGroup
        [TelstraNthTrunkOptions] $Telstra2ndTrunkGroup
        [string[]] $RoutingDomains
        [string] $DisplayName
        [string] $DisplayName
        [string] $Id
}

29.82 CertificateListEntry

29.82.1 CertificateListEntry Field Description

  • Issuer

    Type: String

  • Subject

    Type: String

  • ValidFrom

    Type: String

  • ValidUntil

    Type: String

29.82.2 CertificateListEntry Powershell class

class CertificateListEntry {
        [string] $Issuer
        [string] $Subject
        [string] $ValidFrom
        [string] $ValidUntil
}

29.83 TransportConnectionStatusCodeErrorFlag

29.83.1 TransportConnectionStatusCodeErrorFlag Field Description

  • DOWN

    Change the state to non-operational.

    Type: TransportConnectionStatusCodeErrorFlag section 29.83

  • DOWN_RETRY_AFTER

    Change the state to non-operational if the response message contains a Retry-After header.

    Type: TransportConnectionStatusCodeErrorFlag section 29.83

  • FAILOVER

    Perform failover to another transport connection, if possible.

    Type: TransportConnectionStatusCodeErrorFlag section 29.83

  • TERMINATE_INCOMING

    Terminate incoming traffic.

    Type: TransportConnectionStatusCodeErrorFlag section 29.83

  • TERMINATE_OUTGOING

    Terminate outgoing traffic.

    Type: TransportConnectionStatusCodeErrorFlag section 29.83

29.83.2 TransportConnectionStatusCodeErrorFlag Powershell class

enum TransportConnectionStatusCodeErrorFlag {
        DOWN
        DOWN_RETRY_AFTER
        FAILOVER
        TERMINATE_INCOMING
        TERMINATE_OUTGOING
}

29.84 SipLoadBalancerDefaultLoad

29.84.1 SipLoadBalancerDefaultLoad Field Description

29.84.2 SipLoadBalancerDefaultLoad Powershell class

enum SipLoadBalancerDefaultLoad {
        HIGH
        LOW
        MEDIUM
}

29.85 ResourcesMemory

29.85.1 ResourcesMemory Field Description

  • Total

    Type: long

  • Used

    Type: long

29.85.2 ResourcesMemory Powershell class

class ResourcesMemory {
        $Total
        $Used
}

29.86 RequestRouter

29.86.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

  • SecondarySideOptions

    Type: RequestRouterSideOptions

29.86.2 RequestRouter Powershell class

class RequestRouter {
        [string] $Id
        [string] $ForwardingMode
        [string] $OperationalStateConditionId
        [RequestRouterSideOptions] $PrimarySideOptions
        [RequestRouterSideOptions] $SecondarySideOptions
}

29.87 String

29.87.1 String Field Description

  • CASE_INSENSITIVE_ORDER

    Type: Comparator

29.87.2 String Powershell class

class String {
        $CASE_INSENSITIVE_ORDER
}

29.88 RoutingTelRewrite

29.88.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

29.88.2 RoutingTelRewrite Powershell class

class RoutingTelRewrite {
        [int] $DelLeading
        [int] $DelTrailing
        [int] $KeepLeading
        [int] $KeepTrailing
        [int] $MatchedPart
        [string] $Prefix
        [string] $Source
        [string] $Suffix
}

29.89 RoutingDomainRouteEstablishAccept

29.89.1 RoutingDomainRouteEstablishAccept Field Description

  • DestinationNodeId

    The identifier of the destination node. For a list of all nodes use section 14.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 29.88

  • AssertedDialStringRewriting

    Optional rewriting rules for the asserted dial string.

    Type: Array of RoutingTelRewrite section 29.88

  • DestinationDialStringRewriting

    Optional rewriting rules for the destination dial string.

    Type: Array of RoutingTelRewrite section 29.88

  • TransferrerDialStringRewriting

    Optional rewriting rules for the transferrer dial string.

    Type: Array of RoutingTelRewrite section 29.88

  • ElinDialStringRewriting

    Optional rewriting rules for the ELIN dial string.

    Type: Array of RoutingTelRewrite section 29.88

  • 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 29.106

29.89.2 RoutingDomainRouteEstablishAccept Powershell class

class RoutingDomainRouteEstablishAccept {
        [string] $DestinationNodeId
        [string] $RoutingForwardProfileSelection
        [string] $RoutingForwardProfileId
        [string] $RoutingForwardProfileDisplayName
        [string] $RoutingForwardProfileMode
        $AdjustRoutingForwardProfileSettings
        [RoutingTelRewrite[]] $SourceDialStringRewriting
        [RoutingTelRewrite[]] $AssertedDialStringRewriting
        [RoutingTelRewrite[]] $DestinationDialStringRewriting
        [RoutingTelRewrite[]] $TransferrerDialStringRewriting
        [RoutingTelRewrite[]] $ElinDialStringRewriting
        [RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch] $FailoverStatusMatch
}

29.90 RoutingDomainRouteLookupDirectories

29.90.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

29.90.2 RoutingDomainRouteLookupDirectories Powershell class

class RoutingDomainRouteLookupDirectories {
        [string] $AssertedUriDirectoryId
        [string] $DestinationDialStringDirectoryId
        [string] $FirstDiversionNumberDirectoryId
        [string] $LastDiversionNumberDirectoryId
        [string] $SourceDialStringDirectoryId
        [string] $TransferrerDialStringDirectoryId
}

29.91 RoutingDomainRouteEstablishmentV0

29.91.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 29.88

  • DestinationDialStringRewriting

    Only for "type=ROUTE" or "type=REDIRECT".

    Type: Array of RoutingTelRewrite section 29.88

  • 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 29.88

  • 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 29.88

  • TransferrerDialStringRewriting

    Only for "type=ROUTE".

    Type: Array of RoutingTelRewrite section 29.88

  • 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

29.91.2 RoutingDomainRouteEstablishmentV0 Powershell class

class RoutingDomainRouteEstablishmentV0 {
        [bool] $AdjustRoutingForwardProfileSettings
        [RoutingTelRewrite[]] $AssertedDialStringRewriting
        [RoutingTelRewrite[]] $DestinationDialStringRewriting
        [string] $DestinationNodeId
        [RoutingTelRewrite[]] $ElinDialStringRewriting
        [string] $ParallelCallDialStringDirectoryId
        [String] $ParallelCalls
        [string] $RejectStatus
        [string] $RoutingForwardProfileDisplayName
        [string] $RoutingForwardProfileId
        [string] $RoutingForwardProfileMode
        [string] $RoutingForwardProfileSelection
        [bool] $SkipIfNodeNotOperational
        [RoutingTelRewrite[]] $SourceDialStringRewriting
        [RoutingTelRewrite[]] $TransferrerDialStringRewriting
        [string] $Type
}

29.92 RoutingForwardProfile

29.92.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 29.107

  • 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

29.92.2 RoutingForwardProfile Powershell class

class RoutingForwardProfile {
        [bool] $AnnouncementIncoming
        [string] $AnnouncementMediaSourceId
        [bool] $AnnouncementOutgoing
        [string] $DisplayName
        [bool] $EarlyMediaPassThrough
        [string] $Id
        [string] $MediaRecorderId
        [bool] $RemoveAnynodeFromSignalingPath
        [TelephonyForwarding] $TelephonyForwardingStack
        [string] $TelephonyForwardingStackId
}

29.93 NotifySipInfoFilter

29.93.1 NotifySipInfoFilter Field Description

  • MaxContentLength

    Type: Integer

  • MimeContentTypeName

    Type: String

29.93.2 NotifySipInfoFilter Powershell class

class NotifySipInfoFilter {
        [int] $MaxContentLength
        [string] $MimeContentTypeName
}

29.94 Backend

29.94.1 Backend Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

29.94.2 Backend Powershell class

class Backend {
        [string] $DisplayName
        [string] $Id
}

29.95 NetworkInterface

29.95.1 NetworkInterface Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

29.95.2 NetworkInterface Powershell class

class NetworkInterface {
        [string] $DisplayName
        [string] $Id
}

29.96 NetworkController

29.96.1 NetworkController Field Description

  • DisplayName

    Type: String

  • Id

    Type: String

  • Interface

    Type: String

29.96.2 NetworkController Powershell class

class NetworkController {
        [string] $DisplayName
        [string] $Id
        [string] $Interface
}

29.97 WebserverConnector

29.97.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 29.59

  • OpenPortOnDemand

    If set to true the port will only be opened when necessary to fulfill the services.

    Type: Boolean

  • ConnectorPort

    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 29.60

29.97.2 WebserverConnector Powershell class

class WebserverConnector {
        [string] $DisplayName
        [string] $HttpMode
        [int] $HttpRedirectorPort
        [string] $Id
        [WebserverConnectorNetworkOptions] $NetworkOptions
        [bool] $OpenPortOnDemand
        [int] $ConnectorPort
        [WebserverConnectorRequestDomain] $RequestDomains
        [WebserverConnectorTlsOptions] $TlsOptions
}

29.98 TlsProtocol

29.98.1 TlsProtocol Field Description

  • TLSv1

    Type: TlsProtocol

    Possible values:

    • TLSv1

    • TLSv1_1

    • TLSv1_2

    • TLSv1_3

  • TLSv1_1

    Type: TlsProtocol

    Possible values:

    • TLSv1

    • TLSv1_1

    • TLSv1_2

    • TLSv1_3

  • TLSv1_2

    Type: TlsProtocol

    Possible values:

    • TLSv1

    • TLSv1_1

    • TLSv1_2

    • TLSv1_3

  • TLSv1_3

    Type: TlsProtocol

    Possible values:

    • TLSv1

    • TLSv1_1

    • TLSv1_2

    • TLSv1_3

29.98.2 TlsProtocol Powershell class

enum TlsProtocol {
        TLSv1
        TLSv1_1
        TLSv1_2
        TLSv1_3
}

29.99 HotStandbyReplicationOptions

29.99.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

29.99.2 HotStandbyReplicationOptions Powershell class

class HotStandbyReplicationOptions {
        [String] $SystemIdentifiers
        [bool] $SystemIdentifiersEnabled
}

29.100 HotStandbyLinkStatus

29.100.1 HotStandbyLinkStatus Field Description

29.100.2 HotStandbyLinkStatus Powershell class

enum HotStandbyLinkStatus {
        ACTIVE
        DISABLED
        ERROR
        ESTABLISHING
        NOT_COMMITTED
        UNKNOWN
}

29.101 HotStandbyMainRoleStatus

29.101.1 HotStandbyMainRoleStatus Field Description

29.101.2 HotStandbyMainRoleStatus Powershell class

enum HotStandbyMainRoleStatus {
        ACTIVE
        CONDITION
        HANDOVER_HOLD_OR_CONDITION
        INACTIVE
        RECOVERING
        RECOVERY_HOLD
}

29.102 HotStandbyMainSystemStatus

29.102.1 HotStandbyMainSystemStatus Field Description

29.102.2 HotStandbyMainSystemStatus Powershell class

enum HotStandbyMainSystemStatus {
        ACTIVE
        NOT_COMMITTED
        OUT_OF_SERVICE
        STANDBY
        UNKNOWN
}

29.103 HotStandbyStandbyRoleStatus

29.103.1 HotStandbyStandbyRoleStatus Field Description

29.103.2 HotStandbyStandbyRoleStatus Powershell class

enum HotStandbyStandbyRoleStatus {
        ACTIVE
        CONDITION
        INACTIVE
        RECOVERY_CONDITION
}

29.104 HotStandbyStandbySystemStatus

29.104.1 HotStandbyStandbySystemStatus Field Description

29.104.2 HotStandbyStandbySystemStatus Powershell class

enum HotStandbyStandbySystemStatus {
        ACTIVE
        NOT_COMMITTED
        OUT_OF_SERVICE
        STANDBY
        UNKNOWN
}

29.105 SbaHttpStatus

29.105.1 SbaHttpStatus Field Description

  • StatusCode

    Type: Integer

  • StatusLine

    Type: String

29.105.2 SbaHttpStatus Powershell class

class SbaHttpStatus {
        [int] $StatusCode
        [string] $StatusLine
}

29.106 RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch

29.106.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 29.109

29.106.2 RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch Powershell class

class RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch {
        [string] $SipStatusCodes
        [string[]] $TelStatusList
}

29.107 TelephonyForwarding

29.107.1 TelephonyForwarding Field Description

  • MediaNegotiationForwarder

    Type: MediaNegotiationForwarder section 29.110

  • MediaNegotiationForwarderId

    Type: String

  • SignalingForwardingFromCalledToCalling

    Type: SignalingForwardingOptions section 29.58

  • SignalingForwardingFromCallingToCalled

    Type: SignalingForwardingOptions section 29.58

29.107.2 TelephonyForwarding Powershell class

class TelephonyForwarding {
        [MediaNegotiationForwarder] $MediaNegotiationForwarder
        [string] $MediaNegotiationForwarderId
        [SignalingForwardingOptions] $SignalingForwardingFromCalledToCalling
        [SignalingForwardingOptions] $SignalingForwardingFromCallingToCalled
}

29.108 WebserverConnectorRequestDomain

29.108.1 WebserverConnectorRequestDomain Field Description

  • ACME

    Type: WebserverConnectorRequestDomain

    Possible values:

    • ACME

    • GUI

    • REST_API

  • GUI

    Type: WebserverConnectorRequestDomain

    Possible values:

    • ACME

    • GUI

    • REST_API

  • REST_API

    Type: WebserverConnectorRequestDomain

    Possible values:

    • ACME

    • GUI

    • REST_API

29.108.2 WebserverConnectorRequestDomain Powershell class

enum WebserverConnectorRequestDomain {
        ACME
        GUI
        REST_API
}

29.109 TelStatusNoSuccess

29.109.1 TelStatusNoSuccess Field Description

29.109.2 TelStatusNoSuccess Powershell class

enum TelStatusNoSuccess {
        DIAL_STRING
        DOMAIN_SPECIFIC_0
        DOMAIN_SPECIFIC_1
        DOMAIN_SPECIFIC_10
        DOMAIN_SPECIFIC_11
        DOMAIN_SPECIFIC_12
        DOMAIN_SPECIFIC_13
        DOMAIN_SPECIFIC_14
        DOMAIN_SPECIFIC_15
        DOMAIN_SPECIFIC_16
        DOMAIN_SPECIFIC_17
        DOMAIN_SPECIFIC_18
        DOMAIN_SPECIFIC_19
        DOMAIN_SPECIFIC_2
        DOMAIN_SPECIFIC_3
        DOMAIN_SPECIFIC_4
        DOMAIN_SPECIFIC_5
        DOMAIN_SPECIFIC_6
        DOMAIN_SPECIFIC_7
        DOMAIN_SPECIFIC_8
        DOMAIN_SPECIFIC_9
        ERROR
        MEDIA_NEGOTIATION
        NETWORK_CONGESTION
        NETWORK_EQUIPMENT
        NETWORK_PERMISSION
        USER_BUSY
        USER_NOT_RESPONDING
        USER_NOT_SELECTED
        USER_REDIRECTED
        USER_REJECTED
        USER_TERMINATED
}

29.110 MediaNegotiationForwarder

29.110.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 29.111

  • 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

29.110.2 MediaNegotiationForwarder Powershell class

class MediaNegotiationForwarder {
        [string] $DisplayName
        [string] $Id
        [string] $MediaMode
        [MediaTranscodingOptions] $MediaTranscodingOptions
        [string] $MediaTranscodingOptionsId
}

29.111 MediaTranscodingOptions

29.111.1 MediaTranscodingOptions Field Description

  • DisplayName

    The name shown in the anynode frontend.

    Type: String

  • Id

    The id of this object.

    Type: String

29.111.2 MediaTranscodingOptions Powershell class

class MediaTranscodingOptions {
        [string] $DisplayName
        [string] $Id
}