REST API Documentation for anynode 4.14.12

32.1.1 SoftwareVersion Field Description

• versionMajor

  Type: Integer

• versionMinor

  Type: Integer

• versionRelease

  Type: Integer

32.1.2 SoftwareVersion JSON Schema

32.2.1 AddUserData Field Description

• displayName

  The displayed name of the new user.

  Type: String

• emailAddress

  The email address of the new user.

  Type: String

• enabled

  Determines if the new user should be enabled. Disabled user cannot login.

  Type: Boolean

• ldapAuthentications

  Add LDAP users here to link this user to LDAP users.

  Type: Array of LdapUserJson

  • name

    Type: String

  • ldapAuthorityId

    Type: String

• ldapLogin

  Defines if the user should be able to login with LDAP credentials.

  Type: Boolean

• localPassword

  The password for local authentication.

  Type: String

• localUsername

  The username for local authentication.

  Type: String

• loginLocally

  Defines if the user should be able to login with a local username and password.

  Type: Boolean

• passwordChange

  Define whether and, if so, when the password has to be changed.

  Type: PasswordChange

  Possible values:

  • NOT_NECESSARY

  • REQUIERED

  • RECOMMENDED

• roleIds

  Add roles for this user to determine the permissions.

  Type: Array of String

32.2.2 AddUserData JSON Schema

32.3.1 CustomUserOptions Field Description

• blockedUntil

  Type: Date

• displayName

  Type: String

• emailAddress

  Type: String

• enabled

  Type: Boolean

• failedLogins

  Type: Integer

• id

  Type: String

• lastFailedLogin

  Type: Date

• lastLogin

  Type: Date

• ldapUsers

  Type: Array of LdapUserJson

  • name

    Type: String

  • ldapAuthorityId

    Type: String

• local

  Type: LocalUser (section 32.53)

• localUserName

  Type: String

• localV0

  Type: LocalV0User (section 32.54)

• roleBuiltIns

  Type: String

• roles

  Type: Array of String

32.3.2 CustomUserOptions JSON Schema

32.4.1 PasswordPolicy Field Description

• minLength

  Minimum password length in characters.

  Type: Integer

• maxLength

  Maximum password length in characters.

  Type: Integer

• minDigits

  Minimum number of digit characters.

  Type: Integer

• minCharacters

  Minimum number of letter characters (any case).

  Type: Integer

• minLowerCase

  Minimum number of lowercase letters.

  Type: Integer

• minUpperCase

  Minimum number of uppercase letters.

  Type: Integer

• minSpecial

  Minimum number of special characters.

  Type: Integer

• constraintAreas

  How many independent character-class constraints must be satisfied (digits, letters, lower, upper, special).

  Type: Integer

• patterns

  Whether repetitions, sequences and keyboard sequences are allowed.

  Type: Boolean

• blacklist

  Blacklisted substrings that passwords must not contain.

  Type: Array of PasswordPolicyBlacklistItem (section 32.56)

• addUsernameToBlacklist

  If true, the username is treated as blacklisted.

  Type: boolean

32.4.2 PasswordPolicy JSON Schema

32.5.1 LoginPolicy Field Description

• minLoginDelay

  Minimum delay between login attempts (seconds).

  Type: Integer

• maxLoginDelay

  Maximum delay between login attempts (seconds).

  Type: Integer

• attemptsUntilBlocked

  Failed attempts before the account is blocked.

  Type: Integer

• showLoginFailureMessage

  Whether to show a message on login failure.

  Type: Boolean

• passwordExpiration

  Password expiration period (days).

  Type: Integer

• passwordExpirationWarning

  Days before expiration when a warning is shown.

  Type: Integer

• maxObsoletePasswords

  Maximum number of previous passwords remembered.

  Type: Integer

• passwordUnchangeableMinutes

  Minimum time before the password may be changed again (minutes).

  Type: Integer

32.5.2 LoginPolicy JSON Schema

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

32.6.2 Role JSON Schema

32.7.1 TracingOptionsJson Field Description

• selection

  Selects how tracing records will be stored.

  Type: TracingSelection

  Possible values:

  • FILE

    Single file, no size limit.

  • SPLIT

    Rolling files of limited size.

• traceActive

  Type: Boolean

• options

  Type: TracingFileOptions

  • count

    Determines how many trace files will be kept. Only for selection=SPLIT

    Type: Integer

  • flags

    Possible values: TRIO_FLAG_MARKED (only trace sessions that are marked for tracing) and TRIO_FLAG_IGNORE_HIGH_VOLUME_MESSAGES (removes high-volume trace messages) seperated by '|'

    Type: String

  • size

    Determines the maximum size for trace files.

    Type: Integer

32.7.2 TracingOptionsJson JSON Schema

32.8.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 32.57)

• constaints

  The constraints for this license.

  Type: String

32.8.2 License JSON Schema

32.9.1 ImportLodData Field Description

• companyName

  If the LOD key has already been used to generate a license using a different licensing device, please confirm that you are eligible for requesting a new license and provide the name of your company.

  Type: String

• emailAddress

  An additional copy of the generated license will be sent to the given e-mail address.

  Type: String

• licensingDevice

  Each license must be bound to a certain device already installed in your system. The list of devices available for licensing can be requested via section 6.3.Please specify the devices system ID that should be used to bind the new license to.

  Type: String

• lodKey

  The LOD key that was supplied together with the product.

  Type: String

32.9.2 ImportLodData JSON Schema

32.10.1 AddSystemProfile Field Description

• sipTransport

  Create a SIP transport object or select an existing one.

  Type: AddSystemSipTransport (section 32.61)

• 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 32.62)

• tcpPortRange

  Restricts the tcp port range

  Type: PortRange (section 32.62)

• 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 32.63)

• 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 32.40)

• 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 32.40)

• 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 32.64)

• srvProxyDomain

  The proxy address for nodes that are using an SRV loadbalancer.

  Type: String

• useNetworkPeerWhitelist

  Type: Boolean

• includeRemoteSipDomainInWhitelist

  Include the remote SIP domain in the whitelist.

  Type: Boolean

• includeSipRegistrarInWhitelist

  Include the SIP registrar in the whitelist.

  Type: Boolean

• includeOwnSubnetInWhitelist

  Include the own subnet in the whitelist.

  Type: Boolean

• networkPeerWhitelist

  Type: Array of NetworkPeerWhitelistEntry

  • dnsLookup

    Additional protocol prefixes.

    Type: Array of String

  • host

    The hostname or ip address.

    Type: String

  • ipVersion

    If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)

    Type: IpVersion

    Possible values:

    • [Any Address Version]

    • IN_ADDRESS_VERSION_4

    • IN_ADDRESS_VERSION_6

  • subnetPrefixLength

    Type: Integer

• allowOnlyNegotiatedPeersForRtpRtcp

  Allow only negotiated peers for RTP/RTCP.

  Type: Boolean

• sipNodeNetworkPeerWhitelist

  Network peer whitelist for filtering of incoming calls. Only applies when creating a shared SIP transport or using an existing SIP transport.

  Type: AddSystemSipNodeWhitelist (section 32.65)

• incomingDialStringRewriteRules

  Type: Array of DialStringRewrite (section 32.18)

• outgoingDialStringRewriteRules

  Type: Array of DialStringRewrite (section 32.18)

• 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

32.10.2 AddSystemProfile JSON Schema

32.11.1 AddProviderProfile Field Description

• deutscheTelekomNumberExtensionRange

  Number Extension Range for seperating incomming calls. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.

  Type: TelMatchExtensionRange (section 32.68)

• 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 32.62)

• tcpPortRange

  The TCP port range.

  Type: PortRange (section 32.62)

• 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 32.63)

• localSipDomain

  The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls.

  Type: String

• activateClientAuthentication

  Activate client authentication. These authentication settings determine how the node authenticate to a remote station.

  Type: Boolean

• credentials

  Client SIP User Name and Password.

  Type: SipUserCredentials (section 32.69)

• registrarUri

  The node will register as a client at a remote station. Select the necessary settings for this registration.

  Type: String

• addressOfRecord

  User Part of Address-Of-Record for registration.

  Type: String

• proxyUri

  Optional proxy server. Outgoing calls will be forwarded to this proxy. The specified value must begin with "sip:".

  Type: String

• primaryProxyUri

  Deprecated use "proxyUri" instead.

  Primary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".

  Type: String

• defineAssertedUri

  Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.

  Type: Boolean

• assertedUriHost

  Mandatory, if the URI is not based on the registrar uri or proxy uri.

  Type: String

• assertedUri

  User Part of Asserted-URI.

  Type: String

• useNetworkPeerWhitelist

  If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.

  Type: Boolean

• includeRemoteSipDomainInWhitelist

  Whether to include the remote SIP domain in the whitelist.

  Type: Boolean

• includeSipRegistrarInWhitelist

  Whether to include the SIP registrar in the whitelist.

  Type: Boolean

• includeProxyInWhitelist

  Whether to include the configured proxy in the whitelist.

  Type: Boolean

• networkPeerWhitelist

  The whitelist.

  Type: Array of NetworkPeerWhitelistEntry

  • dnsLookup

    Additional protocol prefixes.

    Type: Array of String

  • host

    The hostname or ip address.

    Type: String

  • ipVersion

    If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)

    Type: IpVersion

    Possible values:

    • [Any Address Version]

    • IN_ADDRESS_VERSION_4

    • IN_ADDRESS_VERSION_6

  • subnetPrefixLength

    Type: Integer

• allowOnlyNegotiatedPeersForRtpRtcp

  Allow only negotiated peers for RTP/RTCP.

  Type: Boolean

• incomingDialStringRewriteRules

  Type: Array of DialStringRewrite (section 32.18)

• outgoingDialStringRewriteRules

  Type: Array of DialStringRewrite (section 32.18)

• 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 32.70)

• telstra2ndTrunkGroup

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

  Type: TelstraNthTrunkOptions (section 32.70)

• 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

32.11.2 AddProviderProfile JSON Schema

32.12.1 AddSipPhoneRegistrarProfile Field Description

• createNewNetworkController

  Create new network controller or select an existing one.

  Type: Boolean

• networkControllerDisplayName

  The display name of the newly created network controller.

  Type: String

• networkControllerInterface

  The interface of the newly created network controller.

  Type: String

• networkControllerIpVersion

  The IP version of the newly created network controller.

  Type: IpVersion

  Possible values:

  • [Any Address Version]

  • IN_ADDRESS_VERSION_4

  • IN_ADDRESS_VERSION_6

• networkControllerIpAddress

  The IP address of the newly created network controller.

  Type: String

• enableReverseDnsLookup

  Specify whether reverse DNS lookup is enabled for the newly created network controller.

  Type: Boolean

• networkControllerId

  In case no new network controller is created, this value must be given.

  Type: String

• udpTcpPort

  The UDP/TCP Port.

  Type: Integer

• tlsPort

  The TLS port.

  Type: Integer

• udpPortRange

  The UDP port range.

  Type: PortRange (section 32.62)

• tcpPortRange

  The TCP port range.

  Type: PortRange (section 32.62)

• sipPhoneRegistrarDirectoryId

  The identifiert of the directory that determines how SIP phones authenticate.

  Type: String

• useNetworkPeerWhitelist

  If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.

  Type: Boolean

• includeOwnSubnetInWhitelist

  Whether to include the own subnet in the whitelist.

  Type: Boolean

• networkPeerWhitelist

  The whitelist.

  Type: Array of NetworkPeerWhitelistEntry

  • dnsLookup

    Additional protocol prefixes.

    Type: Array of String

  • host

    The hostname or ip address.

    Type: String

  • ipVersion

    If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)

    Type: IpVersion

    Possible values:

    • [Any Address Version]

    • IN_ADDRESS_VERSION_4

    • IN_ADDRESS_VERSION_6

  • subnetPrefixLength

    Type: Integer

• allowOnlyNegotiatedPeersForRtpRtcp

  Allow only negotiated peers for RTP/RTCP.

  Type: Boolean

• incomingDialStringRewriteRules

  Type: Array of DialStringRewrite (section 32.18)

• outgoingDialStringRewriteRules

  Type: Array of DialStringRewrite (section 32.18)

• 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

32.12.2 AddSipPhoneRegistrarProfile JSON Schema

32.13.1 SipNodeTransportConnection Field Description

• matchingCondition

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

  Type: TelMatch (section 32.64)

• transportConnectionId

  The id of the transport connection

  Type: String

32.13.2 SipNodeTransportConnection JSON Schema

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

32.14.2 NetworkPeerWhitelistEntry JSON Schema

32.15.1 ActiveSessionsFilter Field Description

• count

  Limits the amount of sessions that will be returned by the request.

  Type: Integer

• nodeFilter

  The name of the incoming or outgoing node of the sessions that will be returned by the request.

  Type: String

• routeFilter

  The name of the route of the sessions that will be returned by the request.

  Type: String

• numberFilter

  The number of the caller or callee of the sessions that will be returned by the request.

  Type: String

• numberFilterMode

  Determines how the number is matched with the "numberFilter".

  Type: NumberFilterMode

  Possible values:

  • equal

  • startswith

  • endswith

  • contains

32.15.2 ActiveSessionsFilter JSON Schema

32.16.1 CallHistoryFilter Field Description

• startIndex

  The index of the first call record to return.

  Type: int

• count

  The maximum number of call records to return.

  Type: int

• filterByResult

  Filter results by the call outcome.

  Type: CallResult

  Possible values:

  • success

  • error

  • noLicense

  • noRoute

  • invalidDial

  • noPermission

  • noResource

  • noDevice

  • busy

  • noAnswer

  • reject

  • mediaError

  • cancelled

  • transferred

  • replaced

  • notSelected

  • tlsIncompatible

  • peerCertificateInvalid

  • successTermByAdmin

  • connectingTermByAdmin

  • sessionMaximumExceeded

  • maintenanceMode

  • dnsError

  • inFilterError

  • lostAnynode

  • redirect

  • noConditionMatch

  • recordingError

  • routeSupervisorNoServer

  • routeSupervisorAbort

  • routeSupervisorIgnore

  • licenseRemovedByPriority

  • authenticationRequired

  • registrarError

  • registrationAborted

  • authenticationRejected

  • noRegistration

  • notificationExpired

  • notificationFailed

  • routeIgnoreCall

  • sessionInterval

• filterByNode

  Filter results by the node identifier that handled the call.

  Type: String

• filterByRoute

  Filter results by the route identifier used for the call.

  Type: String

• filterByDateTimeStart

  Filter results to calls that started on or after this time.

  Type: Date

• filterByDateTimeEnd

  Filter results to calls that ended on or before this time.

  Type: Date

• filterByNumber

  Filter results by the phone number involved in the call.

  Type: String

• filterByNumberMode

  Define how the number filter should be applied (e.g., exact, prefix).

  Type: FilterNumberMode

  Possible values:

  • equal

  • startswith

  • endswith

  • contains

• filterTagSet

  Filter results by a set of tags associated with the call.

  Type: String

• filterByPriority

  Filter results by the priority level of the call.

  Type: CallPrioritySet

• filterTimezone

  Filter results by the timezone in which the call occurred.

  Type: FilterTimezone

  Possible values:

  • utc

  • server

  • offset

• filterTimezoneOffsetSeconds

  Filter results by the offset in seconds from UTC for the call's timezone. Only for "filterTimezone"="offset".

  Type: int

• filterDurationGreater

  Filter results to calls with a duration greater than this value (seconds).

  Type: int

• filterDurationLess

  Filter results to calls with a duration less than this value (seconds).

  Type: int

• filterSystemIdentifier

  Filter results by the system identifier that processed the call.

  Type: String

• filterSipCallId

  Filter results by the SIP Call ID header value.

  Type: String

• filterMsCorrelationId

  Filter results by the Microsoft correlation ID associated with the call.

  Type: String

32.16.2 CallHistoryFilter JSON Schema

32.17.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 32.18)

32.17.2 DialStringRewriting JSON Schema

32.18.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 32.68)

• structuralPattern

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

  Type: Array of MatchPatternSegment (section 32.72)

• 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

• displayNameOperation

  This parameter can decide how the display name will be altered. This overwrites the "clearDisplayName" parameter.

  Type: RewriteDisplayNameOperation

  Possible values:

  • clear

  • set

  • addPrefix

  • addSuffix

• displayName

  This parameter can be used to modify the display name.

  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 32.73)

• branchRewrites

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

  Type: Array of DialStringRewrite (section 32.18)

• branchElseRewrites

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

  Type: Array of DialStringRewrite (section 32.18)

• 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 32.74)

• 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 32.75)

• 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

32.18.2 DialStringRewrite JSON Schema

32.19.1 TelIdent Field Description

• sdpMLineAddress

  The IP address of the media channel that is established on a SIP call.

  Type: String

• sdpMLinePort

  The port of the media channel that is established on a SIP call.

  Type: Integer

• sdpOrigin

  The origin field of SDP messages.

  Type: String

• sipCallId

  The SIP Call-ID of the SIP call

  Type: String

• sipLocalTag

  The local(from anynodes perspective) SIP tag of a SIP call.

  Type: String

• sipRemoteTag

  The remote(from anynodes perspective) SIP tag of a SIP call.

  Type: String

• sipUserAgentDialog

  anynode specific identifier for a SIP user-agent dialog.

  Type: String

32.19.2 TelIdent JSON Schema

32.20.1 SetMuteRequestDataJson Field Description

• identifier

  The session identifier from the function Lookup by local session identification section 12.1.

  Type: String

• mute

  Specify if the session should be muted.

  Type: Boolean

32.20.2 SetMuteRequestDataJson JSON Schema

32.21.1 AnynodeConfigState Field Description

• committed

  Indicates if all changes to the configuration are committed.

  Type: Boolean

32.21.2 AnynodeConfigState JSON Schema

32.22.1 BackupExportOptions Field Description

• includedData

  Determines which components will be included in the backup. The default value includes 'ANYNODE_CONFIG', 'MEDIA_FILES', 'HTTP_SERVER_FILES', 'FRONTEND_CONFIG', 'MONITOR_CONFIG'

  Type: Array of ConfigurationBackupIncludededDataSelection

  Possible values:

  • ANYNODE_CONFIG

    The configuration of anynode.

  • MEDIA_FILES

    Audio files from the anynode configuration. Can only be exported with the anynode configuration.

  • HTTP_SERVER_FILES

    Static files uploaded to HTTP server from the anynode configuration. Can only be exported with the anynode configuration.

  • FRONTEND_CONFIG

    The configuration of the anynode frontend.

  • RECORDINGS

    Recorded sessions. To export this the initiating user needs the permission to access media recordings.

  • MONITOR_CONFIG

    The configuration of the anynode monitor.

  • CALL_HISTORY

    The internal call history. Can only be exported with the anynode monitor configuration.

  • EVENT_LOG

    The internal event log. Can only be exported with the anynode monitor configuration.

  • MESSAGE_HISTORY

    The internal signaling message history. Can only be exported with the anynode monitor configuration.

• encryptData

  Determines if the exported backup will be encrypted.

  Type: Boolean

• password

  The password if encryption is enabled. Mandatory if "encryptData=true".

  Type: String

32.22.2 BackupExportOptions JSON Schema

32.23.1 MaintenanceMode Field Description

• modeActive

  Indicates if the maintenance mode should be activated or deactivated.

  Type: Boolean

32.23.2 MaintenanceMode JSON Schema

32.24.1 MonitorCallHistoryConfig Field Description

• enabled

  Required. Enables or disables call history recording.

  Type: Boolean

• cleanupEnabled

  Required. Enables or disables the cleanup routine.

  Type: Boolean

• maxRecords

  Maximum number of call history records to retain. Applies only if cleanup is enabled.

  Type: Integer

• deleteOlderDays

  Deletes call history records older than the specified number of days. Applies only if cleanup is enabled.

  Type: Integer

• recordedFilesDeleteOlderDays

  Deletes recorded files older than the specified number of days. Applies only if cleanup is enabled.

  Type: Integer

• cleanupInterval

  Cleanup execution interval in minutes.

  Type: Integer

• customHeaderNames

  List of custom SIP header names to be stored in the call history.

  Type: String[]

32.24.2 MonitorCallHistoryConfig JSON Schema

32.25.1 MonitorSipFlowConfig Field Description

• enabled

  Required. Enables or disables SIP flow recording.

  Type: Boolean

• maxMessageLength

  Maximum allowed size of a SIP message in bytes. Messages exceeding this limit are truncated.

  Type: Integer

• deleteOlderDays

  Deletes SIP flow records older than the specified number of days.

  Type: Integer

• maxFileSizeGBytes

  Maximum size of the SIP flow database in gigabytes.

  Type: Integer

• minDiskSpaceGBytes

  Minimum required free disk space in gigabytes. If the available space falls below this threshold, the oldest SIP flow records are deleted.

  Type: Integer

32.25.2 MonitorSipFlowConfig JSON Schema

32.26.1 MediaRecording Field Description

• mediaRecordingActive

  Type: Boolean

32.26.2 MediaRecording JSON Schema

32.27.1 MsTeamsSbaOptions Field Description

• fingerprint

  The trusted certificate fingerprint source. This needs to be the fingerprint of the Teams node, that is using the SBA service.

  Type: MsTeamsSbaFingerprint

  • source

    Determines the source of the fingerprint.

    Type: FingerprintSource

    Possible values:

    • NONE

    • CUSTOM

    • MS_TEAMS_NODE

  • value

    The fingerprint for "source"="CUSTOM"

    Type: String

  • msTeamsNodeId

    Only for "source"="MS_TEAMS_NODE". The id of the Teams node, that uses the certificate. The fingerprint will be extracted automatically.

    Type: String

• identity

  The identity / FQDN of the SBA

  Type: String

• tenantId

  Directory (tenant) ID

  Type: String

• application

  Application (client) ID

  Type: String

• secret

  Application (client) secrect

  Type: String

• log

  Settings for the SBA log.

  Type: MsTeamsSbaLog (section 32.30)

• certificate

  The certificate for the SBA service

  Type: CryCertificate (section 32.76)

• 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 32.77)

32.27.2 MsTeamsSbaOptions JSON Schema

32.28.1 MsTeamsSbaStatus Field Description

• state

  Type: MsTeamsSbaDiagnosticsServiceState (section 32.78)

• 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 32.79)

• lastSbaServiceStatusRequestState

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

  Type: SbaHttpRequestState (section 32.80)

32.28.2 MsTeamsSbaStatus JSON Schema

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

32.29.2 MsTeamsSbaFingerprint JSON Schema

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

32.30.2 MsTeamsSbaLog JSON Schema

32.31.1 HotStandbyOptions Field Description

• mainSystem

  The options for the main system

  Type: HotStandbyMainSystemOptions (section 32.82)

• standbySystem

  The options for the standby system

  Type: HotStandbyStandbySystemOptions (section 32.83)

32.31.2 HotStandbyOptions JSON Schema

32.32.1 AddHotStandbyResponse Field Description

• hotStandbyId

  Type: String

• ipcClientId

  Type: String

• networkControllerId

  Type: String

• networkSecurityProfileId

  Type: String

32.32.2 AddHotStandbyResponse JSON Schema

32.33.1 HotStandbyStatus Field Description

• handoverPossible

  Type: Boolean

• linkStatus

  Type: HotStandbyLinkStatus (section 32.84)

• mainEnabled

  Type: Boolean

• mainLinkActive

  Type: Boolean

• mainRoleStatus

  Type: HotStandbyMainRoleStatus (section 32.85)

• mainSetEnabledPossible

  Type: Boolean

• mainStatus

  Type: HotStandbyMainSystemStatus (section 32.86)

• onlyImmediateRoleChangePossible

  Type: Boolean

• recoveryPossible

  Type: Boolean

• standbyEnabled

  Type: Boolean

• standbyLinkActive

  Type: Boolean

• standbyRoleStatus

  Type: HotStandbyStandbyRoleStatus (section 32.87)

• standbySetEnabledPossible

  Type: Boolean

• standbyStatus

  Type: HotStandbyStandbySystemStatus (section 32.88)

32.33.2 HotStandbyStatus JSON Schema