21 Routing Domains

21.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 27.36.1. For the JSON schema refer to section 27.36.2.

Example

GET http://127.0.0.1:8110/api/routingDomains/get?version=0
HTTP Response Body
[{
  "pathReplacementRoutes": [],
  "sourceNodeIds": ["9a157527-6c32-4800-8f85-88c961415774"],
  "routes": [],
  "displayName": "test_domain",
  "id": "a3fc8ac9-8cac-4ec5-8f80-f349cd968aef"
}]

21.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 27.35.1. For the JSON schema refer to section 27.35.2.

Response Body Structure

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

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"
}

21.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 27.35.1. For the JSON schema refer to section 27.35.2.

Response Body Structure

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

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"
}

21.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

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 GetRoutingDomainOptions JSON objects. A description for its fields is at section 27.36.1. For the JSON schema refer to section 27.36.2.

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

21.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 27.37.1. For the JSON schema refer to section 27.37.2.

Example

GET http://127.0.0.1:8110/api/routingDomains/routes/get?routingDomain=a3fc8ac9-8cac-4ec5-8f80-f349cd968aef&version=0
HTTP Response Body
[{
  "displayName": "test_route",
  "establishment": {
    "routingForwardProfileId": "cc850eaf-d9ed-4b7b-a7c6-7062500c9ec0",
    "destinationNodeId": "9a157527-6c32-4800-8f85-88c961415774",
    "action": "ACCEPT"
  },
  "filters": [{"sourceNodeIds": ["9a157527-6c32-4800-8f85-88c961415774"]}],
  "enabled": true
}]

21.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 27.37.1. For the JSON schema refer to section 27.37.2.

Response Body Structure

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

Example

POST http://127.0.0.1:8110/api/routingDomains/routes/add?mode=establishment&routingDomain=a3fc8ac9-8cac-4ec5-8f80-f349cd968aef&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": "9a157527-6c32-4800-8f85-88c961415774",
    "adjustRoutingForwardProfileSettings": true,
    "skipIfNodeNotOperational": true,
    "routingForwardProfileMode": "BYPASS",
    "routingForwardProfileSelection": "CREATE_NEW",
    "type": "ROUTE"
  },
  "filters": [{
    "sourceNodeIds": ["9a157527-6c32-4800-8f85-88c961415774"],
    "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 Body
{
  "displayName": "test_route",
  "establishment": {
    "routingForwardProfileId": "cc850eaf-d9ed-4b7b-a7c6-7062500c9ec0",
    "destinationNodeId": "9a157527-6c32-4800-8f85-88c961415774",
    "action": "ACCEPT"
  },
  "filters": [{"sourceNodeIds": ["9a157527-6c32-4800-8f85-88c961415774"]}],
  "enabled": true
}

21.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 27.37.1. For the JSON schema refer to section 27.37.2.

Example

POST http://127.0.0.1:8110/api/routingDomains/routes/clone?mode=establishment&routingDomain=a3fc8ac9-8cac-4ec5-8f80-f349cd968aef&displayName=test_route_edited&version=0
HTTP Response Body
{
  "displayName": "Copy of test_route_edited",
  "establishment": {
    "routingForwardProfileId": "4e0907aa-09c8-440b-b89a-ace1078e3361",
    "destinationNodeId": "d46272a8-6662-4076-ba09-6fb130e5941a",
    "action": "ACCEPT"
  },
  "id": "D3C098A77463C14E06A75D591E0F0543",
  "filters": [{"sourceNodeIds": ["d46272a8-6662-4076-ba09-6fb130e5941a"]}],
  "enabled": true
}

21.8 Set Route

POST https://<HOST>:<PORT>/api/routingDomains/routes/set?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 27.37.1. For the JSON schema refer to section 27.37.2.

Response Body Structure

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

Example

POST http://127.0.0.1:8110/api/routingDomains/routes/set?mode=establishment&routingDomain=a3fc8ac9-8cac-4ec5-8f80-f349cd968aef&index=0&version=0
HTTP Request Body
{
  "useUnconditionalRouting": false,
  "displayName": "test_route_edited",
  "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": "d46272a8-6662-4076-ba09-6fb130e5941a",
    "adjustRoutingForwardProfileSettings": true,
    "skipIfNodeNotOperational": true,
    "routingForwardProfileMode": "BYPASS",
    "routingForwardProfileSelection": "CREATE_NEW",
    "type": "ROUTE"
  },
  "filters": [{
    "sourceNodeIds": ["d46272a8-6662-4076-ba09-6fb130e5941a"],
    "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 Body
{
  "displayName": "test_route_edited",
  "establishment": {
    "routingForwardProfileId": "4e0907aa-09c8-440b-b89a-ace1078e3361",
    "destinationNodeId": "d46272a8-6662-4076-ba09-6fb130e5941a",
    "action": "ACCEPT"
  },
  "filters": [{"sourceNodeIds": ["d46272a8-6662-4076-ba09-6fb130e5941a"]}],
  "enabled": true
}

21.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 27.37.1. For the JSON schema refer to section 27.37.2.

Example

DELETE http://127.0.0.1:8110/api/routingDomains/routes/remove?mode=establishment&routingDomain=a3fc8ac9-8cac-4ec5-8f80-f349cd968aef&displayName=test_route_edited&version=0
HTTP Response Body
[{
  "displayName": "Copy of test_route_edited",
  "establishment": {
    "routingForwardProfileId": "4e0907aa-09c8-440b-b89a-ace1078e3361",
    "destinationNodeId": "d46272a8-6662-4076-ba09-6fb130e5941a",
    "action": "ACCEPT"
  },
  "id": "D3C098A77463C14E06A75D591E0F0543",
  "filters": [{"sourceNodeIds": ["d46272a8-6662-4076-ba09-6fb130e5941a"]}],
  "enabled": true
}]

21.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.

Example

GET http://127.0.0.1:8110/api/routingDomains/sourceNodes/get?routingDomain=8bac587c-d956-47f7-b6a3-993e10e5f3ff&version=0
HTTP Response Body
["d46272a8-6662-4076-ba09-6fb130e5941a"]

21.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 must 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 27.74.1. For the JSON schema refer to section 27.74.2.

Example

POST http://127.0.0.1:8110/api/routingDomains/sourceNodes/add?routingDomain=8bac587c-d956-47f7-b6a3-993e10e5f3ff&version=1
HTTP Request Body
["d46272a8-6662-4076-ba09-6fb130e5941a"]
HTTP Response Body
["d46272a8-6662-4076-ba09-6fb130e5941a"]

21.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.

Request Body Structure

The body must be a list of the node object ids that should replace 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 27.74.1. For the JSON schema refer to section 27.74.2.

Example

POST http://127.0.0.1:8110/api/routingDomains/sourceNodes/set?routingDomain=8bac587c-d956-47f7-b6a3-993e10e5f3ff&version=0
HTTP Request Body
["9a157527-6c32-4800-8f85-88c961415774"]
HTTP Response Body
Set source nodes.

21.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.

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

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
[]

21.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.

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

21.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.

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

21.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.

Example

POST http://127.0.0.1:8110/api/routingDomains/proceedingSignal/disable?routingDomain=8bac587c-d956-47f7-b6a3-993e10e5f3ff&version=0

21.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.

Example

GET http://127.0.0.1:8110/api/routingDomains/routeInMaintenance/get?routingDomain=8bac587c-d956-47f7-b6a3-993e10e5f3ff&version=0
HTTP Response Body
disabled

21.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.

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

21.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.

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