18 Routing Domains
18.1 Get-anynodeRoutingDomains
Returns the currently configured routing domains.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
Return Value Structure
The response body is strutured as an array. The array consists of GetRoutingDomainOptions JSON objects. A description for its fields is at section 29.52.1. For the JSON schema refer to section 29.52.2.
18.2 Add-anynodeRoutingDomain
Adds a new routing domain to the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
-
DisplayName
Type: String
-
SourceNodes
Type: Array of String
Return Value Structure
The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 29.52.1. For the JSON schema refer to section 29.52.2.
18.3 Set-anynodeRoutingDomain
Modifies the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The display name or id of the routing domain.
-
DisplayName
Type: String
-
SourceNodes
Type: Array of String
Return Value Structure
The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 29.52.1. For the JSON schema refer to section 29.52.2.
18.4 Remove-anynodeRoutingDomain
Removes a routing domain from the current configuration.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The ID or display name of the routing domain.
Return Value Structure
The response body is strutured as an array. The array consists of GetRoutingDomainOptions JSON objects. A description for its fields is at section 29.52.1. For the JSON schema refer to section 29.52.2.
18.5 Get-anynodeRoutes
Returns the routes of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
Return Value Structure
The response body is strutured as an array. The array consists of RoutingDomainRouteV0 JSON objects. A description for its fields is at section 29.57.1. For the JSON schema refer to section 29.57.2.
18.6 Add-anynodeRoute
Adds a route to the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
-
string: Mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
string: RoutingDomain
The id or display name of the routing domain.
-
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
Return Value Structure
The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 29.56.1. For the JSON schema refer to section 29.56.2.
18.7 Copy-anynodeRoute
Clones the selected route.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: Mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
string: RoutingDomain
The id or display name of the routing domain.
-
string: DisplayName
The display name of the route that will be cloned. Either this, the "id" or the "index" must be specified.
-
string: Index
The index of the route that will be cloned. Either this, the "id" or the "displayName" must be specified.
-
string: Id
The id of the route that will be cloned. Either this, the "index" or the "displayName" must be specified.
Return Value Structure
The response body is structured as RoutingDomainRouteV0 JSON object. A description for its fields is at section 29.57.1. For the JSON schema refer to section 29.57.2.
18.8 Set Route
Modifies a route of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
-
string: Mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
string: RoutingDomain
The id or display name of the routing domain.
-
string: Index
The display name of the route that should be modified. Either this or the "index" must be specified.
-
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
Return Value Structure
The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 29.56.1. For the JSON schema refer to section 29.56.2.
18.9 Set-anynodeRoute
Removes a route from the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
-
string: Mode
Determines which type of route will be added.
Type: String
Possible Values:
-
establishment
-
pathReplacement
-
-
string: RoutingDomain
The id or display name of the routing domain.
-
string: Index
The display name of the route that should be modified. Either this or the "index" must be specified.
-
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
Return Value Structure
The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 29.56.1. For the JSON schema refer to section 29.56.2.
18.10 Get-anynodeRoutingDomainSourceNodes
Returns the source nodes of the selected routing domain
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id of the routing domain.
18.11 Add-anynodeRoutingDomainSourceNodes
Adds source nodes to the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 1
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id of the routing domain.
-
string[]: SourceNodeIds
The body must be a list of the node object ids that should be added to the source nodes of the select routing domain.
18.12 Set-anynodeRoutingDomainSourceNodes
Modifies the source nodes of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
-
string[]: SourceNodeIds
The body must be a list of the node object ids that should replace the source nodes of the select routing domain.
18.13 Remove-anynodeRoutingDomainSourceNodes
Removes source nodes from the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 2
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
-
string[]: sourceNodeIds
The request body is structured as an array containing the node ids that should be removed.
18.14 Get-anynodeRoutingDomainProceedingSignal
Returns whether the proceeding signal is enabled or not.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
18.15 Enable-anynodeRoutingDomainProceedingSignal
Enables the proceeding signal of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
18.16 Disable-anynodeRoutingDomainProceedingSignal
Disables the proceeding signal of the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
18.17 Get-anynodeRoutingDomainRouteInMaintenance
Returns whether routing is active in maintenance mode.
Required Permissions
-
API
-
Configuration Mode Read Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
18.18 Enable-anynodeRoutingDomainRouteInMaintenance
Enables routing in maintenance mode for the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.
18.19 Disable-anynodeRoutingDomainRouteInMaintenance
Disables routing in maintenance mode for the selected routing domain.
Required Permissions
-
API
-
Configuration Mode Read/Write Access
Request parameters
-
Address
mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.
Type: String
-
Port
mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.
Type: Integer
-
APIVersion = 0
This parameter states which version of the request should be used.
Type: Integer
-
string: RoutingDomain
The id or display name of the routing domain.