20 Transport Connections

20.1 Get Transport Connection

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

Returns detailed information about the selected transport connection.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The identifier or display name of the transport connection.

Response Body Structure

The response body is structured as StandardTransportConnection JSON object. A description for its fields is at section 32.35.1. For the JSON schema refer to section 32.35.2.

Example

GET http://127.0.0.1:8888/api/transportConnections/get?id=48bff71e-eae8-4f11-8296-41630dbf9261&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "proxy": {
    "iri": "sip:test.test",
    "options": true,
    "optionsNextHop": true,
    "omitInitialRouteSet": true,
    "flow": true
  },
  "authenticationEnabled": true,
  "credentials": {
    "authenticationProfileId": "df921e1f-a71b-4b25-a1fa-b07bb4fafc5b",
    "username": "user"
  },
  "displayName": "test_connection",
  "registration": {
    "sipDomain": "sip:sip.domain",
    "addressOfRecord": "sip:registration.aor"
  },
  "id": "48bff71e-eae8-4f11-8296-41630dbf9261",
  "type": "STANDARD",
  "sipNodeId": "f3955ba4-26fd-4191-b7ad-56db461c192e"
}

20.2 Create Standard Transport Connection

PUT https://<HOST>:<PORT>/api/transportConnections/addStandard?version=0

Creates a new standard transport connection.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • displayName

    The display name of the new transport connection.

Request Body Structure

The request body is structured as StandardTransportConnection JSON object. A description for its fields is at section 32.35.1. For the JSON schema refer to section 32.35.2.

Response Body Structure

The response body is structured as StandardTransportConnection JSON object. A description for its fields is at section 32.35.1. For the JSON schema refer to section 32.35.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/addStandard?displayName=test_connection&version=0
HTTP Request Body
{
  "proxy": {
    "iri": "sip:test.test",
    "options": true,
    "optionsNextHop": true,
    "omitInitialRouteSet": true,
    "flow": true
  },
  "authenticationEnabled": true,
  "credentials": {
    "password": "pw",
    "username": "user"
  },
  "registration": {
    "sipDomain": "sip:sip.domain",
    "addressOfRecord": "sip:registration.aor"
  }
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "proxy": {
    "iri": "sip:test.test",
    "options": true,
    "optionsNextHop": true,
    "omitInitialRouteSet": true,
    "flow": true
  },
  "authenticationEnabled": true,
  "credentials": {
    "authenticationProfileId": "df921e1f-a71b-4b25-a1fa-b07bb4fafc5b",
    "username": "user"
  },
  "displayName": "test_connection",
  "registration": {
    "sipDomain": "sip:sip.domain",
    "addressOfRecord": "sip:registration.aor"
  },
  "id": "48bff71e-eae8-4f11-8296-41630dbf9261",
  "type": "STANDARD"
}

20.3 Add Plain Transport Connection

PUT https://<HOST>:<PORT>/api/transportConnections/addPlain?version=0

Creates a new plain transport connection.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • displayName

    The display name of the new transport connection.

Request Body Structure

The request body is structured as PlainTransportConnection JSON object. A description for its fields is at section 32.36.1. For the JSON schema refer to section 32.36.2.

Response Body Structure

The response body is structured as PlainTransportConnection JSON object. A description for its fields is at section 32.36.1. For the JSON schema refer to section 32.36.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/addPlain?displayName=test&version=0
HTTP Request Body
{
  "transportErrorFlags": ["TERMINATE_INCOMING"],
  "assertedUri": {
    "iri": "sip:test",
    "displayName": "test"
  },
  "initialRouteSet": [{"iri": "sip:qwe"}],
  "statusCodesErrorFlags": [{
    "errorHandling": ["TERMINATE_INCOMING"],
    "statusCode": "501"
  }],
  "optionsErrorFlags": ["DOWN"],
  "uri": {
    "iri": "sip:iri",
    "displayName": "displayName"
  },
  "properties": ["FLOW"],
  "sipTransport": "ea384604-80cf-4906-82f2-c75f44094e0c",
  "timeoutErrorFlags": ["FAILOVER"],
  "authentication": {
    "password": "qwe",
    "username": "asd"
  }
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "transportErrorFlags": ["TERMINATE_INCOMING"],
  "displayName": "test",
  "initialRouteSet": [],
  "type": "PLAIN",
  "optionsErrorFlags": ["DOWN"],
  "uri": {
    "iri": "sip:iri",
    "displayName": "displayName"
  },
  "timeoutErrorFlags": ["TERMINATE_INCOMING"],
  "assertedUri": {
    "iri": "sip:test",
    "displayName": "test"
  },
  "statusCodesErrorFlags": [{
    "errorHandling": ["TERMINATE_INCOMING"],
    "statusCode": "501"
  }],
  "id": "c5e1355d-e644-4d01-b0e4-9d53d6fa266c",
  "properties": ["FLOW"],
  "sipTransport": "ea384604-80cf-4906-82f2-c75f44094e0c",
  "authentication": {
    "authenticationProfileId": "68e2ba2c-5349-4495-a2f9-1b06b14c2f1f",
    "username": "asd"
  }
}

20.4 Add Load Balancing Transport Connection

PUT https://<HOST>:<PORT>/api/transportConnections/addSipLoadBalancing?version=0

Create a new load balancing transport connection.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • displayName

    The display name of the new transport connection.

Request Body Structure

The request body is structured as SipLoadBalancingTransportConnection JSON object. A description for its fields is at section 32.37.1. For the JSON schema refer to section 32.37.2.

Response Body Structure

The response body is structured as SipLoadBalancingTransportConnection JSON object. A description for its fields is at section 32.37.1. For the JSON schema refer to section 32.37.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/addSipLoadBalancing?displayName=test%20Load%20Balancer&version=0
HTTP Request Body
{
  "targets": [{
    "routeId": "b1223e77-5844-403a-b263-e8088a8056ee",
    "defaultLoad": "HIGH",
    "targetIriFlags": [
      "USER_INFO",
      "USER_PARAMETER"
    ]
  }],
  "properties": [
    "FAILOVER",
    "SEQUENTIAL_FAILOVER",
    "REDIRECT_INVITE",
    "REDIRECT_NOTIFY",
    "REDIRECT_OPTIONS",
    "REDIRECT_REFER",
    "REDIRECT_REGISTER"
  ]
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "test Load Balancer",
  "id": "3f9927cf-9094-4f51-ae89-9c6690f93164",
  "type": "LOAD_BALANCING",
  "targets": [{
    "routeId": "b1223e77-5844-403a-b263-e8088a8056ee",
    "defaultLoad": "HIGH",
    "targetIriFlags": [
      "USER_INFO",
      "USER_PARAMETER"
    ]
  }],
  "properties": [
    "FAILOVER",
    "SEQUENTIAL_FAILOVER",
    "REDIRECT_INVITE",
    "REDIRECT_NOTIFY",
    "REDIRECT_OPTIONS",
    "REDIRECT_REFER",
    "REDIRECT_REGISTER"
  ]
}

20.5 Add SIP Registration As Transport Connection

PUT https://<HOST>:<PORT>/api/transportConnections/addSipRegistrar?version=0

Creates a new SIP registration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • displayName

    The display name of the new SIP registration.

Request Body Structure

The request body is structured as SipRegistrationAsTransportConnection JSON object. A description for its fields is at section 32.38.1. For the JSON schema refer to section 32.38.2.

Response Body Structure

The response body is structured as SipRegistrationAsTransportConnection JSON object. A description for its fields is at section 32.38.1. For the JSON schema refer to section 32.38.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/addSipRegistrar?displayName=test%20SIP%20reg&version=0
HTTP Request Body
{
  "innerTransportConnectionId": "b1223e77-5844-403a-b263-e8088a8056ee",
  "registrar": "sip:test",
  "assertedUri": {
    "iri": "sip:test",
    "displayName": "test"
  },
  "sipUserAgentStackId": "f115606a-be1f-4f60-8e1f-0c74e48d2bed",
  "authentication": {
    "password": "qwe",
    "username": "asd"
  },
  "aorUri": {
    "iri": "sip:aor",
    "displayName": "aorDn"
  }
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "innerTransportConnectionId": "b1223e77-5844-403a-b263-e8088a8056ee",
  "registrar": "sip:test",
  "displayName": "test SIP reg",
  "assertedUri": {
    "iri": "sip:test",
    "displayName": "test"
  },
  "id": "f488d05d-a84f-4613-907d-331420b1d097",
  "type": "SIP_REGISTRATION",
  "sipUserAgentStackId": "f115606a-be1f-4f60-8e1f-0c74e48d2bed",
  "authentication": {
    "authenticationProfileId": "1ca3ac46-b4c2-41d0-9e5b-a734f8dba4c1",
    "username": "asd"
  },
  "aorUri": {
    "iri": "sip:aor",
    "displayName": "aorDn"
  }
}

20.6 Add SRV Load Balancer

PUT https://<HOST>:<PORT>/api/transportConnections/addSrvLoadBalancer?version=0

Creates a new SRV Load Balancer.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • displayName

    The display name of the new transport connection.

Request Body Structure

The request body is structured as SrvLoadBalancer JSON object. A description for its fields is at section 32.39.1. For the JSON schema refer to section 32.39.2.

Response Body Structure

The response body is structured as SrvLoadBalancer JSON object. A description for its fields is at section 32.39.1. For the JSON schema refer to section 32.39.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/addSrvLoadBalancer?displayName=srv%20test&version=0
HTTP Request Body
{
  "domain": "qwe.asd",
  "transportProtocol": "TLS",
  "sipTransportId": "ea384604-80cf-4906-82f2-c75f44094e0c",
  "targetTemplateOptions": {
    "transportErrorFlags": ["TERMINATE_INCOMING"],
    "statusCodesErrorFlags": [{
      "errorHandling": ["TERMINATE_INCOMING"],
      "statusCode": "501"
    }],
    "optionsErrorFlags": ["DOWN"],
    "properties": ["FLOW"],
    "timeoutErrorFlags": ["FAILOVER"]
  }
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "displayName": "srv test",
  "domain": "qwe.asd",
  "transportProtocol": "TLS",
  "sipTransportId": "ea384604-80cf-4906-82f2-c75f44094e0c",
  "targetTemplateOptions": {
    "transportErrorFlags": ["TERMINATE_INCOMING"],
    "statusCodesErrorFlags": [{
      "errorHandling": ["TERMINATE_INCOMING"],
      "statusCode": "501"
    }],
    "optionsErrorFlags": ["DOWN"],
    "properties": ["FLOW"],
    "timeoutErrorFlags": ["TERMINATE_INCOMING"]
  },
  "id": "9146dd4a-eeab-4e32-9ce0-cd15fafeed9f",
  "type": "SRV_LOAD_BALANCER"
}

20.7 Remove Transport Connection

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

Removes a transport connection from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • transportConnection

    The id of the transport connection.

  • force

    If set to true the transport connection and it's referenced objects will be removed, even if it is referenced by other objects.

Example

DELETE http://127.0.0.1:8888/api/transportConnections/remove?transportConnection=9146dd4a-eeab-4e32-9ce0-cd15fafeed9f&force=true&version=0
HTTP Response
HTTP/1.1 200 OK

20.8 Get Authentication

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

Returns the authentication configuration of the requested transport connection.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • transportConnection

    The id of the Transport Connection..

Response Body Structure

The response body is structured as SipCredentials JSON object. A description for its fields is at section 32.40.1. For the JSON schema refer to section 32.40.2.

Example

GET http://127.0.0.1:8888/api/transportConnections/authentication/get?transportConnection=48bff71e-eae8-4f11-8296-41630dbf9261&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "authenticationProfileId": "df921e1f-a71b-4b25-a1fa-b07bb4fafc5b",
  "username": "user"
}

20.9 Set Authentication

PUT https://<HOST>:<PORT>/api/transportConnections/authentication/set?version=0

Modifies the username and password of the selected transport connection.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • transportConnection

    The id of the transport connection.

Request Body Structure

The request body is structured as Credentials JSON object. A description for its fields is at section 32.41.1. For the JSON schema refer to section 32.41.2.

Response Body Structure

The response body is structured as SipCredentials JSON object. A description for its fields is at section 32.40.1. For the JSON schema refer to section 32.40.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/authentication/set?transportConnection=48bff71e-eae8-4f11-8296-41630dbf9261&version=0
HTTP Request Body
{
  "password": "pw",
  "username": "user"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "authenticationProfileId": "df921e1f-a71b-4b25-a1fa-b07bb4fafc5b",
  "username": "user"
}

20.10 Get Asserted URI

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

Returns the asserted URI of the selected transport connection.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • transportConnection

    The id of the transport connection.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 32.42.1. For the JSON schema refer to section 32.42.2.

Example

GET http://127.0.0.1:8888/api/transportConnections/assertedUri/get?transportConnection=48bff71e-eae8-4f11-8296-41630dbf9261&version=0
HTTP Response
HTTP/1.1 200 OK

20.11 Set Asserted URI

PUT https://<HOST>:<PORT>/api/transportConnections/assertedUri/set?version=0

Modifies the asserted URI of the selected transport connection.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • transportConnection

    The id of the transport connection

Request Body Structure

The request body is structured as AssertedUri JSON object. A description for its fields is at section 32.42.1. For the JSON schema refer to section 32.42.2.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 32.42.1. For the JSON schema refer to section 32.42.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/assertedUri/set?transportConnection=48bff71e-eae8-4f11-8296-41630dbf9261&version=0
HTTP Request Body
{
  "iri": "sip:asserted.uri",
  "displayName": "display.name"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "iri": "sip:asserted.uri",
  "displayName": "display.name"
}

20.12 Get Address of Record

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

Returns the Address of Record for the selected transport connection

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • transportConnection

    The id of the transport connection.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 32.42.1. For the JSON schema refer to section 32.42.2.

Example

GET http://127.0.0.1:8888/api/transportConnections/addressOfRecord/get?transportConnection=48bff71e-eae8-4f11-8296-41630dbf9261&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"iri": "sip:registration.aor"}

20.13 Set Address of Record

PUT https://<HOST>:<PORT>/api/transportConnections/addressOfRecord/set?version=0

Modifies the transport connection of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • transportConnection

    The id of the transport connection.

Request Body Structure

The request body is structured as AssertedUri JSON object. A description for its fields is at section 32.42.1. For the JSON schema refer to section 32.42.2.

Response Body Structure

The response body is structured as AssertedUri JSON object. A description for its fields is at section 32.42.1. For the JSON schema refer to section 32.42.2.

Example

PUT http://127.0.0.1:8888/api/transportConnections/addressOfRecord/set?transportConnection=48bff71e-eae8-4f11-8296-41630dbf9261&version=0
HTTP Request Body
{
  "iri": "sip:aor",
  "displayName": "display.name"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{"iri": "sip:aor"}