REST Documentation for anynode 4.10.18
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 Port
7.12
Set Port
7.13
Get TlsPort
7.14
Set TlsPort
7.15
Get Teams FQDN
7.16
Set Teams FQDN
7.17
Get Hostname/FQDN
7.18
Set Hostname/FQDN
7.19
Get Network Security Profile Name
7.20
Set Network Security Profile Name
7.21
Get Certificate
7.22
Set Certificate
7.23
Get Transport Connections
7.24
Add Transport Connection
7.25
Clear Transport Connections
7.26
Set Transport Connections
7.27
Remove Transport Connection
7.28
Add Trusted Certificates
7.29
Clear Trusted Certificates
7.30
Get Incoming Dial String Rewrite Rules
7.31
Set Incoming Dial String Rewrite Rules
7.32
Add Incoming Dial String Rewrite Rules
7.33
Remove Incoming Dial String Rewrite Rules
7.34
Get Outgoing Dial String Rewrite Rules
7.35
Set Outgoing Dial String Rewrite Rules
7.36
Add Outgoing Dial String Rewrite Rules
7.37
Remove Outgoing Dial String Rewrite Rules
7.38
Get Network Peer Whitelist
7.39
Set Network Peer Whitelist
7.40
Add Network Peer Whitelist Entry
7.41
Remove Network Peer Whitelist Entry
7.42
Get Certificate Chain
7.43
Add Chain Certificate
7.44
Remove Chain Certificate
7.45
Clear Certificate Chain
7.46
Request Certificate Chain
8
Dashboard
8.1
Get
9
ActiveSessions
9.1
Get
10
Call History
10.1
Export
10.2
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
Transport Connections
18.1
Get Transport Connection
18.2
Create Standard Transport Connection
18.3
Add Plain Transport Connection
18.4
Add Load Balancing Transport Connection
18.5
Add SIP Registration As Transport Connection
18.6
Add SRV Load Balancer
18.7
Remove Transport Connection
18.8
Get Authentication
18.9
Set Authentication
18.10
Get Asserted URI
18.11
Set Asserted URI
18.12
Get Address of Record
18.13
Set Address of Record
19
Directories
19.1
Get Directories
19.2
Remove Directory
19.3
Add Static User Directory
19.4
Set Static User Directory
19.5
Set OAuth Client Secret
20
System Resources
20.1
Get Resources
21
Routing Domains
21.1
Get Routing Domains
21.2
Add Routing Domain
21.3
Set Routing Domain
21.4
Remove Routing Domain
21.5
Get Routes
21.6
Add Route
21.7
Clone Route
21.8
Set Route
21.9
Remove Route
21.10
Get Source Nodes
21.11
Add Source Nodes
21.12
Set Source Nodes
21.13
Remove Source Nodes
21.14
Get Proceeding Signal
21.15
Enable Proceeding Signal
21.16
Disable Proceeding Signal
21.17
Get Route in Maintenance
21.18
Enable Route in Maintenance
21.19
Disable Route in Maintenance
22
Routing Forward Profiles
22.1
Get
22.2
Add
23
Detached Objects
23.1
Get Sorts
23.2
Get Object
23.3
Set Object
23.4
Remove Object
23.5
Import Object
23.6
Export Object
24
Backends
24.1
Get
25
Network Interfaces
25.1
Get
26
Network Controllers
26.1
Get
27
JSON Objects
27.1
SoftwareVersion
27.1.1
SoftwareVersion Field Description
27.1.2
SoftwareVersion JSON Schema
27.2
AddUserData
27.2.1
AddUserData Field Description
27.2.2
AddUserData JSON Schema
27.3
CustomUserOptions
27.3.1
CustomUserOptions Field Description
27.3.2
CustomUserOptions JSON Schema
27.4
Role
27.4.1
Role Field Description
27.4.2
Role JSON Schema
27.5
TracingOptionsJson
27.5.1
TracingOptionsJson Field Description
27.5.2
TracingOptionsJson JSON Schema
27.6
License
27.6.1
License Field Description
27.6.2
License JSON Schema
27.7
ImportLodData
27.7.1
ImportLodData Field Description
27.7.2
ImportLodData JSON Schema
27.8
AddSystemProfile
27.8.1
AddSystemProfile Field Description
27.8.2
AddSystemProfile JSON Schema
27.9
AddProviderProfile
27.9.1
AddProviderProfile Field Description
27.9.2
AddProviderProfile JSON Schema
27.10
AddSipPhoneRegistrarProfile
27.10.1
AddSipPhoneRegistrarProfile Field Description
27.10.2
AddSipPhoneRegistrarProfile JSON Schema
27.11
SipNodeTransportConnection
27.11.1
SipNodeTransportConnection Field Description
27.11.2
SipNodeTransportConnection JSON Schema
27.12
NetworkPeerWhitelistEntry
27.12.1
NetworkPeerWhitelistEntry Field Description
27.12.2
NetworkPeerWhitelistEntry JSON Schema
27.13
DialStringRewriting
27.13.1
DialStringRewriting Field Description
27.13.2
DialStringRewriting JSON Schema
27.14
DialStringRewrite
27.14.1
DialStringRewrite Field Description
27.14.2
DialStringRewrite JSON Schema
27.15
TelIdent
27.15.1
TelIdent Field Description
27.15.2
TelIdent JSON Schema
27.16
AnynodeConfigState
27.16.1
AnynodeConfigState Field Description
27.16.2
AnynodeConfigState JSON Schema
27.17
BackupExportOptions
27.17.1
BackupExportOptions Field Description
27.17.2
BackupExportOptions JSON Schema
27.18
MaintenanceMode
27.18.1
MaintenanceMode Field Description
27.18.2
MaintenanceMode JSON Schema
27.19
MediaRecording
27.19.1
MediaRecording Field Description
27.19.2
MediaRecording JSON Schema
27.20
MsTeamsSbaOptions
27.20.1
MsTeamsSbaOptions Field Description
27.20.2
MsTeamsSbaOptions JSON Schema
27.21
MsTeamsSbaStatus
27.21.1
MsTeamsSbaStatus Field Description
27.21.2
MsTeamsSbaStatus JSON Schema
27.22
MsTeamsSbaFingerprint
27.22.1
MsTeamsSbaFingerprint Field Description
27.22.2
MsTeamsSbaFingerprint JSON Schema
27.23
MsTeamsSbaLog
27.23.1
MsTeamsSbaLog Field Description
27.23.2
MsTeamsSbaLog JSON Schema
27.24
StandardTransportConnection
27.24.1
StandardTransportConnection Field Description
27.24.2
StandardTransportConnection JSON Schema
27.25
PlainTransportConnection
27.25.1
PlainTransportConnection Field Description
27.25.2
PlainTransportConnection JSON Schema
27.26
SipLoadBalancingTransportConnection
27.26.1
SipLoadBalancingTransportConnection Field Description
27.26.2
SipLoadBalancingTransportConnection JSON Schema
27.27
SipRegistrationAsTransportConnection
27.27.1
SipRegistrationAsTransportConnection Field Description
27.27.2
SipRegistrationAsTransportConnection JSON Schema
27.28
SrvLoadBalancer
27.28.1
SrvLoadBalancer Field Description
27.28.2
SrvLoadBalancer JSON Schema
27.29
SipCredentials
27.29.1
SipCredentials Field Description
27.29.2
SipCredentials JSON Schema
27.30
Credentials
27.30.1
Credentials Field Description
27.30.2
Credentials JSON Schema
27.31
AssertedUri
27.31.1
AssertedUri Field Description
27.31.2
AssertedUri JSON Schema
27.32
DirectoryInfo
27.32.1
DirectoryInfo Field Description
27.32.2
DirectoryInfo JSON Schema
27.33
StaticUserDirectory
27.33.1
StaticUserDirectory Field Description
27.33.2
StaticUserDirectory JSON Schema
27.34
Resources
27.34.1
Resources Field Description
27.34.2
Resources JSON Schema
27.35
AddRoutingDomainOptions
27.35.1
AddRoutingDomainOptions Field Description
27.35.2
AddRoutingDomainOptions JSON Schema
27.36
GetRoutingDomainOptions
27.36.1
GetRoutingDomainOptions Field Description
27.36.2
GetRoutingDomainOptions JSON Schema
27.37
RoutingDomainRoute
27.37.1
RoutingDomainRoute Field Description
27.37.2
RoutingDomainRoute JSON Schema
27.38
AddRoutingForwardProfileOptions
27.38.1
AddRoutingForwardProfileOptions Field Description
27.38.2
AddRoutingForwardProfileOptions JSON Schema
27.39
LocalUser
27.39.1
LocalUser Field Description
27.39.2
LocalUser JSON Schema
27.40
LocalV0User
27.40.1
LocalV0User Field Description
27.40.2
LocalV0User JSON Schema
27.41
LdapAuthority
27.41.1
LdapAuthority Field Description
27.41.2
LdapAuthority JSON Schema
27.42
LicenseFacility
27.42.1
LicenseFacility Field Description
27.42.2
LicenseFacility JSON Schema
27.43
SystemId
27.43.1
SystemId Field Description
27.43.2
SystemId JSON Schema
27.44
GetNodesNode
27.44.1
GetNodesNode Field Description
27.44.2
GetNodesNode JSON Schema
27.45
GetSystemsProfilesProfile
27.45.1
GetSystemsProfilesProfile Field Description
27.45.2
GetSystemsProfilesProfile JSON Schema
27.46
PortRange
27.46.1
PortRange Field Description
27.46.2
PortRange JSON Schema
27.47
RemoteSipDomain
27.47.1
RemoteSipDomain Field Description
27.47.2
RemoteSipDomain JSON Schema
27.48
TelMatch
27.48.1
TelMatch Field Description
27.48.2
TelMatch JSON Schema
27.49
AddNodeResult
27.49.1
AddNodeResult Field Description
27.49.2
AddNodeResult JSON Schema
27.50
GetProviderProfilesProfile
27.50.1
GetProviderProfilesProfile Field Description
27.50.2
GetProviderProfilesProfile JSON Schema
27.51
TelMatchExtensionRange
27.51.1
TelMatchExtensionRange Field Description
27.51.2
TelMatchExtensionRange JSON Schema
27.52
SipUserCredentials
27.52.1
SipUserCredentials Field Description
27.52.2
SipUserCredentials JSON Schema
27.53
TelstraNthTrunkOptions
27.53.1
TelstraNthTrunkOptions Field Description
27.53.2
TelstraNthTrunkOptions JSON Schema
27.54
CertificateListEntry
27.54.1
CertificateListEntry Field Description
27.54.2
CertificateListEntry JSON Schema
27.55
MatchPatternSegment
27.55.1
MatchPatternSegment Field Description
27.55.2
MatchPatternSegment JSON Schema
27.56
TelRewriteSegment
27.56.1
TelRewriteSegment Field Description
27.56.2
TelRewriteSegment JSON Schema
27.57
TagMatch
27.57.1
TagMatch Field Description
27.57.2
TagMatch JSON Schema
27.58
TagRewrite
27.58.1
TagRewrite Field Description
27.58.2
TagRewrite JSON Schema
27.59
CryCertificate
27.59.1
CryCertificate Field Description
27.59.2
CryCertificate JSON Schema
27.60
CryPrivateKey
27.60.1
CryPrivateKey Field Description
27.60.2
CryPrivateKey JSON Schema
27.61
MsTeamsSbaUser
27.61.1
MsTeamsSbaUser Field Description
27.61.2
MsTeamsSbaUser JSON Schema
27.62
TransportConnectionProxy
27.62.1
TransportConnectionProxy Field Description
27.62.2
TransportConnectionProxy JSON Schema
27.63
SipbnAddress
27.63.1
SipbnAddress Field Description
27.63.2
SipbnAddress JSON Schema
27.64
SipsnRoute
27.64.1
SipsnRoute Field Description
27.64.2
SipsnRoute JSON Schema
27.65
TransportConnectionStatusCodeErrorFlags
27.65.1
TransportConnectionStatusCodeErrorFlags Field Description
27.65.2
TransportConnectionStatusCodeErrorFlags JSON Schema
27.66
TransportConnectionAuthentication
27.66.1
TransportConnectionAuthentication Field Description
27.66.2
TransportConnectionAuthentication JSON Schema
27.67
SipLoadBalancerTarget
27.67.1
SipLoadBalancerTarget Field Description
27.67.2
SipLoadBalancerTarget JSON Schema
27.68
SrvLoadBalancerTargetTemplate
27.68.1
SrvLoadBalancerTargetTemplate Field Description
27.68.2
SrvLoadBalancerTargetTemplate JSON Schema
27.69
StaticUserDirectoryUser
27.69.1
StaticUserDirectoryUser Field Description
27.69.2
StaticUserDirectoryUser JSON Schema
27.70
ResourcesMemory
27.70.1
ResourcesMemory Field Description
27.70.2
ResourcesMemory JSON Schema
27.71
RoutingDomainRouteEstablishment
27.71.1
RoutingDomainRouteEstablishment Field Description
27.71.2
RoutingDomainRouteEstablishment JSON Schema
27.72
RoutingDomainRouteFilter
27.72.1
RoutingDomainRouteFilter Field Description
27.72.2
RoutingDomainRouteFilter JSON Schema
27.73
RoutingDomainRoutePathReplacement
27.73.1
RoutingDomainRoutePathReplacement Field Description
27.73.2
RoutingDomainRoutePathReplacement JSON Schema
27.74
String
27.74.1
String Field Description
27.74.2
String JSON Schema
27.75
RoutingForwardProfile
27.75.1
RoutingForwardProfile Field Description
27.75.2
RoutingForwardProfile JSON Schema
27.76
SignalingForwardingOptions
27.76.1
SignalingForwardingOptions Field Description
27.76.2
SignalingForwardingOptions JSON Schema
27.77
Backend
27.77.1
Backend Field Description
27.77.2
Backend JSON Schema
27.78
NetworkInterface
27.78.1
NetworkInterface Field Description
27.78.2
NetworkInterface JSON Schema
27.79
NetworkController
27.79.1
NetworkController Field Description
27.79.2
NetworkController JSON Schema
27.80
TelMatchList
27.80.1
TelMatchList Field Description
27.80.2
TelMatchList JSON Schema
27.81
TagRewriteOperation
27.81.1
TagRewriteOperation Field Description
27.81.2
TagRewriteOperation JSON Schema
27.82
TransportConnectionStatusCodeErrorFlag
27.82.1
TransportConnectionStatusCodeErrorFlag Field Description
27.82.2
TransportConnectionStatusCodeErrorFlag JSON Schema
27.83
SipLoadBalancerDefaultLoad
27.83.1
SipLoadBalancerDefaultLoad Field Description
27.83.2
SipLoadBalancerDefaultLoad JSON Schema
27.84
StaticUserDirectoryUserApplications
27.84.1
StaticUserDirectoryUserApplications Field Description
27.84.2
StaticUserDirectoryUserApplications JSON Schema
27.85
RoutingTelRewrite
27.85.1
RoutingTelRewrite Field Description
27.85.2
RoutingTelRewrite JSON Schema
27.86
RoutingDomainRouteLookupDirectories
27.86.1
RoutingDomainRouteLookupDirectories Field Description
27.86.2
RoutingDomainRouteLookupDirectories JSON Schema
27.87
TelephonyForwarding
27.87.1
TelephonyForwarding Field Description
27.87.2
TelephonyForwarding JSON Schema
27.88
NotifySipInfoFilter
27.88.1
NotifySipInfoFilter Field Description
27.88.2
NotifySipInfoFilter JSON Schema
27.89
ProvisioningUserAssociatedDevice
27.89.1
ProvisioningUserAssociatedDevice Field Description
27.89.2
ProvisioningUserAssociatedDevice JSON Schema
27.90
SipPolicyUserData
27.90.1
SipPolicyUserData Field Description
27.90.2
SipPolicyUserData JSON Schema
27.91
SipRegistrarUserData
27.91.1
SipRegistrarUserData Field Description
27.91.2
SipRegistrarUserData JSON Schema
27.92
WebRtcUserData
27.92.1
WebRtcUserData Field Description
27.92.2
WebRtcUserData JSON Schema
27.93
MediaNegotiationForwarder
27.93.1
MediaNegotiationForwarder Field Description
27.93.2
MediaNegotiationForwarder JSON Schema
27.94
ProvisioningStaticVariableTable
27.94.1
ProvisioningStaticVariableTable JSON Schema
27.95
SipPolicyPrivacyOptions
27.95.1
SipPolicyPrivacyOptions Field Description
27.95.2
SipPolicyPrivacyOptions JSON Schema
27.96
SipRegistrarUserDialStrings
27.96.1
SipRegistrarUserDialStrings Field Description
27.96.2
SipRegistrarUserDialStrings JSON Schema
27.97
SipRegistrarUserFailover
27.97.1
SipRegistrarUserFailover Field Description
27.97.2
SipRegistrarUserFailover JSON Schema
27.98
TelAddress
27.98.1
TelAddress Field Description
27.98.2
TelAddress JSON Schema
27.99
MediaTranscodingOptions
27.99.1
MediaTranscodingOptions Field Description
27.99.2
MediaTranscodingOptions JSON Schema
Go to top
1
General
REST Documentation for anynode 4.10.18
February 29, 2024
1
General