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