4 Dial String Rewriting

4.1 Get-anynodeDialStringRewritings

Returns the specified dial string rewriting object.

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: DialStringRewriting

    Display name or ID of the dial string rewriting object. If not provided, all dial string rewriting objects will be returned.

Return Value Structure

The response body is strutured as an array. The array consists of DialStringRewriting JSON objects. A description for its fields is at section 25.5.1. For the JSON schema refer to section 25.5.2.

4.2 Set-anynodeDialStringRewriting

Modifies the selected dial string rewriting object.

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: DialStringRewriting

    The ID of the dial string rewriting object.

  • DisplayName

    Set up a name that helps you identify this object.

    Type: String

  • Id

    Type: String

  • Rules

    Type: Array of DialStringRewrite section 25.4

Return Value Structure

The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 25.5.1. For the JSON schema refer to section 25.5.2.

4.3 Add-anynodeDialStringRewriting

Adds a new dial string rewriting object.

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

  • DisplayName

    Set up a name that helps you identify this object.

    Type: String

  • Id

    Type: String

  • Rules

    Type: Array of DialStringRewrite section 25.4

Return Value Structure

The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 25.5.1. For the JSON schema refer to section 25.5.2.

4.4 Remove-anynodeDialStringRewriting

Removes a dial string rewriting object.

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: DialStringRewriting

    Display name or ID of the dial string rewriting object to be removed.

4.5 Get-anynodeDialStringRewritingRules

Returns the rewriting rules of the choosen dial string rewriting object.

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: DialStringRewriting

    Display name or ID of the dial string rewriting object to request rules from.

Return Value Structure

The response body is strutured as an array. The array consists of DialStringRewriting JSON objects. A description for its fields is at section 25.5.1. For the JSON schema refer to section 25.5.2.

4.6 Set-anynodeDialStringRewritingRules

Replaces the rewriting rules of the choosen dial string rewriting object.

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: DialStringRewriting

    Display name or ID of the dial string rewriting object the rewriting rules should be modified of.

  • Rules

    Array of type section 25.4.1

Return Value Structure

The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 25.4.1. For the JSON schema refer to section 25.4.2.

4.7 Import-anynodeDialStringRewritingRules

Imports dial string rewriting rules into the specified dial string rewriting object.

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

  • bool: Json

    Determines if the uploaded file is in the JSON format. Defaults to false.

  • string: DialStringRewriting

    Display name or ID of the dial string rewriting object to add rewriting rules to.

4.8 Export-anynodeDialStringRewritingRules

Exports dial string rewriting rules from the specified dial string rewriting object as JSON.

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: BackendName

    (Optional) If there are additionally configured backends...

  • string: DialStringRewriting

    Display name or ID of the dial string rewriting object to add rewriting rules to.

4.9 Add-anynodeDialStringRewritingRule

Add dial string rewriting rules to the specified dial string rewriting object.

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: DialStringRewriting

    Display name or ID of the dial string rewriting object the rewriting rules should be modified of.

  • RewriteType

    Type of dial string rewrite

    Type: RewriteTypeJson

    Possible values:

    • prefixAndSuffix

    • wildcardPattern

    • cutExtensionNumber

    • 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 25.6

  • StructuralPattern

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

    Type: Array of MatchPatternSegment section 25.7

  • 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

  • DisplayName

    The display name of the dial string can be modified with this value.

    Type: String

  • RewriteSegments

    This setting determines how the rewritten dial string is structured.

    Type: Array of TelRewriteSegment section 25.8

  • BranchRewrites

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

    Type: Array of DialStringRewrite section 25.4

  • BranchElseRewrites

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

    Type: Array of DialStringRewrite section 25.4

  • 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 25.9

  • 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 25.10

  • 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

Return Value Structure

The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 25.5.1. For the JSON schema refer to section 25.5.2.

4.10 Remove-anynodeDialStringRewritingRule

Removes a dial string rewriting rule of the specified dial string rewriting object.

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: Index

    The index of the rule that will be removed. Either this or the parameter rule must be provided.

  • string: Rule

    The display name of the rule that will be removed. Either this or the parameter index must be provided.

  • string: DialStringRewriting

    Display name or ID of the dial string rewriting object the rewriting rules should be modified of.

Return Value Structure

The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 25.5.1. For the JSON schema refer to section 25.5.2.

4.11 Clear-anynodeDialStringRewritingRules

Removes all dial string rewriting rules of the specified dial string rewriting object.

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: DialStringRewriting

    Display name or ID of the dial string rewriting object the rewriting rules should be modified of.

Return Value Structure

The response body is structured as DialStringRewriting JSON object. A description for its fields is at section 25.5.1. For the JSON schema refer to section 25.5.2.