25 Routing Forward Profiles

25.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 32.104.1. For the JSON schema refer to section 32.104.2.

Example

GET http://127.0.0.1:8888/api/routingForwardProfiles/get?completeData=false&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[]

25.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 AddRoutingForwardProfileOptions JSON object. A description for its fields is at section 32.51.1. For the JSON schema refer to section 32.51.2.

Response Body Structure

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

Example

POST http://127.0.0.1:8888/api/routingForwardProfiles/add?version=0
HTTP Request Body
{
  "signalingForwardingFromCallingToCalled": {"ADDRESS": true},
  "signalingForwardingFromCalledToCalling": {"ACTIVE_APPARENT_STATE": true},
  "announcementIncoming": true,
  "displayName": "test_domain",
  "removeAnynodeFromSignalingPath": true,
  "earlyMediaPassThrough": true,
  "announcementOutgoing": true
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "telephonyForwardingStack": {
    "signalingForwardingFromCallingToCalled": {
      "notifySipInfoFilters": [],
      "ADDRESS": true,
      "profile": "STANDARD"
    },
    "signalingForwardingFromCalledToCalling": {
      "notifySipInfoFilters": [],
      "profile": "STANDARD",
      "ACTIVE_APPARENT_STATE": true
    },
    "displayName": "test_domain",
    "mediaNegotiationForwarder": {
      "mediaMode": "TRANSCODING",
      "displayName": "test_domain",
      "mediaTranscodingOptionsId": "5d69b48b-8c41-4aff-89c4-22eb75dbbcc4",
      "id": "44927101-d4c6-472a-9e10-9bfe2ea0de1d"
    },
    "id": "2d8638e1-338a-4445-8410-355b9724cf5b"
  },
  "announcementIncoming": true,
  "displayName": "test_domain",
  "removeAnynodeFromSignalingPath": true,
  "id": "a7d11877-3668-4e54-8cf0-497d30a36b67",
  "earlyMediaPassThrough": true,
  "announcementOutgoing": true
}