Skip to main content
DELETE
/
phone_numbers
/
{id}
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.phoneNumbers.delete('1293384261075731499');

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.phone_numbers.delete(
    "1293384261075731499",
)
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.PhoneNumbers.Delete(context.TODO(), "1293384261075731499")
	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.phonenumbers.PhoneNumberDeleteParams;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberDeleteResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        PhoneNumberDeleteResponse phoneNumber = client.phoneNumbers().delete("1293384261075731499");
    }
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

phone_number = telnyx.phone_numbers.delete("1293384261075731499")

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->phoneNumbers->delete('1293384261075731499');

  var_dump($phoneNumber);
} catch (APIException $e) {
  echo $e->getMessage();
}
telnyx phone-numbers delete \
  --api-key 'My API Key' \
  --id 1293384261075731499
curl --request DELETE \
  --url https://api.telnyx.com/v2/phone_numbers/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "1293384261075731499",
    "record_type": "phone_number",
    "phone_number": "+19705555098",
    "status": "deleted",
    "tags": [
      "tag_1",
      "tag_2"
    ],
    "external_pin": "1234",
    "connection_id": "1293384261075731499",
    "connection_name": "connection-name",
    "customer_reference": "customer-reference",
    "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
    "messaging_profile_name": "regional-customers",
    "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
    "emergency_enabled": true,
    "emergency_address_id": "1315261609962112019",
    "call_forwarding_enabled": true,
    "cnam_listing_enabled": true,
    "caller_id_name_enabled": true,
    "call_recording_enabled": true,
    "t38_fax_gateway_enabled": true,
    "phone_number_type": "local",
    "purchased_at": "2019-10-23T18:10:00.000Z",
    "created_at": "2019-10-23T18:10:00.000Z",
    "updated_at": "2019-10-24T18:10:00.000Z",
    "hd_voice_enabled": true,
    "deletion_lock_enabled": false,
    "activated_at": "2019-10-23T18:10:00.000Z"
  }
}
{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}
{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}
{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}
{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}
{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Identifies the resource.

Example:

"1293384261075731499"

Response

Successful response with details about a phone number.

data
object
Example:
{
  "id": "1293384261075731499",
  "record_type": "phone_number",
  "phone_number": "+19705555098",
  "status": "deleted",
  "tags": ["tag_1", "tag_2"],
  "external_pin": "1234",
  "connection_id": "1293384261075731499",
  "connection_name": "connection-name",
  "customer_reference": "customer-reference",
  "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
  "messaging_profile_name": "regional-customers",
  "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
  "emergency_enabled": true,
  "emergency_address_id": "1315261609962112019",
  "call_forwarding_enabled": true,
  "cnam_listing_enabled": true,
  "caller_id_name_enabled": true,
  "call_recording_enabled": true,
  "t38_fax_gateway_enabled": true,
  "phone_number_type": "local",
  "purchased_at": "2019-10-23T18:10:00.000Z",
  "created_at": "2019-10-23T18:10:00.000Z",
  "updated_at": "2019-10-24T18:10:00.000Z",
  "hd_voice_enabled": true,
  "deletion_lock_enabled": false,
  "activated_at": "2019-10-23T18:10:00.000Z"
}