Telnyx Numbers Config - Python

Installation

bash

pip install telnyx

Setup

python

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)

All examples below assume

client

is already initialized as shown above.

Lists the phone number blocks jobs

GET /phone_number_blocks/jobs

python

page = client.phone_number_blocks.jobs.list()
page = page.data[0]
print(page.id)

Retrieves a phone number blocks job

GET /phone_number_blocks/jobs/{id}

python

job = client.phone_number_blocks.jobs.retrieve(
    "id",
)
print(job.data)

Deletes all numbers associated with a phone number block

Creates a new background job to delete all the phone numbers associated with the given block.

POST /phone_number_blocks/jobs/delete_phone_number_block

— Required:

phone_number_block_id

python

response = client.phone_number_blocks.jobs.delete_phone_number_block(
    phone_number_block_id="f3946371-7199-4261-9c3d-81a0d7935146",
)
print(response.data)

List phone numbers

GET /phone_numbers

python

page = client.phone_numbers.list()
page = page.data[0]
print(page.id)

Retrieve a phone number

GET /phone_numbers/{id}

python

phone_number = client.phone_numbers.retrieve(
    "1293384261075731499",
)
print(phone_number.data)

Update a phone number

PATCH /phone_numbers/{id}

Optional:

address_id

(string),

billing_group_id

(string),

connection_id

(string),

customer_reference

(string),

external_pin

(string),

hd_voice_enabled

(boolean),

id

(string),

tags

(array[string])

python

phone_number = client.phone_numbers.update(
    phone_number_id="1293384261075731499",
)
print(phone_number.data)

Delete a phone number

DELETE /phone_numbers/{id}

python

phone_number = client.phone_numbers.delete(
    "1293384261075731499",
)
print(phone_number.data)

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

PATCH /phone_numbers/{id}/actions/bundle_status_change

— Required:

bundle_id

python

response = client.phone_numbers.actions.change_bundle_status(
    id="1293384261075731499",
    bundle_id="5194d8fc-87e6-4188-baa9-1c434bbe861b",
)
print(response.data)

Enable emergency for a phone number

POST /phone_numbers/{id}/actions/enable_emergency

— Required:

emergency_enabled

emergency_address_id

python

response = client.phone_numbers.actions.enable_emergency(
    id="1293384261075731499",
    emergency_address_id="53829456729313",
    emergency_enabled=True,
)
print(response.data)

Retrieve a phone number with voice settings

GET /phone_numbers/{id}/voice

python

voice = client.phone_numbers.voice.retrieve(
    "1293384261075731499",
)
print(voice.data)

Update a phone number with voice settings

PATCH /phone_numbers/{id}/voice

Optional:

call_forwarding

(object),

call_recording

(object),

caller_id_name_enabled

(boolean),

cnam_listing

(object),

inbound_call_screening

(enum),

media_features

(object),

tech_prefix_enabled

(boolean),

translated_number

(string),

usage_payment_method

(enum)

python

voice = client.phone_numbers.voice.update(
    id="1293384261075731499",
)
print(voice.data)

Verify ownership of phone numbers

Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account.

POST /phone_numbers/actions/verify_ownership

— Required:

phone_numbers

python

response = client.phone_numbers.actions.verify_ownership(
    phone_numbers=["+15551234567"],
)
print(response.data)

List CSV downloads

GET /phone_numbers/csv_downloads

python

page = client.phone_numbers.csv_downloads.list()
page = page.data[0]
print(page.id)

Create a CSV download

POST /phone_numbers/csv_downloads

python

csv_download = client.phone_numbers.csv_downloads.create()
print(csv_download.data)

Retrieve a CSV download

GET /phone_numbers/csv_downloads/{id}

python

csv_download = client.phone_numbers.csv_downloads.retrieve(
    "id",
)
print(csv_download.data)

Lists the phone numbers jobs

GET /phone_numbers/jobs

python

page = client.phone_numbers.jobs.list()
page = page.data[0]
print(page.id)

Retrieve a phone numbers job

GET /phone_numbers/jobs/{id}

python

job = client.phone_numbers.jobs.retrieve(
    "id",
)
print(job.data)

Delete a batch of numbers

Creates a new background job to delete a batch of numbers.

POST /phone_numbers/jobs/delete_phone_numbers

— Required:

phone_numbers

python

response = client.phone_numbers.jobs.delete_batch(
    phone_numbers=["+19705555098", "+19715555098", "32873127836"],
)
print(response.data)

Update the emergency settings from a batch of numbers

Creates a background job to update the emergency settings of a collection of phone numbers.

POST /phone_numbers/jobs/update_emergency_settings

— Required:

emergency_enabled

phone_numbers

Optional:

emergency_address_id

(['string', 'null'])

python

response = client.phone_numbers.jobs.update_emergency_settings_batch(
    emergency_enabled=True,
    phone_numbers=["+19705555098", "+19715555098", "32873127836"],
)
print(response.data)

Update a batch of numbers

Creates a new background job to update a batch of numbers.

POST /phone_numbers/jobs/update_phone_numbers

— Required:

phone_numbers

Optional:

billing_group_id

(string),

connection_id

(string),

customer_reference

(string),

deletion_lock_enabled

(boolean),

external_pin

(string),

hd_voice_enabled

(boolean),

tags

(array[string]),

voice

(object)

python

response = client.phone_numbers.jobs.update_batch(
    phone_numbers=["1583466971586889004", "+13127367254"],
)
print(response.data)

Retrieve regulatory requirements for a list of phone numbers

GET /phone_numbers/regulatory_requirements

python

phone_numbers_regulatory_requirement = client.phone_numbers_regulatory_requirements.retrieve()
print(phone_numbers_regulatory_requirement.data)

Slim List phone numbers

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.

GET /phone_numbers/slim

python

page = client.phone_numbers.slim_list()
page = page.data[0]
print(page.id)

List phone numbers with voice settings

GET /phone_numbers/voice

python

page = client.phone_numbers.voice.list()
page = page.data[0]
print(page.id)

List Mobile Phone Numbers

GET /v2/mobile_phone_numbers

python

page = client.mobile_phone_numbers.list()
page = page.data[0]
print(page.id)

Retrieve a Mobile Phone Number

GET /v2/mobile_phone_numbers/{id}

python

mobile_phone_number = client.mobile_phone_numbers.retrieve(
    "id",
)
print(mobile_phone_number.data)

Update a Mobile Phone Number

PATCH /v2/mobile_phone_numbers/{id}

Optional:

call_forwarding

(object),

call_recording

(object),

caller_id_name_enabled

(boolean),

cnam_listing

(object),

connection_id

(['string', 'null']),

customer_reference

(['string', 'null']),

inbound

(object),

inbound_call_screening

(enum),

noise_suppression

(boolean),

outbound

(object),

tags

(array[string])

python

mobile_phone_number = client.mobile_phone_numbers.update(
    id="id",
)
print(mobile_phone_number.data)

telnyx-numbers-config-python

NPX Install

Tags

SKILL.md Content

Telnyx Numbers Config - Python

Installation

Setup

Lists the phone number blocks jobs

Retrieves a phone number blocks job

Deletes all numbers associated with a phone number block

List phone numbers

Retrieve a phone number

Update a phone number

Delete a phone number

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

Enable emergency for a phone number

Retrieve a phone number with voice settings

Update a phone number with voice settings

Verify ownership of phone numbers

List CSV downloads

Create a CSV download

Retrieve a CSV download

Lists the phone numbers jobs

Retrieve a phone numbers job

Delete a batch of numbers

Update the emergency settings from a batch of numbers

Update a batch of numbers

Retrieve regulatory requirements for a list of phone numbers

Slim List phone numbers

List phone numbers with voice settings

List Mobile Phone Numbers

Retrieve a Mobile Phone Number

Update a Mobile Phone Number