SIP Connection

GetSIPConnectionProductsList

GET https://api.opentact.org/rest/sip/connection/product

Get SIP connection products list

Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Content-Type

string

application/json

{
  "success": true,
  "payload": [
    {
      "created_on": "2020-10-28T12:11:25.634Z",
      "modified_on": "2020-10-28T12:11:25.634Z",
      "id": 0,
      "name": "string",
      "description": "string",
      "type": "public",
      "tech_prefix": 0,
      "rate_table_id": 0,
      "route_plan_id": 0
    }
  ]
}

Code Example

CreateSIPConnection

POST https://api.opentact.org/rest/sip/connection

Create a new SIP Connection

Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name
Type
Description

X.Auth-Token

string

JWT_TOKEN

Content-Type

string

application/json

Request Body

Name
Type
Description

name

string

[ 1 .. 255 ] characters A user-assigned name to help manage the application

subdomain

string

[ 3 .. 255 ] characters SIP domain name

ip

string

[ 7 .. 15 ] characters Remote SIP service IP

port

number

<double> [ 1024 .. 65535 ] Remote SIP service port

is_active

boolean

Default: "true"

product

integer

<int32> [ 1 .. 1024 ] SIP Connection Product ID

class4_ingress_trunk_settings

object

(ISIPConnectionTrunkSettingsNewParams)

class4_egress_trunk_stings

object

(ISIPConnectionTrunkSettingsNewParams)

outbound_voice_profile

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Outbound Voice Profile uuid

Code Example

ModifySIPConnnection

PATCH https://api.opentact.org/rest/sip/connection/{uuid}

Modify a SIP Connection

Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Content-Type

string

application/json

Request Body

Name
Type
Description

name

string

[ 1 .. 255 ] characters A user-assigned name to help manage the application

subdomain

string

[ 3 .. 255 ] characters SIP domain name

ip

string

[ 7 .. 15 ] characters Remote SIP service IP

port

number

<double> [ 1024 .. 65535 ] Remote SIP service port

is_active

boolean

Default: "true"

product

integer

<int32> [ 1 .. 1024 ] SIP Connection Product ID

class4_ingress_trunk_settings

object

(ISIPConnectionTrunkSettingsNewParams)

class4_egress_trunk_stings

object

(ISIPConnectionTrunkSettingsNewParams)

outbound_voice_profile

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$ Outbound Voice Profile uuid

Code Example

ListSIPConnections

GET https://api.opentact.org/rest/sip/connection

Get SIP connections List

Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Code Example

GetSIPConnectionProductsList

GET https://api.opentact.org/rest/sip/connection/product

Get SIP connection products list

Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Content-Type

string

application/json

Code Example

GetSIPConnectionByUUID

POST https://api.opentact.org/rest/sip/connection/{uuid}

Get extended SIP connection info.

Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Code Example

RemoveSIPConnectionByID

DELETE https://api.opentact.org/rest/sip/connection/{uuid}

Remove SIP connection.

Path Parameters

Name
Type
Description

uuid

string

^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Headers

Name
Type
Description

X-Auth-Token

string

JWT_TOKEN

Code Example

Last updated

Was this helpful?