22 SIP Proxies

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.41.1. For the JSON schema refer to section 30.41.2.

Example

GET http://localhost:8888/api/requestRouters/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "secondarySideOptions": {
      "transportConnectionId": "38224d3d-628e-43de-93cc-e7382d5bec25",
      "sipTransportId": "dbb14a94-3e18-4316-88a5-1ad060ffa162"
    },
    "id": "20d1a1d2-661e-4b9a-92e2-b38a6008ed93",
    "primarySideOptions": {"sipTransportId": "dbb14a94-3e18-4316-88a5-1ad060ffa162"},
    "forwardingMode": "PRIMARY_TO_SECONDARY_EDGE"
  },
  {
    "secondarySideOptions": {
      "transportConnectionId": "852f0dd9-71aa-408b-a435-45beaf7d1802",
      "sipTransportId": "627d51aa-bee0-4a0a-845f-5d6d37010961"
    },
    "id": "7f192984-5b0b-453c-905e-a72419d33b8a",
    "primarySideOptions": {"sipTransportId": "627d51aa-bee0-4a0a-845f-5d6d37010961"},
    "forwardingMode": "PRIMARY_TO_SECONDARY_EDGE"
  }
]

22.2 Add

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

Creates a new request router.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    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.41.1. For the JSON schema refer to section 30.41.2.

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.41.1. For the JSON schema refer to section 30.41.2.

Example

POST http://localhost:8888/api/requestRouters/add?version=0
HTTP Request Body
{
  "routingTargets": ["sip:localhost:5070"],
  "hostname": "localhost",
  "requestRouterName": "Request Router REST Local Node",
  "useLocalNode": true,
  "localNodeId": "0cc93cf3-763f-408c-9ce8-9c101d413415",
  "portOptions": {
    "tlsPort": 5071,
    "udpTcpPort": 5070
  }
}
HTTP Response
HTTP/1.1 200 OK

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.41.1. For the JSON schema refer to section 30.41.2.

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.41.1. For the JSON schema refer to section 30.41.2.

Example

POST http://localhost:8888/api/requestRouters/set?requestRouter=5595c73f-b917-4c06-8282-f42611eff4f6&version=0
HTTP Request Body
{
  "secondarySideOptions": {
    "transportConnectionId": "12a97eaf-c499-46cc-ab69-7093dffff920",
    "sipTransportId": "d9754802-17cd-46f1-9228-1acebcd348df"
  },
  "id": "5595c73f-b917-4c06-8282-f42611eff4f6",
  "primarySideOptions": {"sipTransportId": "d9754802-17cd-46f1-9228-1acebcd348df"},
  "forwardingMode": "DISABLED"
}
HTTP Response
HTTP/1.1 200 OK

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.

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.41.1. For the JSON schema refer to section 30.41.2.

Example

DELETE http://localhost:8888/api/requestRouters/remove?requestRouter=5595c73f-b917-4c06-8282-f42611eff4f6&version=0
HTTP Response
HTTP/1.1 200 OK