18 Routing Forward Profiles
18.1 Get-anynodeRoutingForwardProfiles
Returns the currently configured routing forward profiles
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
-
bool: CompleteData
Determines if the configuration (true) of the routing forward profiles or only its id and display name (false) will be returned.
Return Value Structure
The response body is strutured as an array. The array consists of RoutingForwardProfile JSON objects. A description for its fields is at section 25.75.1. For the JSON schema refer to section 25.75.2.
18.2 Add-anynodeRoutingForwardProfile
Adds a new routing forward profile.
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
-
AnnouncementIncoming
Play an announcement at the incoming node.
Type: Boolean
-
AnnouncementMediaSourceId
The id of the Announcement Media Source used as specified.
Type: String
-
AnnouncementOutgoing
Play an announcement at the outgoing node.
Type: Boolean
-
DisplayName
The name shown in the anynode frontend.
Type: String
-
EarlyMediaPassThrough
Specify whether early media should be already passed through during call setup.
Type: Boolean
-
Id
The ID of this object.
Type: String
-
MediaMode
Type: MediaMode
Possible values:
-
TRANSCODING
-
BYPASS
-
PASSTHROUGH
-
PASSTHROUGH_WITH_FALLBACK_TO_BYPASS
-
-
MediaNegotiationForwarderId
The ID of the media negotiation forwarder object. This can be set to use an existing object instead of creating a new one.
Type: String
-
MediaRecorderId
The id of the Media Recorder used to record as specified.
Type: String
-
MediaTranscodingOptionsId
The ID of the media transcoding options object. This can be set to use an existing object instead of creating a new one.
Type: String
-
RemoveAnynodeFromSignalingPath
Type: Boolean
-
SignalingForwardingFromCalledToCalling
Type: SignalingForwardingOptions section 25.54
-
SignalingForwardingFromCallingToCalled
Type: SignalingForwardingOptions section 25.54
-
TelephonyForwardingStackId
This value will be used instead of telephonyForwardingStack if the object is not complete. The id of a Telephony Forwarding is a collection of protocol specific settings which influence the way forwarding of signaling information or media data is going to take place.
Type: String
Return Value Structure
The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 25.49.1. For the JSON schema refer to section 25.49.2.