Delete phone numbers from a project

DELETE /v1/agents/{agentId}/telephony/phone-numbers

Delete phone numbers from a project

cURL

curl --request DELETE \
  --url https://api.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "phoneNumbers": [
    "<string>"
  ]
}
'

import requests

url = "https://api.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers"

payload = { "phoneNumbers": ["<string>"] }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({phoneNumbers: ['<string>']})
};

fetch('https://api.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers', 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.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'phoneNumbers' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$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.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers"

	payload := strings.NewReader("{\n  \"phoneNumbers\": [\n    \"<string>\"\n  ]\n}")

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

	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.delete("https://api.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"phoneNumbers\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.us.poly.ai/v1/agents/{agentId}/telephony/phone-numbers")

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

request = Net::HTTP::Delete.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"phoneNumbers\": [\n    \"<string>\"\n  ]\n}"

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

200

{
  "deleted": [
    "<string>"
  ],
  "errors": [
    {
      "phoneNumber": "<string>",
      "error": "<string>"
    }
  ]
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

{
  "success": false,
  "error": "<string>",
  "error_id": "<string>",
  "error_code": "<string>",
  "error_message": "<string>",
  "data": "<unknown>"
}

Authorizations

X-API-KEY · string · header · required

Path Parameters

agentId · string · required

Body

application/json

Phone numbers to release in a single call.

Releases are processed independently; see the response for per-number results.

phoneNumbers · string[] · required

List of phone numbers to delete

Minimum array length: 1

Response

200

application/json

Successful response

Per-number results of a batch release — phone numbers that were successfully released, plus any that couldn't be and why.

deleted · string[] · required

Successfully deleted phone numbers

errors · object[]

Per-number errors (omitted when empty)

Show child attributes