22 Request Routers

22.1 Get

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

Returns the configured request routers.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • requestRouter

    The identifier or display name of the request router object.

Response Body Structure

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

Example

GET http://127.0.0.1:13010/api/requestRouters/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "incomingEdgeSipTransportId": "8c694406-be56-4541-9f0c-430cbe7c046b",
  "routes": [{"transportConnectionId": "35a96d64-1b71-486b-bc6c-bd0ddd4c2ebf"}],
  "id": "a1e2bbee-b997-4248-a396-0c35a7f4a6bc",
  "outgoingEdgeSipTransportId": "8c694406-be56-4541-9f0c-430cbe7c046b"
}]

22.2 Add

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

Creates a new request router.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as RequestRouter JSON object. A description for its fields is at section 30.42.1. For the JSON schema refer to section 30.42.2.

Example

POST http://127.0.0.1:13010/api/requestRouters/add?version=0
HTTP Request Body
{
  "routingTargets": ["sip:localhost:5070"],
  "requestRouterName": "Request Router REST",
  "useLocalNode": false,
  "portOptions": {
    "tlsPort": 5071,
    "udpTcpPort": 5070,
    "tcpPortRange": {
      "lastPort": 12000,
      "firstPort": 9000
    },
    "udpPortRange": {
      "lastPort": 12000,
      "firstPort": 9000
    }
  },
  "networkControllerOptions": {
    "createNewNetworkController": true,
    "newNetworkControllerIpAddress": "127.0.0.1"
  }
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "Request Router REST",
  "id": "a1e2bbee-b997-4248-a396-0c35a7f4a6bc"
}

22.3 Set

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

Modifies a request router object.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • requestRouter

    The identifier or display name of the request router object.

Request Body Structure

The request body is structured as RequestRouter JSON object. A description for its fields is at section 30.42.1. For the JSON schema refer to section 30.42.2.

Example

POST http://127.0.0.1:13010/api/requestRouters/set?requestRouter=a1e2bbee-b997-4248-a396-0c35a7f4a6bc&version=0
HTTP Request Body
{
  "routes": [{
    "filter": {
      "rules": [{
        "operandA": "from",
        "operandB": "+49",
        "negate": true,
        "caseInsensitive": true
      }],
      "operator": "NAND"
    },
    "transportConnectionId": "d457fbaa-520c-4dbb-b94a-05ee3c513a87"
  }],
  "id": "a1e2bbee-b997-4248-a396-0c35a7f4a6bc"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{}

22.4 Remove

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

Deletes a request router object.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • requestRouter

    The identifier or display name of the request router object.

Example

DELETE http://127.0.0.1:13010/api/requestRouters/remove?requestRouter=a1e2bbee-b997-4248-a396-0c35a7f4a6bc&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{}