Skip to main content

Update a phone number

PATCH 
/phone_numbers/:id

Update a phone number

Request ​

Path Parameters

    id int64required

    Identifies the resource.

Body

required

Updated settings for the phone number.

    tags string[]

    A list of user-assigned tags to help organize phone numbers.

    external_pin string

    If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, we will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.

    hd_voice_enabled boolean

    Indicates whether HD voice is enabled for this number.

    customer_reference string

    A customer reference string for customer look ups.

    connection_id string

    Identifies the connection associated with the phone number.

    billing_group_id string

    Identifies the billing group associated with the phone number.

    number_level_routing string

    Possible values: [disabled]

    Default value: enabled

    Deprecated field, the only value for this is 'disabled'. All routing for numbers should be configured via connection settings.

Responses ​

200: Successful response with details about a phone number.

Schema

    data

    object

    id int64

    Identifies the resource.

    record_type string

    Identifies the type of the resource.

    phone_number string

    The +E.164-formatted phone number associated with this record.

    status string

    Possible values: [purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending]

    The phone number's current status.

    tags string[]

    A list of user-assigned tags to help manage the phone number.

    external_pin string

    If someone attempts to port your phone number away from Telnyx and your phone number has an external PIN set, Telnyx will attempt to verify that you provided the correct external PIN to the winning carrier. Note that not all carriers cooperate with this security mechanism.

    connection_name string

    The user-assigned name of the connection to be associated with this phone number.

    connection_id string

    Identifies the connection associated with the phone number.

    customer_reference string

    A customer reference string for customer look ups.

    messaging_profile_id string

    Identifies the messaging profile associated with the phone number.

    messaging_profile_name string

    The name of the messaging profile associated with the phone number.

    billing_group_id string

    Identifies the billing group associated with the phone number.

    emergency_enabled boolean

    Indicates whether emergency services are enabled for this number.

    emergency_address_id int64

    Identifies the emergency address associated with the phone number.

    call_forwarding_enabled boolean

    Default value: true

    Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.

    cnam_listing_enabled boolean

    Indicates whether a CNAM listing is enabled for this number.

    caller_id_name_enabled boolean

    Indicates whether caller ID is enabled for this number.

    call_recording_enabled boolean

    Indicates whether call recording is enabled for this number.

    t38_fax_gateway_enabled boolean

    Indicates whether T38 Fax Gateway for inbound calls to this number.

    purchased_at string

    ISO 8601 formatted date indicating when the resource was purchased.

    created_at string

    ISO 8601 formatted date indicating when the resource was created.

    number_level_routing string

    Possible values: [disabled]

    Default value: disabled

    Deprecated field, the only value for this is 'disabled'. All routing for numbers should be configured via connection settings.

    phone_number_type string

    Possible values: [local, toll_free, mobile, national, shared_cost, landline, tollfree, shortcode, longcode]

    The phone number's type. Note: For numbers purchased prior to July 2023 or when fetching a number's details immediately after a purchase completes, the legacy values tollfree, shortcode or longcode may be returned instead.

    inbound_call_screening string

    Possible values: [disabled, reject_calls, flag_calls]

    Default value: disabled

    The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Request samples

curl -L -X PATCH 'https://api.telnyx.com/v2/phone_numbers/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
  "tags": [
    "tag"
  ],
  "address_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
  "external_pin": "1234",
  "customer_reference": "customer-reference",
  "connection_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
  "billing_group_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
  "number_level_routing": "disabled",
  "hd_voice_enabled": true
}'

Response samples

{
  "data": {
    "id": "1293384261075731499",
    "record_type": "phone_number",
    "phone_number": "+19705555098",
    "status": "active",
    "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,
    "number_level_routing": "disabled",
    "phone_number_type": "local",
    "inbound_call_screening": "disabled",
    "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
  }
}