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

200

{
  "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
    }
  ]
}

400

{
  "success": false,
  "message": "string",
  "status": 400
}

Code Example

cURL

curl -X GET "https://api.opentact.org/rest/sip/connection/product" \
-H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN'
);
$response = Requests::get('https://api.opentact.org/rest/sip/connection/product', $headers);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
}

response = requests.get('https://api.opentact.org/rest/sip/connection/product', headers=headers)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/product', {
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN'
    }
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://api.opentact.org/rest/sip/connection/product", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

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

201

{
  "name": "string",
  "subdomain": "string",
  "ip": "string",
  "port": 0,
  "is_active": true,
  "product": 0,
  "class4_ingress_trunk_settings": {
    "rpid_id_type": "None",
    "pdd": 0,
    "rpid": "Never",
    "ignore_early_media": true,
    "cli_type": "white",
    "pci": "Yes",
    "call_limit": 0,
    "t38": true,
    "billing_method": "by minutes",
    "ani_cap_limit": 0,
    "min_profit_value": 0,
    "rate_rounding": "Up",
    "account_id": "string",
    "ignore_early_no_sdp": true,
    "enfource_cid": true,
    "oli": "Yes",
    "codecs": [
      "string"
    ],
    "media_timeout": 0,
    "us_other": "other",
    "bypass_media": "Bypass Media",
    "trunk_type2": "Termination Traffic",
    "reg_gateway": [
      {
        "rofile_id": 0,
        "reg_srv_ip": "string",
        "username": "string",
        "reg_srv_port": 0,
        "password": "string",
        "expires": 0
      }
    ],
    "pass_through": "transparent",
    "dnis_cap_limit": 0,
    "min_duration": 0,
    "min_profit_type": "percentage",
    "dnis_cps_limit": 0,
    "reg_user": [
      {
        "password": "string",
        "profile_id": 0,
        "username": "string"
      }
    ],
    "service_type": "Self Service",
    "amount_per_port": 0,
    "rate_decimal": 0,
    "jurisdiction_use_dnis": "LRN",
    "paid": "Yes",
    "host_routing_strategy": "top-down",
    "rate_use_rpid": true,
    "ring_timeout": 0,
    "ignore_ring": true,
    "enable_global_404_blocking": true,
    "pass_lrn": 0,
    "rpid_screen": "None",
    "auth_type": "Authorized by Host Only",
    "ip": [
      {
        "fqdn": "string",
        "port": 0,
        "ip": "string",
        "addr_type": "ip"
      }
    ],
    "ani_cps_limit": 0,
    "cps_limit": 0,
    "max_duration": 0,
    "priv": "Yes",
    "rpid_party": "None",
    "rpid_privacy": "None",
    "transaction_fee_id": 0,
    "codes": [
      "string"
    ],
    "media_type": "Bypass Media",
    "div": "Yes",
    "prefixes": [
      {
        "tech_prefix": "string",
        "rate_table_id": 0,
        "product_id": 0,
        "routing_plan_id": 0,
        "code": "string",
        "code_cps": 0,
        "trunk_id": 0,
        "code_cap": 0
      }
    ],
    "display_name": true
  },
  "class4_egress_trunk_settings": {
    "rpid_id_type": "None",
    "pdd": 0,
    "rpid": "Never",
    "ignore_early_media": true,
    "cli_type": "white",
    "pci": "Yes",
    "call_limit": 0,
    "t38": true,
    "billing_method": "by minutes",
    "ani_cap_limit": 0,
    "min_profit_value": 0,
    "rate_rounding": "Up",
    "account_id": "string",
    "ignore_early_no_sdp": true,
    "enfource_cid": true,
    "oli": "Yes",
    "codecs": [
      "string"
    ],
    "media_timeout": 0,
    "us_other": "other",
    "bypass_media": "Bypass Media",
    "trunk_type2": "Termination Traffic",
    "reg_gateway": [
      {
        "rofile_id": 0,
        "reg_srv_ip": "string",
        "username": "string",
        "reg_srv_port": 0,
        "password": "string",
        "expires": 0
      }
    ],
    "pass_through": "transparent",
    "dnis_cap_limit": 0,
    "min_duration": 0,
    "min_profit_type": "percentage",
    "dnis_cps_limit": 0,
    "reg_user": [
      {
        "password": "string",
        "profile_id": 0,
        "username": "string"
      }
    ],
    "service_type": "Self Service",
    "amount_per_port": 0,
    "rate_decimal": 0,
    "jurisdiction_use_dnis": "LRN",
    "paid": "Yes",
    "host_routing_strategy": "top-down",
    "rate_use_rpid": true,
    "ring_timeout": 0,
    "ignore_ring": true,
    "enable_global_404_blocking": true,
    "pass_lrn": 0,
    "rpid_screen": "None",
    "auth_type": "Authorized by Host Only",
    "ip": [
      {
        "fqdn": "string",
        "port": 0,
        "ip": "string",
        "addr_type": "ip"
      }
    ],
    "ani_cps_limit": 0,
    "cps_limit": 0,
    "max_duration": 0,
    "priv": "Yes",
    "rpid_party": "None",
    "rpid_privacy": "None",
    "transaction_fee_id": 0,
    "codes": [
      "string"
    ],
    "media_type": "Bypass Media",
    "div": "Yes",
    "prefixes": [
      {
        "tech_prefix": "string",
        "rate_table_id": 0,
        "product_id": 0,
        "routing_plan_id": 0,
        "code": "string",
        "code_cps": 0,
        "trunk_id": 0,
        "code_cap": 0
      }
    ],
    "display_name": true
  },
  "outbound_voice_profile": "string"
}

401 Forbidden

{
  "success": false,
  "message": "string",
  "status": 0
}

404 SIP control App / Outbound voice profile / SIP connection product not found

{
  "success": false,
  "message": "string",
  "status": 0
}

Code Example

cURL

curl -X POST "https://api.opentact.org/rest/sip/connection" \
-H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" \
-H  "Content-Type: application/json" \
-d "{\"name\":\"string\",\"subdomain\":\"string\",\"ip\":\"string\",\"port\":0,\"is_active\":true,\"product\":0,\"class4_ingress_trunk_settings\":{\"rpid_id_type\":\"None\",\"pdd\":0,\"rpid\":\"Never\",\"ignore_early_media\":true,\"cli_type\":\"white\",\"pci\":\"Yes\",\"call_limit\":0,\"t38\":true,\"billing_method\":\"by minutes\",\"ani_cap_limit\":0,\"min_profit_value\":0,\"rate_rounding\":\"Up\",\"account_id\":\"string\",\"ignore_early_no_sdp\":true,\"enfource_cid\":true,\"oli\":\"Yes\",\"codecs\":[\"string\"],\"media_timeout\":0,\"us_other\":\"other\",\"bypass_media\":\"Bypass Media\",\"trunk_type2\":\"Termination Traffic\",\"reg_gateway\":[{\"rofile_id\":0,\"reg_srv_ip\":\"string\",\"username\":\"string\",\"reg_srv_port\":0,\"password\":\"string\",\"expires\":0}],\"pass_through\":\"transparent\",\"dnis_cap_limit\":0,\"min_duration\":0,\"min_profit_type\":\"percentage\",\"dnis_cps_limit\":0,\"reg_user\":[{\"password\":\"string\",\"profile_id\":0,\"username\":\"string\"}],\"service_type\":\"Self Service\",\"amount_per_port\":0,\"rate_decimal\":0,\"jurisdiction_use_dnis\":\"LRN\",\"paid\":\"Yes\",\"host_routing_strategy\":\"top-down\",\"rate_use_rpid\":true,\"ring_timeout\":0,\"ignore_ring\":true,\"enable_global_404_blocking\":true,\"pass_lrn\":0,\"rpid_screen\":\"None\",\"auth_type\":\"Authorized by Host Only\",\"ip\":[{\"fqdn\":\"string\",\"port\":0,\"ip\":\"string\",\"addr_type\":\"ip\"}],\"ani_cps_limit\":0,\"cps_limit\":0,\"max_duration\":0,\"priv\":\"Yes\",\"rpid_party\":\"None\",\"rpid_privacy\":\"None\",\"transaction_fee_id\":0,\"codes\":[\"string\"],\"media_type\":\"Bypass Media\",\"div\":\"Yes\",\"prefixes\":[{\"tech_prefix\":\"string\",\"rate_table_id\":0,\"product_id\":0,\"routing_plan_id\":0,\"code\":\"string\",\"code_cps\":0,\"trunk_id\":0,\"code_cap\":0}],\"display_name\":true},\"class4_egress_trunk_settings\":{\"rpid_id_type\":\"None\",\"pdd\":0,\"rpid\":\"Never\",\"ignore_early_media\":true,\"cli_type\":\"white\",\"pci\":\"Yes\",\"call_limit\":0,\"t38\":true,\"billing_method\":\"by minutes\",\"ani_cap_limit\":0,\"min_profit_value\":0,\"rate_rounding\":\"Up\",\"account_id\":\"string\",\"ignore_early_no_sdp\":true,\"enfource_cid\":true,\"oli\":\"Yes\",\"codecs\":[\"string\"],\"media_timeout\":0,\"us_other\":\"other\",\"bypass_media\":\"Bypass Media\",\"trunk_type2\":\"Termination Traffic\",\"reg_gateway\":[{\"rofile_id\":0,\"reg_srv_ip\":\"string\",\"username\":\"string\",\"reg_srv_port\":0,\"password\":\"string\",\"expires\":0}],\"pass_through\":\"transparent\",\"dnis_cap_limit\":0,\"min_duration\":0,\"min_profit_type\":\"percentage\",\"dnis_cps_limit\":0,\"reg_user\":[{\"password\":\"string\",\"profile_id\":0,\"username\":\"string\"}],\"service_type\":\"Self Service\",\"amount_per_port\":0,\"rate_decimal\":0,\"jurisdiction_use_dnis\":\"LRN\",\"paid\":\"Yes\",\"host_routing_strategy\":\"top-down\",\"rate_use_rpid\":true,\"ring_timeout\":0,\"ignore_ring\":true,\"enable_global_404_blocking\":true,\"pass_lrn\":0,\"rpid_screen\":\"None\",\"auth_type\":\"Authorized by Host Only\",\"ip\":[{\"fqdn\":\"string\",\"port\":0,\"ip\":\"string\",\"addr_type\":\"ip\"}],\"ani_cps_limit\":0,\"cps_limit\":0,\"max_duration\":0,\"priv\":\"Yes\",\"rpid_party\":\"None\",\"rpid_privacy\":\"None\",\"transaction_fee_id\":0,\"codes\":[\"string\"],\"media_type\":\"Bypass Media\",\"div\":\"Yes\",\"prefixes\":[{\"tech_prefix\":\"string\",\"rate_table_id\":0,\"product_id\":0,\"routing_plan_id\":0,\"code\":\"string\",\"code_cps\":0,\"trunk_id\":0,\"code_cap\":0}],\"display_name\":true},\"outbound_voice_profile\":\"string\"}"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN',
    'Content-Type' => 'application/json'
);
$data = '{"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"}';
$response = Requests::post('https://api.opentact.org/rest/sip/connection', $headers, $data);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
    'Content-Type': 'application/json',
}

data = '{"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"}'

response = requests.post('https://api.opentact.org/rest/sip/connection', headers=headers, data=data)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection', {
    method: 'POST',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"})
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"}`)
	req, err := http.NewRequest("POST", "https://api.opentact.org/rest/sip/connection", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	req.Header.Set("Content-Type", "application/json")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

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

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "is_active": true,
    "tech_prefix": 0,
    "product": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "id": 1,
      "name": "string",
      "description": "string",
      "type": "public",
      "tech_prefix": 1,
      "rate_table_id": 1,
      "route_plan_id": 1
    },
    "subdomain": "string",
    "ip": "string",
    "port": 0,
    "class4_ingress_trunk_id": 0,
    "class4_ingress_trunk_settings": {
      "name": "string",
      "rpid_id_type": "None",
      "pdd": 0,
      "rpid": "Never",
      "ignore_early_media": true,
      "cli_type": "white",
      "pci": "Yes",
      "call_limit": 0,
      "is_active": true,
      "t38": true,
      "billing_method": "by minutes",
      "ani_cap_limit": 0,
      "min_profit_value": 0,
      "rate_rounding": "Up",
      "account_id": "string",
      "ignore_early_no_sdp": true,
      "enfource_cid": true,
      "oli": "Yes",
      "codecs": [],
      "media_timeout": 0,
      "us_other": "other",
      "bypass_media": "Bypass Media",
      "trunk_type2": "Termination Traffic",
      "reg_gateway": [],
      "pass_through": "transparent",
      "dnis_cap_limit": 0,
      "min_duration": 0,
      "min_profit_type": "percentage",
      "dnis_cps_limit": 0,
      "reg_user": [],
      "service_type": "Self Service",
      "amount_per_port": 0,
      "rate_decimal": "6",
      "jurisdiction_use_dnis": "LRN",
      "paid": "Yes",
      "host_routing_strategy": "top-down",
      "rate_use_rpid": true,
      "ring_timeout": 0,
      "ignore_ring": true,
      "enable_global_404_blocking": true,
      "pass_lrn": 0,
      "rpid_screen": "None",
      "auth_type": "Authorized by Host Only",
      "ip": [],
      "ani_cps_limit": 0,
      "cps_limit": 0,
      "max_duration": 0,
      "rate_table_id": 0,
      "priv": "Yes",
      "rpid_party": "None",
      "rpid_privacy": "None",
      "transaction_fee_id": 0,
      "codes": [],
      "media_type": "Bypass Media",
      "div": "Yes",
      "prefixes": [],
      "display_name": true
    },
    "class4_ingress_resource_ip_id": 0,
    "class4_egress_trunk_id": 0,
    "class4_egress_trunk_settings": {
      "name": "string",
      "rpid_id_type": "None",
      "pdd": 0,
      "rpid": "Never",
      "ignore_early_media": true,
      "cli_type": "white",
      "pci": "Yes",
      "call_limit": 0,
      "is_active": true,
      "t38": true,
      "billing_method": "by minutes",
      "ani_cap_limit": 0,
      "min_profit_value": 0,
      "rate_rounding": "Up",
      "account_id": "string",
      "ignore_early_no_sdp": true,
      "enfource_cid": true,
      "oli": "Yes",
      "codecs": [],
      "media_timeout": 0,
      "us_other": "other",
      "bypass_media": "Bypass Media",
      "trunk_type2": "Termination Traffic",
      "reg_gateway": [],
      "pass_through": "transparent",
      "dnis_cap_limit": 0,
      "min_duration": 0,
      "min_profit_type": "percentage",
      "dnis_cps_limit": 0,
      "reg_user": [],
      "service_type": "Self Service",
      "amount_per_port": 0,
      "rate_decimal": "6",
      "jurisdiction_use_dnis": "LRN",
      "paid": "Yes",
      "host_routing_strategy": "top-down",
      "rate_use_rpid": true,
      "ring_timeout": 0,
      "ignore_ring": true,
      "enable_global_404_blocking": true,
      "pass_lrn": 0,
      "rpid_screen": "None",
      "auth_type": "Authorized by Host Only",
      "ip": [],
      "ani_cps_limit": 0,
      "cps_limit": 0,
      "max_duration": 0,
      "rate_table_id": 0,
      "priv": "Yes",
      "rpid_party": "None",
      "rpid_privacy": "None",
      "transaction_fee_id": 0,
      "codes": [],
      "media_type": "Bypass Media",
      "div": "Yes",
      "prefixes": [],
      "display_name": true
    },
    "class4_egress_resource_ip_id": 0,
    "class4_trunk_prefix_id": 0,
    "tnleases": [
      {}
    ],
    "sipusers": [
      {}
    ],
    "sip_user_invites": [
      {}
    ],
    "account": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "email": "string",
      "level": "ServiceAccount",
      "balance": 0,
      "class4_id": 0,
      "deleted_on": "2019-08-24T14:15:22Z",
      "time_zone": {},
      "users": [],
      "admin": {},
      "messaging_profile_default": {},
      "messaging_profiles": [],
      "addresses": []
    },
    "created_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "modified_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "outbound_voice_profile": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "channel_limit": 0,
      "max_rate": 0,
      "daily_spent_limit": 0,
      "record_calls": 0,
      "filemat": "mp3",
      "audio_track_type": 0,
      "account": {},
      "created_by": {},
      "modified_by": {},
      "sip_connections": [],
      "sip_control_apps": []
    }
  }
}

401

{
  "success": false,
  "message": "string",
  "status": 404
}

404

{
  "success": false,
  "message": "string",
  "status": 404
}

Code Example

cURL

curl -X PATCH "https://api.opentact.org/rest/sip/connection/{uuid}" -H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN" -H  "Content-Type: application/json" \
-d "{\"name\":\"string\",\"subdomain\":\"string\",\"ip\":\"string\",\"port\":0,\"is_active\":true,\"product\":0,\"class4_ingress_trunk_settings\":{\"rpid_id_type\":\"None\",\"pdd\":0,\"rpid\":\"Never\",\"ignore_early_media\":true,\"cli_type\":\"white\",\"pci\":\"Yes\",\"call_limit\":0,\"t38\":true,\"billing_method\":\"by minutes\",\"ani_cap_limit\":0,\"min_profit_value\":0,\"rate_rounding\":\"Up\",\"account_id\":\"string\",\"ignore_early_no_sdp\":true,\"enfource_cid\":true,\"oli\":\"Yes\",\"codecs\":[\"string\"],\"media_timeout\":0,\"us_other\":\"other\",\"bypass_media\":\"Bypass Media\",\"trunk_type2\":\"Termination Traffic\",\"reg_gateway\":[{\"rofile_id\":0,\"reg_srv_ip\":\"string\",\"username\":\"string\",\"reg_srv_port\":0,\"password\":\"string\",\"expires\":0}],\"pass_through\":\"transparent\",\"dnis_cap_limit\":0,\"min_duration\":0,\"min_profit_type\":\"percentage\",\"dnis_cps_limit\":0,\"reg_user\":[{\"password\":\"string\",\"profile_id\":0,\"username\":\"string\"}],\"service_type\":\"Self Service\",\"amount_per_port\":0,\"rate_decimal\":0,\"jurisdiction_use_dnis\":\"LRN\",\"paid\":\"Yes\",\"host_routing_strategy\":\"top-down\",\"rate_use_rpid\":true,\"ring_timeout\":0,\"ignore_ring\":true,\"enable_global_404_blocking\":true,\"pass_lrn\":0,\"rpid_screen\":\"None\",\"auth_type\":\"Authorized by Host Only\",\"ip\":[{\"fqdn\":\"string\",\"port\":0,\"ip\":\"string\",\"addr_type\":\"ip\"}],\"ani_cps_limit\":0,\"cps_limit\":0,\"max_duration\":0,\"priv\":\"Yes\",\"rpid_party\":\"None\",\"rpid_privacy\":\"None\",\"transaction_fee_id\":0,\"codes\":[\"string\"],\"media_type\":\"Bypass Media\",\"div\":\"Yes\",\"prefixes\":[{\"tech_prefix\":\"string\",\"rate_table_id\":0,\"product_id\":0,\"routing_plan_id\":0,\"code\":\"string\",\"code_cps\":0,\"trunk_id\":0,\"code_cap\":0}],\"display_name\":true},\"class4_egress_trunk_settings\":{\"rpid_id_type\":\"None\",\"pdd\":0,\"rpid\":\"Never\",\"ignore_early_media\":true,\"cli_type\":\"white\",\"pci\":\"Yes\",\"call_limit\":0,\"t38\":true,\"billing_method\":\"by minutes\",\"ani_cap_limit\":0,\"min_profit_value\":0,\"rate_rounding\":\"Up\",\"account_id\":\"string\",\"ignore_early_no_sdp\":true,\"enfource_cid\":true,\"oli\":\"Yes\",\"codecs\":[\"string\"],\"media_timeout\":0,\"us_other\":\"other\",\"bypass_media\":\"Bypass Media\",\"trunk_type2\":\"Termination Traffic\",\"reg_gateway\":[{\"rofile_id\":0,\"reg_srv_ip\":\"string\",\"username\":\"string\",\"reg_srv_port\":0,\"password\":\"string\",\"expires\":0}],\"pass_through\":\"transparent\",\"dnis_cap_limit\":0,\"min_duration\":0,\"min_profit_type\":\"percentage\",\"dnis_cps_limit\":0,\"reg_user\":[{\"password\":\"string\",\"profile_id\":0,\"username\":\"string\"}],\"service_type\":\"Self Service\",\"amount_per_port\":0,\"rate_decimal\":0,\"jurisdiction_use_dnis\":\"LRN\",\"paid\":\"Yes\",\"host_routing_strategy\":\"top-down\",\"rate_use_rpid\":true,\"ring_timeout\":0,\"ignore_ring\":true,\"enable_global_404_blocking\":true,\"pass_lrn\":0,\"rpid_screen\":\"None\",\"auth_type\":\"Authorized by Host Only\",\"ip\":[{\"fqdn\":\"string\",\"port\":0,\"ip\":\"string\",\"addr_type\":\"ip\"}],\"ani_cps_limit\":0,\"cps_limit\":0,\"max_duration\":0,\"priv\":\"Yes\",\"rpid_party\":\"None\",\"rpid_privacy\":\"None\",\"transaction_fee_id\":0,\"codes\":[\"string\"],\"media_type\":\"Bypass Media\",\"div\":\"Yes\",\"prefixes\":[{\"tech_prefix\":\"string\",\"rate_table_id\":0,\"product_id\":0,\"routing_plan_id\":0,\"code\":\"string\",\"code_cps\":0,\"trunk_id\":0,\"code_cap\":0}],\"display_name\":true},\"outbound_voice_profile\":\"string\"}"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN',
    'Content-Type' => 'application/json'
);
$data = '{"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"}';
$response = Requests::patch('https://api.opentact.org/rest/sip/connection/{uuid}', $headers, $data);

Python

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN',
    'Content-Type' => 'application/json'
);
$data = '{"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"}';
$response = Requests::patch('https://api.opentact.org/rest/sip/connection/{uuid}', $headers, $data);

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/{uuid}', {
    method: 'PATCH',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN',
        'Content-Type': 'application/json'
    },
    body: JSON.stringify({"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"})
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
	"strings"
)

func main() {
	client := &http.Client{}
	var data = strings.NewReader(`{"name":"string","subdomain":"string","ip":"string","port":0,"is_active":true,"product":0,"class4_ingress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"class4_egress_trunk_settings":{"rpid_id_type":"None","pdd":0,"rpid":"Never","ignore_early_media":true,"cli_type":"white","pci":"Yes","call_limit":0,"t38":true,"billing_method":"by minutes","ani_cap_limit":0,"min_profit_value":0,"rate_rounding":"Up","account_id":"string","ignore_early_no_sdp":true,"enfource_cid":true,"oli":"Yes","codecs":["string"],"media_timeout":0,"us_other":"other","bypass_media":"Bypass Media","trunk_type2":"Termination Traffic","reg_gateway":[{"rofile_id":0,"reg_srv_ip":"string","username":"string","reg_srv_port":0,"password":"string","expires":0}],"pass_through":"transparent","dnis_cap_limit":0,"min_duration":0,"min_profit_type":"percentage","dnis_cps_limit":0,"reg_user":[{"password":"string","profile_id":0,"username":"string"}],"service_type":"Self Service","amount_per_port":0,"rate_decimal":0,"jurisdiction_use_dnis":"LRN","paid":"Yes","host_routing_strategy":"top-down","rate_use_rpid":true,"ring_timeout":0,"ignore_ring":true,"enable_global_404_blocking":true,"pass_lrn":0,"rpid_screen":"None","auth_type":"Authorized by Host Only","ip":[{"fqdn":"string","port":0,"ip":"string","addr_type":"ip"}],"ani_cps_limit":0,"cps_limit":0,"max_duration":0,"priv":"Yes","rpid_party":"None","rpid_privacy":"None","transaction_fee_id":0,"codes":["string"],"media_type":"Bypass Media","div":"Yes","prefixes":[{"tech_prefix":"string","rate_table_id":0,"product_id":0,"routing_plan_id":0,"code":"string","code_cps":0,"trunk_id":0,"code_cap":0}],"display_name":true},"outbound_voice_profile":"string"}`)
	req, err := http.NewRequest("PATCH", "https://api.opentact.org/rest/sip/connection/{uuid}", data)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	req.Header.Set("Content-Type", "application/json")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

ListSIPConnections

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

Get SIP connections List

Headers

Name	Type	Description
X-Auth-Token	string	JWT_TOKEN

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "expired_on": "2019-08-24T14:15:22Z",
    "token": "string",
    "sip_connection": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "is_active": true,
      "tech_prefix": 0,
      "product": {},
      "subdomain": "string",
      "ip": "string",
      "port": 0,
      "class4_ingress_trunk_id": 0,
      "class4_ingress_trunk_settings": {},
      "class4_ingress_resource_ip_id": 0,
      "class4_egress_trunk_id": 0,
      "class4_egress_trunk_settings": {},
      "class4_egress_resource_ip_id": 0,
      "class4_trunk_prefix_id": 0,
      "tnleases": [],
      "sipusers": [],
      "sip_user_invites": [],
      "account": {},
      "created_by": {},
      "modified_by": {},
      "outbound_voice_profile": {}
    },
    "account": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "email": "string",
      "level": "ServiceAccount",
      "balance": 0,
      "class4_id": 0,
      "deleted_on": "2019-08-24T14:15:22Z",
      "time_zone": {},
      "users": [],
      "admin": {},
      "messaging_profile_default": {},
      "messaging_profiles": [],
      "addresses": []
    },
    "created_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "modified_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    }
  }
}

401

{
  "success": false,
  "message": "string",
  "status": 401
}

404

{
  "success": false,
  "message": "string",
  "status": 404
}

Code Example

cURL

curl -X GET "https://api.opentact.org/rest/sip/connection" \
-H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN'
);
$response = Requests::get('https://api.opentact.org/rest/sip/connection', $headers);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
}

response = requests.get('https://api.opentact.org/rest/sip/connection', headers=headers)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection', {
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN'
    }
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://api.opentact.org/rest/sip/connection", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

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

200

Code Example

cURL

PHP

Python

Javascript

Go

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

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "is_active": true,
    "tech_prefix": 0,
    "product": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "id": 1,
      "name": "string",
      "description": "string",
      "type": "public",
      "tech_prefix": 1,
      "rate_table_id": 1,
      "route_plan_id": 1
    },
    "subdomain": "string",
    "ip": "string",
    "port": 0,
    "class4_ingress_trunk_id": 0,
    "class4_ingress_trunk_settings": {
      "name": "string",
      "rpid_id_type": "None",
      "pdd": 0,
      "rpid": "Never",
      "ignore_early_media": true,
      "cli_type": "white",
      "pci": "Yes",
      "call_limit": 0,
      "is_active": true,
      "t38": true,
      "billing_method": "by minutes",
      "ani_cap_limit": 0,
      "min_profit_value": 0,
      "rate_rounding": "Up",
      "account_id": "string",
      "ignore_early_no_sdp": true,
      "enfource_cid": true,
      "oli": "Yes",
      "codecs": [],
      "media_timeout": 0,
      "us_other": "other",
      "bypass_media": "Bypass Media",
      "trunk_type2": "Termination Traffic",
      "reg_gateway": [],
      "pass_through": "transparent",
      "dnis_cap_limit": 0,
      "min_duration": 0,
      "min_profit_type": "percentage",
      "dnis_cps_limit": 0,
      "reg_user": [],
      "service_type": "Self Service",
      "amount_per_port": 0,
      "rate_decimal": "6",
      "jurisdiction_use_dnis": "LRN",
      "paid": "Yes",
      "host_routing_strategy": "top-down",
      "rate_use_rpid": true,
      "ring_timeout": 0,
      "ignore_ring": true,
      "enable_global_404_blocking": true,
      "pass_lrn": 0,
      "rpid_screen": "None",
      "auth_type": "Authorized by Host Only",
      "ip": [],
      "ani_cps_limit": 0,
      "cps_limit": 0,
      "max_duration": 0,
      "rate_table_id": 0,
      "priv": "Yes",
      "rpid_party": "None",
      "rpid_privacy": "None",
      "transaction_fee_id": 0,
      "codes": [],
      "media_type": "Bypass Media",
      "div": "Yes",
      "prefixes": [],
      "display_name": true
    },
    "class4_ingress_resource_ip_id": 0,
    "class4_egress_trunk_id": 0,
    "class4_egress_trunk_settings": {
      "name": "string",
      "rpid_id_type": "None",
      "pdd": 0,
      "rpid": "Never",
      "ignore_early_media": true,
      "cli_type": "white",
      "pci": "Yes",
      "call_limit": 0,
      "is_active": true,
      "t38": true,
      "billing_method": "by minutes",
      "ani_cap_limit": 0,
      "min_profit_value": 0,
      "rate_rounding": "Up",
      "account_id": "string",
      "ignore_early_no_sdp": true,
      "enfource_cid": true,
      "oli": "Yes",
      "codecs": [],
      "media_timeout": 0,
      "us_other": "other",
      "bypass_media": "Bypass Media",
      "trunk_type2": "Termination Traffic",
      "reg_gateway": [],
      "pass_through": "transparent",
      "dnis_cap_limit": 0,
      "min_duration": 0,
      "min_profit_type": "percentage",
      "dnis_cps_limit": 0,
      "reg_user": [],
      "service_type": "Self Service",
      "amount_per_port": 0,
      "rate_decimal": "6",
      "jurisdiction_use_dnis": "LRN",
      "paid": "Yes",
      "host_routing_strategy": "top-down",
      "rate_use_rpid": true,
      "ring_timeout": 0,
      "ignore_ring": true,
      "enable_global_404_blocking": true,
      "pass_lrn": 0,
      "rpid_screen": "None",
      "auth_type": "Authorized by Host Only",
      "ip": [],
      "ani_cps_limit": 0,
      "cps_limit": 0,
      "max_duration": 0,
      "rate_table_id": 0,
      "priv": "Yes",
      "rpid_party": "None",
      "rpid_privacy": "None",
      "transaction_fee_id": 0,
      "codes": [],
      "media_type": "Bypass Media",
      "div": "Yes",
      "prefixes": [],
      "display_name": true
    },
    "class4_egress_resource_ip_id": 0,
    "class4_trunk_prefix_id": 0,
    "tnleases": [
      {}
    ],
    "sipusers": [
      {}
    ],
    "sip_user_invites": [
      {}
    ],
    "account": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "email": "string",
      "level": "ServiceAccount",
      "balance": 0,
      "class4_id": 0,
      "deleted_on": "2019-08-24T14:15:22Z",
      "time_zone": {},
      "users": [],
      "admin": {},
      "messaging_profile_default": {},
      "messaging_profiles": [],
      "addresses": []
    },
    "created_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "modified_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "outbound_voice_profile": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "channel_limit": 0,
      "max_rate": 0,
      "daily_spent_limit": 0,
      "record_calls": 0,
      "filemat": "mp3",
      "audio_track_type": 0,
      "account": {},
      "created_by": {},
      "modified_by": {},
      "sip_connections": [],
      "sip_control_apps": []
    }
  }
}

404

{
  "success": false,
  "message": "string",
  "status": 404
}

Code Example

cURL

curl -X GET "https://api.opentact.org/rest/sip/connection/{uuid}" \
-H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN'
);
$response = Requests::get('https://api.opentact.org/rest/sip/connection/{uuid}', $headers);

Python

import requests

headers = {
    'accept': 'application/json',
    'X-Auth-Token': 'JWT_TOKEN',
}

response = requests.get('https://api.opentact.org/rest/sip/connection/%7Buuid%7D', headers=headers)

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/{uuid}', {
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN'
    }
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("GET", "https://api.opentact.org/rest/sip/connection/{uuid}", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}

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

200

{
  "success": true,
  "payload": {
    "created_on": "2019-08-24T14:15:22Z",
    "modified_on": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "name": "string",
    "is_active": true,
    "tech_prefix": 0,
    "product": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "id": 1,
      "name": "string",
      "description": "string",
      "type": "public",
      "tech_prefix": 1,
      "rate_table_id": 1,
      "route_plan_id": 1
    },
    "subdomain": "string",
    "ip": "string",
    "port": 0,
    "class4_ingress_trunk_id": 0,
    "class4_ingress_trunk_settings": {
      "name": "string",
      "rpid_id_type": "None",
      "pdd": 0,
      "rpid": "Never",
      "ignore_early_media": true,
      "cli_type": "white",
      "pci": "Yes",
      "call_limit": 0,
      "is_active": true,
      "t38": true,
      "billing_method": "by minutes",
      "ani_cap_limit": 0,
      "min_profit_value": 0,
      "rate_rounding": "Up",
      "account_id": "string",
      "ignore_early_no_sdp": true,
      "enfource_cid": true,
      "oli": "Yes",
      "codecs": [],
      "media_timeout": 0,
      "us_other": "other",
      "bypass_media": "Bypass Media",
      "trunk_type2": "Termination Traffic",
      "reg_gateway": [],
      "pass_through": "transparent",
      "dnis_cap_limit": 0,
      "min_duration": 0,
      "min_profit_type": "percentage",
      "dnis_cps_limit": 0,
      "reg_user": [],
      "service_type": "Self Service",
      "amount_per_port": 0,
      "rate_decimal": "6",
      "jurisdiction_use_dnis": "LRN",
      "paid": "Yes",
      "host_routing_strategy": "top-down",
      "rate_use_rpid": true,
      "ring_timeout": 0,
      "ignore_ring": true,
      "enable_global_404_blocking": true,
      "pass_lrn": 0,
      "rpid_screen": "None",
      "auth_type": "Authorized by Host Only",
      "ip": [],
      "ani_cps_limit": 0,
      "cps_limit": 0,
      "max_duration": 0,
      "rate_table_id": 0,
      "priv": "Yes",
      "rpid_party": "None",
      "rpid_privacy": "None",
      "transaction_fee_id": 0,
      "codes": [],
      "media_type": "Bypass Media",
      "div": "Yes",
      "prefixes": [],
      "display_name": true
    },
    "class4_ingress_resource_ip_id": 0,
    "class4_egress_trunk_id": 0,
    "class4_egress_trunk_settings": {
      "name": "string",
      "rpid_id_type": "None",
      "pdd": 0,
      "rpid": "Never",
      "ignore_early_media": true,
      "cli_type": "white",
      "pci": "Yes",
      "call_limit": 0,
      "is_active": true,
      "t38": true,
      "billing_method": "by minutes",
      "ani_cap_limit": 0,
      "min_profit_value": 0,
      "rate_rounding": "Up",
      "account_id": "string",
      "ignore_early_no_sdp": true,
      "enfource_cid": true,
      "oli": "Yes",
      "codecs": [],
      "media_timeout": 0,
      "us_other": "other",
      "bypass_media": "Bypass Media",
      "trunk_type2": "Termination Traffic",
      "reg_gateway": [],
      "pass_through": "transparent",
      "dnis_cap_limit": 0,
      "min_duration": 0,
      "min_profit_type": "percentage",
      "dnis_cps_limit": 0,
      "reg_user": [],
      "service_type": "Self Service",
      "amount_per_port": 0,
      "rate_decimal": "6",
      "jurisdiction_use_dnis": "LRN",
      "paid": "Yes",
      "host_routing_strategy": "top-down",
      "rate_use_rpid": true,
      "ring_timeout": 0,
      "ignore_ring": true,
      "enable_global_404_blocking": true,
      "pass_lrn": 0,
      "rpid_screen": "None",
      "auth_type": "Authorized by Host Only",
      "ip": [],
      "ani_cps_limit": 0,
      "cps_limit": 0,
      "max_duration": 0,
      "rate_table_id": 0,
      "priv": "Yes",
      "rpid_party": "None",
      "rpid_privacy": "None",
      "transaction_fee_id": 0,
      "codes": [],
      "media_type": "Bypass Media",
      "div": "Yes",
      "prefixes": [],
      "display_name": true
    },
    "class4_egress_resource_ip_id": 0,
    "class4_trunk_prefix_id": 0,
    "tnleases": [
      {}
    ],
    "sipusers": [
      {}
    ],
    "sip_user_invites": [
      {}
    ],
    "account": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "email": "string",
      "level": "ServiceAccount",
      "balance": 0,
      "class4_id": 0,
      "deleted_on": "2019-08-24T14:15:22Z",
      "time_zone": {},
      "users": [],
      "admin": {},
      "messaging_profile_default": {},
      "messaging_profiles": [],
      "addresses": []
    },
    "created_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "modified_by": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "email": "string",
      "password": "string",
      "phone_number": "string",
      "first_name": "string",
      "last_name": "string",
      "avatar": "string",
      "gender": "Agender",
      "dob": "2019-08-24T14:15:22Z",
      "role": "Admin",
      "gmail_user_id": "string",
      "facebook_user_id": "string",
      "apple_user_id": "string",
      "wechat_user_id": "string",
      "deleted_on": "2019-08-24T14:15:22Z",
      "token": "string",
      "account": {}
    },
    "outbound_voice_profile": {
      "created_on": "2019-08-24T14:15:22Z",
      "modified_on": "2019-08-24T14:15:22Z",
      "uuid": "string",
      "name": "string",
      "channel_limit": 0,
      "max_rate": 0,
      "daily_spent_limit": 0,
      "record_calls": 0,
      "filemat": "mp3",
      "audio_track_type": 0,
      "account": {},
      "created_by": {},
      "modified_by": {},
      "sip_connections": [],
      "sip_control_apps": []
    }
  }
}

404

{
  "success": false,
  "message": "string",
  "status": 404
}

Code Example

cURL

curl -X DELETE "https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7" \
-H  "accept: application/json" -H  "X-Auth-Token: JWT_TOKEN"

PHP

<?php
include('vendor/rmccue/requests/library/Requests.php');
Requests::register_autoloader();
$headers = array(
    'accept' => 'application/json',
    'X-Auth-Token' => 'JWT_TOKEN'
);
$response = Requests::delete('https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7', $headers);

Javascript

var fetch = require('node-fetch');

fetch('https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7', {
    method: 'DELETE',
    headers: {
        'accept': 'application/json',
        'X-Auth-Token': 'JWT_TOKEN'
    }
});

Go

package main

import (
	"fmt"
	"io/ioutil"
	"log"
	"net/http"
)

func main() {
	client := &http.Client{}
	req, err := http.NewRequest("DELETE", "https://api.opentact.org/rest/sip/connection/66eb0a8a-571e-41b1-8f50-4d97275cfab7", nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("accept", "application/json")
	req.Header.Set("X-Auth-Token", "JWT_TOKEN")
	resp, err := client.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	bodyText, err := ioutil.ReadAll(resp.Body)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%s\n", bodyText)
}