Remove phone numbers from a DIR
Deregister phone numbers from a DIR. The enterprise is resolved server-side from the DIR id. Returns a partial-success envelope.
DELETE
/
dir
/
{dir_id}
/
phone_numbers
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const phoneNumber = await client.dir.phoneNumbers.remove('16635d38-75a6-4481-82e8-69af60e05011', {
phone_numbers: ['+19493253498'],
});
console.log(phoneNumber.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
phone_number = client.dir.phone_numbers.remove(
dir_id="16635d38-75a6-4481-82e8-69af60e05011",
phone_numbers=["+19493253498"],
)
print(phone_number.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
phoneNumber, err := client.Dir.PhoneNumbers.Remove(
context.TODO(),
"16635d38-75a6-4481-82e8-69af60e05011",
telnyx.DirPhoneNumberRemoveParams{
PhoneNumbers: []string{"+19493253498"},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", phoneNumber.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.phonenumbers.PhoneNumberRemoveParams;
import com.telnyx.sdk.models.dir.phonenumbers.PhoneNumberRemoveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
PhoneNumberRemoveParams params = PhoneNumberRemoveParams.builder()
.dirId("16635d38-75a6-4481-82e8-69af60e05011")
.addPhoneNumber("+19493253498")
.build();
PhoneNumberRemoveResponse phoneNumber = client.dir().phoneNumbers().remove(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
phone_number = telnyx.dir.phone_numbers.remove("16635d38-75a6-4481-82e8-69af60e05011", phone_numbers: ["+19493253498"])
puts(phone_number)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$phoneNumber = $client->dir->phoneNumbers->remove(
'16635d38-75a6-4481-82e8-69af60e05011', phoneNumbers: ['+19493253498']
);
var_dump($phoneNumber);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx dir:phone-numbers remove \
--api-key 'My API Key' \
--dir-id 16635d38-75a6-4481-82e8-69af60e05011 \
--phone-number "'+19493253498'"curl --request DELETE \
--url https://api.telnyx.com/v2/dir/{dir_id}/phone_numbers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_numbers": [
"+19493253498"
]
}
'{
"data": [
"+19493253498"
],
"meta": {
"errors": [
{
"phone_number": "+19493253498",
"code": "not_associated",
"title": "Phone number not associated",
"detail": "Phone number not associated with this DIR."
}
]
}
}Authorizations
Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
Path Parameters
The DIR id. Lowercase UUID.
Example:
"16635d38-75a6-4481-82e8-69af60e05011"
Body
application/json
Required array length:
1 - 100 elementsResponse
Bulk-delete response. Inspect both deleted and errors.
Bulk-delete partial-success response. data is the list of phone numbers that were soft-deleted. meta.errors holds per-number failures (e.g. number not associated with this DIR). When EVERY number in the request fails, the endpoint instead returns 400 with the canonical Telnyx error envelope and data/meta are absent.
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const phoneNumber = await client.dir.phoneNumbers.remove('16635d38-75a6-4481-82e8-69af60e05011', {
phone_numbers: ['+19493253498'],
});
console.log(phoneNumber.data);import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
phone_number = client.dir.phone_numbers.remove(
dir_id="16635d38-75a6-4481-82e8-69af60e05011",
phone_numbers=["+19493253498"],
)
print(phone_number.data)
package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
phoneNumber, err := client.Dir.PhoneNumbers.Remove(
context.TODO(),
"16635d38-75a6-4481-82e8-69af60e05011",
telnyx.DirPhoneNumberRemoveParams{
PhoneNumbers: []string{"+19493253498"},
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", phoneNumber.Data)
}
package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.dir.phonenumbers.PhoneNumberRemoveParams;
import com.telnyx.sdk.models.dir.phonenumbers.PhoneNumberRemoveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
PhoneNumberRemoveParams params = PhoneNumberRemoveParams.builder()
.dirId("16635d38-75a6-4481-82e8-69af60e05011")
.addPhoneNumber("+19493253498")
.build();
PhoneNumberRemoveResponse phoneNumber = client.dir().phoneNumbers().remove(params);
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
phone_number = telnyx.dir.phone_numbers.remove("16635d38-75a6-4481-82e8-69af60e05011", phone_numbers: ["+19493253498"])
puts(phone_number)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$phoneNumber = $client->dir->phoneNumbers->remove(
'16635d38-75a6-4481-82e8-69af60e05011', phoneNumbers: ['+19493253498']
);
var_dump($phoneNumber);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx dir:phone-numbers remove \
--api-key 'My API Key' \
--dir-id 16635d38-75a6-4481-82e8-69af60e05011 \
--phone-number "'+19493253498'"curl --request DELETE \
--url https://api.telnyx.com/v2/dir/{dir_id}/phone_numbers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone_numbers": [
"+19493253498"
]
}
'{
"data": [
"+19493253498"
],
"meta": {
"errors": [
{
"phone_number": "+19493253498",
"code": "not_associated",
"title": "Phone number not associated",
"detail": "Phone number not associated with this DIR."
}
]
}
}