Unassign Phone Number from Agent

Unassign a phone number from an agent’s call flow. This removes the assignment and automatically cleans up associated SIP trunking.

POST /v1/api/agents/{agentId}/release/{phoneNumberId}

Release Phone Number from Agent

cURL

curl --request POST \
  --url https://api.trillet.ai/v1/api/agents/{agentId}/release/{phoneNumberId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-workspace-id: <x-workspace-id>' \
  --data '
{
  "confirmation": true
}
'

import requests

url = "https://api.trillet.ai/v1/api/agents/{agentId}/release/{phoneNumberId}"

payload = { "confirmation": True }
headers = {
    "x-workspace-id": "<x-workspace-id>",
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-workspace-id': '<x-workspace-id>',
    'x-api-key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({confirmation: true})
};

fetch('https://api.trillet.ai/v1/api/agents/{agentId}/release/{phoneNumberId}', 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.trillet.ai/v1/api/agents/{agentId}/release/{phoneNumberId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'confirmation' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>",
    "x-workspace-id: <x-workspace-id>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.trillet.ai/v1/api/agents/{agentId}/release/{phoneNumberId}"

	payload := strings.NewReader("{\n  \"confirmation\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-workspace-id", "<x-workspace-id>")
	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.trillet.ai/v1/api/agents/{agentId}/release/{phoneNumberId}")
  .header("x-workspace-id", "<x-workspace-id>")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"confirmation\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.trillet.ai/v1/api/agents/{agentId}/release/{phoneNumberId}")

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

request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"confirmation\": true\n}"

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

{
  "status": "success",
  "message": "Call flow released from phone number successfully"
}

Path Parameters

agentId · string · required

The ID of the agent whose phone number will be released.

phoneNumberId · string · required

The ID of the phone number to release from the agent.

Headers

x-workspace-id · string · required

Workspace identifier for the API. Required to scope the release operation.

Request Body

confirmation · boolean

Are you sure you want to unbind this?

Response Fields

agent · object

The updated agent object after the phone number has been released.

Request Body

No request body is required for this endpoint.

{
  "status": "success",
  "message": "Call flow released from phone number successfully"
}