REST Documentation for anynode 4.10.4

August 2, 2023

1 General

This document is compatible with the anynode frontend version 4.10.4 and upwards, which provide an application programming interface (API) with many functions via HTTP requests

All REST request are handled by the anynode frontend. Therefore all request must be directed at the URL and port the anynode frontend is running on. The IP address and port on which REST request are accepted can be configured via the user interface. The options for this can be found in the 'Extras' menu in the 'Web Server->Connectors' tab.

Authentication

The REST API uses basic access authentication. In order to use the API it is recommended to create a dedicated user. Users can either be created by using the User Management in the anynode frontend user interface (Configuration ModeExtrasUser Management) or this API (section 9).

Session ID

If a user was able to be identified after any kind of request, the HTTP Response will contain the cookie JSESSIONID. This cookie can be used to communicate further with the server, using the same web session.

Query string parameters

Every request has a set of parameters that control how the request works. The following parameters can be set on every request.

  • version

    This parameter is mandatory and tells the server which version of the request is to be used. The latest version of a request can be found in this document. The latest version is version 0, if the section of a request doesn't state otherwise.If this parameter is not provided or invalid, the server will respond with the HTTP status 400 - Bad Request.

  • backendName

    The backend name unambiguously identifies the backend, which has been configured in the frontend. Each backend consists of a set of services (anynode, anynode monitor, anynode ucma...) that belong together. A standard installation sets the local backend name to "localBackend" by default.

  • keepSession

    If true, session resources will be held by the server until the session timeout has been reached.

Query String Parameter Encoding

Some characters are not allowed for query strings and may lead to faulty interpretations and erroneous results. For information about query string encoding refer to the RFC3986 (https://tools.ietf.org/html/rfc3986)

2 Version

2.1 Get

GET https://<HOST>:<PORT>/api/version/get?version=0

Returns version numbers for all products.

Required Permissions

  • API

Request parameters

  • product

    Select the component for which the version should be returned.

    Type: String

    Possible Values:

    • anynode

    • ucma

    • administration

    • monitor

    • frontend

    • java

Response Body Structure

The response body is structured as SoftwareVersion JSON object. A description for its fields is at section 26.1.1. For the JSON schema refer to section 26.1.2.

2.1.1 Example

GET http://127.0.0.1:8111/api/version/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "anynode": {
    "versionRelease": 14,
    "versionMajor": 4,
    "versionMinor": 11
  },
  "java": {"version": "1.8.0_372"},
  "administration": {
    "versionRelease": 0,
    "versionMajor": 4,
    "versionMinor": 9
  },
  "monitor": {
    "versionRelease": 2,
    "versionMajor": 4,
    "versionMinor": 11
  },
  "frontend": {
    "versionRelease": 0,
    "versionMajor": 255,
    "versionMinor": 0
  }
}

3 Tracing

3.1 Get

GET https://<HOST>:<PORT>/api/tracing/get?version=0

Returns the current tracing options.

Required Permissions

  • API

  • Tracing

Request parameters

  • product

    Choose for which product the current tracing options should be requested for. If this parameter is not given, the current options for anynode are requested.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration

Response Body Structure

The response body is structured as TracingOptionsJson JSON object. A description for its fields is at section 26.2.1. For the JSON schema refer to section 26.2.2.

3.1.1 Example

GET http://127.0.0.1:8111/api/tracing/get?product=anynodeFrontend&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "selection": "FILE",
  "traceActive": false
}

3.2 Set

PUT https://<HOST>:<PORT>/api/tracing/set?version=0

Sets the tracing options.

Required Permissions

  • API

  • Tracing

Request parameters

  • product

    Choose for which product the current tracing options should be requested for. If this parameter is not given, the current options for anynode are requested.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration

Request Body Structure

The request body is structured as TracingOptionsJson JSON object. A description for its fields is at section 26.2.1. For the JSON schema refer to section 26.2.2.

Response Body Structure

The response body is structured as TracingOptionsJson JSON object. A description for its fields is at section 26.2.1. For the JSON schema refer to section 26.2.2.

3.2.1 Example

PUT http://127.0.0.1:8111/api/tracing/set?product=anynodeFrontend&version=0
HTTP Request Body
{
  "selection": "FILE",
  "options": {},
  "traceActive": false
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "selection": "FILE",
  "traceActive": false
}

3.3 Download

GET https://<HOST>:<PORT>/api/trace/get?version=0

Returns the trace file(s).

Required Permissions

  • API

  • Tracing

Request parameters

  • product

    Choose for which product the current trace files should be requested for. If this parameter is not given, the current trace from anynode will be returned.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration

4 Dial String Rewriting

4.1 Get

GET https://<HOST>:<PORT>/api/dialStringRewriting/get?version=0

Returns the specified dial string rewriting object.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • dialStringRewriting

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

Response Body Structure

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

4.1.1 Example

GET http://127.0.0.1:8111/api/dialStringRewriting/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "RD 1",
    "rules": [{
      "prefix": "123",
      "displayName": "test",
      "addSuffix": "3",
      "matchTags": {
        "tagSet": [
          "userIp",
          "userPhone"
        ],
        "type": "xor"
      },
      "index": 0,
      "deleteTrailingCharacters": 2,
      "suffix": "456",
      "deleteLeadingCharacters": 1,
      "clearDisplayName": false,
      "rewriteType": "prefixAndSuffix",
      "skipRulesBelow": false,
      "skipFurtherRules": true,
      "comment": "Prefix Suffix Rewrite",
      "tagRewrite": {
        "operations": [
          {
            "tag": "userIp",
            "type": "keep"
          },
          {
            "tag": "userPhone",
            "type": "delete"
          }
        ],
        "clearTags": false
      },
      "applyToSourceDialString": true,
      "case": "lowercase",
      "addPrefix": "2"
    }],
    "id": "94b6df47-a230-4e1c-8109-10a94b63bcfd"
  },
  {
    "displayName": "",
    "rules": [
      {
        "clearDisplayName": false,
        "prefix": "00",
        "rewriteType": "prefixAndSuffix",
        "skipRulesBelow": false,
        "index": 0,
        "skipFurtherRules": false,
        "applyToAllDialStrings": true,
        "deleteLeadingCharacters": 2,
        "addPrefix": "+"
      },
      {
        "clearDisplayName": false,
        "prefix": "0",
        "rewriteType": "prefixAndSuffix",
        "skipRulesBelow": false,
        "index": 1,
        "skipFurtherRules": false,
        "applyToAllDialStrings": true,
        "deleteLeadingCharacters": 1,
        "addPrefix": "+41"
      }
    ],
    "id": "9e1ea384-85d5-456b-aa5b-6d56def9ffdd"
  }
]

4.2 Set

PUT https://<HOST>:<PORT>/api/dialStringRewriting/set?version=0

Modifies the selected dial string rewriting object.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as DialStringRewriting JSON object. A description for its fields is at section 26.3.1. For the JSON schema refer to section 26.3.2.

Response Body Structure

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

4.2.1 Example

PUT http://127.0.0.1:8111/api/dialStringRewriting/set?dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Request Body
{
  "displayName": "RD 1",
  "rules": []
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "RD 1",
  "rules": [],
  "id": "94b6df47-a230-4e1c-8109-10a94b63bcfd"
}

4.3 Add

POST https://<HOST>:<PORT>/api/dialStringRewriting/add?version=0

Adds a new dial string rewriting object.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as DialStringRewriting JSON object. A description for its fields is at section 26.3.1. For the JSON schema refer to section 26.3.2.

Response Body Structure

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

4.3.1 Example

POST http://127.0.0.1:8111/api/dialStringRewriting/add?version=0
HTTP Request Body
{
  "displayName": "RD 1",
  "rules": [{
    "applyToDestinationDialString": false,
    "prefix": "123",
    "displayName": "test",
    "addSuffix": "3",
    "matchTags": {
      "tagSet": [
        "userIp",
        "userPhone"
      ],
      "type": "xor"
    },
    "index": 0,
    "deleteTrailingCharacters": 2,
    "suffix": "456",
    "deleteLeadingCharacters": 1,
    "clearDisplayName": false,
    "rewriteType": "prefixAndSuffix",
    "skipRulesBelow": false,
    "skipFurtherRules": true,
    "comment": "Prefix Suffix Rewrite",
    "tagRewrite": {
      "operations": [
        {
          "tag": "userIp",
          "type": "keep"
        },
        {
          "tag": "userPhone",
          "type": "delete"
        }
      ],
      "clearTags": false
    },
    "applyToSourceDialString": true,
    "applyToAllDialStrings": false,
    "case": "lowercase",
    "addPrefix": "2"
  }]
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "RD 1",
  "rules": [{
    "prefix": "123",
    "displayName": "test",
    "addSuffix": "3",
    "matchTags": {
      "tagSet": [
        "userIp",
        "userPhone"
      ],
      "type": "xor"
    },
    "index": 0,
    "deleteTrailingCharacters": 2,
    "suffix": "456",
    "deleteLeadingCharacters": 1,
    "clearDisplayName": false,
    "rewriteType": "prefixAndSuffix",
    "skipRulesBelow": false,
    "skipFurtherRules": true,
    "comment": "Prefix Suffix Rewrite",
    "tagRewrite": {
      "operations": [
        {
          "tag": "userIp",
          "type": "keep"
        },
        {
          "tag": "userPhone",
          "type": "delete"
        }
      ],
      "clearTags": false
    },
    "applyToSourceDialString": true,
    "case": "lowercase",
    "addPrefix": "2"
  }],
  "id": "94b6df47-a230-4e1c-8109-10a94b63bcfd"
}

4.4 Remove

DELETE https://<HOST>:<PORT>/api/dialStringRewriting/remove?version=0

Removes a dial string rewriting object.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • dialStringRewriting

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

4.4.1 Example

DELETE http://127.0.0.1:8111/api/dialStringRewriting/remove?dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "",
    "rules": [
      {
        "clearDisplayName": false,
        "prefix": "00",
        "rewriteType": "prefixAndSuffix",
        "skipRulesBelow": false,
        "index": 0,
        "skipFurtherRules": false,
        "applyToAllDialStrings": true,
        "deleteLeadingCharacters": 2,
        "addPrefix": "+"
      },
      {
        "clearDisplayName": false,
        "prefix": "0",
        "rewriteType": "prefixAndSuffix",
        "skipRulesBelow": false,
        "index": 1,
        "skipFurtherRules": false,
        "applyToAllDialStrings": true,
        "deleteLeadingCharacters": 1,
        "addPrefix": "+41"
      }
    ],
    "id": "9e1ea384-85d5-456b-aa5b-6d56def9ffdd"
  },
  {
    "displayName": "",
    "rules": [{
      "clearDisplayName": false,
      "prefix": "+41",
      "rewriteType": "prefixAndSuffix",
      "skipRulesBelow": false,
      "index": 0,
      "skipFurtherRules": false,
      "applyToSourceDialString": true,
      "deleteLeadingCharacters": 3,
      "addPrefix": "0"
    }],
    "id": "c101605c-9a9e-4123-ac63-81b7fdc35eda"
  }
]

4.5 Get Rules

GET https://<HOST>:<PORT>/api/dialStringRewriting/rules/get?version=0

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

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • dialStringRewriting

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

Response Body Structure

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

4.5.1 Example

GET http://127.0.0.1:8111/api/dialStringRewriting/rules/get?dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

4.6 Set Rules

PUT https://<HOST>:<PORT>/api/dialStringRewriting/rules/set?version=0

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

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • dialStringRewriting

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

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 26.4.1. For the JSON schema refer to section 26.4.2.

Response Body Structure

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

4.6.1 Example

PUT http://127.0.0.1:8111/api/dialStringRewriting/rules/set?dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

4.7 Import Rules

PUT https://<HOST>:<PORT>/api/dialStringRewriting/rules/import?version=0

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

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • json

    Type: Boolean

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

  • dialStringRewriting

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

Request Body Structure

The request expects the .csv or .json file that should be imported.

4.7.1 Example

PUT http://127.0.0.1:8111/api/dialStringRewriting/rules/import?json=true&dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "prefix": "123",
    "displayName": "test",
    "addSuffix": "3",
    "matchTags": {
      "tagSet": [
        "userIp",
        "userPhone"
      ],
      "type": "xor"
    },
    "index": 0,
    "deleteTrailingCharacters": 2,
    "suffix": "456",
    "deleteLeadingCharacters": 1,
    "clearDisplayName": false,
    "rewriteType": "prefixAndSuffix",
    "skipRulesBelow": false,
    "skipFurtherRules": true,
    "comment": "Prefix Suffix Rewrite",
    "tagRewrite": {
      "operations": [
        {
          "tag": "userIp",
          "type": "keep"
        },
        {
          "tag": "userPhone",
          "type": "delete"
        }
      ],
      "clearTags": false
    },
    "applyToSourceDialString": true,
    "case": "lowercase",
    "addPrefix": "2"
  },
  {
    "applyToDestinationDialString": true,
    "displayName": "test",
    "addSuffix": "3",
    "matchTags": {
      "tagSet": [
        "userIp",
        "userPhone"
      ],
      "type": "xor"
    },
    "index": 1,
    "deleteTrailingCharacters": 2,
    "deleteLeadingCharacters": 1,
    "wildcardPattern": "0123456789+\\+!?X.[]",
    "clearDisplayName": false,
    "rewriteType": "wildcardPattern",
    "skipRulesBelow": false,
    "skipFurtherRules": false,
    "comment": "Wildcard Pattern Rewrite",
    "tagRewrite": {
      "operations": [
        {
          "tag": "userIp",
          "type": "keep"
        },
        {
          "tag": "userPhone",
          "type": "delete"
        }
      ],
      "clearTags": false
    },
    "case": "casefold",
    "addPrefix": "2"
  }
]

4.8 Export Rules

GET https://<HOST>:<PORT>/api/dialStringRewriting/rules/export?version=0

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

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • filename

    (Optional) Name of the exported file.

  • backendName

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

  • dialStringRewriting

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

4.8.1 Example

GET http://127.0.0.1:8111/api/dialStringRewriting/rules/export?dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Response
HTTP/1.1 200 OK

4.9 Add Rules

POST https://<HOST>:<PORT>/api/dialStringRewriting/rules/add?version=0

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

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • dialStringRewriting

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

Request Body Structure

The request body is structured as DialStringRewrite JSON object. A description for its fields is at section 26.4.1. For the JSON schema refer to section 26.4.2.

Response Body Structure

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

4.9.1 Example

POST http://127.0.0.1:8111/api/dialStringRewriting/rules/add?dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Request Body
{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "RD 1",
  "rules": [{
    "prefix": "123",
    "displayName": "test",
    "addSuffix": "3",
    "matchTags": {
      "tagSet": [
        "userIp",
        "userPhone"
      ],
      "type": "xor"
    },
    "index": 0,
    "deleteTrailingCharacters": 2,
    "suffix": "456",
    "deleteLeadingCharacters": 1,
    "clearDisplayName": false,
    "rewriteType": "prefixAndSuffix",
    "skipRulesBelow": false,
    "skipFurtherRules": true,
    "comment": "Prefix Suffix Rewrite",
    "tagRewrite": {
      "operations": [
        {
          "tag": "userIp",
          "type": "keep"
        },
        {
          "tag": "userPhone",
          "type": "delete"
        }
      ],
      "clearTags": false
    },
    "applyToSourceDialString": true,
    "case": "lowercase",
    "addPrefix": "2"
  }],
  "id": "94b6df47-a230-4e1c-8109-10a94b63bcfd"
}

4.10 Remove Rules

DELETE https://<HOST>:<PORT>/api/dialStringRewriting/rules/remove?version=0

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

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • index

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

  • rule

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

  • dialStringRewriting

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

Response Body Structure

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

4.10.1 Example

DELETE http://127.0.0.1:8111/api/dialStringRewriting/rules/remove?index=0&dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "RD 1",
  "rules": [],
  "id": "94b6df47-a230-4e1c-8109-10a94b63bcfd"
}

4.11 Clear Rules

DELETE https://<HOST>:<PORT>/api/dialStringRewriting/rules/clear?version=0

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

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • dialStringRewriting

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

Response Body Structure

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

4.11.1 Example

DELETE http://127.0.0.1:8111/api/dialStringRewriting/rules/clear?dialStringRewriting=94b6df47-a230-4e1c-8109-10a94b63bcfd&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "RD 1",
  "rules": [],
  "id": "94b6df47-a230-4e1c-8109-10a94b63bcfd"
}

5 Forwarded Session Recording

5.1 Lookup by local session identification

POST https://<HOST>:<PORT>/api/forwardedSessionRecording/lookupByLocalSessionIdentification?version=0

Returns a list of session identifiers that match the provided filter.

Required Permissions

  • API

  • Administration

Request Body Structure

The request body is structured as TelIdent JSON object. A description for its fields is at section 26.5.1. For the JSON schema refer to section 26.5.2.

Response Body Structure

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

5.2 Set Mute

POST https://<HOST>:<PORT>/api/forwardedSessionRecording/setMute?version=0

Mutes the session specified by the identifier.

Required Permissions

  • API

  • Administration

Request parameters

  • identifier

    Type: String

    The session identifier from the function Lookup by local session identification section 5.1.

  • mute

    Type: Boolean

    Specify if the session should be muted.

6 anynode Configuration

6.1 Import

PUT https://<HOST>:<PORT>/api/anynodeConfig/set?version=0

Imports the given configuration without committing it.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • commitProtection

    Type: Boolean

    If set to true, the imported configuration cannot be committed. It can only be viewed.

Request Body Structure

The request expects the .xzconfig file that should be imported.

6.2 Export

GET https://<HOST>:<PORT>/api/anynodeConfig/get?version=0

Returns the current anynode configuration.

Required Permissions

  • API

  • Configuration Mode Read Access

6.3 Commit

POST https://<HOST>:<PORT>/api/anynodeConfig/commit?version=0

Commits the current anynode configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

6.3.1 Example

POST http://127.0.0.1:8111/api/anynodeConfig/commit?version=0
HTTP Response
HTTP/1.1 200 OK

6.4 Revert

POST https://<HOST>:<PORT>/api/anynodeConfig/revert?version=0

Reverts the current anynode configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

6.4.1 Example

POST http://127.0.0.1:8111/api/anynodeConfig/revert?version=0
HTTP Response
HTTP/1.1 200 OK

6.5 Clean

DELETE https://<HOST>:<PORT>/api/anynodeConfig/clean?version=0

Deletes everything from the current anynode configuration. This can still be reverted if it has not been committed.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

6.5.1 Example

DELETE http://127.0.0.1:8111/api/anynodeConfig/clean?version=0
HTTP Response
HTTP/1.1 200 OK

7 Licenses

7.1 Get

GET https://<HOST>:<PORT>/api/licenses/get?version=0

Returns a list of currently loaded licenses. For more information about the license status go to section 26.6,

Required Permissions

  • API

  • User Management Read/Write Access

Response Body Structure

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

7.1.1 Example

GET http://127.0.0.1:8111/api/licenses/get?dateFormat=XZWO&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "identifier": "c1b436f1-a81d-4f0a-8bdf-42cdb8bdb509",
  "name": "anynode 4 lines demo license",
  "validUntil": "UTC 2023-12-31 23:59:59",
  "validFrom": "UTC 2022-01-04 00:00:00",
  "id": "f416560b-9f9a-4021-bb49-07c4a9e3a1e7",
  "facilities": [
    {
      "name": "recSession = 2",
      "value": 2
    },
    {
      "name": "telrtSession = 4",
      "value": 4
    }
  ],
  "constraints": "[telrtDemo]",
  "products": "[anynode]",
  "status": "ACTIVE"
}]

7.2 Import LOD

PUT https://<HOST>:<PORT>/api/licenses/importLod?version=0

Requests a license using the LOD key.

Required Permissions

  • API

  • User Management Read/Write Access

Request Body Structure

The request body is structured as ImportLodData JSON object. A description for its fields is at section 26.7.1. For the JSON schema refer to section 26.7.2.

Response Body Structure

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

7.3 Get System IDs

GET https://<HOST>:<PORT>/api/licenses/systemIds/get?version=0

Returns a list of the available device IDs for licensing.

Required Permissions

  • API

  • User Management Read/Write Access

Response Body Structure

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

7.4 Import

PUT https://<HOST>:<PORT>/api/licenses/importFile?version=0

Imports a xzlicense file.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request expects the license file that should be imported.

8 Maintenance Mode

8.1 Get

GET https://<HOST>:<PORT>/api/maintenanceMode/get?version=0

Returns whether the maintenance mode is active or not

Required Permissions

  • API

Response Body Structure

The response body is structured as MaintenanceMode JSON object. A description for its fields is at section 26.8.1. For the JSON schema refer to section 26.8.2.

8.1.1 Example

GET http://127.0.0.1:8111/api/maintenanceMode/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"modeActive": true}

8.2 Set

PUT https://<HOST>:<PORT>/api/maintenanceMode/set?version=0

Enables or disables the maintenance mode.

Required Permissions

  • API

  • Administration

Request Body Structure

The request body is structured as MaintenanceMode JSON object. A description for its fields is at section 26.8.1. For the JSON schema refer to section 26.8.2.

Response Body Structure

The response body is structured as MaintenanceMode JSON object. A description for its fields is at section 26.8.1. For the JSON schema refer to section 26.8.2.

8.2.1 Example

PUT http://127.0.0.1:8111/api/maintenanceMode/set?version=0
HTTP Request Body
{"modeActive": false}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"modeActive": false}

9 User Management

9.1 Add User

POST https://<HOST>:<PORT>/api/users/add?version=0

Adds a new user.

Required Permissions

  • API

  • User Management Read/Write Access

Request Body Structure

The request body is structured as AddUserData JSON object. A description for its fields is at section 26.9.1. For the JSON schema refer to section 26.9.2.

Response Body Structure

The response body is structured as CustomUserOptions JSON object. A description for its fields is at section 26.10.1. For the JSON schema refer to section 26.10.2.

9.1.1 Example

POST http://127.0.0.1:8111/api/users/add?version=0
HTTP Request Body
{
  "ldapLogin": null,
  "loginLocally": true,
  "localPassword": "test1234",
  "roleIds": ["new_role"],
  "localUsername": "test",
  "displayName": "test",
  "enabled": true
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "emailAddress": "",
  "displayName": "test",
  "localUserName": "test",
  "roles": ["new_role"],
  "id": "c7fa28f9-c322-4247-821a-350da56327af",
  "enabled": true,
  "local": {"name": "test"}
}

9.2 Remove User

DELETE https://<HOST>:<PORT>/api/users/remove?version=0

Removes an exiting user

Required Permissions

  • API

  • User Management Read/Write Access

Request parameters

  • user

    The name or id of the user that should be removed.

Response Body Structure

The response body is structured as CustomUserOptions JSON object. A description for its fields is at section 26.10.1. For the JSON schema refer to section 26.10.2.

9.2.1 Example

DELETE http://127.0.0.1:8111/api/users/remove?version=0&user=test
HTTP Response
HTTP/1.1 200 OK

9.3 Submit Password Change

POST https://<HOST>:<PORT>/api/users/changePassword?version=0

Sets a new password for a user.

Required Permissions

  • API

  • User Management Read/Write Access

Request parameters

  • passwordChange

    Define whether and, if so, when the password has to be changed.

    Possible values:

    • NOT_NECESSARY

    • REQUIERED

    • RECOMMENDED

  • oldPassword

    The old password of the selected user.

  • newPassword

    The new password of the selected user.

  • user

    The name of the user which password will be changed.

9.4 Get LDAP Authorities

GET https://<HOST>:<PORT>/api/users/ldapAuthorities/get?version=0

Returns the configured LDAP Authorities

Required Permissions

  • API

  • User Management Read Access

Response Body Structure

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

9.4.1 Example

GET http://127.0.0.1:8111/api/users/ldapAuthorities/get?version=0
HTTP Response
HTTP/1.1 200 OK

10 Roles

10.1 Get Roles

GET https://<HOST>:<PORT>/api/roles/get?version=0

Returns all congigured roles.

Required Permissions

  • API

  • User Management Read Access

Response Body Structure

The response body is structured as Role JSON object. A description for its fields is at section 26.11.1. For the JSON schema refer to section 26.11.2.

10.1.1 Example

GET http://127.0.0.1:8111/api/roles/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "ADMINISTRATOR",
    "permissions": {
      "userManagement": "READ_WRITE_ACCESS",
      "configurationMode": "READ_WRITE_ACCESS",
      "tracing": "ACCESS",
      "administration": "ACCESS",
      "monitoringMode": "READ_WRITE_ACCESS",
      "webServer": "READ_WRITE_ACCESS",
      "userInterface": "ACCESS",
      "api": "ACCESS",
      "backends": "READ_WRITE_ACCESS",
      "mediaRecording": "NO_ACCESS"
    },
    "id": "ADMINISTRATOR"
  },
  {
    "displayName": "CALL_HISTORY_EXPORTER",
    "permissions": {
      "userManagement": "NO_ACCESS",
      "configurationMode": "NO_ACCESS",
      "tracing": "NO_ACCESS",
      "administration": "NO_ACCESS",
      "monitoringMode": "READ_ACCESS",
      "webServer": "NO_ACCESS",
      "userInterface": "NO_ACCESS",
      "api": "ACCESS",
      "backends": "NO_ACCESS",
      "mediaRecording": "NO_ACCESS"
    },
    "id": "CALL_HISTORY_EXPORTER"
  }
]

10.2 Add Role

PUT https://<HOST>:<PORT>/api/roles/add?version=0

Adds a new role

Required Permissions

  • User Management Read/Write Access

Request Body Structure

The request body is structured as Role JSON object. A description for its fields is at section 26.11.1. For the JSON schema refer to section 26.11.2.

Response Body Structure

The response body is structured as Role JSON object. A description for its fields is at section 26.11.1. For the JSON schema refer to section 26.11.2.

10.2.1 Example

PUT http://127.0.0.1:8111/api/roles/add?version=0
HTTP Request Body
{
  "displayName": "new_role",
  "permissions": {
    "userManagement": "NO_ACCESS",
    "configurationMode": "NO_ACCESS",
    "tracing": "NO_ACCESS",
    "administration": "NO_ACCESS",
    "monitoringMode": "NO_ACCESS",
    "webServer": "NO_ACCESS",
    "userInterface": "NO_ACCESS",
    "api": "ACCESS",
    "backends": "NO_ACCESS",
    "mediaRecording": "NO_ACCESS"
  },
  "id": "new_role"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "new_role",
  "permissions": {
    "userManagement": "NO_ACCESS",
    "configurationMode": "NO_ACCESS",
    "tracing": "NO_ACCESS",
    "administration": "NO_ACCESS",
    "monitoringMode": "NO_ACCESS",
    "webServer": "NO_ACCESS",
    "userInterface": "NO_ACCESS",
    "api": "ACCESS",
    "backends": "NO_ACCESS",
    "mediaRecording": "NO_ACCESS"
  },
  "id": "new_role"
}

10.3 Remove role

DELETE https://<HOST>:<PORT>/api/roles/remove?version=0

Remove an existing role.

Required Permissions

  • User Management Read/Write Access

Request parameters

  • role

    The id or displayname of the role to be removed.

10.3.1 Example

DELETE http://127.0.0.1:8111/api/roles/remove?role=new_role&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[]

11 Media Recording

11.1 Get Media Recording state

GET https://<HOST>:<PORT>/api/mediaRecording/get?version=0

Returns the media recording state

Required Permissions

  • API

Response Body Structure

The response body is structured as MediaRecording JSON object. A description for its fields is at section 26.12.1. For the JSON schema refer to section 26.12.2.

11.1.1 Example

GET http://127.0.0.1:8111/api/mediaRecording/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"mediaRecordingActive": false}

12 Microsoft Teams SBA

12.1 Get SBA configuration

GET https://<HOST>:<PORT>/api/sba/get?version=0

Returns the current Microsoft Teams SBA configuration

Required Permissions

  • API

  • Administration

Response Body Structure

The response body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 26.13.1. For the JSON schema refer to section 26.13.2.

12.1.1 Example

GET http://127.0.0.1:8111/api/sba/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "application": "",
  "log": {
    "level": "INFO",
    "directory": "./test",
    "maxArchiveFiles": 30
  },
  "identity": "",
  "tenantId": "",
  "fingerprint": {
    "source": "CUSTOM",
    "value": "2f8164f7-217b-4809-821d-73fc6ae71d0c"
  }
}

12.2 Set SBA configuration.

PUT https://<HOST>:<PORT>/api/sba/set?version=0

Modifies the Microsoft Teams SBA configuration.

Required Permissions

  • API

  • Administration

Request Body Structure

The request body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 26.13.1. For the JSON schema refer to section 26.13.2.

Response Body Structure

The response body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 26.13.1. For the JSON schema refer to section 26.13.2.

12.2.1 Example

PUT http://127.0.0.1:8111/api/sba/set?version=0
HTTP Request Body
{
  "application": "",
  "log": {
    "directory": "./test",
    "maxArchiveFiles": 0
  },
  "identity": "",
  "fingerprint": {
    "source": "CUSTOM",
    "value": "394af106-dd72-4a0f-b2e8-53bf731efa14"
  },
  "tenantId": "",
  "secret": ""
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "application": "",
  "log": {
    "level": "INFO",
    "directory": "./test",
    "maxArchiveFiles": 30
  },
  "identity": "",
  "tenantId": "",
  "fingerprint": {
    "source": "CUSTOM",
    "value": "394af106-dd72-4a0f-b2e8-53bf731efa14"
  }
}

12.3 Enable SBA Services

POST https://<HOST>:<PORT>/api/sba/enable?version=0

Enables the Microsoft Teams SBA services.

Required Permissions

  • API

  • Administration

12.3.1 Example

POST http://127.0.0.1:8111/api/sba/enable?version=0
HTTP Response
HTTP/1.1 200 OK

12.4 Disable SBA Services

POST https://<HOST>:<PORT>/api/sba/disable?version=0

Disables the Microsoft Teams SBA services.

Required Permissions

  • API

  • Administration

12.4.1 Example

POST http://127.0.0.1:8111/api/sba/disable?version=0
HTTP Response
HTTP/1.1 200 OK

12.5 Get Status

GET https://<HOST>:<PORT>/api/sba/status/get?version=0

Returns the status of the Micosoft Teams SBA service

Required Permissions

  • API

  • Administration

Response Body Structure

The response body is structured as MsTeamsSbaStatus JSON object. A description for its fields is at section 26.14.1. For the JSON schema refer to section 26.14.2.

12.5.1 Example

GET http://127.0.0.1:8111/api/sba/status/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"state": "noConnection"}

12.6 Get Private Key

GET https://<HOST>:<PORT>/api/sba/privateKey/get?version=0

Returns the private key of the SBA service.

Required Permissions

  • API

  • Administration

12.6.1 Example

GET http://127.0.0.1:8111/api/sba/privateKey/get?version=0
HTTP Response
HTTP/1.1 200 OK

12.7 Set Private Key

PUT https://<HOST>:<PORT>/api/sba/privateKey/set?version=0

Sets a new private key to the SBA services.

Required Permissions

  • API

  • Administration

Request parameters

  • password

    The password of the private key file.

Request Body Structure

The body must contain the file of the private key.

12.7.1 Example

PUT http://127.0.0.1:8111/api/sba/privateKey/set?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
    "pem": "-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAlp0FmyimgyAQUQm06In+YiIzXzcRo1U+8OzRkj0H5Z9ow9g4
z/w5Az1ArN7SmQ8rvZiWqKpgNlqJMIT0d4PGIJAxak5meNQfJidsZh9ly7iRhfRh
KyAj6lhPA6smRrNwS4f7WZC0tFpAsw9v9tRcWPqGR+vPzAegx30ctijSbAruJUSo
fiNbll4aVWSKDCGL1PFdgRRE1wnKvwk/OmiKldliV8rWANDf+TAlE/9kJ/ro7zpN
CiC6opidYh4MYhx+gje6SQD20Bp7pWbrWpwQEl8Zq/ra5x3qLrCY9kiN5WdldaM8
Qul7j3Ok11N6104NG4mda5JgH066emx/o0irhQIDAQABAoIBAAVIjtjJjUXOSyQ8
ne8GYDkbEAhIC0NaizGybQufPnasp+Uu4ZdSNsHJVUp7KpIZ+SPWhXp3N5bQiD1+
fIDwy3N6+3DKPUgB0PHqsh/G/DAwUlKLpxj3MKtY27S6PUZ/pvHPXF7g96XYAKsH
YJsdCfxJFYrSV+DFZ7t3xRkSx4bosXkgm0FAd9GNaWDP4PTyH77BHWC0xr40Rx7+
9HJN80utBEBPGtIiWbuyUCRmrKohrA7j9mecScnZYEw8ntJebrETW+kGRUDCuMzT
i1aU14t346LqF24U7GtY1kLolW/3+f+IoJm2WGUoNgc+8mDvJ2hlx2i5+PbYIV25
oo5Kh+UCgYEAxUkQ9kMyilTtROM3p+gCm0pWNOf/pQFZrrDj/N83TuV+9ZZVy8ES
c4FtoFUCMMyNrYynckrG5n6eYFJKhdYV8BI7yoLa/wIx2bsXj5PqlU+hO7jQMPfV
/rCLfWA4iDMjNF76CW5HykaDk7C1+zVWfodCiaexwy49Bep3rbU1fwcCgYEAw3AR
zWqE6KMuzy9ySCjmaCXY8dUVIZAXEx3We8kNpRH5jlkUe5RaVRQYDi/r0oB4PBoU
qK+vMRrUBzXOghgUPvyBcz0qDqDQS45LVNu4CQj0+ZZUKPgJ1zJJAcfawdIts8KF
GvaZqcSxzNc5NicybKqjhYLqjtH9v++4Nn1gUhMCgYBJs3Edvp7L5Mw61vN8y4Tl
xJCN9Tmgx+9b/oM9fZoo5D1Yu8/TbY5aDjkJE5jc6B3pfskzPlIt25GJBFUIyKCr
bfReRCJR79z1rRoxLh4Np5DhQbqtAHk2S3fg36he4VO+hdi82zEAlPUkoHhrn1Jv
tFIcIMSc2NI9Ool5IGAa0wKBgG2yTLvAyyMM3Ow71Gh+VH0mqTNsB7VT/C+lssq+
GeOKSEnG5EFNDrrsUWg9K592roYFmYzpN2tXhKUbZXMN8uc7sakuLpoRV3jhQJU7
0nt3xJEG+OwZ9OQN/H58X+QkhbR9PVraCXwJxEaWky07KQlnaes5hVBuu3/tHLew
/cxzAoGAdHp4g4Ml1H5JYMBDXO5DkZ7zLaI6TH6SpHVwqi565k3xdi3/NRTkFC/V
8OKEFLL9hieSigTcgo1riyfFDZMGOUhW3qXImzyEAyKYD3Bp1cDIkKO+omk+G+v9
F7mOIjwvbrPVR53oejFhUjVGiz8Bv2d3K7FqLsCP+bqJj+iFDSk=
-----END RSA PRIVATE KEY-----
"
}

12.8 Get Certificate

GET https://<HOST>:<PORT>/api/sba/certificate/get?version=0

Returns the certificate of the SBA service.

Required Permissions

  • API

  • Administration

12.8.1 Example

GET http://127.0.0.1:8111/api/sba/certificate/get?version=0
HTTP Response
HTTP/1.1 200 OK

12.9 Set Certificate

PUT https://<HOST>:<PORT>/api/sba/certificate/set?version=0

Sets a new certificate to the SBA services.

Required Permissions

  • API

  • Administration

Request parameters

  • password

    The password of the certificate file.

Request Body Structure

The body must contain the certificate file.

12.9.1 Example

PUT http://127.0.0.1:8111/api/sba/certificate/set?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
    "pem": "-----BEGIN CERTIFICATE-----
MIIDRjCCAi6gAwIBAgIICKL1N6x8IoQwDQYJKoZIhvcNAQELBQAwFDESMBAGA1UE
AxMJdGVzdC5jZXJ0MB4XDTIzMDcwNTEyNTgwMFoXDTI0MDcwNDEyNTgwMFowFDES
MBAGA1UEAxMJdGVzdC5jZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC
AQEAlp0FmyimgyAQUQm06In+YiIzXzcRo1U+8OzRkj0H5Z9ow9g4z/w5Az1ArN7S
mQ8rvZiWqKpgNlqJMIT0d4PGIJAxak5meNQfJidsZh9ly7iRhfRhKyAj6lhPA6sm
RrNwS4f7WZC0tFpAsw9v9tRcWPqGR+vPzAegx30ctijSbAruJUSofiNbll4aVWSK
DCGL1PFdgRRE1wnKvwk/OmiKldliV8rWANDf+TAlE/9kJ/ro7zpNCiC6opidYh4M
Yhx+gje6SQD20Bp7pWbrWpwQEl8Zq/ra5x3qLrCY9kiN5WdldaM8Qul7j3Ok11N6
104NG4mda5JgH066emx/o0irhQIDAQABo4GbMIGYMAwGA1UdEwEB/wQCMAAwHQYD
VR0OBBYEFFgJQMmaiZdLkxGQfErjpVivPBj8MAsGA1UdDwQEAwID6DATBgNVHSUE
DDAKBggrBgEFBQcDATAUBgNVHREEDTALggl0ZXN0LmNlcnQwEQYJYIZIAYb4QgEB
BAQDAgZAMB4GCWCGSAGG+EIBDQQRFg94Y2EgY2VydGlmaWNhdGUwDQYJKoZIhvcN
AQELBQADggEBAEv09qpCxyDrvGXQG4M94En7U5dsSd7XijBHlO8+gnn/HqBqgqE+
JxB9fBx+WI+6ubQ/wwNvvx/FRyJ3ixU7sFj/jWDuqs1g4XPwXN72nMqxp/s5Sotd
vQ4tb8khu7nBh489DJJe7+ijy4NS06YuCh0eplamkYfSXxgQlHxLbDFLxWwWPriQ
00FDsBvHZ8q+Qqr8YQIdONKgUocR3mNhCa2li+14AxSZ7ksTFRUO6qc4UbOYmfMU
GgEUKLP9DqpSMdrf0yySPGlHpeLIbE4bLnhY3gg1tyfk6LjIHKSpTNy9eIwpG51B
ylfki4qQ9ck7HxOhZH53qbiXlpwUl0l26t4=
-----END CERTIFICATE-----
"
}

12.10 Get Fingerprint

GET https://<HOST>:<PORT>/api/sba/fingerprint/get?version=0

Returns the currently configured fingerprint of the SBA service.

Required Permissions

  • API

  • Administration

Response Body Structure

The response body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 26.15.1. For the JSON schema refer to section 26.15.2.

12.10.1 Example

GET http://127.0.0.1:8111/api/sba/fingerprint/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "source": "CUSTOM",
  "value": "2f8164f7-217b-4809-821d-73fc6ae71d0c"
}

12.11 Set Fingerprint

PUT https://<HOST>:<PORT>/api/sba/fingerprint/set?version=0

Sets a new fingerprint to the SBA service.

Required Permissions

  • API

  • Administration

Request Body Structure

The request body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 26.15.1. For the JSON schema refer to section 26.15.2.

Response Body Structure

The response body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 26.15.1. For the JSON schema refer to section 26.15.2.

12.11.1 Example

PUT http://127.0.0.1:8111/api/sba/fingerprint/set?version=0
HTTP Request Body
{
  "source": "CUSTOM",
  "value": "fc56c95d-a379-46f8-b1d3-8113791242ff"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "source": "CUSTOM",
  "value": "fc56c95d-a379-46f8-b1d3-8113791242ff"
}

12.12 Get IP Address

GET https://<HOST>:<PORT>/api/sba/ipAddress/get?version=0

Returns the IP address of the SBA service.

Required Permissions

  • API

  • Administration

12.12.1 Example

GET http://127.0.0.1:8111/api/sba/ipAddress/get?version=0
HTTP Response
HTTP/1.1 200 OK

12.13 Set IP Address

PUT https://<HOST>:<PORT>/api/sba/ipAddress/set?version=0

Sets the IP address of the SBA service.

Required Permissions

  • API

  • Administration

Request Body Structure

The body needs to contain the new IP address (e.g. "127.0.0.1").

12.13.1 Example

PUT http://127.0.0.1:8111/api/sba/ipAddress/set?version=0
HTTP Request Body
127.0.0.1
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
127.0.0.1

12.14 Get Identity

GET https://<HOST>:<PORT>/api/sba/identity/get?version=0

Returns the identity / FQDN of the SBA.

Required Permissions

  • API

  • Administration

12.14.1 Example

GET http://127.0.0.1:8111/api/sba/identity/get?version=0
HTTP Response
HTTP/1.1 200 OK

12.15 Set Identity

PUT https://<HOST>:<PORT>/api/sba/identity/set?version=0

Sets the identity / FQDN of the SBA.

Required Permissions

  • API

  • Administration

Request Body Structure

The body must contain the new Identity for the SBA service.

12.15.1 Example

PUT http://127.0.0.1:8111/api/sba/identity/set?version=0
HTTP Request Body
testIdentity
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
testIdentity

12.16 Get TenantId

GET https://<HOST>:<PORT>/api/sba/tenantId/get?version=0

Returns the tenant id of the SBA service.

Required Permissions

  • API

  • Administration

12.16.1 Example

GET http://127.0.0.1:8111/api/sba/tenantId/get?version=0
HTTP Response
HTTP/1.1 200 OK

12.17 Set TenantId

PUT https://<HOST>:<PORT>/api/sba/tenantId/set?version=0

Sets the tenant id of the SBA service.

Required Permissions

  • API

  • Administration

Request Body Structure

The body must contain the new tenant id for the SBA service.

12.17.1 Example

PUT http://127.0.0.1:8111/api/sba/tenantId/set?version=0
HTTP Request Body
6d813f04-3832-4323-94ab-763e87746984
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
6d813f04-3832-4323-94ab-763e87746984

12.18 Get Application

GET https://<HOST>:<PORT>/api/sba/application/get?version=0

Returns the application / client id of the SBA service.

Required Permissions

  • API

  • Administration

12.18.1 Example

GET http://127.0.0.1:8111/api/sba/application/get?version=0
HTTP Response
HTTP/1.1 200 OK

12.19 Set Application

PUT https://<HOST>:<PORT>/api/sba/application/set?version=0

Sets the application / client id of the SBA service.

Required Permissions

  • API

  • Administration

Request Body Structure

The body must contain the application / client id for the SBA service.

12.19.1 Example

PUT http://127.0.0.1:8111/api/sba/application/set?version=0
HTTP Request Body
ef4a0ba4-f42b-46a4-93ca-49b1aa462549
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
ef4a0ba4-f42b-46a4-93ca-49b1aa462549

12.20 Set Secret

PUT https://<HOST>:<PORT>/api/sba/secret/set?version=0

Sets the application / client secret of the SBA service.

Required Permissions

  • API

  • Administration

Request Body Structure

The body must contain the application / client secret for the SBA service.

12.20.1 Example

PUT http://127.0.0.1:8111/api/sba/secret/set?version=0
HTTP Request Body
bcf4ed11-f996-4609-8bbc-3bc4e4f95e87
HTTP Response
HTTP/1.1 200 OK

12.21 Get Log

GET https://<HOST>:<PORT>/api/sba/log/get?version=0

Returns the logging options of the SBA service.

Required Permissions

  • API

  • Administration

Response Body Structure

The response body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 26.16.1. For the JSON schema refer to section 26.16.2.

12.21.1 Example

GET http://127.0.0.1:8111/api/sba/log/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "level": "INFO",
  "directory": "./test",
  "maxArchiveFiles": 30
}

12.22 Set Log

PUT https://<HOST>:<PORT>/api/sba/log/set?version=0

Sets the logging options of the SBA service.

Required Permissions

  • API

  • Administration

Request Body Structure

The request body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 26.16.1. For the JSON schema refer to section 26.16.2.

Response Body Structure

The response body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 26.16.1. For the JSON schema refer to section 26.16.2.

12.22.1 Example

PUT http://127.0.0.1:8111/api/sba/log/set?version=0
HTTP Request Body
{
  "level": "FATAL",
  "directory": "",
  "maxArchiveFiles": 24
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "level": "FATAL",
  "directory": "",
  "maxArchiveFiles": 24
}

12.23 Get Users

GET https://<HOST>:<PORT>/api/sba/users/get?version=0

Returns a list of the Teams SBA users.

Required Permissions

  • API

  • Administration

Response Body Structure

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

12.24 Refresh Users

POST https://<HOST>:<PORT>/api/sba/users/refresh?version=0

Refreshes and returns the list of the Teams SBA users.

Required Permissions

  • API

  • Administration

Response Body Structure

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

13 Node

13.1 Get Nodes

GET https://<HOST>:<PORT>/api/nodes/get?version=0

Returns all configured nodes.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

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

13.1.1 Example

GET http://127.0.0.1:8111/api/nodes/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "Speedvoice test",
    "id": "4e8313ff-3307-4856-ab3f-8be80c4c7629"
  },
  {
    "displayName": "Amazon Chime test",
    "id": "b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc"
  }
]

13.2 Get System Profiles

GET https://<HOST>:<PORT>/api/nodes/systemProfiles/get?version=0

Retrieves a list of all possible system profiles that can be used to add a PBX or Voice over IP System.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • completeData

    Type: Boolean

    Indicates if additional data for each node should be included.

Response Body Structure

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

13.2.1 Example

GET http://127.0.0.1:8111/api/nodes/systemProfiles/get?completeData=true&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "activateServerAuthentication": true,
    "serverCredentials": {},
    "displayName": "[Other VoIP System]",
    "includeSipRegistrarInWhitelist": true,
    "includeRemoteSipDomainInWhitelist": true,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "createNewTeamsCarrierNode": true,
    "routingDomains": [],
    "includeOwnSubnetInWhitelist": true,
    "sbcFqdn": "",
    "clientCredentials": {},
    "id": "2380B08F-93F8-468C-B302-A52C91B30828",
    "activateClientAuthentication": false,
    "networkControllerInterface": "",
    "tenantFqdn": "",
    "createNewNetworkController": true,
    "remoteSipDomain": {},
    "networkPeerWhitelist": [],
    "sipRegistrar": {"type": "ALWAYS"},
    "networkControllerDisplayName": "[Other VoIP System]",
    "udpPortRange": {
      "lastPort": 13000,
      "firstPort": 10000
    },
    "useNetworkPeerWhitelist": true,
    "sipInterconnection": "TRUNK",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]"
  },
  {
    "activateServerAuthentication": true,
    "serverCredentials": {},
    "displayName": "3CX Phone System",
    "includeSipRegistrarInWhitelist": true,
    "includeRemoteSipDomainInWhitelist": true,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "createNewTeamsCarrierNode": true,
    "routingDomains": [],
    "includeOwnSubnetInWhitelist": true,
    "sbcFqdn": "",
    "clientCredentials": {},
    "id": "A7D45C2D-EB6D-4F4C-9F4F-C0B9C4CD3A19",
    "activateClientAuthentication": false,
    "networkControllerInterface": "",
    "tenantFqdn": "",
    "createNewNetworkController": true,
    "remoteSipDomain": {},
    "networkPeerWhitelist": [],
    "sipRegistrar": {"type": "ALWAYS"},
    "networkControllerDisplayName": "3CX Phone System",
    "udpPortRange": {
      "lastPort": 13000,
      "firstPort": 10000
    },
    "useNetworkPeerWhitelist": true,
    "sipInterconnection": "TRUNK",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]"
  }
]

13.3 Get Microsoft teams carrier nodes.

GET https://<HOST>:<PORT>/api/nodes/msTeamsCarriers/get?version=0

Retrieves a list of all configured Nodes using Microsoft Teams Carrier Nodes.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

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

13.3.1 Example

GET http://127.0.0.1:8111/api/nodes/msTeamsCarriers/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "displayName": "Ms Teams Direct Routing test",
  "id": "afaf59dc-d239-42d4-9378-b989bd358c6e"
}]

13.4 Add PBX or Voice over IP System

POST https://<HOST>:<PORT>/api/nodes/addSystem?version=3

Adds a new PBX or Voice over IP System node to the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • profile

    The id of the profile, that should be used. To get a list of availabled profiles use section 13.2.

  • version

    3

Request Body Structure

The request body is structured as AddSystemProfile JSON object. A description for its fields is at section 26.17.1. For the JSON schema refer to section 26.17.2.

Response Body Structure

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

13.4.1 Example

POST http://127.0.0.1:8111/api/nodes/addSystem?profile=01DF27B3-6E35-46B5-BB80-CE1EB9D97870&version=3
HTTP Request Body
{
  "createNewNetworkController": true,
  "tlsPort": 5999,
  "sbcFqdn": "test.fqdn",
  "displayName": "Ms Teams Direct Routing test ",
  "udpTcpPort": 0,
  "networkControllerDisplayName": "NC 1",
  "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
  "networkControllerIpAddress": "127.0.0.1",
  "routingDomains": ["Routing Domain"]
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "displayName": "Ms Teams Direct Routing test",
  "id": "afaf59dc-d239-42d4-9378-b989bd358c6e"
}]

13.5 Get Provider Profiles

GET https://<HOST>:<PORT>/api/nodes/providerProfiles/get?version=0

Retrieves a list of all possible provider profiles that can be used to add a provider.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

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

13.5.1 Example

GET http://127.0.0.1:8111/api/nodes/providerProfiles/get?completeData=true&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "networkControllerInterface": "",
    "createNewNetworkController": true,
    "createNewDeutscheTelekomSipTrunk": true,
    "activateNatTraversal": false,
    "defineAssertedUri": true,
    "deutscheTelekomNumberExtensionRange": {"zeroExtend": true},
    "credentials": {},
    "displayName": "[Other VoIP Provider]",
    "remoteSipDomain": {},
    "includeSipRegistrarInWhitelist": true,
    "networkPeerWhitelist": [],
    "includeRemoteSipDomainInWhitelist": true,
    "includeProxyInWhitelist": true,
    "nodeViaSipTrunking": false,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "networkControllerDisplayName": "[Other VoIP Provider]",
    "routingDomains": [],
    "useNetworkPeerWhitelist": true,
    "addressOfRecord": "",
    "assertedUri": "",
    "id": "9E7B52A2-B9F8-42B4-BB8A-1EFE9E376511",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]",
    "activateClientAuthentication": true
  },
  {
    "networkControllerInterface": "",
    "createNewNetworkController": true,
    "createNewDeutscheTelekomSipTrunk": true,
    "activateNatTraversal": false,
    "defineAssertedUri": false,
    "deutscheTelekomNumberExtensionRange": {"zeroExtend": true},
    "credentials": {},
    "displayName": "Amazon Chime",
    "remoteSipDomain": {},
    "includeSipRegistrarInWhitelist": true,
    "networkPeerWhitelist": [],
    "includeRemoteSipDomainInWhitelist": true,
    "includeProxyInWhitelist": true,
    "nodeViaSipTrunking": true,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "networkControllerDisplayName": "Amazon Chime",
    "routingDomains": [],
    "useNetworkPeerWhitelist": true,
    "addressOfRecord": "",
    "id": "42121cdc-bf69-4F6C-AE44-538b536cf434",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]",
    "activateClientAuthentication": true
  }
]

13.6 Add Provider

POST https://<HOST>:<PORT>/api/nodes/addProvider?version=2

Adds a Provider Node to the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • profile

    The id of the profile, that should be used. To get a list of availabled profiles use section 13.5.

  • version

    2

Request Body Structure

The request body is structured as AddProviderProfile JSON object. A description for its fields is at section 26.18.1. For the JSON schema refer to section 26.18.2.

Response Body Structure

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

13.6.1 Example

POST http://127.0.0.1:8111/api/nodes/addProvider?profile=42121cdc-bf69-4F6C-AE44-538b536cf434&version=2
HTTP Request Body
{
  "fixedTlsPort": 0,
  "createNewNetworkController": true,
  "tlsPort": 5888,
  "credentials": {
    "password": "asd",
    "username": "qwe"
  },
  "displayName": "Amazon Chime test",
  "remoteSipDomain": {
    "iri": "sip:test",
    "port": 0
  },
  "includeSipRegistrarInWhitelist": true,
  "networkPeerWhitelist": [{
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "subnetPrefixLength": 24,
    "dnsLookup": []
  }],
  "includeRemoteSipDomainInWhitelist": true,
  "includeProxyInWhitelist": true,
  "nodeViaSipTrunking": true,
  "networkControllerDisplayName": "NC 1",
  "routingDomains": [],
  "fixedUdpPortRangeStart": 0,
  "proxyUri": "sip:proxy",
  "udpTcpPort": 5887,
  "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
  "networkControllerIpAddress": "127.0.0.1",
  "fixedUdpTcpPort": 0,
  "fixedTcpPortRangeStart": 0,
  "activateClientAuthentication": true
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "displayName": "Amazon Chime test",
  "id": "927aabf0-14a1-44c6-b30b-2a54f95e1a76"
}]

13.7 Add SIP Phones Registrar

POST https://<HOST>:<PORT>/api/nodes/addSipPhoneRegistrar?version=0

Adds a new SIP phones registrar to the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as AddSipPhoneRegistrarProfile JSON object. A description for its fields is at section 26.19.1. For the JSON schema refer to section 26.19.2.

Response Body Structure

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

13.7.1 Example

POST http://127.0.0.1:8111/api/nodes/addSipPhoneRegistrar?version=0
HTTP Request Body
{
  "createNewNetworkController": true,
  "tlsPort": 5888,
  "displayName": "SIP Phones Registrar test",
  "networkPeerWhitelist": [{
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "subnetPrefixLength": 24,
    "dnsLookup": []
  }],
  "sipPhoneRegistrarDirectoryId": "a29117f9-1474-4ad0-8b52-2ac1b5e654cf",
  "allowOnlyNegotiatedPeersForRtpRtcp": false,
  "networkControllerDisplayName": "NC 1",
  "routingDomains": [],
  "includeOwnSubnetInWhitelist": false,
  "useNetworkPeerWhitelist": false,
  "udpTcpPort": 5887,
  "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
  "networkControllerIpAddress": "127.0.0.1"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "SIP Phones Registrar test",
    "id": "a66c9951-63de-4287-968e-fa5a6af8e43b"
  }
]

13.8 Remove Node

DELETE https://<HOST>:<PORT>/api/nodes/remove?version=0

Removes a node from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the node that should be removed

  • force

    If this is true, objects will be deleted even if they have other references than this node. This can cause errors inside the configuration.

13.8.1 Example

DELETE http://127.0.0.1:8111/api/nodes/remove?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&force=true&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Node was removed.

13.9 Get Port

GET https://<HOST>:<PORT>/api/nodes/port/get?version=0

Returns the UDP/TCP port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node that should be removed

13.9.1 Example

GET http://127.0.0.1:8111/api/nodes/port/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
2222

13.10 Set Port

PUT https://<HOST>:<PORT>/api/nodes/port/set?version=0

Modifies the UDP/TCP port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node which port should be modified.

Request Body Structure

The body must contain the new UDP/TCP port for the given node.

13.10.1 Example

PUT http://127.0.0.1:8111/api/nodes/port/set?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
2222
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
2222

13.11 Get TlsPort

GET https://<HOST>:<PORT>/api/nodes/tlsPort/get?version=0

Returns the TLS port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node that should be removed

13.11.1 Example

GET http://127.0.0.1:8111/api/nodes/tlsPort/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
2223

13.12 Set TlsPort

PUT https://<HOST>:<PORT>/api/nodes/tlsPort/set?version=0

Modifies the TLS port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node which port should be modified.

Request Body Structure

The body must contain the new TLS port for the given node.

13.12.1 Example

PUT http://127.0.0.1:8111/api/nodes/tlsPort/set?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
2223
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
2223

13.13 Get Teams FQDN

GET https://<HOST>:<PORT>/api/nodes/tenants/fqdn/get?version=0

Returns the FQDN of the requested Teams node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the Teams node which FQDN should be returned.

13.13.1 Example

GET http://127.0.0.1:8111/api/nodes/tenants/fqdn/get?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
test.fqdn

13.14 Set Teams FQDN

PUT https://<HOST>:<PORT>/api/nodes/tenants/fqdn/set?version=0

Modifies the FQDN of the requested Teams node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the Teams node which FQDN should be returned.

Request Body Structure

The body must contain the new FQDN for the Teams node.

13.14.1 Example

PUT http://127.0.0.1:8111/api/nodes/tenants/fqdn/set?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Request Body
test.fqdn
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
test.fqdn

13.15 Get Hostname/FQDN

GET https://<HOST>:<PORT>/api/nodes/overrideHostname/get?version=0

Returns the hostname/FQDN of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node which hostname/FQDN should be returned.

13.15.1 Example

GET http://127.0.0.1:8111/api/nodes/overrideHostname/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
test.hostname

13.16 Set Hostname/FQDN

PUT https://<HOST>:<PORT>/api/nodes/overrideHostname/set?version=0

Modifies the hostname/FQDN of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the node which hostname/FQDN should be modified.

Request Body Structure

The body must contain the new hostname/FQDN for the requested node.

13.16.1 Example

PUT http://127.0.0.1:8111/api/nodes/overrideHostname/set?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
test.hostname
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
test.hostname

13.17 Get Certificate

GET https://<HOST>:<PORT>/api/nodes/certificates/get?version=0

Returns the certificate of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node which certificate should be returned.

13.18 Set Certificate

PUT https://<HOST>:<PORT>/api/nodes/certificates/set?version=0

Modifies the certificate of the requested node.

Required Permissions

  • API

  • Administration

Request parameters

  • mode

    Determines which items will be modified with the uploaded file.

    Type: mode

    Possible Values:

    • CERTIFICATES_AND_PRIVATE_KEY

    • CERTIFICATES_ONLY

    • PRIVATE_KEY_ONLY

  • node

    The id or displayName of the Node to be modified.

  • password

    The password of the certificate file.

Request Body Structure

The body must contain the certificate file.

13.18.1 Example

PUT http://127.0.0.1:8111/api/nodes/certificates/set?mode=PRIVATE_KEY_ONLY&node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "keySize": 2048,
  "keyType": "RSA"
}]

13.19 Get Transport Connections

GET https://<HOST>:<PORT>/api/nodes/transportConnections/get?version=0

Returns the transport connection of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node whose transport connections should be returned.

Response Body Structure

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

13.19.1 Example

GET http://127.0.0.1:8111/api/nodes/transportConnections/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "matchingCondition": {"type": "ALWAYS"},
  "transportConnectionId": "e35c28d6-e08b-4d61-bd60-1ec27d47a25f"
}]

13.20 Add Transport Connection

POST https://<HOST>:<PORT>/api/nodes/transportConnections/add?version=0

Adds a transport connection to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node whose transport connections should be returned.

Request Body Structure

The request body is structured as AddTransportConnectionData JSON object. A description for its fields is at section 26.20.1. For the JSON schema refer to section 26.20.2.

Response Body Structure

The response body is structured as AddTransportConnectionData JSON object. A description for its fields is at section 26.20.1. For the JSON schema refer to section 26.20.2.

13.20.1 Example

POST http://127.0.0.1:8111/api/nodes/transportConnections/add?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
{
  "matchingCondition": {"type": "ALWAYS"},
  "transportConnectionId": "fa6f5ae7-38c9-44f4-a427-107e4068305b"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "matchingCondition": {"type": "ALWAYS"},
  "transportConnection": {
    "displayName": "test_connection",
    "id": "fa6f5ae7-38c9-44f4-a427-107e4068305b"
  }
}

13.21 Clear Transport Connections

DELETE https://<HOST>:<PORT>/api/nodes/transportConnections/clear?version=0

Removes all transport connections of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node whose transport connections should be returned.

  • removeRoutes

    Decide if the routes should be removed or not.

13.21.1 Example

DELETE http://127.0.0.1:8111/api/nodes/transportConnections/clear?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&removeRoutes=true&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Cleared transport connections.

13.22 Add Trusted Certificates

PUT https://<HOST>:<PORT>/api/nodes/trustedCertficates/add?version=0

Adds a new certificate to the list of trusted certificates for the requested node.

Required Permissions

  • API

  • Administration

Request parameters

  • node

    The id or displayName of the Node to be modified.

  • password

    The password of the certificate file.

Request Body Structure

The body must contain the certificate file.

13.23 Clear Trusted Certificates

DELETE https://<HOST>:<PORT>/api/nodes/trustedCertificates/clear?version=0

Removes all trusted certificates from the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node to be modified.

13.24 Get Incoming Dial String Rewrite Rules

GET https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/get?version=0

Returns the incoming dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node

  • includeDefaults

    Whether default values should be displayed or not.

Response Body Structure

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

13.24.1 Example

GET http://127.0.0.1:8111/api/nodes/incomingDialStringRewriteRules/get?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

13.25 Set Incoming Dial String Rewrite Rules

PUT https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/set?version=0

Modifies the incoming dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 26.4.1. For the JSON schema refer to section 26.4.2.

Response Body Structure

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

13.25.1 Example

PUT http://127.0.0.1:8111/api/nodes/incomingDialStringRewriteRules/set?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

13.26 Add Incoming Dial String Rewrite Rules

POST https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/add?version=0

Adds additional dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 26.4.1. For the JSON schema refer to section 26.4.2.

Response Body Structure

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

13.26.1 Example

POST http://127.0.0.1:8111/api/nodes/incomingDialStringRewriteRules/add?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

13.27 Remove Incoming Dial String Rewrite Rules

DELETE https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/remove?version=0

Removes incoming dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

  • displayName

    The displayName or id of the incoming dial string rewrite rule to be removed.

  • index

    The index of the incoming dial string rewrite rule to be removed.

13.27.1 Example

DELETE http://127.0.0.1:8111/api/nodes/incomingDialStringRewriteRules/remove?node=afaf59dc-d239-42d4-9378-b989bd358c6e&index=0&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[]

13.28 Get Outgoing Dial String Rewrite Rules

GET https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/get?version=0

Returns the outgoing dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node.

Response Body Structure

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

13.28.1 Example

GET http://127.0.0.1:8111/api/nodes/outgoingDialStringRewriteRules/get?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

13.29 Set Outgoing Dial String Rewrite Rules

PUT https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/set?version=0

Modifies the outgoing dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 26.4.1. For the JSON schema refer to section 26.4.2.

Response Body Structure

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

13.29.1 Example

PUT http://127.0.0.1:8111/api/nodes/outgoingDialStringRewriteRules/set?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

13.30 Add Outgoing Dial String Rewrite Rules

POST https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/add?version=0

Adds additional dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 26.4.1. For the JSON schema refer to section 26.4.2.

Response Body Structure

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

13.30.1 Example

POST http://127.0.0.1:8111/api/nodes/outgoingDialStringRewriteRules/add?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

13.31 Remove Outgoing Dial String Rewrite Rules

DELETE https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/remove?version=0

Removes outgoing dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

  • displayName

    The displayName or id of the incoming dial string rewrite rule to be removed.

  • index

    The index of the incoming dial string rewrite rule to be removed.

13.31.1 Example

DELETE http://127.0.0.1:8111/api/nodes/outgoingDialStringRewriteRules/remove?node=afaf59dc-d239-42d4-9378-b989bd358c6e&index=0&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[]

13.32 Get Network Peer Whitelist

GET https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/get?version=0

Returns the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node.

Response Body Structure

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

13.32.1 Example

GET http://127.0.0.1:8111/api/nodes/networkPeerWhitelist/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "hostnameFlags": {
      "querySrvRecords": false,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": false
    },
    "subnetPrefixLength": 24
  },
  {
    "ipVersion": "[Any Address Version]",
    "host": "proxy",
    "hostnameFlags": {
      "querySrvRecords": true,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": true
    },
    "dnsLookup": [
      "_sip._udp",
      "_sip._tcp",
      "_sips._tcp"
    ]
  }
]

13.33 Set Network Peer Whitelist

PUT https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/set?version=0

Modifies the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 26.21.1. For the JSON schema refer to section 26.21.2.

Response Body Structure

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

13.33.1 Example

PUT http://127.0.0.1:8111/api/nodes/networkPeerWhitelist/set?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
[{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "127.0.0.1",
  "subnetPrefixLength": 24,
  "dnsLookup": []
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "127.0.0.1",
  "hostnameFlags": {
    "querySrvRecords": false,
    "interpretAsIpAddress": false,
    "queryAAndAaaaRecords": false
  },
  "subnetPrefixLength": 24
}]

13.34 Add Network Peer Whitelist Entry

PUT https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/add?version=0

Adds a new entry to the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node

Request Body Structure

The request body is structured as NetworkPeerWhitelistEntry JSON object. A description for its fields is at section 26.21.1. For the JSON schema refer to section 26.21.2.

Response Body Structure

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

13.34.1 Example

PUT http://127.0.0.1:8111/api/nodes/networkPeerWhitelist/add?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "test2.fqdn",
  "subnetPrefixLength": 24,
  "dnsLookup": []
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "hostnameFlags": {
      "querySrvRecords": false,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": false
    },
    "subnetPrefixLength": 24
  },
  {
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "test2.fqdn",
    "hostnameFlags": {
      "querySrvRecords": false,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": false
    },
    "subnetPrefixLength": 24
  }
]

13.35 Remove Network Peer Whitelist Entry

DELETE https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/remove?version=0

Removes a entry from the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

  • host

    The host of the network peer whitelist entry to be removed.

  • index

    The index of the network peer whitelist entry to be removed.

Response Body Structure

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

13.35.1 Example

DELETE http://127.0.0.1:8111/api/nodes/networkPeerWhitelist/remove?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&hostname=test2.fqdn&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "127.0.0.1",
  "hostnameFlags": {
    "querySrvRecords": false,
    "interpretAsIpAddress": false,
    "queryAAndAaaaRecords": false
  },
  "subnetPrefixLength": 24
}]

13.36 Get Certificate Chain

GET https://<HOST>:<PORT>/api/nodes/certificateChain/get?version=0

Returns the chain certificate information for the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node whose certificate chain should be returned.

Response Body Structure

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

13.37 Add Chain Certificate

POST https://<HOST>:<PORT>/api/nodes/certificateChain/add?version=0

Adds Certificates to the certificate chain of the requested node.

Required Permissions

  • API

  • Administration

Request parameters

  • node

    The id or displayName of the Node to be modified.

Request Body Structure

The body must contain the certificate file.

Response Body Structure

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

13.37.1 Example

POST http://127.0.0.1:8111/api/nodes/certificateChain/add?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "extendedUsage": ["AGE_FLAG_"],
  "serial": "410629b7c3f607de",
  "signingAlgorithm": "RSA_SHA256",
  "subject": "CN=test.chaincert",
  "usage": [
    "DIGITAL_SIGNATURE",
    "KEY_ENCIPHERMENT",
    "DATA_ENCIPHERMENT",
    "KEY_AGREEMENT"
  ],
  "fingerprintAlgorithm": "SHA1",
  "fingerprint": "58A8F3CCACFE2CF55ED911758D29F23F776400B7",
  "validUntil": "UTC 2024-07-04 13:22:00",
  "validFrom": "UTC 2023-07-05 13:22:00",
  "version": "V3",
  "certificateAuthority": "no",
  "issuer": "CN=test.chaincert"
}]

13.38 Remove Chain Certificate

DELETE https://<HOST>:<PORT>/api/nodes/certificateChain/remove?version=0

Removes a certificate from the certificate chain of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Response Body Structure

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

13.39 Clear Certificate Chain

DELETE https://<HOST>:<PORT>/api/nodes/certificateChain/clear?version=0

Removes all certificates from the certificate chain of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node to be modified.

13.40 Request Certificate Chain

POST https://<HOST>:<PORT>/api/nodes/certificateChain/request?version=0

Requests the certificate chain for the configured certificate of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node to be modified.

14 Transport Connections

14.1 Get Transport Connection

GET https://<HOST>:<PORT>/api/transportConnections/get?version=0

Returns detailed information about the selected transport connection.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the transport connection.

Response Body Structure

The response body is structured as TransportConnection JSON object. A description for its fields is at section 26.22.1. For the JSON schema refer to section 26.22.2.

14.1.1 Example

GET http://127.0.0.1:8111/api/transportConnections/get?id=1d9d4a89-5408-46a8-8116-cb67f711a6e9&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "proxy": {
    "iri": "sip:test.test",
    "options": true,
    "optionsNextHop": true,
    "omitInitialRouteSet": true,
    "flow": true
  },
  "authenticationEnabled": true,
  "credentials": {
    "authenticationProfileId": "cec02f43-30fb-4a1a-8fe3-a31b705a44d4",
    "username": "user"
  },
  "displayName": "test_connection",
  "registration": {
    "sipDomain": "sip:sip.domain",
    "addressOfRecord": "sip:registration.aor"
  },
  "id": "1d9d4a89-5408-46a8-8116-cb67f711a6e9",
  "type": "STANDARD"
}

14.2 Create Standard Transport Connection

PUT https://<HOST>:<PORT>/api/transportConnections/addStandard?version=0

Creates a new standard transport connection.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • displayName

    The display name of the new transport connection.

Request Body Structure

The request body is structured as TransportConnection JSON object. A description for its fields is at section 26.22.1. For the JSON schema refer to section 26.22.2.

Response Body Structure

The response body is structured as TransportConnection JSON object. A description for its fields is at section 26.22.1. For the JSON schema refer to section 26.22.2.

14.2.1 Example

PUT http://127.0.0.1:8111/api/transportConnections/addStandard?displayName=test_connection&version=0
HTTP Request Body
{
  "proxy": {
    "iri": "sip:test.test",
    "options": true,
    "optionsNextHop": true,
    "omitInitialRouteSet": true,
    "flow": true
  },
  "credentials": {
    "password": "pw",
    "username": "user"
  },
  "registration": {
    "sipDomain": "sip:sip.domain",
    "addressOfRecord": "sip:registration.aor"
  },
  "authencationEnabled": true
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "proxy": {
    "iri": "sip:test.test",
    "options": true,
    "optionsNextHop": true,
    "omitInitialRouteSet": true,
    "flow": true
  },
  "authenticationEnabled": true,
  "credentials": {
    "authenticationProfileId": "161d7346-7d77-4a85-8761-3519141cafbe",
    "username": "user"
  },
  "displayName": "test_connection",
  "registration": {
    "sipDomain": "sip:sip.domain",
    "addressOfRecord": "sip:registration.aor"
  },
  "id": "fa6f5ae7-38c9-44f4-a427-107e4068305b",
  "type": "STANDARD"
}

14.3 Remove Transport Connection

DELETE https://<HOST>:<PORT>/api/transportConnections/remove?version=0

Removes a transport connection from the current configuration.

Required Permissions

  • API

  • Administration

Request parameters

  • transportConnection

    The id of the transport connection.

  • force

    If set to true the transport connection and it's referenced objects will be removed, even if it is referenced by other objects.

14.3.1 Example

DELETE http://127.0.0.1:8111/api/transportConnections/remove?transportConnection=fa6f5ae7-38c9-44f4-a427-107e4068305b&force=true&version=0
HTTP Response
HTTP/1.1 200 OK

14.4 Get Authentication

GET https://<HOST>:<PORT>/api/transportConnections/authentication/get?version=0

Returns the authentication configuration of the requested transport connection.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • transportConnection

    The id of the Transport Connection..

Response Body Structure

The response body is structured as SipCredentials JSON object. A description for its fields is at section 26.23.1. For the JSON schema refer to section 26.23.2.

14.4.1 Example

GET http://127.0.0.1:8111/api/transportConnections/authentication/get?transportConnection=fa6f5ae7-38c9-44f4-a427-107e4068305b&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "authenticationProfileId": "161d7346-7d77-4a85-8761-3519141cafbe",
  "username": "user"
}

14.5 Set Authentication

PUT https://<HOST>:<PORT>/api/transportConnections/authentication/set?version=0

Modifies the username and password of the selected transport connection.

Required Permissions

  • API

  • Administration

Request parameters

  • transportConnection

    The id of the transport connection.

Request Body Structure

The request body is structured as Credentials JSON object. A description for its fields is at section 26.24.1. For the JSON schema refer to section 26.24.2.

Response Body Structure

The response body is structured as SipCredentials JSON object. A description for its fields is at section 26.23.1. For the JSON schema refer to section 26.23.2.

14.5.1 Example

PUT http://127.0.0.1:8111/api/transportConnections/authentication/set?transportConnection=fa6f5ae7-38c9-44f4-a427-107e4068305b&version=0
HTTP Request Body
{
  "password": "pw",
  "username": "user"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "authenticationProfileId": "161d7346-7d77-4a85-8761-3519141cafbe",
  "username": "user"
}

14.6 Get Asserted URI

GET https://<HOST>:<PORT>/api/transportConnections/assertedUri/get?version=0

Returns the asserted URI of the selected transport connection.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • transportConnection

    The id of the transport connection.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 26.25.1. For the JSON schema refer to section 26.25.2.

14.6.1 Example

GET http://127.0.0.1:8111/api/transportConnections/assertedUri/get?transportConnection=fa6f5ae7-38c9-44f4-a427-107e4068305b&version=0
HTTP Response
HTTP/1.1 200 OK

14.7 Set Asserted URI

PUT https://<HOST>:<PORT>/api/transportConnections/assertedUri/set?version=0

Modifies the asserted URI of the selected transport connection.

Required Permissions

  • API

  • Administration

Request parameters

  • transportConnection

    The id of the transport connection

Request Body Structure

The request body is structured as AssertedUri JSON object. A description for its fields is at section 26.25.1. For the JSON schema refer to section 26.25.2.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 26.25.1. For the JSON schema refer to section 26.25.2.

14.7.1 Example

PUT http://127.0.0.1:8111/api/transportConnections/assertedUri/set?transportConnection=fa6f5ae7-38c9-44f4-a427-107e4068305b&version=0
HTTP Request Body
{
  "iri": "sip:asserted.uri",
  "displayName": "display.name"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "iri": "sip:asserted.uri",
  "displayName": "display.name"
}

14.8 Get Address of Record

GET https://<HOST>:<PORT>/api/transportConnections/addressOfRecord/get?version=0

Returns the Address of Record for the selected transport connection

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • transportConnection

    The id of the transport connection.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 26.25.1. For the JSON schema refer to section 26.25.2.

14.8.1 Example

GET http://127.0.0.1:8111/api/transportConnections/addressOfRecord/get?transportConnection=fa6f5ae7-38c9-44f4-a427-107e4068305b&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"iri": "sip:registration.aor"}

14.9 Set Transport Connections

PUT https://<HOST>:<PORT>/api/transportConnections/addressOfRecord/set?version=0

Modifies the transport connection of the requested node.

Required Permissions

  • API

  • Administration

Request parameters

  • transportConnection

    The id of the transport connection.

Request Body Structure

The request body is structured as AssertedUri JSON object. A description for its fields is at section 26.25.1. For the JSON schema refer to section 26.25.2.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 26.25.1. For the JSON schema refer to section 26.25.2.

14.9.1 Example

PUT http://127.0.0.1:8111/api/transportConnections/addressOfRecord/set?transportConnection=fa6f5ae7-38c9-44f4-a427-107e4068305b&version=0
HTTP Request Body
{
  "iri": "sip:aor",
  "displayName": "display.name"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"iri": "sip:aor"}

15 Directories

15.1 Get Directories

GET https://<HOST>:<PORT>/api/directories/get?version=0

Returns a list of directories or detailed information about a static user directory

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the directory.

Response Body Structure

The response body is structured as DirectoryInfo JSON object. A description for its fields is at section 26.26.1. For the JSON schema refer to section 26.26.2.

15.1.1 Example

GET http://127.0.0.1:8111/api/directories/get?id=edadc2e6-9da2-411d-ac0f-17c8dc65dd52&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "Test Static User Directory",
  "id": "edadc2e6-9da2-411d-ac0f-17c8dc65dd52",
  "directoryType": "STATIC_USER_DIRECTORY",
  "userRecords": [{
    "displayName": "Test User",
    "applicationRecords": {
      "associatedProvisioningDevices": [{
        "subId": "asd",
        "aorUserName": "asd",
        "staticVariables": {"test": "value"},
        "deviceId": "00b0d063c226"
      }],
      "webrtc": {
        "address": {
          "tagSet": ["userPhone"],
          "displayName": "qwe",
          "dialString": "123"
        },
        "credentials": {
          "passwordBase64": "d2VicnRjUHc=",
          "username": "webrtcUser"
        }
      },
      "sipCredentials": {"username": "qwe"},
      "sipRegistrar": {
        "dialStrings": [{
          "addresses": [
            {
              "tagSet": "",
              "dialString": "123"
            },
            {
              "tagSet": "",
              "dialString": "456"
            }
          ],
          "aorMatch": {
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          },
          "matches": [{
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          }]
        }],
        "failover": {
          "statusCodes": "486,501-503",
          "groupIdentifier": "93134fe9-8eff-4313-a5fe-e8513d21f043"
        }
      },
      "policy": {
        "rewriteTableOutgoing": [{
          "applyToDestinationDialString": true,
          "displayName": "test",
          "addSuffix": "3",
          "matchTags": {
            "tagSet": [
              "userIp",
              "userPhone"
            ],
            "type": "xor"
          },
          "index": 0,
          "deleteTrailingCharacters": 2,
          "deleteLeadingCharacters": 1,
          "wildcardPattern": "0123456789+\\+!?X.[]",
          "clearDisplayName": false,
          "rewriteType": "wildcardPattern",
          "skipRulesBelow": false,
          "skipFurtherRules": false,
          "comment": "Wildcard Pattern Rewrite Outgoing",
          "tagRewrite": {
            "operations": [
              {
                "tag": "userIp",
                "type": "keep"
              },
              {
                "tag": "userPhone",
                "type": "delete"
              }
            ],
            "clearTags": false
          },
          "case": "casefold",
          "addPrefix": "2"
        }],
        "sippgIncoming": {
          "include": [
            "RFC3323_SESSION",
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ],
          "permit": [
            "RFC3323_USER",
            "RFC3323_SESSION",
            "RFC3325_ID"
          ],
          "passthrough": [
            "RFC3323_USER",
            "RFC3323_SESSION",
            "RFC7044_HISTORY"
          ],
          "enforce": [
            "RFC3323_USER",
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ]
        },
        "sippgOutgoing": {
          "include": [
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ],
          "permit": [
            "RFC3323_USER",
            "RFC3323_SESSION"
          ],
          "passthrough": [
            "RFC3323_SESSION",
            "RFC7044_HISTORY"
          ],
          "enforce": ["RFC3323_USER"]
        },
        "rewriteTableIncoming": [{
          "applyToDestinationDialString": true,
          "displayName": "test",
          "addSuffix": "3",
          "matchTags": {
            "tagSet": [
              "userIp",
              "userPhone"
            ],
            "type": "xor"
          },
          "index": 0,
          "deleteTrailingCharacters": 2,
          "deleteLeadingCharacters": 1,
          "wildcardPattern": "0123456789+\\+!?X.[]",
          "clearDisplayName": false,
          "rewriteType": "wildcardPattern",
          "skipRulesBelow": false,
          "skipFurtherRules": false,
          "comment": "Wildcard Pattern Rewrite",
          "tagRewrite": {
            "operations": [
              {
                "tag": "userIp",
                "type": "keep"
              },
              {
                "tag": "userPhone",
                "type": "delete"
              }
            ],
            "clearTags": false
          },
          "case": "casefold",
          "addPrefix": "2"
        }]
      }
    }
  }]
}

15.2 Remove Directory

DELETE https://<HOST>:<PORT>/api/directories/remove?version=0

Deletes a directory from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • force

    Deletes the object from the configuration even it is referenced elsewhere.

Request Body Structure

The request body must contain the identifier of the directory that should be deleted.

15.2.1 Example

DELETE http://127.0.0.1:8111/api/directories/remove?force=true&version=0
HTTP Request Body
442f1a38-52de-412c-a0fc-70f261cb12f7
HTTP Response
HTTP/1.1 200 OK

15.3 Add Static User Directory

PUT https://<HOST>:<PORT>/api/directories/staticUserDirectories/add?version=0

Creates a new static user directory.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as StaticUserDirectory JSON object. A description for its fields is at section 26.27.1. For the JSON schema refer to section 26.27.2.

Response Body Structure

The response body is structured as DirectoryInfo JSON object. A description for its fields is at section 26.26.1. For the JSON schema refer to section 26.26.2.

15.3.1 Example

PUT http://127.0.0.1:8111/api/directories/staticUserDirectories/add?version=0
HTTP Request Body
{
  "displayName": "Test Static User Directory",
  "userRecords": [{
    "displayName": "Test User",
    "applicationRecords": {
      "associatedProvisioningDevices": [{
        "subId": "asd",
        "aorUserName": "asd",
        "staticVariables": {"test": "value"},
        "deviceId": "00-B0-D0-63-C2-26"
      }],
      "webrtc": {
        "address": {
          "tagSet": ["userPhone"],
          "displayName": "qwe",
          "dialString": "123"
        },
        "credentials": {
          "password": "webrtcPw",
          "username": "webrtcUser"
        }
      },
      "sipCredentials": {
        "password": "asd",
        "username": "qwe"
      },
      "sipRegistrar": {
        "dialStrings": [{
          "addresses": [
            {"dialString": "123"},
            {"dialString": "456"}
          ],
          "aorMatch": {
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          },
          "matches": [{
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          }]
        }],
        "failover": {
          "statusCodes": "486,501-503",
          "groupIdentifier": "93134fe9-8eff-4313-a5fe-e8513d21f043"
        }
      },
      "policy": {
        "rewriteTableOutgoing": [{
          "applyToDestinationDialString": true,
          "displayName": "test",
          "addSuffix": "3",
          "matchTags": {
            "tagSet": [
              "userIp",
              "userPhone"
            ],
            "type": "xor"
          },
          "index": 0,
          "deleteTrailingCharacters": 2,
          "deleteLeadingCharacters": 1,
          "wildcardPattern": "0123456789+\\+!?X.[]",
          "clearDisplayName": false,
          "rewriteType": "wildcardPattern",
          "skipRulesBelow": false,
          "skipFurtherRules": false,
          "comment": "Wildcard Pattern Rewrite Outgoing",
          "tagRewrite": {
            "operations": [
              {
                "tag": "userIp",
                "type": "keep"
              },
              {
                "tag": "userPhone",
                "type": "delete"
              }
            ],
            "clearTags": false
          },
          "applyToSourceDialString": false,
          "applyToAllDialStrings": false,
          "case": "casefold",
          "addPrefix": "2"
        }],
        "sippgIncoming": {
          "include": [
            "RFC3323_SESSION",
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ],
          "permit": [
            "RFC3323_SESSION",
            "RFC3323_USER",
            "RFC3325_ID"
          ],
          "passthrough": [
            "RFC3323_SESSION",
            "RFC3323_USER",
            "RFC7044_HISTORY"
          ],
          "enforce": [
            "RFC3323_USER",
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ]
        },
        "sippgOutgoing": {
          "include": [
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ],
          "permit": [
            "RFC3323_SESSION",
            "RFC3323_USER"
          ],
          "passthrough": [
            "RFC3323_SESSION",
            "RFC7044_HISTORY"
          ],
          "enforce": ["RFC3323_USER"]
        },
        "rewriteTableIncoming": [{
          "applyToDestinationDialString": true,
          "displayName": "test",
          "addSuffix": "3",
          "matchTags": {
            "tagSet": [
              "userIp",
              "userPhone"
            ],
            "type": "xor"
          },
          "index": 0,
          "deleteTrailingCharacters": 2,
          "deleteLeadingCharacters": 1,
          "wildcardPattern": "0123456789+\\+!?X.[]",
          "clearDisplayName": false,
          "rewriteType": "wildcardPattern",
          "skipRulesBelow": false,
          "skipFurtherRules": false,
          "comment": "Wildcard Pattern Rewrite",
          "tagRewrite": {
            "operations": [
              {
                "tag": "userIp",
                "type": "keep"
              },
              {
                "tag": "userPhone",
                "type": "delete"
              }
            ],
            "clearTags": false
          },
          "applyToSourceDialString": false,
          "applyToAllDialStrings": false,
          "case": "casefold",
          "addPrefix": "2"
        }]
      }
    }
  }]
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "Test Static User Directory",
  "id": "edadc2e6-9da2-411d-ac0f-17c8dc65dd52",
  "directoryType": "STATIC_USER_DIRECTORY",
  "userRecords": [{
    "displayName": "Test User",
    "applicationRecords": {
      "associatedProvisioningDevices": [{
        "subId": "asd",
        "aorUserName": "asd",
        "staticVariables": {"test": "value"},
        "deviceId": "00b0d063c226"
      }],
      "webrtc": {
        "address": {
          "tagSet": ["userPhone"],
          "displayName": "qwe",
          "dialString": "123"
        },
        "credentials": {
          "passwordBase64": "d2VicnRjUHc=",
          "username": "webrtcUser"
        }
      },
      "sipCredentials": {"username": "qwe"},
      "sipRegistrar": {
        "dialStrings": [{
          "addresses": [
            {
              "tagSet": "",
              "dialString": "123"
            },
            {
              "tagSet": "",
              "dialString": "456"
            }
          ],
          "aorMatch": {
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          },
          "matches": [{
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          }]
        }],
        "failover": {
          "statusCodes": "486,501-503",
          "groupIdentifier": "93134fe9-8eff-4313-a5fe-e8513d21f043"
        }
      },
      "policy": {
        "rewriteTableOutgoing": [{
          "applyToDestinationDialString": true,
          "displayName": "test",
          "addSuffix": "3",
          "matchTags": {
            "tagSet": [
              "userIp",
              "userPhone"
            ],
            "type": "xor"
          },
          "index": 0,
          "deleteTrailingCharacters": 2,
          "deleteLeadingCharacters": 1,
          "wildcardPattern": "0123456789+\\+!?X.[]",
          "clearDisplayName": false,
          "rewriteType": "wildcardPattern",
          "skipRulesBelow": false,
          "skipFurtherRules": false,
          "comment": "Wildcard Pattern Rewrite Outgoing",
          "tagRewrite": {
            "operations": [
              {
                "tag": "userIp",
                "type": "keep"
              },
              {
                "tag": "userPhone",
                "type": "delete"
              }
            ],
            "clearTags": false
          },
          "case": "casefold",
          "addPrefix": "2"
        }],
        "sippgIncoming": {
          "include": [
            "RFC3323_SESSION",
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ],
          "permit": [
            "RFC3323_USER",
            "RFC3323_SESSION",
            "RFC3325_ID"
          ],
          "passthrough": [
            "RFC3323_USER",
            "RFC3323_SESSION",
            "RFC7044_HISTORY"
          ],
          "enforce": [
            "RFC3323_USER",
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ]
        },
        "sippgOutgoing": {
          "include": [
            "RFC3325_ID",
            "RFC7044_HISTORY"
          ],
          "permit": [
            "RFC3323_USER",
            "RFC3323_SESSION"
          ],
          "passthrough": [
            "RFC3323_SESSION",
            "RFC7044_HISTORY"
          ],
          "enforce": ["RFC3323_USER"]
        },
        "rewriteTableIncoming": [{
          "applyToDestinationDialString": true,
          "displayName": "test",
          "addSuffix": "3",
          "matchTags": {
            "tagSet": [
              "userIp",
              "userPhone"
            ],
            "type": "xor"
          },
          "index": 0,
          "deleteTrailingCharacters": 2,
          "deleteLeadingCharacters": 1,
          "wildcardPattern": "0123456789+\\+!?X.[]",
          "clearDisplayName": false,
          "rewriteType": "wildcardPattern",
          "skipRulesBelow": false,
          "skipFurtherRules": false,
          "comment": "Wildcard Pattern Rewrite",
          "tagRewrite": {
            "operations": [
              {
                "tag": "userIp",
                "type": "keep"
              },
              {
                "tag": "userPhone",
                "type": "delete"
              }
            ],
            "clearTags": false
          },
          "case": "casefold",
          "addPrefix": "2"
        }]
      }
    }
  }]
}

15.4 Set Static User Directory

PUT https://<HOST>:<PORT>/api/directories/staticUserDirectories/set?version=0

Modifies an existing static user directory.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as StaticUserDirectory JSON object. A description for its fields is at section 26.27.1. For the JSON schema refer to section 26.27.2.

Response Body Structure

The response body is structured as DirectoryInfo JSON object. A description for its fields is at section 26.26.1. For the JSON schema refer to section 26.26.2.

15.4.1 Example

PUT http://127.0.0.1:8111/api/directories/staticUserDirectories/set?id=edadc2e6-9da2-411d-ac0f-17c8dc65dd52&version=0
HTTP Request Body
{
  "displayName": "Test Static User Directory Edited",
  "userRecords": [{
    "displayName": "Test User",
    "applicationRecords": {
      "associatedProvisioningDevices": [{
        "subId": "asd",
        "aorUserName": "asd",
        "staticVariables": {"test": "value"},
        "deviceId": "00-B0-D0-63-C2-26"
      }],
      "webrtc": {
        "address": {
          "tagSet": ["userIp"],
          "displayName": "qwe",
          "dialString": "123"
        },
        "credentials": {
          "password": "webrtcPw",
          "username": "webrtcUser"
        }
      },
      "sipCredentials": {
        "password": "asd",
        "username": "qwe"
      },
      "sipRegistrar": {
        "dialStrings": [{
          "addresses": [
            {"dialString": "123"},
            {"dialString": "456"}
          ],
          "aorMatch": {
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          },
          "matches": [{
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          }]
        }],
        "failover": {
          "statusCodes": "486,501-503",
          "groupIdentifier": "93134fe9-8eff-4313-a5fe-e8513d21f043"
        }
      }
    }
  }]
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "Test Static User Directory Edited",
  "id": "edadc2e6-9da2-411d-ac0f-17c8dc65dd52",
  "directoryType": "STATIC_USER_DIRECTORY",
  "userRecords": [{
    "displayName": "Test User",
    "applicationRecords": {
      "associatedProvisioningDevices": [{
        "subId": "asd",
        "aorUserName": "asd",
        "staticVariables": {"test": "value"},
        "deviceId": "00b0d063c226"
      }],
      "webrtc": {
        "address": {
          "tagSet": ["userIp"],
          "displayName": "qwe",
          "dialString": "123"
        },
        "credentials": {
          "passwordBase64": "d2VicnRjUHc=",
          "username": "webrtcUser"
        }
      },
      "sipCredentials": {"username": "qwe"},
      "sipRegistrar": {
        "dialStrings": [{
          "addresses": [
            {
              "tagSet": "",
              "dialString": "123"
            },
            {
              "tagSet": "",
              "dialString": "456"
            }
          ],
          "aorMatch": {
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          },
          "matches": [{
            "plain": {
              "prefix": "123",
              "suffix": "456"
            },
            "type": "PLAIN"
          }]
        }],
        "failover": {
          "statusCodes": "486,501-503",
          "groupIdentifier": "93134fe9-8eff-4313-a5fe-e8513d21f043"
        }
      }
    }
  }]
}

16 System Resources

16.1 Get Resources

GET https://<HOST>:<PORT>/api/resources/get?version=0

Returns the utilization of the systems resources.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request parameters

  • value

    If set only the utilization of the selected resources will be returned

    Type: String

    Possible Values:

    • disk

    • cpu

    • ram

Response Body Structure

The response body is structured as Resources JSON object. A description for its fields is at section 26.28.1. For the JSON schema refer to section 26.28.2.

16.1.1 Example

GET http://127.0.0.1:8111/api/resources/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "disk": {
    "total": 1022870155264,
    "used": 737593999360
  },
  "cpu": 49,
  "ram": {
    "total": 17040580608,
    "used": 10704080896
  }
}

17 Routing Domains

17.1 Get Routing Domains

GET https://<HOST>:<PORT>/api/routingDomains/get?version=0

Returns the currently configured routing domains.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

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

17.1.1 Example

GET http://127.0.0.1:8111/api/routingDomains/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "pathReplacementRoutes": [],
  "sourceNodeIds": ["927aabf0-14a1-44c6-b30b-2a54f95e1a76"],
  "routes": [],
  "displayName": "test_domain",
  "id": "44457996-2919-4809-a9b2-8a179d0dac2d"
}]

17.2 Add Routing Domain

POST https://<HOST>:<PORT>/api/routingDomains/add?version=1

Adds a new routing domain to the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as AddRoutingDomainOptions JSON object. A description for its fields is at section 26.29.1. For the JSON schema refer to section 26.29.2.

Response Body Structure

The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 26.30.1. For the JSON schema refer to section 26.30.2.

17.2.1 Example

POST http://127.0.0.1:8111/api/routingDomains/add?version=1
HTTP Request Body
{
  "sourceNodes": ["afaf59dc-d239-42d4-9378-b989bd358c6e"],
  "displayName": "test_domain"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "pathReplacementRoutes": [],
  "sourceNodeIds": ["afaf59dc-d239-42d4-9378-b989bd358c6e"],
  "routes": [],
  "displayName": "test_domain",
  "id": "5b55cd9f-c9ea-4b19-8684-3fa9e95c5098"
}

17.3 Set Routing Domain

POST https://<HOST>:<PORT>/api/routingDomains/set?version=1

Modifies the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The display name or id of the routing domain.

  • version

    1

Request Body Structure

The request body is structured as AddRoutingDomainOptions JSON object. A description for its fields is at section 26.29.1. For the JSON schema refer to section 26.29.2.

Response Body Structure

The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 26.30.1. For the JSON schema refer to section 26.30.2.

17.3.1 Example

POST http://127.0.0.1:8111/api/routingDomains/set?routingDomain=44457996-2919-4809-a9b2-8a179d0dac2d&version=1
HTTP Request Body
{
  "sourceNodes": ["afaf59dc-d239-42d4-9378-b989bd358c6e"],
  "displayName": "test_domain_set"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "pathReplacementRoutes": [],
  "sourceNodeIds": [
    "927aabf0-14a1-44c6-b30b-2a54f95e1a76",
    "afaf59dc-d239-42d4-9378-b989bd358c6e"
  ],
  "routes": [{
    "displayName": "Copy of test_route_edited",
    "establishment": {
      "routingForwardProfileId": "1a8a1765-c23a-4932-b00e-b3ef3757ff22",
      "destinationNodeId": "afaf59dc-d239-42d4-9378-b989bd358c6e",
      "action": "ACCEPT"
    },
    "id": "5D2EBE90EB06A8AC4DF746CC9306FFAE",
    "filters": [{"sourceNodeIds": ["afaf59dc-d239-42d4-9378-b989bd358c6e"]}],
    "enabled": true
  }],
  "displayName": "test_domain_set",
  "id": "44457996-2919-4809-a9b2-8a179d0dac2d"
}

17.4 Remove Routing Domain

DELETE https://<HOST>:<PORT>/api/routingDomains/remove?version=0

Removes a routing domain from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Response Body Structure

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

17.4.1 Example

DELETE http://127.0.0.1:8111/api/routingDomains/remove?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK

17.5 Get Routes

GET https://<HOST>:<PORT>/api/routingDomains/routes/get?version=0

Returns the routes of the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

Response Body Structure

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

17.5.1 Example

GET http://127.0.0.1:8111/api/routingDomains/routes/get?routingDomain=44457996-2919-4809-a9b2-8a179d0dac2d&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "displayName": "test_route",
  "establishment": {
    "routingForwardProfileId": "721a5686-8406-4a38-a773-37baf1c7e755",
    "destinationNodeId": "927aabf0-14a1-44c6-b30b-2a54f95e1a76",
    "action": "ACCEPT"
  },
  "filters": [{"sourceNodeIds": ["927aabf0-14a1-44c6-b30b-2a54f95e1a76"]}],
  "enabled": true
}]

17.6 Add Route

POST https://<HOST>:<PORT>/api/routingDomains/routes/add?version=0

Adds a route to the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • mode

    Determines which type of route will be added.

    Type: String

    Possible Values:

    • establishment

    • pathReplacement

  • routingDomain

    The id or display name of the routing domain.

Request Body Structure

The request body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 26.31.1. For the JSON schema refer to section 26.31.2.

Response Body Structure

The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 26.31.1. For the JSON schema refer to section 26.31.2.

17.6.1 Example

POST http://127.0.0.1:8111/api/routingDomains/routes/add?mode=establishment&routingDomain=44457996-2919-4809-a9b2-8a179d0dac2d&version=0
HTTP Request Body
{
  "useUnconditionalRouting": false,
  "displayName": "test_route",
  "establishment": {
    "routingForwardProfileDisplayName": "test_routing_forward",
    "destinationDialStringRewriting": [{
      "delTrailing": 0,
      "matchedPart": 0,
      "prefix": "123",
      "source": "LAST_DIVERSION",
      "suffix": "456",
      "delLeading": 0,
      "keepLeading": 0,
      "keepTrailing": 0
    }],
    "sourceDialStringRewriting": [{
      "delTrailing": 0,
      "matchedPart": 0,
      "prefix": "123",
      "source": "MOST_APPROPRIATE",
      "suffix": "456",
      "delLeading": 0,
      "keepLeading": 0,
      "keepTrailing": 0
    }],
    "destinationNodeId": "927aabf0-14a1-44c6-b30b-2a54f95e1a76",
    "adjustRoutingForwardProfileSettings": true,
    "skipIfNodeNotOperational": true,
    "routingForwardProfileMode": "BYPASS",
    "routingForwardProfileSelection": "CREATE_NEW",
    "type": "ROUTE"
  },
  "filters": [{
    "sourceNodeIds": ["927aabf0-14a1-44c6-b30b-2a54f95e1a76"],
    "sourceDialString": [{"type": "NEVER"}],
    "firstDiversionDialString": [{
      "type": "DIRECTORY",
      "directory": [
        "1",
        "2"
      ]
    }],
    "lookupDirectories": {},
    "assertedDialString": [{"type": "ALWAYS"}],
    "lastDiversionDialString": [{
      "extensionRange": {
        "lastExtension": "99",
        "firstExtension": "0",
        "zeroExtend": true,
        "trunk": "123"
      },
      "type": "EXTENSION_RANGE"
    }],
    "destinationDialString": [{
      "wildcardPattern": "X+!",
      "type": "CUCM_PATTERN"
    }],
    "transferrerDialString": [{
      "plain": {
        "prefix": "123",
        "suffix": "456"
      },
      "type": "PLAIN"
    }]
  }]
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "test_route",
  "establishment": {
    "routingForwardProfileId": "721a5686-8406-4a38-a773-37baf1c7e755",
    "destinationNodeId": "927aabf0-14a1-44c6-b30b-2a54f95e1a76",
    "action": "ACCEPT"
  },
  "filters": [{"sourceNodeIds": ["927aabf0-14a1-44c6-b30b-2a54f95e1a76"]}],
  "enabled": true
}

17.7 Clone Route

POST https://<HOST>:<PORT>/api/routingDomains/routes/clone?version=0

Clones the selected route.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • mode

    Determines which type of route will be added.

    Type: String

    Possible Values:

    • establishment

    • pathReplacement

  • routingDomain

    The id or display name of the routing domain.

  • displayName

    The display name of the route that will be cloned. Either this, the "id" or the "index" must be specified.

  • index

    The index of the route that will be cloned. Either this, the "id" or the "displayName" must be specified.

  • id

    The id of the route that will be cloned. Either this, the "index" or the "displayName" must be specified.

Response Body Structure

The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 26.31.1. For the JSON schema refer to section 26.31.2.

17.7.1 Example

POST http://127.0.0.1:8111/api/routingDomains/routes/clone?mode=establishment&routingDomain=44457996-2919-4809-a9b2-8a179d0dac2d&displayName=test_route_edited&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "Copy of test_route_edited",
  "establishment": {
    "routingForwardProfileId": "1a8a1765-c23a-4932-b00e-b3ef3757ff22",
    "destinationNodeId": "afaf59dc-d239-42d4-9378-b989bd358c6e",
    "action": "ACCEPT"
  },
  "id": "5D2EBE90EB06A8AC4DF746CC9306FFAE",
  "filters": [{"sourceNodeIds": ["afaf59dc-d239-42d4-9378-b989bd358c6e"]}],
  "enabled": true
}

17.8 Set Route

POST https://<HOST>:<PORT>/api/routingDomains/routes/add?version=0

Modifies a route of the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • mode

    Determines which type of route will be added.

    Type: String

    Possible Values:

    • establishment

    • pathReplacement

  • routingDomain

    The id or display name of the routing domain.

  • index

    The display name of the route that should be modified. Either this or the "index" must be specified.

Request Body Structure

The request body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 26.31.1. For the JSON schema refer to section 26.31.2.

Response Body Structure

The response body is structured as RoutingDomainRoute JSON object. A description for its fields is at section 26.31.1. For the JSON schema refer to section 26.31.2.

17.8.1 Example

POST http://127.0.0.1:8111/api/routingDomains/routes/add?mode=establishment&routingDomain=44457996-2919-4809-a9b2-8a179d0dac2d&version=0
HTTP Request Body
{
  "useUnconditionalRouting": false,
  "displayName": "test_route",
  "establishment": {
    "routingForwardProfileDisplayName": "test_routing_forward",
    "destinationDialStringRewriting": [{
      "delTrailing": 0,
      "matchedPart": 0,
      "prefix": "123",
      "source": "LAST_DIVERSION",
      "suffix": "456",
      "delLeading": 0,
      "keepLeading": 0,
      "keepTrailing": 0
    }],
    "sourceDialStringRewriting": [{
      "delTrailing": 0,
      "matchedPart": 0,
      "prefix": "123",
      "source": "MOST_APPROPRIATE",
      "suffix": "456",
      "delLeading": 0,
      "keepLeading": 0,
      "keepTrailing": 0
    }],
    "destinationNodeId": "927aabf0-14a1-44c6-b30b-2a54f95e1a76",
    "adjustRoutingForwardProfileSettings": true,
    "skipIfNodeNotOperational": true,
    "routingForwardProfileMode": "BYPASS",
    "routingForwardProfileSelection": "CREATE_NEW",
    "type": "ROUTE"
  },
  "filters": [{
    "sourceNodeIds": ["927aabf0-14a1-44c6-b30b-2a54f95e1a76"],
    "sourceDialString": [{"type": "NEVER"}],
    "firstDiversionDialString": [{
      "type": "DIRECTORY",
      "directory": [
        "1",
        "2"
      ]
    }],
    "lookupDirectories": {},
    "assertedDialString": [{"type": "ALWAYS"}],
    "lastDiversionDialString": [{
      "extensionRange": {
        "lastExtension": "99",
        "firstExtension": "0",
        "zeroExtend": true,
        "trunk": "123"
      },
      "type": "EXTENSION_RANGE"
    }],
    "destinationDialString": [{
      "wildcardPattern": "X+!",
      "type": "CUCM_PATTERN"
    }],
    "transferrerDialString": [{
      "plain": {
        "prefix": "123",
        "suffix": "456"
      },
      "type": "PLAIN"
    }]
  }]
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "test_route",
  "establishment": {
    "routingForwardProfileId": "721a5686-8406-4a38-a773-37baf1c7e755",
    "destinationNodeId": "927aabf0-14a1-44c6-b30b-2a54f95e1a76",
    "action": "ACCEPT"
  },
  "filters": [{"sourceNodeIds": ["927aabf0-14a1-44c6-b30b-2a54f95e1a76"]}],
  "enabled": true
}

17.9 Remove Route

DELETE https://<HOST>:<PORT>/api/routingDomains/routes/remove?version=1

Removes a route from the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • mode

    Determines which type of route will be added.

    Type: String

    Possible Values:

    • establishment

    • pathReplacement

  • routingDomain

    The id or display name of the routing domain.

  • displayName

    The display name of the route that will be removed. Either this or the "index" must be specified.

  • index

    The index of the route that will be removed. Either this or the "displayName" must be specified.

  • version

    1

Response Body Structure

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

17.9.1 Example

DELETE http://127.0.0.1:8111/api/routingDomains/routes/remove?mode=establishment&routingDomain=44457996-2919-4809-a9b2-8a179d0dac2d&displayName=test_route_edited&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "displayName": "Copy of test_route_edited",
  "establishment": {
    "routingForwardProfileId": "1a8a1765-c23a-4932-b00e-b3ef3757ff22",
    "destinationNodeId": "afaf59dc-d239-42d4-9378-b989bd358c6e",
    "action": "ACCEPT"
  },
  "id": "5D2EBE90EB06A8AC4DF746CC9306FFAE",
  "filters": [{"sourceNodeIds": ["afaf59dc-d239-42d4-9378-b989bd358c6e"]}],
  "enabled": true
}]

17.10 Get Source Nodes

GET https://<HOST>:<PORT>/api/routingDomains/sourceNodes/get?version=0

Returns the source nodes of the selected routing domain

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • routingDomain

    The id of the routing domain.

17.10.1 Example

GET http://127.0.0.1:8111/api/routingDomains/sourceNodes/get?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
["afaf59dc-d239-42d4-9378-b989bd358c6e"]

17.11 Add Source Nodes

POST https://<HOST>:<PORT>/api/routingDomains/sourceNodes/add?version=1

Adds source nodes to the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The id of the routing domain.

  • version

    1

Request Body Structure

The body musst be a list of the node object ids that should be added to the source nodes of the select routing domain.

The request body is strutured as JSON array. The array consists of String JSON objects. A description for its fields is at section 26.38.1. For the JSON schema refer to section 26.38.2.

17.11.1 Example

POST http://127.0.0.1:8111/api/routingDomains/sourceNodes/add?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=1
HTTP Request Body
["afaf59dc-d239-42d4-9378-b989bd358c6e"]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
["afaf59dc-d239-42d4-9378-b989bd358c6e"]

17.12 Set Source Nodes

POST https://<HOST>:<PORT>/api/routingDomains/sourceNodes/set?version=0

Modifies the source nodes of the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

17.12.1 Example

POST http://127.0.0.1:8111/api/routingDomains/sourceNodes/set?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Request Body
["927aabf0-14a1-44c6-b30b-2a54f95e1a76"]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Set source nodes.

17.13 Remove Source Nodes

DELETE https://<HOST>:<PORT>/api/routingDomains/sourceNodes/remove?version=2

Removes source nodes from the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

  • version

    2

Request Body Structure

The request body is structured as an array containing the node ids that should be removed.

17.13.1 Example

DELETE http://127.0.0.1:8111/api/routingDomains/sourceNodes/remove?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=2
HTTP Request Body
["927aabf0-14a1-44c6-b30b-2a54f95e1a76"]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[]

17.14 Get Proceeding Signal

GET https://<HOST>:<PORT>/api/routingDomains/proceedingSignal/get?version=0

Returns whether the proceeding signal is enabled or not.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

17.14.1 Example

GET http://127.0.0.1:8111/api/routingDomains/proceedingSignal/get?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
disabled

17.15 Enable Proceeding Signal

POST https://<HOST>:<PORT>/api/routingDomains/proceedingSignal/enable?version=0

Enables the proceeding signal of the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

17.15.1 Example

POST http://127.0.0.1:8111/api/routingDomains/proceedingSignal/enable?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK

17.16 Disable Proceeding Signal

POST https://<HOST>:<PORT>/api/routingDomains/proceedingSignal/disable?version=0

Disables the proceeding signal of the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

17.16.1 Example

POST http://127.0.0.1:8111/api/routingDomains/proceedingSignal/disable?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK

17.17 Get Route in Maintenance

GET https://<HOST>:<PORT>/api/routingDomains/routeInMaintenance/get?version=0

Returns whether routing is active in maintenance mode.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

17.17.1 Example

GET http://127.0.0.1:8111/api/routingDomains/routeInMaintenance/get?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
disabled

17.18 Enable Route in Maintenance

POST https://<HOST>:<PORT>/api/routingDomains/routeInMaintenance/enable?version=0

Enables routing in maintenance mode for the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

17.18.1 Example

POST http://127.0.0.1:8111/api/routingDomains/routeInMaintenance/enable?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK

17.19 Disable Route in Maintenance

POST https://<HOST>:<PORT>/api/routingDomains/routeInMaintenance/disable?version=0

Disables routing in maintenance mode for the selected routing domain.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • routingDomain

    The id or display name of the routing domain.

17.19.1 Example

POST http://127.0.0.1:8111/api/routingDomains/routeInMaintenance/disable?routingDomain=5b55cd9f-c9ea-4b19-8684-3fa9e95c5098&version=0
HTTP Response
HTTP/1.1 200 OK

18 Routing Forward Profiles

18.1 Get

GET https://<HOST>:<PORT>/api/routingForwardProfiles/get?version=0

Returns the currently configured routing forward profiles

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • completeData

    Type: Boolean

    Determines if the configuration (true) of the routing forward profiles or only its id and display name (false) will be returned.

Response Body Structure

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

18.1.1 Example

GET http://127.0.0.1:8111/api/routingForwardProfiles/get?completeData=false&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "displayName": "test_domain",
  "id": "b96cd5c2-1d95-4ed3-92f1-797335547e2b"
}]

18.2 Add

POST https://<HOST>:<PORT>/api/routingForwardProfiles/add?version=0

Adds a new routing forward profile.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as RoutingForwardProfile JSON object. A description for its fields is at section 26.32.1. For the JSON schema refer to section 26.32.2.

Response Body Structure

The response body is structured as GetRoutingDomainOptions JSON object. A description for its fields is at section 26.30.1. For the JSON schema refer to section 26.30.2.

18.2.1 Example

POST http://127.0.0.1:8111/api/routingForwardProfiles/add?version=0
HTTP Request Body
{
  "telephonyForwardingStack": {
    "signalingForwardingFromCallingToCalled": {
      "notifySipInfoFilters": [{"mimeContentTypeName": "application/json"}],
      "profile": "FULL",
      "USER": true
    },
    "signalingForwardingFromCalledToCalling": {
      "notifySipInfoFilters": [{"mimeContentTypeName": "application/json"}],
      "profile": "FULL",
      "USER": true
    },
    "mediaNegotiationForwarder": {
      "displayName": "test_forwarder",
      "mediaMode": "PASSTHROUGH_WITH_FALLBACK_TO_BYPASS",
      "mediaTranscodingOptions": {"displayName": "test_transcoding"}
    }
  },
  "announcementIncoming": true,
  "displayName": "test_domain",
  "removeAnynodeFromSignalingPath": true,
  "earlyMediaPassThrough": true,
  "announcementOutgoing": true
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "telephonyForwardingStack": {
    "signalingForwardingFromCallingToCalled": {
      "notifySipInfoFilters": [],
      "profile": "STANDARD"
    },
    "signalingForwardingFromCalledToCalling": "Use settings from opposite direction.",
    "displayName": "test_domain",
    "mediaNegotiationForwarder": {
      "mediaMode": "TRANSCODING",
      "displayName": "test_domain",
      "mediaTranscodingOptionsId": "88af6de6-5632-4808-834f-8b69e3ce3400",
      "id": "97874de7-99c4-4bb8-865b-588721b3671d"
    },
    "id": "6b5da36b-3d18-4e63-ba26-ad01a3a993c3"
  },
  "announcementIncoming": true,
  "displayName": "test_domain",
  "removeAnynodeFromSignalingPath": true,
  "id": "70cf8137-ce01-48c8-8cb8-81fd59981531",
  "earlyMediaPassThrough": true,
  "announcementOutgoing": true
}

19 Detached Objects

The structure of the objects returned by the functions in this chapter may vary depending on the anynode version.

19.1 Get Sorts

GET https://<HOST>:<PORT>/api/objects/sorts?version=0

Returns (depending on its paramters) a list of object sorts, a list of objects of a specific sort or a single object of a specific sort.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • displayName

    If this parameter is supplied additionally to the sort only the object with this display name will be returned.

  • sort

    If this parameter is not present, a list of all sorts will be returned. If a sort is selected with this parameter, all objects of that sort are returned.

19.1.1 Example

GET http://127.0.0.1:8111/api/objects/sorts?sort=INS_STACK&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "Speedvoice test",
    "id": "7d324b55-4278-42a8-991a-fff62e8c6cdd",
    "sort": "INS_STACK"
  },
  {
    "displayName": "Amazon Chime test",
    "id": "d80ee87e-c9e8-44ef-81d3-9e005c30ec22",
    "sort": "INS_STACK"
  }
]

19.2 Get Object

GET https://<HOST>:<PORT>/api/objects/get?version=0

Returns the configuration of a object identified by it's id.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The id of the object that should be returned

19.2.1 Example

GET http://127.0.0.1:8111/api/objects/get?id=b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "AB9537F1-AA01-4F13-ACA5-45849B7B65C6",
      "preset": "42121cdc-bf69-4F6C-AE44-538b536cf434",
      "compatibility": "0"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Amazon Chime test",
  "sort": "TEL_STACK",
  "id": "b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "7AE4DF447BF83D8887DB607F3242AF5F",
    "backendStackName": "b53a7102-1d7f-40df-adf5-9f24cacd2de0",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}

19.3 Set Object

PUT https://<HOST>:<PORT>/api/objects/set?version=0

Modifies the options of a single object identified by it's id.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • id

    The id of the object that should be set.

Request Body Structure

The object to be set must be encoded in the requests body. All parameters in the JSON body must be given as a string. Note that only one object can be set at a time. This does not work recursively.

19.3.1 Example

PUT http://127.0.0.1:8111/api/objects/set?id=b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc&version=0
HTTP Request Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "AB9537F1-AA01-4F13-ACA5-45849B7B65C6",
      "preset": "42121cdc-bf69-4F6C-AE44-538b536cf434",
      "compatibility": "0"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Amazon Chime test",
  "sort": "TEL_STACK",
  "id": "b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "7AE4DF447BF83D8887DB607F3242AF5F",
    "backendStackName": "b53a7102-1d7f-40df-adf5-9f24cacd2de0",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "AB9537F1-AA01-4F13-ACA5-45849B7B65C6",
      "preset": "42121cdc-bf69-4F6C-AE44-538b536cf434",
      "compatibility": "0"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Amazon Chime test",
  "sort": "TEL_STACK",
  "id": "b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "7AE4DF447BF83D8887DB607F3242AF5F",
    "backendStackName": "b53a7102-1d7f-40df-adf5-9f24cacd2de0",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}

19.4 Remove Object

DELETE https://<HOST>:<PORT>/api/objects/remove?version=0

Deletes a object from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • id

    The id of the object that should be deleted.

19.4.1 Example

DELETE http://127.0.0.1:8111/api/objects/remove?id=b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "AB9537F1-AA01-4F13-ACA5-45849B7B65C6",
      "preset": "42121cdc-bf69-4F6C-AE44-538b536cf434",
      "compatibility": "0"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Amazon Chime test",
  "sort": "TEL_STACK",
  "id": "b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "7AE4DF447BF83D8887DB607F3242AF5F",
    "backendStackName": "b53a7102-1d7f-40df-adf5-9f24cacd2de0",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}

19.5 Import Object

PUT https://<HOST>:<PORT>/api/objects/import?version=0

Imports a previously exported object into anynode.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • cloneComment

    In case objects are cloned, their name will change to the given comment specified here.

  • reassignPortOnCollision

    Type: Boolean

    If set to true and the imported objects contain a SIP transport object, which ports collide with an existing SIP transport object, the ports will be reassigned automatically.

  • action

    Determines how import objects that already exist in the current config are handled.

    Possible values:

    • SKIP

      Skip duplicates and only import objects which don't exist in this configuration.

    • OVERRIDE

      Overwrite all duplicate objects. Existing objects with the same name as an imported object will be overwritten (Data may be lost).

    • CLONE

      Clone all duplicate objects. This means all current objects will be kept.

    • CANCEL

      Cancel the import request.

19.5.1 Example

PUT http://127.0.0.1:8111/api/objects/import?action=OVERRIDE&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Success.

19.6 Export Object

GET https://<HOST>:<PORT>/api/objects/export?version=0

Exports a object from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • includePrivateData

    Determines if passwords, private keys and certificates should be included in the exported objects.

  • filename

    In case the config file should have a specific name, it can be set with this parameter. If this is not set, it will be generated automatically.

  • id

    The id of the object that should be exported.

19.6.1 Example

GET http://127.0.0.1:8111/api/objects/export?includePrivateData=true&id=b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc&version=0
HTTP Response
HTTP/1.1 200 OK

20 Dashboard

20.1 Get

GET https://<HOST>:<PORT>/api/dashboard/get?version=0

Returns the status information from the dashboard.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request parameters

  • dateFormat

    Determines the format of dates. Default is XZWO.

    Type: String

    Possible Values:

    • ISO-8601

    • XZWO

  • list

    Restricts the returned status information to the selected category, if provided.

    Type: String

    Possible Values:

    • sipNodes

    • sfbUcmaNodes

    • ldapConnections

    • certificates

    • conditions

    • networkControllers

    • ldapDirectories

    • numberValidationRouteSupervision

    • azureActiveDirectories

    • restClientRouteSupervision

    • directoryRouteSupervision

    • certificateIssuance

20.1.1 Example

GET http://127.0.0.1:8111/api/dashboard/get?list=certificateIssuance&version=0
HTTP Response
HTTP/1.1 200 OK

21 ActiveSessions

21.1 Get

GET https://<HOST>:<PORT>/api/activeSessions/get?version=0

Returns the the list of active sessions.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request parameters

  • dateFormat

    Determines the format of dates. Default is XZWO.

    Type: String

    Possible Values:

    • ISO-8601

    • XZWO

21.1.1 Example

GET http://127.0.0.1:8111/api/activeSessions/get?version=0
HTTP Response
HTTP/1.1 200 OK

22 Backends

22.1 Get

GET https://<HOST>:<PORT>/api/backends/get?version=0

Returns a list of the configured backends.

Required Permissions

  • API

  • Backends Read Access

Response Body Structure

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

22.1.1 Example

GET http://127.0.0.1:8111/api/backends/get?version=0
HTTP Response
HTTP/1.1 200 OK

23 Network Interfaces

23.1 Get

GET https://<HOST>:<PORT>/api/networkInterfaces/get?version=0

Returns a list of network interfaces.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

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

23.1.1 Example

GET http://127.0.0.1:8111/api/networkInterfaces/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "Intel(R) Ethernet Connection (7) I219-V-WFP Native MAC Layer LightWeight Filter-0000",
    "id": "{04302ED3-220B-11EE-9152-806E6F6E6963}"
  },
  {
    "displayName": "Intel(R) Ethernet Connection (7) I219-V-QoS Packet Scheduler-0000",
    "id": "{04302ED4-220B-11EE-9152-806E6F6E6963}"
  }
]

24 Network Controllers

24.1 Get

GET https://<HOST>:<PORT>/api/networkControllers/get?version=0

Returns a list of network interfaces.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

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

24.1.1 Example

GET http://127.0.0.1:8111/api/networkControllers/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "Amazon Chime",
    "id": "ba709009-51c5-44fc-9fb2-594212ae8f9f",
    "interface": "Software Loopback Interface 1"
  },
  {
    "displayName": "NC 1",
    "id": "c70d074e-0320-4ffc-bf5e-b9be7b74b339",
    "interface": "Software Loopback Interface 1"
  }
]

25 Call History

25.1 Export

POST https://<HOST>:<PORT>/app/monitor/callhistory/export/v0?version=0

To determine the paramters for this request it is recommended to use the "Call History Export Assistant". To do so open the anynode frontend user interface and navigate to Monitor ModeCall HistoryExport.

Required Permissions

  • API

  • Monitoring Mode Read Access

Request Body Structure

26 JSON Objects

26.1 SoftwareVersion

26.1.1 SoftwareVersion Field Description

  • versionMajor

    Type: int

  • versionMinor

    Type: int

  • versionRelease

    Type: int

26.1.2 SoftwareVersion JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "versionRelease": {"type": "integer"},
    "versionMajor": {"type": "integer"},
    "versionMinor": {"type": "integer"}
  }
}

26.2 TracingOptionsJson

26.2.1 TracingOptionsJson Field Description

  • selection

    Selects how tracing records will be stored.

    Type: TracingSelection

    Possible values:

    • FILE

      Single file, no size limit.

    • SPLIT

      Rolling files of limited size.

  • traceActive

    Type: Boolean

  • options

    Type: TracingFileOptions

    • count

      Determines how many trace files will be kept. Only for selection=SPLIT

      Type: Integer

    • flags

      Possible values: TRIO_FLAG_MARKED (only trace sessions that are marked for tracing) and TRIO_FLAG_IGNORE_HIGH_VOLUME_MESSAGES (removes high-volume trace messages) seperated by '|'

      Type: String

    • size

      Determines the maximum size for trace files. Only for selection=SPLIT

      Type: Integer

26.2.2 TracingOptionsJson JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "selection": {
      "type": "string",
      "enum": [
        "FILE",
        "SPLIT"
      ]
    },
    "options": {
      "type": "object",
      "properties": {
        "size": {"type": "integer"},
        "count": {"type": "integer"},
        "flags": {"type": "string"}
      }
    },
    "traceActive": {"type": "boolean"}
  }
}

26.3 DialStringRewriting

26.3.1 DialStringRewriting Field Description

  • displayName

    Set up a name that helps you identify this object.

    Type: String

  • id

    Type: String

  • rules

    Type: Array of DialStringRewrite (section 26.4)

26.3.2 DialStringRewriting JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "rules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "id": {"type": "string"}
  }
}

26.4 DialStringRewrite

The available fields for DialStringRewrite objects depend on the selected rewriteType. The fields for each type are:

  • prefixAndSuffix

    • prefix

    • suffix

    • deleteLeadingCharacters

    • deleteTrailingCharacters

    • addPrefix

    • addSuffix

  • wildcardPattern

    • wildcardPattern

    • deleteLeadingCharacters

    • deleteTrailingCharacters

    • addPrefix

    • addSuffix

  • matchAndModify

    • matchType

    • rewriteSegments

  • matchAndBranch

    • matchType

    • rewriteSegments

    • branchRewrites

    • branchElseRewrites

  • available for all types:

    • skipFurtherRules

    • applyToAllDialStrings

    • applyToSourceDialString

    • applyToDestinationDialString

    • applyTo

    • comment

  • available for all types excluding cutExtensionNumber:

    • matchTags

    • tagRewrite

    • case

    • clearDisplayName

    • displayName

26.4.1 DialStringRewrite Field Description

  • 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 26.33)

  • structuralPattern

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

    Type: Array of MatchPatternSegment (section 26.34)

  • 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 26.35)

  • branchRewrites

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

    Type: List

  • branchElseRewrites

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

    Type: List

  • 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 26.36)

  • 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 26.37)

  • 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: int

26.4.2 DialStringRewrite JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "matchDirectory": {
      "type": "array",
      "items": {"type": "string"}
    },
    "applyToDestinationDialString": {"type": "boolean"},
    "displayName": {"type": "string"},
    "matchType": {
      "type": "string",
      "enum": [
        "anything",
        "never",
        "list",
        "prefixSuffix",
        "dialStringList",
        "structuralPattern",
        "wildcardPattern",
        "extensionRange"
      ]
    },
    "prefix": {"type": "string"},
    "addSuffix": {"type": "string"},
    "matchExtensionRange": {"$ref": "#/$defs/TelMatchExtensionRange"},
    "deleteTrailingCharacters": {"type": "integer"},
    "suffix": {"type": "string"},
    "deleteLeadingCharacters": {"type": "integer"},
    "rewriteType": {
      "type": "string",
      "enum": [
        "prefixAndSuffix",
        "wildcardPattern",
        "cutExtensionNumber",
        "matchAndModify",
        "matchAndBranch"
      ]
    },
    "skipRulesBelow": {"type": "boolean"},
    "applyToSourceDialString": {"type": "boolean"},
    "rewriteSegments": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelRewriteSegment"}
    },
    "case": {
      "type": "string",
      "enum": [
        "lowercase",
        "uppercase",
        "casefold"
      ]
    },
    "addPrefix": {"type": "string"},
    "branchElseRewrites": {
      "type": "array",
      "items": {"$ref": "#"}
    },
    "matchTags": {"$ref": "#/$defs/TagMatch"},
    "index": {"type": "integer"},
    "branchRewrites": {
      "type": "array",
      "items": {"$ref": "#"}
    },
    "structuralPattern": {
      "type": "array",
      "items": {"$ref": "#/$defs/MatchPatternSegment"}
    },
    "clearDisplayName": {"type": "boolean"},
    "wildcardPattern": {"type": "string"},
    "applyTo": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "unspecified",
          "sessionSource",
          "sessionAsserted",
          "sessionDestination",
          "sessionConnected",
          "sessionElin",
          "sessionRedirectHistory",
          "sessionTransferrer",
          "reasonRedirection",
          "reasonSelected",
          "mwiSource",
          "mwiDestination"
        ]
      }
    },
    "comment": {"type": "string"},
    "skipFurtherRules": {"type": "boolean"},
    "tagRewrite": {"$ref": "#/$defs/TagRewrite"},
    "applyToAllDialStrings": {"type": "boolean"}
  }
}

26.5 TelIdent

26.5.1 TelIdent Field Description

  • sdpMLineAddress

    The IP address of the media channel that is established on a SIP call.

    Type: String

  • sdpMLinePort

    The port of the media channel that is established on a SIP call.

    Type: int

  • sdpOrigin

    The origin field of SDP messages.

    Type: String

  • sipCallId

    The SIP Call-ID of the SIP call

    Type: String

  • sipLocalTag

    The local(from anynodes perspective) SIP tag of a SIP call.

    Type: String

  • sipRemoteTag

    The remote(from anynodes perspective) SIP tag of a SIP call.

    Type: String

  • sipUserAgentDialog

    anynode specific identifier for a SIP user-agent dialog.

    Type: String

26.5.2 TelIdent JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sipCallId": {"type": "string"},
    "sdpOrigin": {"type": "string"},
    "sipUserAgentDialog": {"type": "string"},
    "sdpMLineAddress": {"type": "string"},
    "sipLocalTag": {"type": "string"},
    "sipRemoteTag": {"type": "string"},
    "sdpMLinePort": {"type": "integer"}
  }
}

26.6 License

26.6.1 License Field Description

  • status

    Type: LicenseStatus

    Possible values:

    • CONFIGURED

      License is configured but is not active yet.

    • ACTIVE

      License is active.

    • SIGNATURE

      Signature is invalid.

    • PRODUCT

      License belongs to a different product.

    • APPLICATION

      License belongs to a different application

    • SYSTEM_ID

      System ID does not exist

    • VALID_FROM

      License is not valid yet.

    • VALID_UNTIL

      License is expired.

    • SUS_UNTIL

      Software Update Service (SUS) is expired.

    • INVALIDATED

      License is invalidated by another license.

    • MUTEX

      This license or another license which is invalidated by this license is bound to another process.

  • identifier

    The identifier for this license.

    Type: String

  • name

    Type: String

  • validFrom

    The time this license is valid from onwards.

    Type: Date

  • validUntil

    The time when this license expires.

    Type: Date

  • softwareUpdateServiceUntil

    The time this license will be renewed.

    Type: Date

  • requiredSystemIds

    A list of system IDs that were given on license activation this license is bound to.

    Type: String

  • invalidatedLicences

    The amount of invalidated licenses.

    Type: String

  • products

    The products this license is meant for.

    Type: String

  • facilities

    The facilities this license is active for

    Type: List

  • constaints

    The constraints for this license.

    Type: String

26.6.2 License JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "identifier": {"type": "string"},
    "requiredSystemIds": {"type": "string"},
    "invalidatedLicences": {"type": "string"},
    "name": {"type": "string"},
    "constaints": {"type": "string"},
    "validUntil": {"type": "string"},
    "validFrom": {"type": "string"},
    "facilities": {
      "type": "array",
      "items": {"$ref": "#/$defs/LicenseFacility"}
    },
    "softwareUpdateServiceUntil": {"type": "string"},
    "products": {"type": "string"},
    "status": {
      "type": "string",
      "enum": [
        "CONFIGURED",
        "ACTIVE",
        "SIGNATURE",
        "PRODUCT",
        "APPLICATION",
        "SYSTEM_ID",
        "VALID_FROM",
        "VALID_UNTIL",
        "SUS_UNTIL",
        "INVALIDATED",
        "MUTEX"
      ]
    }
  }
}

26.7 ImportLodData

26.7.1 ImportLodData Field Description

  • companyName

    If the LOD key has already been used to generate a license using a different licensing device, please confirm that you are eligible for requesting a new license and provide the name of your company.

    Type: String

  • emailAddress

    An additional copy of the generated license will be sent to the given e-mail address.

    Type: String

  • licensingDevice

    Each license must be bound to a certain device already installed in your system. The list of devices available for licensing can be requested via section 7.3.Please specify the devices system ID that should be used to bind the new license to.

    Type: String

  • lodKey

    The LOD key that was supplied together with the product.

    Type: String

26.7.2 ImportLodData JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "emailAddress": {"type": "string"},
    "licensingDevice": {"type": "string"},
    "companyName": {"type": "string"},
    "lodKey": {"type": "string"}
  }
}

26.8 MaintenanceMode

26.8.1 MaintenanceMode Field Description

  • modeActive

    Indicates if the maintenance mode should be activated or deactivated.

    Type: Boolean

26.8.2 MaintenanceMode JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {"modeActive": {"type": "boolean"}}
}

26.9 AddUserData

26.9.1 AddUserData Field Description

  • displayName

    The displayed name of the new user.

    Type: String

  • emailAddress

    The email address of the new user.

    Type: String

  • enabled

    Determines if the new user should be enabled. Disabled user cannot login.

    Type: Boolean

  • ldapAuthentications

    Add LDAP users here to link this user to LDAP users.

    Type: Array of LdapUserJson

    • name

      Type: String

    • ldapAuthorityId

      Type: String

  • ldapLogin

    Defines if the user should be able to login with LDAP credentials.

    Type: Boolean

  • localPassword

    The password for local authentication.

    Type: String

  • localUsername

    The username for local authentication.

    Type: String

  • loginLocally

    Defines if the user should be able to login with a local username and password.

    Type: Boolean

  • passwordChange

    Define whether and, if so, when the password has to be changed.

    Type: PasswordChange

    Possible values:

    • NOT_NECESSARY

    • REQUIERED

    • RECOMMENDED

  • roleIds

    Add roles for this user to determine the permissions.

    Type: Array of String

26.9.2 AddUserData JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ldapLogin": {"type": "boolean"},
    "loginLocally": {"type": "boolean"},
    "emailAddress": {"type": "string"},
    "localPassword": {"type": "string"},
    "passwordChange": {
      "type": "string",
      "enum": [
        "NOT_NECESSARY",
        "REQUIERED",
        "RECOMMENDED"
      ]
    },
    "roleIds": {
      "type": "array",
      "items": {"type": "string"}
    },
    "localUsername": {"type": "string"},
    "displayName": {"type": "string"},
    "ldapAuthentications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "name": {"type": "string"},
          "ldapAuthorityId": {"type": "string"}
        }
      }
    },
    "enabled": {"type": "boolean"}
  }
}

26.10 CustomUserOptions

26.10.1 CustomUserOptions Field Description

  • blockedUntil

    Type: Date

  • displayName

    Type: String

  • emailAddress

    Type: String

  • enabled

    Type: Boolean

  • failedLogins

    Type: Integer

  • id

    Type: String

  • lastFailedLogin

    Type: Date

  • lastLogin

    Type: Date

  • ldapUsers

    Type: List

  • local

    Type: LocalUser (section 26.40)

  • localUserName

    Type: String

  • localV0

    Type: LocalV0User (section 26.41)

  • roleBuiltIns

    Type: String

  • roles

    Type: List

26.10.2 CustomUserOptions JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "lastLogin": {"type": "string"},
    "displayName": {"type": "string"},
    "localUserName": {"type": "string"},
    "roles": {
      "type": "array",
      "items": {"type": "string"}
    },
    "lastFailedLogin": {"type": "string"},
    "enabled": {"type": "boolean"},
    "local": {"$ref": "#/$defs/LocalUser"},
    "localV0": {"$ref": "#/$defs/LocalV0User"},
    "emailAddress": {"type": "string"},
    "ldapUsers": {
      "type": "array",
      "items": {"$ref": "#/$defs/LdapUserJson"}
    },
    "blockedUntil": {"type": "string"},
    "failedLogins": {"type": "integer"},
    "id": {"type": "string"},
    "roleBuiltIns": {"type": "string"}
  }
}

26.11 Role

26.11.1 Role Field Description

  • displayName

    The displayname of the role..

    Type: String

  • id

    A unique identifier for the role.

    Type: String

  • permissions

    The permission that users with this role have.

    Type: Permissions

    • administration

      Type: AccessPrivilege

      Possible values:

      • NO_ACCESS

      • ACCESS

    • api

      Type: AccessPrivilege

      Possible values:

      • NO_ACCESS

      • ACCESS

    • backends

      Type: ReadWriteAccessPrivilege

      Possible values:

      • NO_ACCESS

      • READ_ACCESS

      • READ_WRITE_ACCESS

    • configurationMode

      Type: ReadWriteAccessPrivilege

      Possible values:

      • NO_ACCESS

      • READ_ACCESS

      • READ_WRITE_ACCESS

    • mediaRecording

      Type: AccessPrivilege

      Possible values:

      • NO_ACCESS

      • ACCESS

    • monitoringMode

      Type: ReadWriteAccessPrivilege

      Possible values:

      • NO_ACCESS

      • READ_ACCESS

      • READ_WRITE_ACCESS

    • tracing

      Type: AccessPrivilege

      Possible values:

      • NO_ACCESS

      • ACCESS

    • userInterface

      Type: AccessPrivilege

      Possible values:

      • NO_ACCESS

      • ACCESS

    • userManagement

      Type: ReadWriteAccessPrivilege

      Possible values:

      • NO_ACCESS

      • READ_ACCESS

      • READ_WRITE_ACCESS

    • webServer

      Type: ReadWriteAccessPrivilege

      Possible values:

      • NO_ACCESS

      • READ_ACCESS

      • READ_WRITE_ACCESS

26.11.2 Role JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "permissions": {
      "$defs": {
        "AccessPrivilege": {
          "type": "string",
          "enum": [
            "NO_ACCESS",
            "ACCESS"
          ]
        },
        "ReadWriteAccessPrivilege": {
          "type": "string",
          "enum": [
            "NO_ACCESS",
            "READ_ACCESS",
            "READ_WRITE_ACCESS"
          ]
        }
      },
      "type": "object",
      "properties": {
        "configurationMode": {"$ref": "#/$defs/ReadWriteAccessPrivilege"},
        "userManagement": {"$ref": "#/$defs/ReadWriteAccessPrivilege"},
        "tracing": {"$ref": "#/$defs/AccessPrivilege"},
        "administration": {"$ref": "#/$defs/AccessPrivilege"},
        "monitoringMode": {"$ref": "#/$defs/ReadWriteAccessPrivilege"},
        "webServer": {"$ref": "#/$defs/ReadWriteAccessPrivilege"},
        "api": {"$ref": "#/$defs/AccessPrivilege"},
        "userInterface": {"$ref": "#/$defs/AccessPrivilege"},
        "backends": {"$ref": "#/$defs/ReadWriteAccessPrivilege"},
        "mediaRecording": {"$ref": "#/$defs/AccessPrivilege"}
      }
    },
    "id": {"type": "string"}
  }
}

26.12 MediaRecording

26.12.1 MediaRecording Field Description

  • mediaRecordingActive

    Type: Boolean

26.12.2 MediaRecording JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {"mediaRecordingActive": {"type": "boolean"}}
}

26.13 MsTeamsSbaOptions

26.13.1 MsTeamsSbaOptions Field Description

  • fingerprint

    The trusted certificate fingerprint source. This needs to be the fingerprint of the Teams node, that is using the SBA service.

    Type: MsTeamsSbaFingerprint

    • source

      Determines the source of the fingerprint.

      Type: FingerprintSource

      Possible values:

      • NONE

      • CUSTOM

      • MS_TEAMS_NODE

    • value

      The fingerprint for "source"="CUSTOM"

      Type: String

    • msTeamsNodeId

      Only for "source"="MS_TEAMS_NODE". The id of the Teams node, that uses the certificate. The fingerprint will be extracted automatically.

      Type: String

  • identity

    The identity / FQDN of the SBA

    Type: String

  • tenantId

    Directory (tenant) ID

    Type: String

  • application

    Application (client) ID

    Type: String

  • secret

    Application (client) secrect

    Type: String

  • log

    Settings for the SBA log.

    Type: MsTeamsSbaLog (section 26.16)

26.13.2 MsTeamsSbaOptions JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "application": {"type": "string"},
    "log": {"$ref": "#/$defs/MsTeamsSbaLog"},
    "identity": {"type": "string"},
    "fingerprint": {
      "$defs": {"FingerprintSource": {
        "type": "string",
        "enum": [
          "NONE",
          "CUSTOM",
          "MS_TEAMS_NODE"
        ]
      }},
      "type": "object",
      "properties": {
        "msTeamsNodeId": {"type": "string"},
        "source": {"$ref": "#/$defs/FingerprintSource"},
        "value": {"type": "string"}
      }
    },
    "tenantId": {"type": "string"},
    "secret": {"type": "string"}
  }
}

26.14 MsTeamsSbaStatus

26.14.1 MsTeamsSbaStatus Field Description

  • state

    Type: String

  • status

    Type: String

26.14.2 MsTeamsSbaStatus JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "state": {"type": "string"},
    "status": {"type": "string"}
  }
}

26.15 MsTeamsSbaFingerprint

26.15.1 MsTeamsSbaFingerprint Field Description

  • source

    Determines the source of the fingerprint.

    Type: FingerprintSource

    Possible values:

    • NONE

    • CUSTOM

    • MS_TEAMS_NODE

  • value

    The fingerprint for "source"="CUSTOM"

    Type: String

  • msTeamsNodeId

    Only for "source"="MS_TEAMS_NODE". The id of the Teams node, that uses the certificate. The fingerprint will be extracted automatically.

    Type: String

26.15.2 MsTeamsSbaFingerprint JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "msTeamsNodeId": {"type": "string"},
    "source": {
      "type": "string",
      "enum": [
        "NONE",
        "CUSTOM",
        "MS_TEAMS_NODE"
      ]
    },
    "value": {"type": "string"}
  }
}

26.16 MsTeamsSbaLog

26.16.1 MsTeamsSbaLog Field Description

  • directory

    The directory where log files should be stored.

    Type: String

  • level

    The log level

    Type: MsTeamsSbaLogLevel

    Possible values:

    • TRACE

    • DEBUG

    • INFO

    • WARN

    • ERROR

    • FATAL

  • maxArchiveFiles

    The maximum amount of log files that will be stored.

    Type: int

26.16.2 MsTeamsSbaLog JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "level": {
      "type": "string",
      "enum": [
        "TRACE",
        "DEBUG",
        "INFO",
        "WARN",
        "ERROR",
        "FATAL"
      ]
    },
    "directory": {"type": "string"},
    "maxArchiveFiles": {"type": "integer"}
  }
}

26.17 AddSystemProfile

26.17.1 AddSystemProfile Field Description

  • createNewNetworkController

    Create new network controller or select an existing one.

    Type: Boolean

  • networkControllerDisplayName

    The display name of the newly created network controller.

    Type: String

  • networkControllerInterface

    The interface of the newly created network controller.

    Type: String

  • networkControllerIpVersion

    The IP version of the newly created network controller.

    Type: IpVersion

    Possible values:

    • [Any Address Version]

    • IN_ADDRESS_VERSION_4

    • IN_ADDRESS_VERSION_6

  • networkControllerIpAddress

    The IP address of the newly created network controller.

    Type: String

  • enableReverseDnsLookup

    Specify whether reverse DNS lookup is enabled for the newly created network controller.

    Type: Boolean

  • networkControllerId

    In case no new network controller is created, this value must be provided.

    Type: String

  • udpTcpPort

    The UDP/TCP Port.

    Type: int

  • tlsPort

    The TLS Port.

    Type: int

  • udpPortRange

    Restricts the udp port range

    Type: PortRange (section 26.46)

  • tcpPortRange

    Restricts the tcp port range

    Type: PortRange (section 26.46)

  • sipInterconnection

    Type: SipInterconnection

    Possible values:

    • REGISTRAR

      The node provides a registration server (registrar) at which the remote station must register.

    • REGISTRATION

      The node registers at a remote station as a client. In this case the remote station has to provide a registrar.

    • TRUNK

      The node uses SIP trunking to interconnect with the remote station. In this way, full dial stringranges can be linked at once.

  • remoteSipDomain

    Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.

    Type: RemoteSipDomain (section 26.47)

  • localSipDomain

    Optionally you can choose the local SIP domain. The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls).

    Type: String

  • activateClientAuthentication

    Activate client authentication. These authentication settings determine how the node authenticate to a remote station.

    Type: Boolean

  • clientCredentials

    Credentials for client authentication.

    Type: SipCredentials (section 26.23)

  • activateServerAuthentication

    Activate server authentication. These authentication settings determine how a remote station has to authenticate to anynode. They will be stored in a User Directory.

    Type: Boolean

  • serverCredentials

    Credentials for server authentication

    Type: SipCredentials (section 26.23)

  • registrarUri

    The node will register as a client at a remote station. Select the necessary settings for this registration.

    Type: String

  • addressOfRecord

    User Part of Address-Of-Record for registration.

    Type: String

  • sipRegistrar

    Dial string matching condition that determines which calls are to be forwarded to the registered remote stations.

    Type: TelMatch (section 26.48)

  • useNetworkPeerWhitelist

    Type: Boolean

  • includeRemoteSipDomainInWhitelist

    Include the remote SIP domain in the whitelist.

    Type: Boolean

  • includeSipRegistrarInWhitelist

    Include the SIP registrar in the whitelist.

    Type: Boolean

  • includeOwnSubnetInWhitelist

    Include the own subnet in the whitelist.

    Type: Boolean

  • networkPeerWhitelist

    Type: Array of NetworkPeerWhitelistEntry

    • dnsLookup

      Additional protocol prefixes.

      Type: Array of String

    • host

      The hostname or ip address.

      Type: String

    • ipVersion

      If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)

      Type: IpVersion

      Possible values:

      • [Any Address Version]

      • IN_ADDRESS_VERSION_4

      • IN_ADDRESS_VERSION_6

    • subnetPrefixLength

      Type: int

  • allowOnlyNegotiatedPeersForRtpRtcp

    Allow only negotiated peers for RTP/RTCP.

    Type: Boolean

  • incomingDialStringRewriteRules

    Type: Array of DialStringRewrite (section 26.4)

  • outgoingDialStringRewriteRules

    Type: Array of DialStringRewrite (section 26.4)

  • routingDomains

    Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.

    Type: Array of String

  • displayName

    Enter a meaningful name for your new node. The name is arbitrary. You will use it to uniquely identify this node later during configuration.

    Type: String

  • createNewTeamsCarrierNode

    Whether to create a new Teams carrier node or use an existing one. If an existing one is used, the value eamsCarrierNodeId" must be given.

    Type: Boolean

  • teamsCarrierNodeId

    Select an existing MS Teams carrier node to share the Microsoft Teams Connectivity.

    Type: String

  • createNewMsOperatorConnectNode

    Whether to create a new Microsoft Teams Connectivity or use an existing one. If an existing one is used, the value "msOperatorConnectNodeId" must be given.

    Type: Boolean

  • msOperatorConnectNodeId

    Select an existing Node to share the Microsoft Teams Connectivity.

    Type: String

  • tenantId

    The tenant ID is mandatory if you want to setup multiple Microsoft Operator Connect nodes, using a single SBC FQDN.

    Type: String

  • sbcFqdn

    Determine the name for the FQDN of the SBC.

    Type: String

  • tenantFqdn

    Enter the tenant FQDN for the desired customer.

    Type: String

  • region

    Type: AddSystemRegion

    Possible values:

    • North America

      For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.

    • EMEA

      For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.

    • Australia

      For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.

    • APAC

      For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.

    • LATAM

      For the profiles Zoom Phone Premise Peering and Zoom Phone Provider Exchange.

    • China

      For the profile Zoom Phone Premise Peering.

    • Japan

      For the profiles Zoom Phone Premise Peering, Zoom Contact Center and Zoom Phone Provider Exchange.

  • xGooglePbxTrunkSecretKey

    The X-Google-Pbx-Trunk-Secret-Key. Only used for the Google Voice profile.

    Type: String

26.17.2 AddSystemProfile JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "activateServerAuthentication": {"type": "boolean"},
    "serverCredentials": {"$ref": "#/$defs/SipCredentials"},
    "tlsPort": {"type": "integer"},
    "displayName": {"type": "string"},
    "localSipDomain": {"type": "string"},
    "includeSipRegistrarInWhitelist": {"type": "boolean"},
    "includeRemoteSipDomainInWhitelist": {"type": "boolean"},
    "allowOnlyNegotiatedPeersForRtpRtcp": {"type": "boolean"},
    "createNewTeamsCarrierNode": {"type": "boolean"},
    "createNewMsOperatorConnectNode": {"type": "boolean"},
    "outgoingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "routingDomains": {
      "type": "array",
      "items": {"type": "string"}
    },
    "includeOwnSubnetInWhitelist": {"type": "boolean"},
    "networkControllerId": {"type": "string"},
    "xGooglePbxTrunkSecretKey": {"type": "string"},
    "msOperatorConnectNodeId": {"type": "string"},
    "teamsCarrierNodeId": {"type": "string"},
    "sbcFqdn": {"type": "string"},
    "clientCredentials": {"$ref": "#/$defs/SipCredentials"},
    "udpTcpPort": {"type": "integer"},
    "tcpPortRange": {"$ref": "#/$defs/PortRange"},
    "activateClientAuthentication": {"type": "boolean"},
    "enableReverseDnsLookup": {"type": "boolean"},
    "incomingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "networkControllerInterface": {"type": "string"},
    "tenantFqdn": {"type": "string"},
    "createNewNetworkController": {"type": "boolean"},
    "networkPeerWhitelist": {
      "type": "array",
      "items": {
        "$defs": {"IpVersion": {
          "type": "string",
          "enum": [
            "[Any Address Version]",
            "IN_ADDRESS_VERSION_4",
            "IN_ADDRESS_VERSION_6"
          ]
        }},
        "type": "object",
        "properties": {
          "ipVersion": {"$ref": "#/$defs/IpVersion"},
          "host": {"type": "string"},
          "subnetPrefixLength": {"type": "integer"},
          "dnsLookup": {
            "type": "array",
            "items": {"type": "string"}
          }
        }
      }
    },
    "remoteSipDomain": {"$ref": "#/$defs/RemoteSipDomain"},
    "sipRegistrar": {"$ref": "#/$defs/TelMatch"},
    "networkControllerDisplayName": {"type": "string"},
    "udpPortRange": {"$ref": "#/$defs/PortRange"},
    "useNetworkPeerWhitelist": {"type": "boolean"},
    "sipInterconnection": {
      "type": "string",
      "enum": [
        "REGISTRAR",
        "REGISTRATION",
        "TRUNK"
      ]
    },
    "addressOfRecord": {"type": "string"},
    "tenantId": {"type": "string"},
    "networkControllerIpVersion": {
      "type": "string",
      "enum": [
        "[Any Address Version]",
        "IN_ADDRESS_VERSION_4",
        "IN_ADDRESS_VERSION_6"
      ]
    },
    "region": {
      "type": "string",
      "enum": [
        "NA",
        "EMEA",
        "AUS",
        "APAC",
        "LATAM",
        "CHINA",
        "JAPAN"
      ]
    },
    "networkControllerIpAddress": {"type": "string"},
    "registrarUri": {"type": "string"}
  }
}

26.18 AddProviderProfile

26.18.1 AddProviderProfile Field Description

  • deutscheTelekomNumberExtensionRange

    Number Extension Range for seperating incomming calls. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.

    Type: TelMatchExtensionRange (section 26.33)

  • createNewDeutscheTelekomSipTrunk

    Create new Deutsche Telekom Sip Trunk or select an existing one. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile.

    Type: Boolean

  • deutscheTelekomSipTrunkId

    In case no new Deutsche Telekom SipTrunk is created, this value must be given. This parameter can only be used with the "Deutsche Telekom CompanyFlex SIP-Trunk" profile

    Type: String

  • createNewNetworkController

    Create new network controller or select an existing one.

    Type: Boolean

  • networkControllerDisplayName

    The display name of the newly created network controller.

    Type: String

  • networkControllerInterface

    The interface of the newly created network controller.

    Type: String

  • networkControllerIpVersion

    The IP version of the newly created network controller.

    Type: IpVersion

    Possible values:

    • [Any Address Version]

    • IN_ADDRESS_VERSION_4

    • IN_ADDRESS_VERSION_6

  • networkControllerIpAddress

    The IP address of the newly created network controller.

    Type: String

  • enableReverseDnsLookup

    Specify whether reverse DNS lookup is enabled for the newly created network controller.

    Type: Boolean

  • networkControllerId

    In case no new network controller is created, this value must be given.

    Type: String

  • udpTcpPort

    The UDP/TCP Port.

    Type: int

  • tlsPort

    The TLS port.

    Type: int

  • udpPortRange

    The UDP port range.

    Type: PortRange (section 26.46)

  • tcpPortRange

    The TCP port range.

    Type: PortRange (section 26.46)

  • activateNatTraversal

    When anynode is located behind a NAT gateway you can determine how this gateway can be traversed. Please ensure that the gateway is configured accordingly.

    Type: Boolean

  • externalHost

    External Host or IP Address

    Type: String

  • natDeviceHasFixedPortMapping

    In the NAT device (firewall/router) a fixed port mapping is defined.

    Type: Boolean

  • fixedUdpTcpPort

    Map the UDP/TCP Port to this.

    Type: int

  • fixedTlsPort

    Map the TLS Port to this.

    Type: int

  • fixedUdpPortRangeStart

    Map dynamic UDP Ports to this.

    Type: int

  • fixedTcpPortRangeStart

    Map dynamic TCP Ports to this.

    Type: int

  • nodeViaSipTrunking

    true

    The node uses SIP trunking to interconnect with the remote station. In this way, full dial string ranges can be linked at once.

    false

    The node registers at a remote station as a client. In this case the remote station has to provide a registrar.

    Type: Boolean

  • remoteSipDomain

    Please choose the remote SIP URI which will be used in SIP URIs of outgoing calls and which describes where the remote endpoint can be reached.

    Type: RemoteSipDomain (section 26.47)

  • localSipDomain

    The local SIP domain will be added to all SIP addresses which belong to the local system (e.g. the calling number of outgoing calls.

    Type: String

  • activateClientAuthentication

    Activate client authentication. These authentication settings determine how the node authenticate to a remote station.

    Type: Boolean

  • credentials

    Client SIP User Name and Password.

    Type: SipUserCredentials (section 26.51)

  • registrarUri

    The node will register as a client at a remote station. Select the necessary settings for this registration.

    Type: String

  • addressOfRecord

    User Part of Address-Of-Record for registration.

    Type: String

  • proxyUri

    Optional proxy server. Outgoing calls will be forwarded to this proxy. The specified value must begin with "sip:".

    Type: String

  • primaryProxyUri

    Primary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".

    Type: String

  • secondaryProxyUri

    Secondary proxy URI for the "Deutsche Telekom CompanyFlex SIP-Trunk" profile. The specified value must begin with "sip:".

    Type: String

  • defineAssertedUri

    Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.

    Type: Boolean

  • assertedUriHost

    Mandatory, if the URI is not based on the registrar uri or proxy uri.

    Type: String

  • assertedUri

    User Part of Asserted-URI.

    Type: String

  • useNetworkPeerWhitelist

    If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.

    Type: Boolean

  • includeRemoteSipDomainInWhitelist

    Whether to include the remote SIP domain in the whitelist.

    Type: Boolean

  • includeSipRegistrarInWhitelist

    Whether to include the SIP registrar in the whitelist.

    Type: Boolean

  • includeProxyInWhitelist

    Whether to include the configured proxy in the whitelist.

    Type: Boolean

  • networkPeerWhitelist

    The whitelist.

    Type: Array of NetworkPeerWhitelistEntry

    • dnsLookup

      Additional protocol prefixes.

      Type: Array of String

    • host

      The hostname or ip address.

      Type: String

    • ipVersion

      If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)

      Type: IpVersion

      Possible values:

      • [Any Address Version]

      • IN_ADDRESS_VERSION_4

      • IN_ADDRESS_VERSION_6

    • subnetPrefixLength

      Type: int

  • allowOnlyNegotiatedPeersForRtpRtcp

    Allow only negotiated peers for RTP/RTCP.

    Type: Boolean

  • incomingDialStringRewriteRules

    Type: Array of DialStringRewrite (section 26.4)

  • outgoingDialStringRewriteRules

    Type: Array of DialStringRewrite (section 26.4)

  • region

    Only for the profile Speedcom AG - Speedvoice

    Type: AddProviderRegion

    Possible values:

    • Schweiz

    • Liechtenstein

  • routingDomains

    Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.

    Type: Array of String

  • displayName

    Type: String

26.18.2 AddProviderProfile JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "fixedTlsPort": {"type": "integer"},
    "activateNatTraversal": {"type": "boolean"},
    "createNewDeutscheTelekomSipTrunk": {"type": "boolean"},
    "defineAssertedUri": {"type": "boolean"},
    "tlsPort": {"type": "integer"},
    "credentials": {"$ref": "#/$defs/SipUserCredentials"},
    "deutscheTelekomNumberExtensionRange": {"$ref": "#/$defs/TelMatchExtensionRange"},
    "displayName": {"type": "string"},
    "localSipDomain": {"type": "string"},
    "includeSipRegistrarInWhitelist": {"type": "boolean"},
    "includeRemoteSipDomainInWhitelist": {"type": "boolean"},
    "includeProxyInWhitelist": {"type": "boolean"},
    "allowOnlyNegotiatedPeersForRtpRtcp": {"type": "boolean"},
    "outgoingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "externalHost": {"type": "string"},
    "routingDomains": {
      "type": "array",
      "items": {"type": "string"}
    },
    "networkControllerId": {"type": "string"},
    "natDeviceHasFixedPortMapping": {"type": "boolean"},
    "secondaryProxyUri": {"type": "string"},
    "fixedUdpPortRangeStart": {"type": "integer"},
    "proxyUri": {"type": "string"},
    "udpTcpPort": {"type": "integer"},
    "tcpPortRange": {"$ref": "#/$defs/PortRange"},
    "activateClientAuthentication": {"type": "boolean"},
    "enableReverseDnsLookup": {"type": "boolean"},
    "incomingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "assertedUriHost": {"type": "string"},
    "networkControllerInterface": {"type": "string"},
    "createNewNetworkController": {"type": "boolean"},
    "networkPeerWhitelist": {
      "type": "array",
      "items": {
        "$defs": {"IpVersion": {
          "type": "string",
          "enum": [
            "[Any Address Version]",
            "IN_ADDRESS_VERSION_4",
            "IN_ADDRESS_VERSION_6"
          ]
        }},
        "type": "object",
        "properties": {
          "ipVersion": {"$ref": "#/$defs/IpVersion"},
          "host": {"type": "string"},
          "subnetPrefixLength": {"type": "integer"},
          "dnsLookup": {
            "type": "array",
            "items": {"type": "string"}
          }
        }
      }
    },
    "remoteSipDomain": {"$ref": "#/$defs/RemoteSipDomain"},
    "nodeViaSipTrunking": {"type": "boolean"},
    "networkControllerDisplayName": {"type": "string"},
    "udpPortRange": {"$ref": "#/$defs/PortRange"},
    "useNetworkPeerWhitelist": {"type": "boolean"},
    "deutscheTelekomSipTrunkId": {"type": "string"},
    "addressOfRecord": {"type": "string"},
    "assertedUri": {"type": "string"},
    "primaryProxyUri": {"type": "string"},
    "networkControllerIpVersion": {
      "type": "string",
      "enum": [
        "[Any Address Version]",
        "IN_ADDRESS_VERSION_4",
        "IN_ADDRESS_VERSION_6"
      ]
    },
    "region": {
      "type": "string",
      "enum": [
        "SCHWEIZ",
        "LIECHTENSTEIN"
      ]
    },
    "fixedTcpPortRangeStart": {"type": "integer"},
    "fixedUdpTcpPort": {"type": "integer"},
    "networkControllerIpAddress": {"type": "string"},
    "registrarUri": {"type": "string"}
  }
}

26.19 AddSipPhoneRegistrarProfile

26.19.1 AddSipPhoneRegistrarProfile Field Description

  • createNewNetworkController

    Create new network controller or select an existing one.

    Type: boolean

  • networkControllerDisplayName

    The display name of the newly created network controller.

    Type: String

  • networkControllerInterface

    The interface of the newly created network controller.

    Type: String

  • networkControllerIpVersion

    The IP version of the newly created network controller.

    Type: IpVersion

    Possible values:

    • [Any Address Version]

    • IN_ADDRESS_VERSION_4

    • IN_ADDRESS_VERSION_6

  • networkControllerIpAddress

    The IP address of the newly created network controller.

    Type: String

  • enableReverseDnsLookup

    Specify whether reverse DNS lookup is enabled for the newly created network controller.

    Type: Boolean

  • networkControllerId

    In case no new network controller is created, this value must be given.

    Type: String

  • udpTcpPort

    The UDP/TCP Port.

    Type: int

  • tlsPort

    The TLS port.

    Type: int

  • udpPortRange

    The UDP port range.

    Type: PortRange (section 26.46)

  • tcpPortRange

    The TCP port range.

    Type: PortRange (section 26.46)

  • sipPhoneRegistrarDirectoryId

    The identifiert of the directory that determines how SIP phones authenticate.

    Type: String

  • useNetworkPeerWhitelist

    If the interconnection to the VoIP peer takes place over a public IP access, it is strictly recommended to minimize the IP addresses from which SIP messages are allowed by this whitelist.

    Type: boolean

  • includeOwnSubnetInWhitelist

    Whether to include the own subnet in the whitelist.

    Type: boolean

  • networkPeerWhitelist

    The whitelist.

    Type: Array of NetworkPeerWhitelistEntry

    • dnsLookup

      Additional protocol prefixes.

      Type: Array of String

    • host

      The hostname or ip address.

      Type: String

    • ipVersion

      If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)

      Type: IpVersion

      Possible values:

      • [Any Address Version]

      • IN_ADDRESS_VERSION_4

      • IN_ADDRESS_VERSION_6

    • subnetPrefixLength

      Type: int

  • allowOnlyNegotiatedPeersForRtpRtcp

    Allow only negotiated peers for RTP/RTCP.

    Type: boolean

  • incomingDialStringRewriteRules

    Type: Array of DialStringRewrite (section 26.4)

  • outgoingDialStringRewriteRules

    Type: Array of DialStringRewrite (section 26.4)

  • routingDomains

    Here, the routing domains (their IDs) can be selected which listen for incoming calls on this new node.

    Type: Array of String

  • displayName

    Type: String

26.19.2 AddSipPhoneRegistrarProfile JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "networkControllerInterface": {"type": "string"},
    "createNewNetworkController": {"type": "boolean"},
    "tlsPort": {"type": "integer"},
    "displayName": {"type": "string"},
    "networkPeerWhitelist": {
      "type": "array",
      "items": {
        "$defs": {"IpVersion": {
          "type": "string",
          "enum": [
            "[Any Address Version]",
            "IN_ADDRESS_VERSION_4",
            "IN_ADDRESS_VERSION_6"
          ]
        }},
        "type": "object",
        "properties": {
          "ipVersion": {"$ref": "#/$defs/IpVersion"},
          "host": {"type": "string"},
          "subnetPrefixLength": {"type": "integer"},
          "dnsLookup": {
            "type": "array",
            "items": {"type": "string"}
          }
        }
      }
    },
    "sipPhoneRegistrarDirectoryId": {"type": "string"},
    "allowOnlyNegotiatedPeersForRtpRtcp": {"type": "boolean"},
    "networkControllerDisplayName": {"type": "string"},
    "outgoingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "routingDomains": {
      "type": "array",
      "items": {"type": "string"}
    },
    "udpPortRange": {"$ref": "#/$defs/PortRange"},
    "includeOwnSubnetInWhitelist": {"type": "boolean"},
    "networkControllerId": {"type": "string"},
    "useNetworkPeerWhitelist": {"type": "boolean"},
    "udpTcpPort": {"type": "integer"},
    "tcpPortRange": {"$ref": "#/$defs/PortRange"},
    "networkControllerIpVersion": {
      "type": "string",
      "enum": [
        "[Any Address Version]",
        "IN_ADDRESS_VERSION_4",
        "IN_ADDRESS_VERSION_6"
      ]
    },
    "networkControllerIpAddress": {"type": "string"},
    "enableReverseDnsLookup": {"type": "boolean"},
    "incomingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    }
  }
}

26.20 AddTransportConnectionData

26.20.1 AddTransportConnectionData Field Description

  • matchingCondition

    The matching condition is used to filter for which calls the transport connection will be used.

    Type: TelMatch (section 26.48)

  • transportConnectionId

    The id of the transport connection

    Type: String

26.20.2 AddTransportConnectionData JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "matchingCondition": {"$ref": "#/$defs/TelMatch"},
    "transportConnectionId": {"type": "string"}
  }
}

26.21 NetworkPeerWhitelistEntry

26.21.1 NetworkPeerWhitelistEntry Field Description

  • dnsLookup

    Additional protocol prefixes.

    Type: Array of String

  • host

    The hostname or ip address.

    Type: String

  • ipVersion

    If you specify an IP version, then only IP addresses with this version will be accepted. (This makes especially sense when a host name is set.)

    Type: IpVersion

    Possible values:

    • [Any Address Version]

    • IN_ADDRESS_VERSION_4

    • IN_ADDRESS_VERSION_6

  • subnetPrefixLength

    Type: int

26.21.2 NetworkPeerWhitelistEntry JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ipVersion": {
      "type": "string",
      "enum": [
        "[Any Address Version]",
        "IN_ADDRESS_VERSION_4",
        "IN_ADDRESS_VERSION_6"
      ]
    },
    "host": {"type": "string"},
    "subnetPrefixLength": {"type": "integer"},
    "dnsLookup": {
      "type": "array",
      "items": {"type": "string"}
    }
  }
}

26.22 TransportConnection

26.22.1 TransportConnection Field Description

  • assertedAddress

    Define your own Asserted-URI. This URI can serve as the basis for special SIP headers (e.g. PAI header) in the case of outgoing calls.

    Type: AssertedUri

    • displayName

      The desired display name.

      Type: String

    • iri

      The desired URI.

      Type: String

  • authencationEnabled

    Whether authentication should be enabled or not. This value only applies if a registration is given.

    Type: Boolean

  • conditionId

    Optional operational condition. This transport connection is only operational as long as this condition is true.

    Type: String

  • credentials

    Credentials to be used for authentication. This value only applies if "authenticationEnabled" is set to true.

    Type: SipCredentials (section 26.23)

  • proxy

    The proxy to be used.

    Type: TransportConnectionProxy (section 26.53)

  • registration

    The registration to be used.

    Type: TransportConnectionRegistration

    • addressOfRecord

      Address-Of-Record (to be registered URI)

      Type: String

    • sipDomain

      SIP Domain (Registrar)

      Type: String

26.22.2 TransportConnection JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "proxy": {"$ref": "#/$defs/TransportConnectionProxy"},
    "assertedAddress": {
      "type": "object",
      "properties": {
        "iri": {"type": "string"},
        "displayName": {"type": "string"}
      }
    },
    "conditionId": {"type": "string"},
    "credentials": {"$ref": "#/$defs/SipCredentials"},
    "authencationEnabled": {"type": "boolean"},
    "registration": {
      "type": "object",
      "properties": {
        "sipDomain": {"type": "string"},
        "addressOfRecord": {"type": "string"}
      }
    }
  }
}

26.23 SipCredentials

26.23.1 SipCredentials Field Description

  • authenticationProfileId

    The identifier of a authentication profile. This can be set to use a existing authentication profile instead of creating a new one.

    Type: String

  • directoryName

    The identifier of the directory. This value only works in combination with "userIdentifier".

    Type: String

  • password

    This value only works in combination with "username".

    Type: String

  • userIdentifier

    The identifier of the user in a directory. This value only works in combination with "directoryName".

    Type: String

  • username

    This value only works in combination with "password".

    Type: String

26.23.2 SipCredentials JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "password": {"type": "string"},
    "authenticationProfileId": {"type": "string"},
    "userIdentifier": {"type": "string"},
    "directoryName": {"type": "string"},
    "username": {"type": "string"}
  }
}

26.24 Credentials

26.24.1 Credentials Field Description

  • password

    The password. Only works in combination with "username".

    Type: String

  • username

    The username. Only works in combination with "password".

    Type: String

26.24.2 Credentials JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "password": {"type": "string"},
    "username": {"type": "string"}
  }
}

26.25 AssertedUri

26.25.1 AssertedUri Field Description

  • displayName

    The desired display name.

    Type: String

  • iri

    The desired URI.

    Type: String

26.25.2 AssertedUri JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "iri": {"type": "string"},
    "displayName": {"type": "string"}
  }
}

26.26 DirectoryInfo

26.26.1 DirectoryInfo Field Description

  • directoryType

    Type: String

  • displayName

    Type: String

  • id

    Type: String

26.26.2 DirectoryInfo JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"},
    "directoryType": {"type": "string"}
  }
}

26.27 StaticUserDirectory

26.27.1 StaticUserDirectory Field Description

  • displayName

    The display name for this directory.

    Type: String

  • userRecords

    User data for this directory

    Type: Array of StaticUserDirectoryUser (section 26.54)

26.27.2 StaticUserDirectory JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "userRecords": {
      "type": "array",
      "items": {"$ref": "#/$defs/StaticUserDirectoryUser"}
    }
  }
}

26.28 Resources

26.28.1 Resources Field Description

26.28.2 Resources JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "disk": {"$ref": "#/$defs/ResourcesMemory"},
    "cpu": {"type": "integer"},
    "ram": {"$ref": "#/$defs/ResourcesMemory"}
  }
}

26.29 AddRoutingDomainOptions

26.29.1 AddRoutingDomainOptions Field Description

  • displayName

    Type: String

  • sourceNodes

    Type: String[]

26.29.2 AddRoutingDomainOptions JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sourceNodes": {
      "type": "array",
      "items": {"type": "string"}
    },
    "displayName": {"type": "string"}
  }
}

26.30 GetRoutingDomainOptions

26.30.1 GetRoutingDomainOptions Field Description

  • displayName

    Type: String

  • id

    Type: String

  • routes

    Type: Array of RoutingDomainRoute

    • displayName

      Type: String

    • establishment

      Only for "mode=establishment".

      Type: RoutingDomainRouteEstablishment (section 26.56)

    • filters

      Filters determine when this route will be used for incoming or outgoing calls.

      Type: Array of RoutingDomainRouteFilter (section 26.57)

    • pathReplacement

      Only for "mode=pathReplacement".

      Type: RoutingDomainRoutePathReplacement (section 26.58)

    • 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

  • sourceNodes

    Type: String[]

26.30.2 GetRoutingDomainOptions JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "routes": {
      "type": "array",
      "items": {
        "$defs": {
          "TelMatchList": {
            "type": "object",
            "properties": {
              "matches": {
                "type": "array",
                "items": {"$ref": "#/$defs/TelMatch"}
              },
              "operator": {"$ref": "#/$defs/TelMatchListOperator"}
            }
          },
          "RoutingDomainRoutingForwardProfileSelection": {
            "type": "string",
            "enum": [
              "CREATE_NEW",
              "USE_REFERENCE",
              "NONE"
            ]
          },
          "TelMatch": {
            "type": "object",
            "properties": {
              "wildcardPattern": {"type": "string"},
              "plain": {"$ref": "#/$defs/TelMatchPlain"},
              "extensionRange": {"$ref": "#/$defs/TelMatchExtensionRange"},
              "list": {"$ref": "#/$defs/TelMatchList"},
              "type": {"$ref": "#/$defs/TelMatchType"},
              "directory": {
                "type": "array",
                "items": {"type": "string"}
              }
            }
          },
          "RoutePathReplacementType": {
            "type": "string",
            "enum": [
              "REPLACE",
              "REJECT"
            ]
          },
          "TelMatchType": {
            "type": "string",
            "enum": [
              "ALWAYS",
              "NEVER",
              "LIST",
              "PLAIN",
              "DIRECTORY",
              "PATTERN",
              "CUCM_PATTERN",
              "EXTENSION_RANGE"
            ]
          },
          "RoutingTelRewriteSource": {
            "type": "string",
            "enum": [
              "MOST_APPROPRIATE",
              "FIRST_DIVERSION",
              "LAST_DIVERSION",
              "SOURCE",
              "DESTINATION",
              "TRANSFERRER"
            ]
          },
          "RoutingForwardProfileMode": {
            "type": "string",
            "enum": [
              "PASSTHROUGH",
              "TRANSCODING",
              "BYPASS",
              "PASSTHROUGH_WITH_FALLBACK_TO_BYPASS"
            ]
          },
          "RoutingDomainRouteEstablishment": {
            "type": "object",
            "properties": {
              "destinationDialStringRewriting": {
                "type": "array",
                "items": {"$ref": "#/$defs/RoutingTelRewrite"}
              },
              "routingForwardProfileId": {"type": "string"},
              "sourceDialStringRewriting": {
                "type": "array",
                "items": {"$ref": "#/$defs/RoutingTelRewrite"}
              },
              "parallelCalls": {
                "type": "array",
                "items": {"type": "string"}
              },
              "routingForwardProfileMode": {"$ref": "#/$defs/RoutingForwardProfileMode"},
              "rejectStatus": {"$ref": "#/$defs/RouteRejectStatus"},
              "type": {"$ref": "#/$defs/RoutingDomainRouteEstablishmentType"},
              "routingForwardProfileDisplayName": {"type": "string"},
              "adjustRoutingForwardProfileSettings": {"type": "boolean"},
              "destinationNodeId": {"type": "string"},
              "skipIfNodeNotOperational": {"type": "boolean"},
              "routingForwardProfileSelection": {"$ref": "#/$defs/RoutingDomainRoutingForwardProfileSelection"},
              "parallelCallDialStringDirectoryId": {"type": "string"}
            }
          },
          "RoutingDomainRouteEstablishmentType": {
            "type": "string",
            "enum": [
              "ROUTE",
              "IGNORE",
              "REJECT",
              "REDIRECT",
              "ESTABLISH_PARALLEL"
            ]
          },
          "RoutingTelRewrite": {
            "type": "object",
            "properties": {
              "delTrailing": {"type": "integer"},
              "matchedPart": {"type": "integer"},
              "prefix": {"type": "string"},
              "source": {"$ref": "#/$defs/RoutingTelRewriteSource"},
              "delLeading": {"type": "integer"},
              "suffix": {"type": "string"},
              "keepLeading": {"type": "integer"},
              "keepTrailing": {"type": "integer"}
            }
          },
          "TelMatchExtensionRange": {
            "type": "object",
            "properties": {
              "lastExtension": {"type": "string"},
              "firstExtension": {"type": "string"},
              "zeroExtend": {"type": "boolean"},
              "trunk": {"type": "string"}
            }
          },
          "RoutingDomainRouteLookupDirectories": {
            "type": "object",
            "properties": {
              "transferrerDialStringDirectoryId": {"type": "string"},
              "assertedUriDirectoryId": {"type": "string"},
              "destinationDialStringDirectoryId": {"type": "string"},
              "firstDiversionNumberDirectoryId": {"type": "string"},
              "lastDiversionNumberDirectoryId": {"type": "string"},
              "sourceDialStringDirectoryId": {"type": "string"}
            }
          },
          "TelMatchPlain": {
            "type": "object",
            "properties": {
              "prefix": {"type": "string"},
              "suffix": {"type": "string"}
            }
          },
          "TelMatchListOperator": {
            "type": "string",
            "enum": [
              "OR",
              "XOR",
              "AND",
              "NOT"
            ]
          },
          "RoutingDomainRoutePathReplacement": {
            "type": "object",
            "properties": {
              "routingForwardProfileDisplayName": {"type": "string"},
              "adjustAcceptNewForwarderDomain": {"type": "boolean"},
              "routingForwardProfileSelection": {"$ref": "#/$defs/RoutingDomainRoutingForwardProfileSelection"},
              "type": {"$ref": "#/$defs/RoutePathReplacementType"}
            }
          },
          "RouteRejectStatus": {
            "type": "string",
            "enum": [
              "SUCCESS",
              "DIAL_STRING",
              "NETWORK_PERMISSION",
              "NETWORK_CONGESTION",
              "NETWORK_EQUIPMENT",
              "USER_BUSY",
              "USER_REDIRECTED",
              "USER_NOT_RESPONDING",
              "USER_NOT_SELECTED",
              "USER_REJECTED",
              "USER_TERMINATED",
              "MEDIA_NEGOTIATION",
              "ERROR",
              "DOMAIN_SPECIFIC_0",
              "DOMAIN_SPECIFIC_1",
              "DOMAIN_SPECIFIC_2",
              "DOMAIN_SPECIFIC_3",
              "DOMAIN_SPECIFIC_4",
              "DOMAIN_SPECIFIC_5",
              "DOMAIN_SPECIFIC_6",
              "DOMAIN_SPECIFIC_7",
              "DOMAIN_SPECIFIC_8",
              "DOMAIN_SPECIFIC_9",
              "DOMAIN_SPECIFIC_10",
              "DOMAIN_SPECIFIC_11",
              "DOMAIN_SPECIFIC_12",
              "DOMAIN_SPECIFIC_13",
              "DOMAIN_SPECIFIC_14",
              "DOMAIN_SPECIFIC_15",
              "DOMAIN_SPECIFIC_16",
              "DOMAIN_SPECIFIC_17",
              "DOMAIN_SPECIFIC_18",
              "DOMAIN_SPECIFIC_19"
            ]
          },
          "RoutingDomainRouteFilter": {
            "type": "object",
            "properties": {
              "sourceNodeIds": {
                "type": "array",
                "items": {"type": "string"}
              },
              "sourceDialString": {
                "type": "array",
                "items": {"$ref": "#/$defs/TelMatch"}
              },
              "conditionId": {"type": "string"},
              "firstDiversionDialString": {
                "type": "array",
                "items": {"$ref": "#/$defs/TelMatch"}
              },
              "lookupDirectories": {"$ref": "#/$defs/RoutingDomainRouteLookupDirectories"},
              "assertedDialString": {
                "type": "array",
                "items": {"$ref": "#/$defs/TelMatch"}
              },
              "lastDiversionDialString": {
                "type": "array",
                "items": {"$ref": "#/$defs/TelMatch"}
              },
              "destinationDialString": {
                "type": "array",
                "items": {"$ref": "#/$defs/TelMatch"}
              },
              "transferrerDialString": {
                "type": "array",
                "items": {"$ref": "#/$defs/TelMatch"}
              }
            }
          }
        },
        "type": "object",
        "properties": {
          "supervisionId": {"type": "string"},
          "displayName": {"type": "string"},
          "useRouteSupervision": {"type": "boolean"},
          "useUnconditionalRouting": {"type": "boolean"},
          "pathReplacement": {"$ref": "#/$defs/RoutingDomainRoutePathReplacement"},
          "establishment": {"$ref": "#/$defs/RoutingDomainRouteEstablishment"},
          "filters": {
            "type": "array",
            "items": {"$ref": "#/$defs/RoutingDomainRouteFilter"}
          }
        }
      }
    },
    "sourceNodes": {
      "type": "array",
      "items": {"type": "string"}
    },
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.31 RoutingDomainRoute

26.31.1 RoutingDomainRoute Field Description

  • displayName

    Type: String

  • establishment

    Only for "mode=establishment".

    Type: RoutingDomainRouteEstablishment (section 26.56)

  • filters

    Filters determine when this route will be used for incoming or outgoing calls.

    Type: Array of RoutingDomainRouteFilter (section 26.57)

  • pathReplacement

    Only for "mode=pathReplacement".

    Type: RoutingDomainRoutePathReplacement (section 26.58)

  • 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

26.31.2 RoutingDomainRoute JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "supervisionId": {"type": "string"},
    "displayName": {"type": "string"},
    "useRouteSupervision": {"type": "boolean"},
    "useUnconditionalRouting": {"type": "boolean"},
    "pathReplacement": {"$ref": "#/$defs/RoutingDomainRoutePathReplacement"},
    "establishment": {"$ref": "#/$defs/RoutingDomainRouteEstablishment"},
    "filters": {
      "type": "array",
      "items": {"$ref": "#/$defs/RoutingDomainRouteFilter"}
    }
  }
}

26.32 RoutingForwardProfile

26.32.1 RoutingForwardProfile Field Description

  • 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

    Display name of the object.

    Type: String

  • earlyMediaPassThrough

    Specify whether early media should be already passed through during call setup.

    Type: Boolean

  • id

    Identifier of the object.

    Type: String

  • mediaRecorderId

    The id of the Media Recorder used to record as specified.

    Type: String

  • removeAnynodeFromSignalingPath

    Type: Boolean

  • telephonyForwardingStack

    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: TelephonyForwarding (section 26.59)

  • 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

26.32.2 RoutingForwardProfile JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "announcementMediaSourceId": {"type": "string"},
    "telephonyForwardingStack": {"$ref": "#/$defs/TelephonyForwarding"},
    "announcementIncoming": {"type": "boolean"},
    "displayName": {"type": "string"},
    "removeAnynodeFromSignalingPath": {"type": "boolean"},
    "mediaRecorderId": {"type": "string"},
    "id": {"type": "string"},
    "earlyMediaPassThrough": {"type": "boolean"},
    "announcementOutgoing": {"type": "boolean"},
    "telephonyForwardingStackId": {"type": "string"}
  }
}

26.33 TelMatchExtensionRange

26.33.1 TelMatchExtensionRange Field Description

  • firstExtension

    Type: String

  • lastExtension

    Type: String

  • trunk

    Type: String

  • zeroExtend

    Type: Boolean

26.33.2 TelMatchExtensionRange JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "lastExtension": {"type": "string"},
    "firstExtension": {"type": "string"},
    "zeroExtend": {"type": "boolean"},
    "trunk": {"type": "string"}
  }
}

26.34 MatchPatternSegment

26.34.1 MatchPatternSegment Field Description

  • comment

    Type: String

  • digits

    Must only contain numeric digits (0-9)

    Type: String

  • greedyMatch

    Type: Boolean

  • maxCount

    Type: Integer

  • minCount

    Type: Integer

  • text

    Type: String

  • type

    Type: TelMatchPatternSegmentType

    Possible values:

    • anything

    • discard

    • digits

    • text

26.34.2 MatchPatternSegment JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "greedyMatch": {"type": "boolean"},
    "comment": {"type": "string"},
    "digits": {"type": "string"},
    "minCount": {"type": "integer"},
    "text": {"type": "string"},
    "type": {
      "type": "string",
      "enum": [
        "anything",
        "discard",
        "digits",
        "text"
      ]
    },
    "maxCount": {"type": "integer"}
  }
}

26.35 TelRewriteSegment

26.35.1 TelRewriteSegment Field Description

  • capture

    Type: Integer

  • delLeading

    Type: Integer

  • delTrailing

    Type: Integer

  • keepLeading

    Type: Integer

  • keepTrailing

    Type: Integer

  • prefix

    Type: String

  • suffix

    Type: String

26.35.2 TelRewriteSegment JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "delTrailing": {"type": "integer"},
    "prefix": {"type": "string"},
    "capture": {"type": "integer"},
    "delLeading": {"type": "integer"},
    "suffix": {"type": "string"},
    "keepLeading": {"type": "integer"},
    "keepTrailing": {"type": "integer"}
  }
}

26.36 TagMatch

26.36.1 TagMatch Field Description

  • tagSet

    Tags may only contain alphabetic and numeric characters and have to start with a lowercase character

    Type: Array of String

  • type

    The operator applied to the matched tags to determine the result of the TagMatch.

    Type: TagMatchTye

    Possible values:

    • or

    • xor

    • and

    • not

26.36.2 TagMatch JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tagSet": {
      "type": "array",
      "items": {"type": "string"}
    },
    "type": {
      "type": "string",
      "enum": [
        "or",
        "xor",
        "and",
        "not"
      ]
    }
  }
}

26.37 TagRewrite

26.37.1 TagRewrite Field Description

  • clearTags

    Incicates if the existing tags should be removed.

    Type: Boolean

  • operations

    Type: Array of TagRewriteOperation (section 26.63)

26.37.2 TagRewrite JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "operations": {
      "type": "array",
      "items": {"$ref": "#/$defs/TagRewriteOperation"}
    },
    "clearTags": {"type": "boolean"}
  }
}

26.38 String

26.38.1 String Field Description

  • CASE_INSENSITIVE_ORDER

    Type: Comparator

  • hash

    Type: int

  • serialPersistentFields

    Type: ObjectStreamField[]

  • serialVersionUID

    Type: long

  • value

    Type: char[]

26.38.2 String JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "string"
}

26.39 SystemId

26.39.1 SystemId Field Description

  • displayName

    Type: String

  • id

    Type: String

26.39.2 SystemId JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.40 LocalUser

26.40.1 LocalUser Field Description

  • Type: String

26.40.2 LocalUser JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {"name": {"type": "string"}}
}

26.41 LocalV0User

26.41.1 LocalV0User Field Description

  • Type: String

26.41.2 LocalV0User JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {"name": {"type": "string"}}
}

26.42 LdapAuthority

26.42.1 LdapAuthority Field Description

  • displayName

    Type: String

  • id

    Type: String

26.42.2 LdapAuthority JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.43 MsTeamsSbaUser

26.43.1 MsTeamsSbaUser Field Description

  • lastActiveTime

    Type: String

  • lastSyncTime

    Type: String

  • sipUri

    Type: String

  • userId

    Type: String

26.43.2 MsTeamsSbaUser JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "lastActiveTime": {"type": "string"},
    "lastSyncTime": {"type": "string"},
    "sipUri": {"type": "string"},
    "userId": {"type": "string"}
  }
}

26.44 GetNodesNode

26.44.1 GetNodesNode Field Description

  • displayName

    Type: String

  • id

    Type: String

26.44.2 GetNodesNode JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.45 GetSystemsProfilesProfile

26.45.1 GetSystemsProfilesProfile Field Description

  • displayName

    Type: String

  • id

    Type: String

26.45.2 GetSystemsProfilesProfile JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "activateServerAuthentication": {"type": "boolean"},
    "serverCredentials": {"$ref": "#/$defs/SipCredentials"},
    "tlsPort": {"type": "integer"},
    "displayName": {"type": "string"},
    "localSipDomain": {"type": "string"},
    "includeSipRegistrarInWhitelist": {"type": "boolean"},
    "includeRemoteSipDomainInWhitelist": {"type": "boolean"},
    "allowOnlyNegotiatedPeersForRtpRtcp": {"type": "boolean"},
    "createNewTeamsCarrierNode": {"type": "boolean"},
    "createNewMsOperatorConnectNode": {"type": "boolean"},
    "outgoingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "routingDomains": {
      "type": "array",
      "items": {"type": "string"}
    },
    "includeOwnSubnetInWhitelist": {"type": "boolean"},
    "networkControllerId": {"type": "string"},
    "xGooglePbxTrunkSecretKey": {"type": "string"},
    "msOperatorConnectNodeId": {"type": "string"},
    "teamsCarrierNodeId": {"type": "string"},
    "sbcFqdn": {"type": "string"},
    "clientCredentials": {"$ref": "#/$defs/SipCredentials"},
    "udpTcpPort": {"type": "integer"},
    "id": {"type": "string"},
    "tcpPortRange": {"$ref": "#/$defs/PortRange"},
    "activateClientAuthentication": {"type": "boolean"},
    "enableReverseDnsLookup": {"type": "boolean"},
    "incomingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "networkControllerInterface": {"type": "string"},
    "tenantFqdn": {"type": "string"},
    "createNewNetworkController": {"type": "boolean"},
    "networkPeerWhitelist": {
      "type": "array",
      "items": {"$ref": "#/$defs/NetworkPeerWhitelistEntry"}
    },
    "remoteSipDomain": {"$ref": "#/$defs/RemoteSipDomain"},
    "sipRegistrar": {"$ref": "#/$defs/TelMatch"},
    "networkControllerDisplayName": {"type": "string"},
    "udpPortRange": {"$ref": "#/$defs/PortRange"},
    "useNetworkPeerWhitelist": {"type": "boolean"},
    "sipInterconnection": {"$ref": "#/$defs/SipInterconnection"},
    "addressOfRecord": {"type": "string"},
    "tenantId": {"type": "string"},
    "networkControllerIpVersion": {"$ref": "#/$defs/IpVersion"},
    "region": {"$ref": "#/$defs/AddSystemRegion"},
    "networkControllerIpAddress": {"type": "string"},
    "registrarUri": {"type": "string"}
  }
}

26.46 PortRange

26.46.1 PortRange Field Description

  • firstPort

    First port of the port range

    Type: int

  • lastPort

    Last port of the port range

    Type: int

26.46.2 PortRange JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "lastPort": {"type": "integer"},
    "firstPort": {"type": "integer"}
  }
}

26.47 RemoteSipDomain

26.47.1 RemoteSipDomain Field Description

  • host

    Type: String

  • iri

    Type: String

  • port

    Type: int

  • transport

    Type: RemoteSipDomainTransport

    Possible values:

    • udp

    • tcp

    • tls

    • sctp

    • tls-sctp

26.47.2 RemoteSipDomain JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "iri": {"type": "string"},
    "port": {"type": "integer"},
    "host": {"type": "string"},
    "transport": {
      "type": "string",
      "enum": [
        "udp",
        "tcp",
        "tls",
        "sctp",
        "tls-sctp"
      ]
    }
  }
}

26.48 TelMatch

26.48.1 TelMatch Field Description

  • directory

    Mandatory for "type=DIRECTORY".

    Type: Array of String

  • extensionRange

    Mandatory for "type=EXTENSION_RANGE".

    Type: TelMatchExtensionRange (section 26.33)

  • list

    Mandatory for "type=LIST".

    Type: TelMatchList (section 26.64)

  • plain

    Mandatory for "type=PLAIN".

    Type: TelMatchPlain

    • prefix

      Prefix which must be present in the dial string.

      Type: String

    • suffix

      Suffix which must be present in the dial string.

      Type: String

  • type

    Type: TelMatchType

    Possible values:

    • anything

    • never

    • list

    • prefixSuffix

    • dialStringList

    • structuralPattern

    • wildcardPattern

    • extensionRange

  • wildcardPattern

    Mandatory for "type=WILDCARD".

    Type: String

26.48.2 TelMatch JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "wildcardPattern": {"type": "string"},
    "plain": {
      "type": "object",
      "properties": {
        "prefix": {"type": "string"},
        "suffix": {"type": "string"}
      }
    },
    "extensionRange": {"$ref": "#/$defs/TelMatchExtensionRange"},
    "list": {"$ref": "#/$defs/TelMatchList"},
    "type": {
      "type": "string",
      "enum": [
        "ALWAYS",
        "NEVER",
        "LIST",
        "PLAIN",
        "DIRECTORY",
        "PATTERN",
        "CUCM_PATTERN",
        "EXTENSION_RANGE"
      ]
    },
    "directory": {
      "type": "array",
      "items": {"type": "string"}
    }
  }
}

26.49 AddNodeResult

26.49.1 AddNodeResult Field Description

  • displayName

    Type: String

  • id

    Type: String

26.49.2 AddNodeResult JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.50 GetProviderProfilesProfile

26.50.1 GetProviderProfilesProfile Field Description

  • displayName

    Type: String

  • id

    Type: String

26.50.2 GetProviderProfilesProfile JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "fixedTlsPort": {"type": "integer"},
    "activateNatTraversal": {"type": "boolean"},
    "createNewDeutscheTelekomSipTrunk": {"type": "boolean"},
    "defineAssertedUri": {"type": "boolean"},
    "tlsPort": {"type": "integer"},
    "credentials": {"$ref": "#/$defs/SipUserCredentials"},
    "deutscheTelekomNumberExtensionRange": {"$ref": "#/$defs/TelMatchExtensionRange"},
    "displayName": {"type": "string"},
    "localSipDomain": {"type": "string"},
    "includeSipRegistrarInWhitelist": {"type": "boolean"},
    "includeRemoteSipDomainInWhitelist": {"type": "boolean"},
    "includeProxyInWhitelist": {"type": "boolean"},
    "allowOnlyNegotiatedPeersForRtpRtcp": {"type": "boolean"},
    "outgoingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "externalHost": {"type": "string"},
    "routingDomains": {
      "type": "array",
      "items": {"type": "string"}
    },
    "networkControllerId": {"type": "string"},
    "natDeviceHasFixedPortMapping": {"type": "boolean"},
    "secondaryProxyUri": {"type": "string"},
    "fixedUdpPortRangeStart": {"type": "integer"},
    "proxyUri": {"type": "string"},
    "udpTcpPort": {"type": "integer"},
    "id": {"type": "string"},
    "tcpPortRange": {"$ref": "#/$defs/PortRange"},
    "activateClientAuthentication": {"type": "boolean"},
    "enableReverseDnsLookup": {"type": "boolean"},
    "incomingDialStringRewriteRules": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "assertedUriHost": {"type": "string"},
    "networkControllerInterface": {"type": "string"},
    "createNewNetworkController": {"type": "boolean"},
    "networkPeerWhitelist": {
      "type": "array",
      "items": {"$ref": "#/$defs/NetworkPeerWhitelistEntry"}
    },
    "remoteSipDomain": {"$ref": "#/$defs/RemoteSipDomain"},
    "nodeViaSipTrunking": {"type": "boolean"},
    "networkControllerDisplayName": {"type": "string"},
    "udpPortRange": {"$ref": "#/$defs/PortRange"},
    "useNetworkPeerWhitelist": {"type": "boolean"},
    "deutscheTelekomSipTrunkId": {"type": "string"},
    "addressOfRecord": {"type": "string"},
    "assertedUri": {"type": "string"},
    "primaryProxyUri": {"type": "string"},
    "networkControllerIpVersion": {"$ref": "#/$defs/IpVersion"},
    "region": {"$ref": "#/$defs/AddProviderRegion"},
    "fixedTcpPortRangeStart": {"type": "integer"},
    "fixedUdpTcpPort": {"type": "integer"},
    "networkControllerIpAddress": {"type": "string"},
    "registrarUri": {"type": "string"}
  }
}

26.51 SipUserCredentials

26.51.1 SipUserCredentials Field Description

  • username

    The SIP username

    Type: String

  • password

    The SIP password

    Type: String

26.51.2 SipUserCredentials JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "password": {"type": "string"},
    "username": {"type": "string"}
  }
}

26.52 CertificateListEntry

26.52.1 CertificateListEntry Field Description

  • issuer

    Type: String

  • subject

    Type: String

  • validFrom

    Type: String

  • validUntil

    Type: String

26.52.2 CertificateListEntry JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "subject": {"type": "string"},
    "validUntil": {"type": "string"},
    "validFrom": {"type": "string"},
    "issuer": {"type": "string"}
  }
}

26.53 TransportConnectionProxy

26.53.1 TransportConnectionProxy Field Description

  • flow

    Whether a transport flow should be established. A flow is a kind of fixed virtual channel through which the entire SIP signaling takes place.

    Type: Boolean

  • iri

    Optional Proxy-URI. Otherwise, the remote SIP domain is used.

    Type: String

  • omitInitialRouteSet

    Omit the initial route set.

    Type: Boolean

  • options

    Send OPTIONS packets and if possible (which means that the remote station is an anynode then use the OPTIONS packets to determine the load of the remote station.

    Type: Boolean

  • optionsNextHop

    OPTIONS packets must be answered by the next hop.

    Type: Boolean

26.53.2 TransportConnectionProxy JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "iri": {"type": "string"},
    "options": {"type": "boolean"},
    "optionsNextHop": {"type": "boolean"},
    "omitInitialRouteSet": {"type": "boolean"},
    "flow": {"type": "boolean"}
  }
}

26.54 StaticUserDirectoryUser

26.54.1 StaticUserDirectoryUser Field Description

  • applicationRecords

    Application specifc data depending on the use case of this directory.

    Type: StaticUserDirectoryUserApplications (section 26.65)

  • displayName

    The display name that is used to identify the user in the directory later on.

    Type: String

26.54.2 StaticUserDirectoryUser JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "applicationRecords": {"$ref": "#/$defs/StaticUserDirectoryUserApplications"}
  }
}

26.55 ResourcesMemory

26.55.1 ResourcesMemory Field Description

  • total

    Type: long

  • used

    Type: long

26.55.2 ResourcesMemory JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "total": {"type": "integer"},
    "used": {"type": "integer"}
  }
}

26.56 RoutingDomainRouteEstablishment

26.56.1 RoutingDomainRouteEstablishment Field Description

  • adjustRoutingForwardProfileSettings

    Only for "routingForwardProfileSelection=CREATE_NEW". If set to true the handling of media channels can be modified.

    Type: Boolean

  • destinationDialStringRewriting

    Only for "type=ROUTE".

    Type: Array of RoutingTelRewrite (section 26.66)

  • destinationNodeId

    The identifier of the destination node. This is mandatory for the value "type=ROUTE".

    Type: String

  • parallelCallDialStringDirectoryId

    Only for ype=ESTABLISH_PARALLEL". The identifier of the directory to determine dial strings for parallel calls.

    Type: String

  • parallelCalls

    Only for ype=ESTABLISH_PARALLEL". A list of dial strings for parallel calls.

    Type: String[]

  • rejectStatus

    Only for "type=REJECT".

    Type: RouteRejectStatus

    Possible values:

    • SUCCESS

      Success.

    • DIAL_STRING

      Erroneous dial string, user not found, no route, etc.

    • NETWORK_PERMISSION

      No permission.

    • NETWORK_CONGESTION

      A network congestion.

    • NETWORK_EQUIPMENT

      Device error.

    • USER_BUSY

      User busy.

    • USER_REDIRECTED

      Redirected.

    • USER_NOT_RESPONDING

      No reaction.

    • USER_NOT_SELECTED

      A different user received the call.

    • USER_REJECTED

      Rejected

    • USER_TERMINATED

      Terminated

    • MEDIA_NEGOTIATION

      Media negotiation error.

    • ERROR

      Generic error

    • DOMAIN_SPECIFIC_0

      Domain specific 0

    • DOMAIN_SPECIFIC_1

      Domain specific 1

    • DOMAIN_SPECIFIC_2

      Domain specific 2

    • DOMAIN_SPECIFIC_3

      Domain specific 3

    • DOMAIN_SPECIFIC_4

      Domain specific 4

    • DOMAIN_SPECIFIC_5

      Domain specific 5

    • DOMAIN_SPECIFIC_6

      Domain specific 6

    • DOMAIN_SPECIFIC_7

      Domain specific 7

    • DOMAIN_SPECIFIC_8

      Domain specific 8

    • DOMAIN_SPECIFIC_9

      Domain specific 9

    • DOMAIN_SPECIFIC_10

      Domain specific 10

    • DOMAIN_SPECIFIC_11

      Domain specific 11

    • DOMAIN_SPECIFIC_12

      Domain specific 12

    • DOMAIN_SPECIFIC_13

      Domain specific 13

    • DOMAIN_SPECIFIC_14

      Domain specific 14

    • DOMAIN_SPECIFIC_15

      Domain specific 15

    • DOMAIN_SPECIFIC_16

      Domain specific 16

    • DOMAIN_SPECIFIC_17

      Domain specific 17

    • DOMAIN_SPECIFIC_18

      Domain specific 18

    • DOMAIN_SPECIFIC_19

      Domain specific 19

  • routingForwardProfileDisplayName

    Only for "routingForwardProfileSelection=CREATE_NEW". The display name for the new routing forward profile.

    Type: String

  • routingForwardProfileId

    Only for "routingForwardProfileSelection=USE_REFERENCE". The identifier of the routing forward profile.

    Type: String

  • routingForwardProfileMode

    Only for "adjustRoutingForwardProfileSettings=true". This is the media channel handling mode.

    Type: RoutingForwardProfileMode

    Possible values:

    • PASSTHROUGH

    • TRANSCODING

    • BYPASS

    • PASSTHROUGH_WITH_FALLBACK_TO_BYPASS

  • routingForwardProfileSelection

    Only for "type=ROUTE". An Routing forward profile can added for this route.

    Type: RoutingDomainRoutingForwardProfileSelection

    Possible values:

    • CREATE_NEW

      Create a new profile.

    • USE_REFERENCE

      Use an existing profile.

    • NONE

      Don't select a file.

  • skipIfNodeNotOperational

    If set to "true" this route will be skipped if the destination node is not operational.

    Type: Boolean

  • sourceDialStringRewriting

    Only for "type=ROUTE".

    Type: Array of RoutingTelRewrite (section 26.66)

  • type

    This is the type of action which is executed after the route filter was passed.

    Type: RoutingDomainRouteEstablishmentType

    Possible values:

    • ROUTE

      Route call

    • IGNORE

      Ignore call

    • REJECT

      Reject call

    • REDIRECT

      Redirect call

    • ESTABLISH_PARALLEL

      Establish parallel calls

26.56.2 RoutingDomainRouteEstablishment JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "destinationDialStringRewriting": {
      "type": "array",
      "items": {"$ref": "#/$defs/RoutingTelRewrite"}
    },
    "routingForwardProfileId": {"type": "string"},
    "sourceDialStringRewriting": {
      "type": "array",
      "items": {"$ref": "#/$defs/RoutingTelRewrite"}
    },
    "parallelCalls": {
      "type": "array",
      "items": {"type": "string"}
    },
    "routingForwardProfileMode": {
      "type": "string",
      "enum": [
        "PASSTHROUGH",
        "TRANSCODING",
        "BYPASS",
        "PASSTHROUGH_WITH_FALLBACK_TO_BYPASS"
      ]
    },
    "rejectStatus": {
      "type": "string",
      "enum": [
        "SUCCESS",
        "DIAL_STRING",
        "NETWORK_PERMISSION",
        "NETWORK_CONGESTION",
        "NETWORK_EQUIPMENT",
        "USER_BUSY",
        "USER_REDIRECTED",
        "USER_NOT_RESPONDING",
        "USER_NOT_SELECTED",
        "USER_REJECTED",
        "USER_TERMINATED",
        "MEDIA_NEGOTIATION",
        "ERROR",
        "DOMAIN_SPECIFIC_0",
        "DOMAIN_SPECIFIC_1",
        "DOMAIN_SPECIFIC_2",
        "DOMAIN_SPECIFIC_3",
        "DOMAIN_SPECIFIC_4",
        "DOMAIN_SPECIFIC_5",
        "DOMAIN_SPECIFIC_6",
        "DOMAIN_SPECIFIC_7",
        "DOMAIN_SPECIFIC_8",
        "DOMAIN_SPECIFIC_9",
        "DOMAIN_SPECIFIC_10",
        "DOMAIN_SPECIFIC_11",
        "DOMAIN_SPECIFIC_12",
        "DOMAIN_SPECIFIC_13",
        "DOMAIN_SPECIFIC_14",
        "DOMAIN_SPECIFIC_15",
        "DOMAIN_SPECIFIC_16",
        "DOMAIN_SPECIFIC_17",
        "DOMAIN_SPECIFIC_18",
        "DOMAIN_SPECIFIC_19"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "ROUTE",
        "IGNORE",
        "REJECT",
        "REDIRECT",
        "ESTABLISH_PARALLEL"
      ]
    },
    "routingForwardProfileDisplayName": {"type": "string"},
    "adjustRoutingForwardProfileSettings": {"type": "boolean"},
    "destinationNodeId": {"type": "string"},
    "skipIfNodeNotOperational": {"type": "boolean"},
    "routingForwardProfileSelection": {
      "type": "string",
      "enum": [
        "CREATE_NEW",
        "USE_REFERENCE",
        "NONE"
      ]
    },
    "parallelCallDialStringDirectoryId": {"type": "string"}
  }
}

26.57 RoutingDomainRouteFilter

26.57.1 RoutingDomainRouteFilter Field Description

  • assertedDialString

    You can specify a required structure of the asserted dial string.

    Type: TelMatch[]

  • conditionId

    A condition can be selected. Only if this condition is met, this route is taken.

    Type: String

  • destinationDialString

    You can specify a required structure of the destination dial string.

    Type: TelMatch[]

  • firstDiversionDialString

    You can specify a required structure of the first diversion dial string

    Type: TelMatch[]

  • lastDiversionDialString

    You can specify a required structure of the last diversion dial string

    Type: TelMatch[]

  • lookupDirectories

    If a lookup directory is selected then the dial string must be included in the directory.

    Type: RoutingDomainRouteLookupDirectories (section 26.67)

  • sourceDialString

    You can specify a required structure of the source dial string.

    Type: TelMatch[]

  • sourceNodeIds

    Optionally you can restrict the set of source nodes which are used for this route. Otherwise, all nodes are accepted.

    Type: String[]

  • transferrerDialString

    You can specify a required structure of the transferrer dial string

    Type: TelMatch[]

26.57.2 RoutingDomainRouteFilter JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sourceNodeIds": {
      "type": "array",
      "items": {"type": "string"}
    },
    "sourceDialString": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    },
    "conditionId": {"type": "string"},
    "firstDiversionDialString": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    },
    "lookupDirectories": {"$ref": "#/$defs/RoutingDomainRouteLookupDirectories"},
    "assertedDialString": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    },
    "lastDiversionDialString": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    },
    "destinationDialString": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    },
    "transferrerDialString": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    }
  }
}

26.58 RoutingDomainRoutePathReplacement

26.58.1 RoutingDomainRoutePathReplacement Field Description

  • adjustAcceptNewForwarderDomain

    Type: Boolean

  • routingForwardProfileDisplayName

    Only for "routingForwardProfileSelection=CREATE_NEW". The display name for the new routing forward profile.

    Type: String

  • routingForwardProfileSelection

    Only for "type=REPLACE". An Routing forward profile can added for this route.

    Type: RoutingDomainRoutingForwardProfileSelection

    Possible values:

    • CREATE_NEW

      Create a new profile.

    • USE_REFERENCE

      Use an existing profile.

    • NONE

      Don't select a file.

  • type

    The action that is carried out if the route filter matches.

    Type: RoutePathReplacementType

    Possible values:

    • REPLACE

    • REJECT

26.58.2 RoutingDomainRoutePathReplacement JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "routingForwardProfileDisplayName": {"type": "string"},
    "adjustAcceptNewForwarderDomain": {"type": "boolean"},
    "routingForwardProfileSelection": {
      "type": "string",
      "enum": [
        "CREATE_NEW",
        "USE_REFERENCE",
        "NONE"
      ]
    },
    "type": {
      "type": "string",
      "enum": [
        "REPLACE",
        "REJECT"
      ]
    }
  }
}

26.59 TelephonyForwarding

26.59.1 TelephonyForwarding Field Description

  • mediaNegotiationForwarder

    Type: MediaNegotiationForwarder (section 26.68)

  • mediaNegotiationForwarderId

    Type: String

  • signalingForwardingFromCalledToCalling

    Type: SignalingForwardingOptions (section 26.69)

  • signalingForwardingFromCallingToCalled

    Type: SignalingForwardingOptions (section 26.69)

26.59.2 TelephonyForwarding JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "signalingForwardingFromCallingToCalled": {"$ref": "#/$defs/SignalingForwardingOptions"},
    "mediaNegotiationForwarderId": {"type": "string"},
    "signalingForwardingFromCalledToCalling": {"$ref": "#/$defs/SignalingForwardingOptions"},
    "mediaNegotiationForwarder": {"$ref": "#/$defs/MediaNegotiationForwarder"}
  }
}

26.60 Backend

26.60.1 Backend Field Description

  • displayName

    Type: String

  • id

    Type: String

26.60.2 Backend JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.61 NetworkInterface

26.61.1 NetworkInterface Field Description

  • displayName

    Type: String

  • id

    Type: String

26.61.2 NetworkInterface JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.62 NetworkController

26.62.1 NetworkController Field Description

  • displayName

    Type: String

  • id

    Type: String

  • interface

    Type: String

26.62.2 NetworkController JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"},
    "interface": {"type": "string"}
  }
}

26.63 TagRewriteOperation

26.63.1 TagRewriteOperation Field Description

  • type

    Indicates which rewrite operation will be carried out on the tag.

    Type: TagRewriteOperationType

    Possible values:

    • add

    • delete

    • keep

  • tag

    Tags may only contain alphabetic and numeric characters and have to start with a lowercase character

    Type: String

26.63.2 TagRewriteOperation JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tag": {"type": "string"},
    "type": {
      "type": "string",
      "enum": [
        "add",
        "delete",
        "keep"
      ]
    }
  }
}

26.64 TelMatchList

26.64.1 TelMatchList Field Description

  • matches

    Type: Array of TelMatch (section 26.48)

  • operator

    The operator applied to the results of the "matches".

    Type: TelMatchListOperator

    Possible values:

    • OR

    • XOR

    • AND

    • NOT

26.64.2 TelMatchList JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "matches": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    },
    "operator": {
      "type": "string",
      "enum": [
        "OR",
        "XOR",
        "AND",
        "NOT"
      ]
    }
  }
}

26.65 StaticUserDirectoryUserApplications

26.65.1 StaticUserDirectoryUserApplications Field Description

  • associatedProvisioningDevices

    Options for associated provisioning devices.

    Type: Array of ProvisioningUserAssociatedDevice (section 26.70)

  • policy

    Telephony policy settings for this user.

    Type: SipPolicyUserData (section 26.71)

  • sipCredentials

    Options for SIP authentication

    Type: Credentials (section 26.24)

  • sipRegistrar

    SIP registrar information.

    Type: SipRegistrarUserData (section 26.72)

  • webrtc

    WebRTC dial string and client authentication information.

    Type: WebRtcUserData (section 26.73)

26.65.2 StaticUserDirectoryUserApplications JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "associatedProvisioningDevices": {
      "type": "array",
      "items": {"$ref": "#/$defs/ProvisioningUserAssociatedDevice"}
    },
    "webrtc": {"$ref": "#/$defs/WebRtcUserData"},
    "sipCredentials": {"$ref": "#/$defs/Credentials"},
    "sipRegistrar": {"$ref": "#/$defs/SipRegistrarUserData"},
    "policy": {"$ref": "#/$defs/SipPolicyUserData"}
  }
}

26.66 RoutingTelRewrite

26.66.1 RoutingTelRewrite Field Description

  • delLeading

    How many of the leading characters will be deleted.

    Type: int

  • delTrailing

    How many of the trailing characters will be deleted.

    Type: int

  • keepLeading

    Keep aditional leading characters of the matched part. This happens before the removal of leading characters.

    Type: int

  • keepTrailing

    Keep aditional trailing characters of the matched part. This happens before the removal of trailing characters.

    Type: int

  • matchedPart

    The matched part of the dial string that will be rewritten. Setting this to 0 will select the whole dial string.

    Type: int

  • prefix

    Adds a prefix to the dial string

    Type: String

  • source

    This determines which dial string will be rewritten.

    Type: RoutingTelRewriteSource

    Possible values:

    • MOST_APPROPRIATE

    • FIRST_DIVERSION

    • LAST_DIVERSION

    • SOURCE

    • DESTINATION

    • TRANSFERRER

  • suffix

    Adds a suffix to the dial string

    Type: String

26.66.2 RoutingTelRewrite JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "delTrailing": {"type": "integer"},
    "matchedPart": {"type": "integer"},
    "prefix": {"type": "string"},
    "source": {
      "type": "string",
      "enum": [
        "MOST_APPROPRIATE",
        "FIRST_DIVERSION",
        "LAST_DIVERSION",
        "SOURCE",
        "DESTINATION",
        "TRANSFERRER"
      ]
    },
    "delLeading": {"type": "integer"},
    "suffix": {"type": "string"},
    "keepLeading": {"type": "integer"},
    "keepTrailing": {"type": "integer"}
  }
}

26.67 RoutingDomainRouteLookupDirectories

26.67.1 RoutingDomainRouteLookupDirectories Field Description

  • assertedUriDirectoryId

    The identifier of the directory to lookup the asserted dial string

    Type: String

  • destinationDialStringDirectoryId

    The identifier of the directory to lookup the destination dial string

    Type: String

  • firstDiversionNumberDirectoryId

    The identifier of the directory to lookup the first diversion dial string

    Type: String

  • lastDiversionNumberDirectoryId

    The identifier of the directory to lookup the last diversion dial string

    Type: String

  • sourceDialStringDirectoryId

    The identifier of the directory to lookup the source dial string

    Type: String

  • transferrerDialStringDirectoryId

    The identifier of the directory to lookup the transferrer dial string

    Type: String

26.67.2 RoutingDomainRouteLookupDirectories JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "transferrerDialStringDirectoryId": {"type": "string"},
    "assertedUriDirectoryId": {"type": "string"},
    "destinationDialStringDirectoryId": {"type": "string"},
    "firstDiversionNumberDirectoryId": {"type": "string"},
    "lastDiversionNumberDirectoryId": {"type": "string"},
    "sourceDialStringDirectoryId": {"type": "string"}
  }
}

26.68 MediaNegotiationForwarder

26.68.1 MediaNegotiationForwarder Field Description

  • displayName

    The name shown in the anynode Frontend.

    Type: String

  • id

    The id of this object.

    Type: String

  • mediaMode

    Type: MediaMode

    Possible values:

    • TRANSCODING

    • BYPASS

    • PASSTHROUGH

    • PASSTHROUGH_WITH_FALLBACK_TO_BYPASS

  • mediaTranscodingOptions

    The Media Transcoding Options to be used.

    Type: MediaTranscodingOptions (section 26.74)

  • mediaTranscodingOptionsId

    This value will be used instead of mediaTranscodingOptions, if the object cannot be found. Id of the media transcoding options object to be used.

    Type: String

26.68.2 MediaNegotiationForwarder JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "mediaMode": {
      "type": "string",
      "enum": [
        "TRANSCODING",
        "BYPASS",
        "PASSTHROUGH",
        "PASSTHROUGH_WITH_FALLBACK_TO_BYPASS"
      ]
    },
    "mediaTranscodingOptionsId": {"type": "string"},
    "mediaTranscodingOptions": {"$ref": "#/$defs/MediaTranscodingOptions"},
    "id": {"type": "string"}
  }
}

26.69 SignalingForwardingOptions

26.69.1 SignalingForwardingOptions Field Description

  • ACTIVE_APPARENT_STATE

    Type: Boolean

  • ADDRESS

    Type: Boolean

  • ASSERTED_ADDRESS

    Type: Boolean

  • DESTINATION_ADDRESS

    Type: Boolean

  • DESTINATION_USER

    Type: Boolean

  • END_REASON

    Type: Boolean

  • HOLD

    Type: Boolean

  • MWI_REQUEST_SIP_DESTINATION_ADDRESS

    Type: Boolean

  • MWI_REQUEST_SIP_SOURCE_ADDRESS

    Type: Boolean

  • MWI_RESPONSE_REASON

    Type: Boolean

  • MWI_RESPONSE_SIP_REASON

    Type: Boolean

  • NOTIFY_SIP_INFO

    Type: Boolean

  • PRIORITY

    Type: Boolean

  • PROCEEDING

    Type: Boolean

  • PROCEEDING_RINGING

    Type: Boolean

  • REDIRECT_HISTORY

    Type: Boolean

  • RINGING

    Type: Boolean

  • SIP_ADDRESS

    Type: Boolean

  • SIP_ASSERTED_ADDRESS

    Type: Boolean

  • SIP_DESTINATION_ADDRESS

    Type: Boolean

  • SIP_END_REASON

    Type: Boolean

  • SIP_HEADER_CALL_INFO

    Type: Boolean

  • SIP_HEADER_DIVERSION

    Type: Boolean

  • SIP_HEADER_HISTORY_INFO

    Type: Boolean

  • SIP_HEADER_ORGANIZATION

    Type: Boolean

  • SIP_HEADER_PRIORITY

    Type: Boolean

  • SIP_HEADER_PRIVACY

    Type: Boolean

  • SIP_HEADER_P_ASSERTED_IDENTITY

    Type: Boolean

  • SIP_HEADER_P_CALLED_PARTY_ID

    Type: Boolean

  • SIP_HEADER_REFERRED_BY

    Type: Boolean

  • SIP_HEADER_REMOTE_PARTY_ID

    Type: Boolean

  • SIP_HEADER_SERVER

    Type: Boolean

  • SIP_HEADER_SUBJECT

    Type: Boolean

  • SIP_HEADER_USER_AGENT

    Type: Boolean

  • SIP_MSFT_GEOLOCATION

    Type: Boolean

  • SIP_PRIORITY

    Type: Boolean

  • SIP_PRIVACY

    Type: Boolean

  • SIP_REDIRECT_HISTORY

    Type: Boolean

  • SIP_REFERRER_ADDRESS

    Type: Boolean

  • SIP_SIPSNX_HEADER_P_ACCESS_NETWORK_INFO

    Type: Boolean

  • SIP_SIPSNX_HEADER_P_RECORDING_FROM

    Type: Boolean

  • SIP_SIPSNX_HEADER_P_RECORDING_TAPPED

    Type: Boolean

  • SIP_SIPSNX_HEADER_P_RECORDING_TO

    Type: Boolean

  • TRANSFERRER_ADDRESS

    Type: Boolean

  • USER

    Type: Boolean

  • notifySipInfoFilters

    Type: Array of NotifySipInfoFilter (section 26.75)

  • profile

    Type: SignalingForwardingOptionsProfile

    Possible values:

    • STANDARD

    • FULL

26.69.2 SignalingForwardingOptions JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "MWI_REQUEST_SIP_SOURCE_ADDRESS": {"type": "boolean"},
    "SIP_HEADER_SERVER": {"type": "boolean"},
    "SIP_HEADER_ORGANIZATION": {"type": "boolean"},
    "DESTINATION_USER": {"type": "boolean"},
    "notifySipInfoFilters": {
      "type": "array",
      "items": {"$ref": "#/$defs/NotifySipInfoFilter"}
    },
    "SIP_HEADER_PRIVACY": {"type": "boolean"},
    "SIP_DESTINATION_ADDRESS": {"type": "boolean"},
    "SIP_END_REASON": {"type": "boolean"},
    "PRIORITY": {"type": "boolean"},
    "SIP_REFERRER_ADDRESS": {"type": "boolean"},
    "SIP_MSFT_GEOLOCATION": {"type": "boolean"},
    "PROCEEDING_RINGING": {"type": "boolean"},
    "MWI_RESPONSE_SIP_REASON": {"type": "boolean"},
    "SIP_HEADER_P_ASSERTED_IDENTITY": {"type": "boolean"},
    "SIP_REDIRECT_HISTORY": {"type": "boolean"},
    "SIP_HEADER_REFERRED_BY": {"type": "boolean"},
    "SIP_SIPSNX_HEADER_P_RECORDING_TO": {"type": "boolean"},
    "HOLD": {"type": "boolean"},
    "SIP_HEADER_USER_AGENT": {"type": "boolean"},
    "SIP_PRIORITY": {"type": "boolean"},
    "SIP_HEADER_HISTORY_INFO": {"type": "boolean"},
    "SIP_ADDRESS": {"type": "boolean"},
    "SIP_SIPSNX_HEADER_P_RECORDING_TAPPED": {"type": "boolean"},
    "SIP_HEADER_P_CALLED_PARTY_ID": {"type": "boolean"},
    "DESTINATION_ADDRESS": {"type": "boolean"},
    "REDIRECT_HISTORY": {"type": "boolean"},
    "profile": {
      "type": "string",
      "enum": [
        "STANDARD",
        "FULL"
      ]
    },
    "ACTIVE_APPARENT_STATE": {"type": "boolean"},
    "MWI_REQUEST_SIP_DESTINATION_ADDRESS": {"type": "boolean"},
    "TRANSFERRER_ADDRESS": {"type": "boolean"},
    "SIP_HEADER_PRIORITY": {"type": "boolean"},
    "USER": {"type": "boolean"},
    "SIP_SIPSNX_HEADER_P_RECORDING_FROM": {"type": "boolean"},
    "SIP_ASSERTED_ADDRESS": {"type": "boolean"},
    "RINGING": {"type": "boolean"},
    "SIP_SIPSNX_HEADER_P_ACCESS_NETWORK_INFO": {"type": "boolean"},
    "MWI_RESPONSE_REASON": {"type": "boolean"},
    "SIP_HEADER_CALL_INFO": {"type": "boolean"},
    "END_REASON": {"type": "boolean"},
    "SIP_PRIVACY": {"type": "boolean"},
    "ADDRESS": {"type": "boolean"},
    "NOTIFY_SIP_INFO": {"type": "boolean"},
    "SIP_HEADER_DIVERSION": {"type": "boolean"},
    "ASSERTED_ADDRESS": {"type": "boolean"},
    "SIP_HEADER_SUBJECT": {"type": "boolean"},
    "PROCEEDING": {"type": "boolean"},
    "SIP_HEADER_REMOTE_PARTY_ID": {"type": "boolean"}
  }
}

26.70 ProvisioningUserAssociatedDevice

26.70.1 ProvisioningUserAssociatedDevice Field Description

  • aorUserName

    User part of the address-of-record from the SIP device that registers.

    Type: String

  • deviceId

    The MAC address of the device.

    Type: String

  • staticVariables

    Static variables for the use in device templates.

    Type: ProvisioningStaticVariableTable (section 26.76)

  • subId

    The sub ID can be used to select sub-devices that are all listed under the same MAC address.

    Type: String

26.70.2 ProvisioningUserAssociatedDevice JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "subId": {"type": "string"},
    "aorUserName": {"type": "string"},
    "staticVariables": {"$ref": "#/$defs/ProvisioningStaticVariableTable"},
    "deviceId": {"type": "string"}
  }
}

26.71 SipPolicyUserData

26.71.1 SipPolicyUserData Field Description

  • rewriteTableIncoming

    Dial string rewriting rules for incoming messages.

    Type: Array of DialStringRewrite (section 26.4)

  • rewriteTableOutgoing

    Dial string rewriting rules for outgoing messages.

    Type: Array of DialStringRewrite (section 26.4)

  • sippgIncoming

    SIP privacy settings for incoming messages.

    Type: SipPolicyPrivacyOptions (section 26.77)

  • sippgOutgoing

    SIP privacy settings for outgoing messages.

    Type: SipPolicyPrivacyOptions (section 26.77)

26.71.2 SipPolicyUserData JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "rewriteTableOutgoing": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    },
    "sippgIncoming": {"$ref": "#/$defs/SipPolicyPrivacyOptions"},
    "sippgOutgoing": {"$ref": "#/$defs/SipPolicyPrivacyOptions"},
    "rewriteTableIncoming": {
      "type": "array",
      "items": {"$ref": "#/$defs/DialStringRewrite"}
    }
  }
}

26.72 SipRegistrarUserData

26.72.1 SipRegistrarUserData Field Description

  • dialStrings

    SIP node registrar dial string settings.

    Type: Array of SipRegistrarUserDialStrings (section 26.78)

  • failover

    SIP node registrar failover settings.

    Type: SipRegistrarUserFailover (section 26.79)

26.72.2 SipRegistrarUserData JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "dialStrings": {
      "type": "array",
      "items": {"$ref": "#/$defs/SipRegistrarUserDialStrings"}
    },
    "failover": {"$ref": "#/$defs/SipRegistrarUserFailover"}
  }
}

26.73 WebRtcUserData

26.73.1 WebRtcUserData Field Description

  • address

    The address of the WebRTC user.

    Type: TelAddress (section 26.80)

  • credentials

    The credentials of the WebRTC user.

    Type: Credentials (section 26.24)

26.73.2 WebRtcUserData JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "address": {"$ref": "#/$defs/TelAddress"},
    "credentials": {"$ref": "#/$defs/Credentials"}
  }
}

26.74 MediaTranscodingOptions

26.74.1 MediaTranscodingOptions Field Description

  • displayName

    The name shown in the anynode Frontend.

    Type: String

  • id

    The id of this object.

    Type: String

26.74.2 MediaTranscodingOptions JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "displayName": {"type": "string"},
    "id": {"type": "string"}
  }
}

26.75 NotifySipInfoFilter

26.75.1 NotifySipInfoFilter Field Description

  • maxContentLength

    Type: Integer

  • mimeContentTypeName

    Type: String

26.75.2 NotifySipInfoFilter JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "maxContentLength": {"type": "integer"},
    "mimeContentTypeName": {"type": "string"}
  }
}

26.76 ProvisioningStaticVariableTable

This JSON object can contain any key value combination if the value is a string.

26.76.1 ProvisioningStaticVariableTable JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object"
}

26.77 SipPolicyPrivacyOptions

26.77.1 SipPolicyPrivacyOptions Field Description

  • enforce

    Enforced privacy functions.

    Type: Array of SipPrivacyServicesHeaderValue

    Possible values:

    • RFC3323_USER

      user (RFC 3323)

    • RFC3323_SESSION

      session (RFC 3323)

    • RFC3325_ID

      id (RFC 3325)

    • RFC7044_HISTORY

      history (RFC 7044)

  • include

    Privacy functions to be included.

    Type: Array of SipPrivacyServicesHeaderValue

    Possible values:

    • RFC3323_USER

      user (RFC 3323)

    • RFC3323_SESSION

      session (RFC 3323)

    • RFC3325_ID

      id (RFC 3325)

    • RFC7044_HISTORY

      history (RFC 7044)

  • passthrough

    Passed through privacy functions.

    Type: Array of SipPrivacyServicesHeaderValue

    Possible values:

    • RFC3323_USER

      user (RFC 3323)

    • RFC3323_SESSION

      session (RFC 3323)

    • RFC3325_ID

      id (RFC 3325)

    • RFC7044_HISTORY

      history (RFC 7044)

  • permit

    Allowed privacy functions when requested.

    Type: Array of SipPrivacyServicesHeaderValue

    Possible values:

    • RFC3323_USER

      user (RFC 3323)

    • RFC3323_SESSION

      session (RFC 3323)

    • RFC3325_ID

      id (RFC 3325)

    • RFC7044_HISTORY

      history (RFC 7044)

26.77.2 SipPolicyPrivacyOptions JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "include": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "RFC3323_USER",
          "RFC3323_SESSION",
          "RFC3325_ID",
          "RFC7044_HISTORY"
        ]
      }
    },
    "passthrough": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "RFC3323_USER",
          "RFC3323_SESSION",
          "RFC3325_ID",
          "RFC7044_HISTORY"
        ]
      }
    },
    "permit": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "RFC3323_USER",
          "RFC3323_SESSION",
          "RFC3325_ID",
          "RFC7044_HISTORY"
        ]
      }
    },
    "enforce": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "RFC3323_USER",
          "RFC3323_SESSION",
          "RFC3325_ID",
          "RFC7044_HISTORY"
        ]
      }
    }
  }
}

26.78 SipRegistrarUserDialStrings

26.78.1 SipRegistrarUserDialStrings Field Description

  • aorMatch

    Through this matching condition detemines the structure of the user part of the address-of-record of a registration.

    Type: TelMatch (section 26.48)

  • addresses

    The user can be reached at all of this dial strings.

    Type: Array of TelAddress (section 26.80)

  • matches

    The user can be reached at all dial strings that pass the filters in this list.

    Type: Array of TelMatch (section 26.48)

26.78.2 SipRegistrarUserDialStrings JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "addresses": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelAddress"}
    },
    "aorMatch": {"$ref": "#/$defs/TelMatch"},
    "matches": {
      "type": "array",
      "items": {"$ref": "#/$defs/TelMatch"}
    }
  }
}

26.79 SipRegistrarUserFailover

26.79.1 SipRegistrarUserFailover Field Description

  • groupIdentifier

    The group identifier can be used to group registrations (also from different users) into a failover group

    Type: String

  • statusCodes

    Apply failover if the previous call failed with one of the following SIP status codes. These status codes can be listed individually or as a range (e.g.: 486, 501-503).

    Type: String

26.79.2 SipRegistrarUserFailover JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "statusCodes": {"type": "string"},
    "groupIdentifier": {"type": "string"}
  }
}

26.80 TelAddress

26.80.1 TelAddress Field Description

  • dialString

    The dial string

    Type: String

  • displayName

    The display name

    Type: String

  • tagSet

    Type: Array of String

26.80.2 TelAddress JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "tagSet": {
      "type": "array",
      "items": {"type": "string"}
    },
    "displayName": {"type": "string"},
    "dialString": {"type": "string"}
  }
}