REST Documentation for anynode 4.12.14
Table of contents
Title page
1
General
2
Version
2.1
Get
3
User Management
3.1
Add User
3.2
Remove User
3.3
Submit Password Change
3.4
Get LDAP Authorities
4
Roles
4.1
Get Roles
4.2
Add Role
4.3
Remove role
5
Tracing
5.1
Get
5.2
Set
5.3
Download
6
Licenses
6.1
Get
6.2
Import LOD
6.3
Get System IDs
6.4
Import
7
Nodes
7.1
Get Nodes
7.2
Enable Node
7.3
Disable Node
7.4
Get System Profiles
7.5
Get Microsoft teams carrier nodes.
7.6
Add PBX or Voice over IP System
7.7
Get Provider Profiles
7.8
Add Provider
7.9
Add SIP Phones Registrar
7.10
Remove Node
7.11
Get Object from Node Graph
7.12
Get Port
7.13
Set Port
7.14
Get TlsPort
7.15
Set TlsPort
7.16
Get Teams FQDN
7.17
Set Teams FQDN
7.18
Get Hostname/FQDN
7.19
Set Hostname/FQDN
7.20
Get Network Security Profile Name
7.21
Set Network Security Profile Name
7.22
Get Certificate
7.23
Set Certificate
7.24
Get Transport Connections
7.25
Add Transport Connection
7.26
Clear Transport Connections
7.27
Set Transport Connections
7.28
Remove Transport Connection
7.29
Add Trusted Certificates
7.30
Clear Trusted Certificates
7.31
Get Incoming Dial String Rewrite Rules
7.32
Set Incoming Dial String Rewrite Rules
7.33
Add Incoming Dial String Rewrite Rules
7.34
Remove Incoming Dial String Rewrite Rules
7.35
Get Outgoing Dial String Rewrite Rules
7.36
Set Outgoing Dial String Rewrite Rules
7.37
Add Outgoing Dial String Rewrite Rules
7.38
Remove Outgoing Dial String Rewrite Rules
7.39
Get Network Peer Whitelist
7.40
Set Network Peer Whitelist
7.41
Add Network Peer Whitelist Entry
7.42
Remove Network Peer Whitelist Entry
7.43
Get Certificate Chain
7.44
Add Chain Certificate
7.45
Remove Chain Certificate
7.46
Clear Certificate Chain
7.47
Request Certificate Chain
8
Dashboard
8.1
Get
9
Active Sessions
9.1
Get
10
Call History
10.1
Export
10.2
Get Message History
10.3
Export Recorded Session
11
Dial String Rewriting
11.1
Get
11.2
Set
11.3
Add
11.4
Remove
11.5
Get Rules
11.6
Set Rules
11.7
Import Rules
11.8
Export Rules
11.9
Add Rules
11.10
Remove Rules
11.11
Clear Rules
12
Forwarded Session Recording
12.1
Lookup by local session identification
12.2
Set Mute
13
anynode Configuration
13.1
Import
13.2
Export
13.3
Commit
13.4
Revert
13.5
Clean
13.6
State
14
Configuration Backup
14.1
Create Configuration Backup
15
Maintenance Mode
15.1
Get
15.2
Set
16
Media Recording
16.1
Get Media Recording state
17
Microsoft Teams SBA
17.1
Get SBA configuration
17.2
Set SBA configuration.
17.3
Enable SBA Services
17.4
Disable SBA Services
17.5
Get Status
17.6
Get Private Key
17.7
Set Private Key
17.8
Get Certificate
17.9
Set Certificate
17.10
Get Fingerprint
17.11
Set Fingerprint
17.12
Get IP Address
17.13
Set IP Address
17.14
Get Identity
17.15
Set Identity
17.16
Get TenantId
17.17
Set TenantId
17.18
Get Application
17.19
Set Application
17.20
Set Secret
17.21
Get Log
17.22
Set Log
17.23
Get Users
17.24
Refresh Users
18
Hot Standby
18.1
Get
18.2
Add
18.3
Set
18.4
Get Status
18.5
Create Conditions
18.6
Hand over
18.7
Recover
18.8
Enable Main System
18.9
Enable Standby System
19
Transport Connections
19.1
Get Transport Connection
19.2
Create Standard Transport Connection
19.3
Add Plain Transport Connection
19.4
Add Load Balancing Transport Connection
19.5
Add SIP Registration As Transport Connection
19.6
Add SRV Load Balancer
19.7
Remove Transport Connection
19.8
Get Authentication
19.9
Set Authentication
19.10
Get Asserted URI
19.11
Set Asserted URI
19.12
Get Address of Record
19.13
Set Address of Record
20
Directories
20.1
Get Directories
20.2
Remove Directory
20.3
Add Static User Directory
20.4
Set Static User Directory
20.5
Set OAuth Client Secret
21
System Resources
21.1
Get Resources
22
SIP Proxies
22.1
Get
22.2
Add
22.3
Set
22.4
Remove
23
Routing Domains
23.1
Get Routing Domains
23.2
Add Routing Domain
23.3
Set Routing Domain
23.4
Remove Routing Domain
23.5
Get Routes
23.6
Add Route
23.7
Clone Route
23.8
Set Route
23.9
Remove Route
23.10
Get Source Nodes
23.11
Add Source Nodes
23.12
Set Source Nodes
23.13
Remove Source Nodes
23.14
Get Proceeding Signal
23.15
Enable Proceeding Signal
23.16
Disable Proceeding Signal
23.17
Get Route in Maintenance
23.18
Enable Route in Maintenance
23.19
Disable Route in Maintenance
24
Routing Forward Profiles
24.1
Get
24.2
Add
25
Webserver Connector
25.1
Get
25.2
Set
25.3
Add
25.4
Remove
26
Detached Objects
26.1
Get Sorts
26.2
Get Object
26.3
Get Unreferenced Objects
26.4
Get Object Tree
26.5
Get Subtree Objects
26.6
Set Object
26.7
Remove Object
26.8
Remove Objects
26.9
Import Object
26.10
Export Object
27
Backends
27.1
Get
28
Network Interfaces
28.1
Get
29
Network Controllers
29.1
Get
30
JSON Objects
30.1
SoftwareVersion
30.1.1
SoftwareVersion Field Description
30.1.2
SoftwareVersion JSON Schema
30.2
AddUserData
30.2.1
AddUserData Field Description
30.2.2
AddUserData JSON Schema
30.3
CustomUserOptions
30.3.1
CustomUserOptions Field Description
30.3.2
CustomUserOptions JSON Schema
30.4
Role
30.4.1
Role Field Description
30.4.2
Role JSON Schema
30.5
TracingOptionsJson
30.5.1
TracingOptionsJson Field Description
30.5.2
TracingOptionsJson JSON Schema
30.6
License
30.6.1
License Field Description
30.6.2
License JSON Schema
30.7
ImportLodData
30.7.1
ImportLodData Field Description
30.7.2
ImportLodData JSON Schema
30.8
AddSystemProfile
30.8.1
AddSystemProfile Field Description
30.8.2
AddSystemProfile JSON Schema
30.9
AddProviderProfile
30.9.1
AddProviderProfile Field Description
30.9.2
AddProviderProfile JSON Schema
30.10
AddSipPhoneRegistrarProfile
30.10.1
AddSipPhoneRegistrarProfile Field Description
30.10.2
AddSipPhoneRegistrarProfile JSON Schema
30.11
SipNodeTransportConnection
30.11.1
SipNodeTransportConnection Field Description
30.11.2
SipNodeTransportConnection JSON Schema
30.12
NetworkPeerWhitelistEntry
30.12.1
NetworkPeerWhitelistEntry Field Description
30.12.2
NetworkPeerWhitelistEntry JSON Schema
30.13
ActiveSessionsFilter
30.13.1
ActiveSessionsFilter Field Description
30.13.2
ActiveSessionsFilter JSON Schema
30.14
DialStringRewriting
30.14.1
DialStringRewriting Field Description
30.14.2
DialStringRewriting JSON Schema
30.15
DialStringRewrite
30.15.1
DialStringRewrite Field Description
30.15.2
DialStringRewrite JSON Schema
30.16
TelIdent
30.16.1
TelIdent Field Description
30.16.2
TelIdent JSON Schema
30.17
SetMuteRequestDataJson
30.17.1
SetMuteRequestDataJson Field Description
30.17.2
SetMuteRequestDataJson JSON Schema
30.18
AnynodeConfigState
30.18.1
AnynodeConfigState Field Description
30.18.2
AnynodeConfigState JSON Schema
30.19
BackupExportOptions
30.19.1
BackupExportOptions Field Description
30.19.2
BackupExportOptions JSON Schema
30.20
MaintenanceMode
30.20.1
MaintenanceMode Field Description
30.20.2
MaintenanceMode JSON Schema
30.21
MediaRecording
30.21.1
MediaRecording Field Description
30.21.2
MediaRecording JSON Schema
30.22
MsTeamsSbaOptions
30.22.1
MsTeamsSbaOptions Field Description
30.22.2
MsTeamsSbaOptions JSON Schema
30.23
MsTeamsSbaStatus
30.23.1
MsTeamsSbaStatus Field Description
30.23.2
MsTeamsSbaStatus JSON Schema
30.24
MsTeamsSbaFingerprint
30.24.1
MsTeamsSbaFingerprint Field Description
30.24.2
MsTeamsSbaFingerprint JSON Schema
30.25
MsTeamsSbaLog
30.25.1
MsTeamsSbaLog Field Description
30.25.2
MsTeamsSbaLog JSON Schema
30.26
HotStandbyOptions
30.26.1
HotStandbyOptions Field Description
30.26.2
HotStandbyOptions JSON Schema
30.27
AddHotStandbyResponse
30.27.1
AddHotStandbyResponse Field Description
30.27.2
AddHotStandbyResponse JSON Schema
30.28
HotStandbyStatus
30.28.1
HotStandbyStatus Field Description
30.28.2
HotStandbyStatus JSON Schema
30.29
CreateConditionsOptions
30.29.1
CreateConditionsOptions Field Description
30.29.2
CreateConditionsOptions JSON Schema
30.30
StandardTransportConnection
30.30.1
StandardTransportConnection Field Description
30.30.2
StandardTransportConnection JSON Schema
30.31
PlainTransportConnection
30.31.1
PlainTransportConnection Field Description
30.31.2
PlainTransportConnection JSON Schema
30.32
SipLoadBalancingTransportConnection
30.32.1
SipLoadBalancingTransportConnection Field Description
30.32.2
SipLoadBalancingTransportConnection JSON Schema
30.33
SipRegistrationAsTransportConnection
30.33.1
SipRegistrationAsTransportConnection Field Description
30.33.2
SipRegistrationAsTransportConnection JSON Schema
30.34
SrvLoadBalancer
30.34.1
SrvLoadBalancer Field Description
30.34.2
SrvLoadBalancer JSON Schema
30.35
SipCredentials
30.35.1
SipCredentials Field Description
30.35.2
SipCredentials JSON Schema
30.36
Credentials
30.36.1
Credentials Field Description
30.36.2
Credentials JSON Schema
30.37
AssertedUri
30.37.1
AssertedUri Field Description
30.37.2
AssertedUri JSON Schema
30.38
DirectoryInfo
30.38.1
DirectoryInfo Field Description
30.38.2
DirectoryInfo JSON Schema
30.39
StaticUserDirectory
30.39.1
StaticUserDirectory Field Description
30.39.2
StaticUserDirectory JSON Schema
30.40
Resources
30.40.1
Resources Field Description
30.40.2
Resources JSON Schema
30.41
RequestRouter
30.41.1
RequestRouter Field Description
30.41.2
RequestRouter JSON Schema
30.42
AddRoutingDomainOptions
30.42.1
AddRoutingDomainOptions Field Description
30.42.2
AddRoutingDomainOptions JSON Schema
30.43
GetRoutingDomainOptions
30.43.1
GetRoutingDomainOptions Field Description
30.43.2
GetRoutingDomainOptions JSON Schema
30.44
RoutingDomainRoute
30.44.1
RoutingDomainRoute Field Description
30.44.2
RoutingDomainRoute JSON Schema
30.45
RoutingDomainRouteV0
30.45.1
RoutingDomainRouteV0 Field Description
30.45.2
RoutingDomainRouteV0 JSON Schema
30.46
AddRoutingForwardProfileOptions
30.46.1
AddRoutingForwardProfileOptions Field Description
30.46.2
AddRoutingForwardProfileOptions JSON Schema
30.47
WebserverConnector
30.47.1
WebserverConnector Field Description
30.47.2
WebserverConnector JSON Schema
30.48
LocalUser
30.48.1
LocalUser Field Description
30.48.2
LocalUser JSON Schema
30.49
LocalV0User
30.49.1
LocalV0User Field Description
30.49.2
LocalV0User JSON Schema
30.50
LdapAuthority
30.50.1
LdapAuthority Field Description
30.50.2
LdapAuthority JSON Schema
30.51
LicenseFacility
30.51.1
LicenseFacility Field Description
30.51.2
LicenseFacility JSON Schema
30.52
SystemId
30.52.1
SystemId Field Description
30.52.2
SystemId JSON Schema
30.53
GetNodesNode
30.53.1
GetNodesNode Field Description
30.53.2
GetNodesNode JSON Schema
30.54
GetSystemsProfilesProfile
30.54.1
GetSystemsProfilesProfile Field Description
30.54.2
GetSystemsProfilesProfile JSON Schema
30.55
AddSystemSipTransport
30.55.1
AddSystemSipTransport Field Description
30.55.2
AddSystemSipTransport JSON Schema
30.56
PortRange
30.56.1
PortRange Field Description
30.56.2
PortRange JSON Schema
30.57
RemoteSipDomain
30.57.1
RemoteSipDomain Field Description
30.57.2
RemoteSipDomain JSON Schema
30.58
TelMatch
30.58.1
TelMatch Field Description
30.58.2
TelMatch JSON Schema
30.59
AddSystemSipNodeWhitelist
30.59.1
AddSystemSipNodeWhitelist Field Description
30.59.2
AddSystemSipNodeWhitelist JSON Schema
30.60
AddNodeResult
30.60.1
AddNodeResult Field Description
30.60.2
AddNodeResult JSON Schema
30.61
GetProviderProfilesProfile
30.61.1
GetProviderProfilesProfile Field Description
30.61.2
GetProviderProfilesProfile JSON Schema
30.62
TelMatchExtensionRange
30.62.1
TelMatchExtensionRange Field Description
30.62.2
TelMatchExtensionRange JSON Schema
30.63
SipUserCredentials
30.63.1
SipUserCredentials Field Description
30.63.2
SipUserCredentials JSON Schema
30.64
TelstraNthTrunkOptions
30.64.1
TelstraNthTrunkOptions Field Description
30.64.2
TelstraNthTrunkOptions JSON Schema
30.65
CertificateListEntry
30.65.1
CertificateListEntry Field Description
30.65.2
CertificateListEntry JSON Schema
30.66
MatchPatternSegment
30.66.1
MatchPatternSegment Field Description
30.66.2
MatchPatternSegment JSON Schema
30.67
TelRewriteSegment
30.67.1
TelRewriteSegment Field Description
30.67.2
TelRewriteSegment JSON Schema
30.68
TagMatch
30.68.1
TagMatch Field Description
30.68.2
TagMatch JSON Schema
30.69
TagRewrite
30.69.1
TagRewrite Field Description
30.69.2
TagRewrite JSON Schema
30.70
CryCertificate
30.70.1
CryCertificate Field Description
30.70.2
CryCertificate JSON Schema
30.71
CryPrivateKey
30.71.1
CryPrivateKey Field Description
30.71.2
CryPrivateKey JSON Schema
30.72
MsTeamsSbaDiagnosticsServiceState
30.72.1
MsTeamsSbaDiagnosticsServiceState Field Description
30.72.2
MsTeamsSbaDiagnosticsServiceState JSON Schema
30.73
SbaServiceDiagnosticState
30.73.1
SbaServiceDiagnosticState Field Description
30.73.2
SbaServiceDiagnosticState JSON Schema
30.74
SbaHttpRequestState
30.74.1
SbaHttpRequestState Field Description
30.74.2
SbaHttpRequestState JSON Schema
30.75
MsTeamsSbaUser
30.75.1
MsTeamsSbaUser Field Description
30.75.2
MsTeamsSbaUser JSON Schema
30.76
HotStandbyMainSystemOptions
30.76.1
HotStandbyMainSystemOptions Field Description
30.76.2
HotStandbyMainSystemOptions JSON Schema
30.77
HotStandbyStandbySystemOptions
30.77.1
HotStandbyStandbySystemOptions Field Description
30.77.2
HotStandbyStandbySystemOptions JSON Schema
30.78
HotStandbyLinkStatus
30.78.1
HotStandbyLinkStatus Field Description
30.78.2
HotStandbyLinkStatus JSON Schema
30.79
HotStandbyMainRoleStatus
30.79.1
HotStandbyMainRoleStatus Field Description
30.79.2
HotStandbyMainRoleStatus JSON Schema
30.80
HotStandbyMainSystemStatus
30.80.1
HotStandbyMainSystemStatus Field Description
30.80.2
HotStandbyMainSystemStatus JSON Schema
30.81
HotStandbyStandbyRoleStatus
30.81.1
HotStandbyStandbyRoleStatus Field Description
30.81.2
HotStandbyStandbyRoleStatus JSON Schema
30.82
HotStandbyStandbySystemStatus
30.82.1
HotStandbyStandbySystemStatus Field Description
30.82.2
HotStandbyStandbySystemStatus JSON Schema
30.83
TransportConnectionProxy
30.83.1
TransportConnectionProxy Field Description
30.83.2
TransportConnectionProxy JSON Schema
30.84
SipbnAddress
30.84.1
SipbnAddress Field Description
30.84.2
SipbnAddress JSON Schema
30.85
SipsnRoute
30.85.1
SipsnRoute Field Description
30.85.2
SipsnRoute JSON Schema
30.86
TransportConnectionStatusCodeErrorFlags
30.86.1
TransportConnectionStatusCodeErrorFlags Field Description
30.86.2
TransportConnectionStatusCodeErrorFlags JSON Schema
30.87
TransportConnectionAuthentication
30.87.1
TransportConnectionAuthentication Field Description
30.87.2
TransportConnectionAuthentication JSON Schema
30.88
SipLoadBalancerTarget
30.88.1
SipLoadBalancerTarget Field Description
30.88.2
SipLoadBalancerTarget JSON Schema
30.89
SrvLoadBalancerTargetTemplate
30.89.1
SrvLoadBalancerTargetTemplate Field Description
30.89.2
SrvLoadBalancerTargetTemplate JSON Schema
30.90
StaticUserDirectoryUser
30.90.1
StaticUserDirectoryUser Field Description
30.90.2
StaticUserDirectoryUser JSON Schema
30.91
ResourcesMemory
30.91.1
ResourcesMemory Field Description
30.91.2
ResourcesMemory JSON Schema
30.92
RoutingDomainRouteEstablishmentV0
30.92.1
RoutingDomainRouteEstablishmentV0 Field Description
30.92.2
RoutingDomainRouteEstablishmentV0 JSON Schema
30.93
RoutingDomainRouteFilter
30.93.1
RoutingDomainRouteFilter Field Description
30.93.2
RoutingDomainRouteFilter JSON Schema
30.94
RoutingDomainRoutePathReplacement
30.94.1
RoutingDomainRoutePathReplacement Field Description
30.94.2
RoutingDomainRoutePathReplacement JSON Schema
30.95
RoutingDomainRouteEstablishment
30.95.1
RoutingDomainRouteEstablishment Field Description
30.95.2
RoutingDomainRouteEstablishment JSON Schema
30.96
String
30.96.1
String Field Description
30.96.2
String JSON Schema
30.97
RoutingForwardProfile
30.97.1
RoutingForwardProfile Field Description
30.97.2
RoutingForwardProfile JSON Schema
30.98
SignalingForwardingOptions
30.98.1
SignalingForwardingOptions Field Description
30.98.2
SignalingForwardingOptions JSON Schema
30.99
WebserverConnectorNetworkOptions
30.99.1
WebserverConnectorNetworkOptions Field Description
30.99.2
WebserverConnectorNetworkOptions JSON Schema
30.100
WebserverConnectorTlsOptions
30.100.1
WebserverConnectorTlsOptions Field Description
30.100.2
WebserverConnectorTlsOptions JSON Schema
30.101
Backend
30.101.1
Backend Field Description
30.101.2
Backend JSON Schema
30.102
NetworkInterface
30.102.1
NetworkInterface Field Description
30.102.2
NetworkInterface JSON Schema
30.103
NetworkController
30.103.1
NetworkController Field Description
30.103.2
NetworkController JSON Schema
30.104
TelMatchList
30.104.1
TelMatchList Field Description
30.104.2
TelMatchList JSON Schema
30.105
TagRewriteOperation
30.105.1
TagRewriteOperation Field Description
30.105.2
TagRewriteOperation JSON Schema
30.106
SbaHttpStatus
30.106.1
SbaHttpStatus Field Description
30.106.2
SbaHttpStatus JSON Schema
30.107
HotStandbyReplicationOptions
30.107.1
HotStandbyReplicationOptions Field Description
30.107.2
HotStandbyReplicationOptions JSON Schema
30.108
TransportConnectionStatusCodeErrorFlag
30.108.1
TransportConnectionStatusCodeErrorFlag Field Description
30.108.2
TransportConnectionStatusCodeErrorFlag JSON Schema
30.109
SipLoadBalancerDefaultLoad
30.109.1
SipLoadBalancerDefaultLoad Field Description
30.109.2
SipLoadBalancerDefaultLoad JSON Schema
30.110
StaticUserDirectoryUserApplications
30.110.1
StaticUserDirectoryUserApplications Field Description
30.110.2
StaticUserDirectoryUserApplications JSON Schema
30.111
RoutingTelRewrite
30.111.1
RoutingTelRewrite Field Description
30.111.2
RoutingTelRewrite JSON Schema
30.112
RoutingDomainRouteLookupDirectories
30.112.1
RoutingDomainRouteLookupDirectories Field Description
30.112.2
RoutingDomainRouteLookupDirectories JSON Schema
30.113
RoutingDomainRouteEstablishAccept
30.113.1
RoutingDomainRouteEstablishAccept Field Description
30.113.2
RoutingDomainRouteEstablishAccept JSON Schema
30.114
TelephonyForwarding
30.114.1
TelephonyForwarding Field Description
30.114.2
TelephonyForwarding JSON Schema
30.115
NotifySipInfoFilter
30.115.1
NotifySipInfoFilter Field Description
30.115.2
NotifySipInfoFilter JSON Schema
30.116
ProvisioningUserAssociatedDevice
30.116.1
ProvisioningUserAssociatedDevice Field Description
30.116.2
ProvisioningUserAssociatedDevice JSON Schema
30.117
SipPolicyUserData
30.117.1
SipPolicyUserData Field Description
30.117.2
SipPolicyUserData JSON Schema
30.118
SipRegistrarUserData
30.118.1
SipRegistrarUserData Field Description
30.118.2
SipRegistrarUserData JSON Schema
30.119
WebRtcUserData
30.119.1
WebRtcUserData Field Description
30.119.2
WebRtcUserData JSON Schema
30.120
RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch
30.120.1
RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch Field Description
30.120.2
RoutingDomainRouteEstablishmentAcceptFailoverStatusMatch JSON Schema
30.121
MediaNegotiationForwarder
30.121.1
MediaNegotiationForwarder Field Description
30.121.2
MediaNegotiationForwarder JSON Schema
30.122
ProvisioningStaticVariableTable
30.122.1
ProvisioningStaticVariableTable JSON Schema
30.123
SipPolicyPrivacyOptions
30.123.1
SipPolicyPrivacyOptions Field Description
30.123.2
SipPolicyPrivacyOptions JSON Schema
30.124
SipRegistrarUserDialStrings
30.124.1
SipRegistrarUserDialStrings Field Description
30.124.2
SipRegistrarUserDialStrings JSON Schema
30.125
SipRegistrarUserFailover
30.125.1
SipRegistrarUserFailover Field Description
30.125.2
SipRegistrarUserFailover JSON Schema
30.126
TelAddress
30.126.1
TelAddress Field Description
30.126.2
TelAddress JSON Schema
30.127
TelStatusNoSuccess
30.127.1
TelStatusNoSuccess Field Description
30.127.2
TelStatusNoSuccess JSON Schema
30.128
MediaTranscodingOptions
30.128.1
MediaTranscodingOptions Field Description
30.128.2
MediaTranscodingOptions JSON Schema
Go to top
1
General
REST Documentation for anynode 4.12.14
February 4, 2025
1
General