Delete SIP trunk API

DELETE

trunk

trunks

{trunk_id}

cURL

curl --request DELETE \
  --url https://api.bolna.ai/trunk/trunks/{trunk_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.bolna.ai/trunk/trunks/{trunk_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bolna.ai/trunk/trunks/{trunk_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.bolna.ai/trunk/trunks/{trunk_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bolna.ai/trunk/trunks/{trunk_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3f2b8c1e-6d4a-4f7b-9e2c-1a5d7b9c0e21",
  "name": "Telnyx production",
  "description": "<string>",
  "preset": "telnyx",
  "is_active": true,
  "inbound_enabled": true,
  "outbound_enabled": true,
  "channels": 20,
  "default_inbound_agent_id": "<string>",
  "auth_username": "bolna-outbound",
  "transport": "udp",
  "codecs": "PCMU,PCMA",
  "outbound_leading_plus_enabled": true,
  "last_inbound_at": "2023-11-07T05:31:56Z",
  "last_outbound_at": "2023-11-07T05:31:56Z",
  "converted_from_byot_trunk_id": "<string>",
  "organization_id": "<string>",
  "sub_account_id": "<string>",
  "user_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_deleted": true,
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>"
}

{
  "detail": {
    "code": "number_taken",
    "message": "<string>"
  }
}

Deleting a trunk removes its gateways, carrier IPs and numbers with it. Inbound calls to its numbers are refused, and agents can no longer place calls from them. Add the numbers to another trunk to keep using them.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

trunk_id

string<uuid>

required

The trunk's id

Response

The deleted trunk

A SIP trunk's own settings.

string<uuid>

Unique trunk ID.

Example:

"3f2b8c1e-6d4a-4f7b-9e2c-1a5d7b9c0e21"

name

string

Display name.

Example:

"Telnyx production"

description

string | null

Free-text note for your own reference.

preset

enum<string> | null

The carrier the trunk was set up for.

Available options:

plivo,

telnyx,

twilio,

exotel,

vobiz,

vonage,

custom

Example:

"telnyx"

is_active

boolean

When false, the trunk takes no inbound calls and places no outbound calls.

inbound_enabled

boolean

Whether the trunk accepts inbound calls from its carrier IPs.

outbound_enabled

boolean

Whether outbound calls can be placed from the trunk's numbers.

channels

integer

Maximum concurrent calls on the trunk, inbound and outbound combined.

Example:

20

default_inbound_agent_id

string | null

Agent that answers inbound calls to any of the trunk's numbers that has no agent_id of its own.

auth_username

string | null

Username your carrier issued, sent when the carrier challenges an outbound call (SIP 401/407). The password is never returned.

Example:

"bolna-outbound"

transport

enum<string>

SIP transport used towards your carrier's gateways.

Available options:

udp,

tcp

codecs

string

Codecs offered to the carrier, comma-separated, in order of preference.

Example:

"PCMU,PCMA"

outbound_leading_plus_enabled

boolean

When true, the dialled number is sent to the carrier with a leading + (+12025550178); when false, as digits only (12025550178).

last_inbound_at

string<date-time> | null

When the trunk last took an inbound call, updated at most once a minute. null until the first one.

last_outbound_at

string<date-time> | null

When an outbound call was last placed through the trunk, updated at most once a minute. null until the first one.

converted_from_byot_trunk_id

string | null

The legacy SIP trunk this trunk was migrated from, when Bolna migrated it for you. null otherwise.

organization_id

string | null

The organisation that owns the trunk. null for an account outside an organisation.

sub_account_id

string | null

The sub-account the trunk was created under. null for an organisation-level trunk.

user_id

string | null

The owning user, for an account outside an organisation. null for an organisation's trunk.

created_at

string<date-time>

When the trunk was created.

updated_at

string<date-time>

When the trunk's settings last changed.

is_deleted

boolean

true only in the response to a delete.

deleted_at

string<date-time> | null

When the trunk was deleted.

cURL

curl --request DELETE \
  --url https://api.bolna.ai/trunk/trunks/{trunk_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.bolna.ai/trunk/trunks/{trunk_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.bolna.ai/trunk/trunks/{trunk_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.bolna.ai/trunk/trunks/{trunk_id}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.bolna.ai/trunk/trunks/{trunk_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "3f2b8c1e-6d4a-4f7b-9e2c-1a5d7b9c0e21",
  "name": "Telnyx production",
  "description": "<string>",
  "preset": "telnyx",
  "is_active": true,
  "inbound_enabled": true,
  "outbound_enabled": true,
  "channels": 20,
  "default_inbound_agent_id": "<string>",
  "auth_username": "bolna-outbound",
  "transport": "udp",
  "codecs": "PCMU,PCMA",
  "outbound_leading_plus_enabled": true,
  "last_inbound_at": "2023-11-07T05:31:56Z",
  "last_outbound_at": "2023-11-07T05:31:56Z",
  "converted_from_byot_trunk_id": "<string>",
  "organization_id": "<string>",
  "sub_account_id": "<string>",
  "user_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "is_deleted": true,
  "deleted_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>"
}

{
  "detail": {
    "code": "number_taken",
    "message": "<string>"
  }
}

Get started

Voice agents

Telephony

Workflows

Account

Legacy

Delete SIP trunk API

Authorizations

Path Parameters

Response