<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Numbers Compliance - 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.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

python
import telnyx

try:
    result = client.messages.send(to="+13125550001", from_="+13125550002", text="Hello")
except telnyx.APIConnectionError:
    print("Network error — check connectivity and retry")
except telnyx.RateLimitError:
    # 429: rate limited — wait and retry with exponential backoff
    import time
    time.sleep(1)  # Check Retry-After header for actual delay
except telnyx.APIStatusError as e:
    print(f"API error {e.status_code}: {e.message}")
    if e.status_code == 422:
        print("Validation error — check required fields and formats")

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
• Pagination: List methods return an auto-paginating iterator. Use for item in page_result: to iterate through all pages automatically.

Retrieve Bundles

Get all allowed bundles.

GET /bundle_pricing/billing_bundles

python
page = client.bundle_pricing.billing_bundles.list()
page = page.data[0]
print(page.id)

Returns: cost_code (string), created_at (date), currency (string), id (uuid), is_public (boolean), mrc_price (float), name (string), slug (string), specs (arraystring])

Get Bundle By Id

Get a single bundle by ID.

GET /bundle_pricing/billing_bundles/{bundle_id}

python
billing_bundle = client.bundle_pricing.billing_bundles.retrieve(
    bundle_id="8661948c-a386-4385-837f-af00f40f111a",
)
print(billing_bundle.data)

Returns: active (boolean), bundle_limits (arrayobject]), cost_code (string), created_at (date), id (uuid), is_public (boolean), name (string), slug (string)

Get User Bundles

Get a paginated list of user bundles.

GET /bundle_pricing/user_bundles

python
page = client.bundle_pricing.user_bundles.list()
page = page.data[0]
print(page.id)

Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (arrayobject]), updated_at (date), user_id (uuid)

Create User Bundles

Creates multiple user bundles for the user.

POST /bundle_pricing/user_bundles/bulk

Optional: idempotency_key (uuid), items (arrayobject])

python
user_bundle = client.bundle_pricing.user_bundles.create()
print(user_bundle.data)

Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (arrayobject]), updated_at (date), user_id (uuid)

Get Unused User Bundles

Returns all user bundles that aren't in use.

GET /bundle_pricing/user_bundles/unused

python
response = client.bundle_pricing.user_bundles.list_unused()
print(response.data)

Returns: billing_bundle (object), user_bundle_ids (arraystring])

Get User Bundle by Id

Retrieves a user bundle by its ID.

GET /bundle_pricing/user_bundles/{user_bundle_id}

python
user_bundle = client.bundle_pricing.user_bundles.retrieve(
    user_bundle_id="ca1d2263-d1f1-43ac-ba53-248e7a4bb26a",
)
print(user_bundle.data)

Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (arrayobject]), updated_at (date), user_id (uuid)

Deactivate User Bundle

Deactivates a user bundle by its ID.

DELETE /bundle_pricing/user_bundles/{user_bundle_id}

python
response = client.bundle_pricing.user_bundles.deactivate(
    user_bundle_id="ca1d2263-d1f1-43ac-ba53-248e7a4bb26a",
)
print(response.data)

Returns: active (boolean), billing_bundle (object), created_at (date), id (uuid), resources (arrayobject]), updated_at (date), user_id (uuid)

Get User Bundle Resources

Retrieves the resources of a user bundle by its ID.

GET /bundle_pricing/user_bundles/{user_bundle_id}/resources

python
response = client.bundle_pricing.user_bundles.list_resources(
    user_bundle_id="ca1d2263-d1f1-43ac-ba53-248e7a4bb26a",
)
print(response.data)

Returns: created_at (date), id (uuid), resource (string), resource_type (string), updated_at (date)

List all document links

List all documents links ordered by created_at descending.

GET /document_links

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

Returns: created_at (string), document_id (uuid), id (uuid), linked_record_type (string), linked_resource_id (string), record_type (string), updated_at (string)

List all documents

List all documents ordered by created_at descending.

GET /documents

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

Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)

Upload a document

Upload a document. Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.

POST /documents

Optional: customer_reference (string), file (byte), filename (string), url (string)

python
response = client.documents.upload_json(
    document={},
)
print(response.data)

Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)

Retrieve a document

Retrieve a document.

GET /documents/{id}

python
document = client.documents.retrieve(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(document.data)

Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)

Update a document

Update a document.

PATCH /documents/{id}

Optional: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)

python
document = client.documents.update(
    document_id="6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(document.data)

Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)

Delete a document

Delete a document. A document can only be deleted if it's not linked to a service. If it is linked to a service, it must be unlinked prior to deleting.

DELETE /documents/{id}

python
document = client.documents.delete(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(document.data)

Returns: av_scan_status (enum: scanned, infected, pending_scan, not_scanned), content_type (string), created_at (string), customer_reference (string), filename (string), id (uuid), record_type (string), sha256 (string), size (object), status (enum: pending, verified, denied), updated_at (string)

Download a document

Download a document.

GET /documents/{id}/download

python
response = client.documents.download(
    "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
)
print(response)
content = response.read()
print(content)

Generate a temporary download link for a document

Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.

GET /documents/{id}/download_link

python
response = client.documents.generate_download_link(
    "550e8400-e29b-41d4-a716-446655440000",
)
print(response.data)

Returns: url (uri)

Update requirement group for a phone number order

POST /number_order_phone_numbers/{id}/requirement_group — Required: requirement_group_id

python
response = client.number_order_phone_numbers.update_requirement_group(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    requirement_group_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(response.data)

Returns: bundle_id (uuid), country_code (string), deadline (date-time), id (uuid), is_block_number (boolean), locality (string), order_request_id (uuid), phone_number (string), phone_number_type (string), record_type (string), regulatory_requirements (arrayobject]), requirements_met (boolean), requirements_status (string), status (string), sub_number_order_id (uuid)

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)

Returns: phone_number (string), phone_number_type (string), record_type (string), region_information (arrayobject]), regulatory_requirements (arrayobject])

Retrieve regulatory requirements

GET /regulatory_requirements

python
regulatory_requirement = client.regulatory_requirements.retrieve()
print(regulatory_requirement.data)

Returns: action (string), country_code (string), phone_number_type (string), regulatory_requirements (arrayobject])

List requirement groups

GET /requirement_groups

python
requirement_groups = client.requirement_groups.list()
print(requirement_groups)

Create a new requirement group

POST /requirement_groups — Required: country_code, phone_number_type, action

Optional: customer_reference (string), regulatory_requirements (arrayobject])

python
requirement_group = client.requirement_groups.create(
    action="ordering",
    country_code="US",
    phone_number_type="local",
)
print(requirement_group.id)

Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (arrayobject]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)

Get a single requirement group by ID

GET /requirement_groups/{id}

python
requirement_group = client.requirement_groups.retrieve(
    "id",
)
print(requirement_group.id)

Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (arrayobject]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)

Update requirement values in requirement group

PATCH /requirement_groups/{id}

Optional: customer_reference (string), regulatory_requirements (arrayobject])

python
requirement_group = client.requirement_groups.update(
    id="550e8400-e29b-41d4-a716-446655440000",
)
print(requirement_group.id)

Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (arrayobject]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)

Delete a requirement group by ID

DELETE /requirement_groups/{id}

python
requirement_group = client.requirement_groups.delete(
    "id",
)
print(requirement_group.id)

Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (arrayobject]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)

Submit a Requirement Group for Approval

POST /requirement_groups/{id}/submit_for_approval

python
requirement_group = client.requirement_groups.submit_for_approval(
    "id",
)
print(requirement_group.id)

Returns: action (string), country_code (string), created_at (date-time), customer_reference (string), id (string), phone_number_type (string), record_type (string), regulatory_requirements (arrayobject]), status (enum: approved, unapproved, pending-approval, declined, expired), updated_at (date-time)

List all requirement types

List all requirement types ordered by created_at descending

GET /requirement_types

python
requirement_types = client.requirement_types.list()
print(requirement_types.data)

Returns: acceptance_criteria (object), created_at (string), description (string), example (string), id (uuid), name (string), record_type (string), type (enum: document, address, textual), updated_at (string)

Retrieve a requirement types

Retrieve a requirement type by id

GET /requirement_types/{id}

python
requirement_type = client.requirement_types.retrieve(
    "a38c217a-8019-48f8-bff6-0fdd9939075b",
)
print(requirement_type.data)

Returns: acceptance_criteria (object), created_at (string), description (string), example (string), id (uuid), name (string), record_type (string), type (enum: document, address, textual), updated_at (string)

List all requirements

List all requirements with filtering, sorting, and pagination

GET /requirements

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

Returns: action (enum: both, branded_calling, ordering, porting), country_code (string), created_at (string), id (uuid), locality (string), phone_number_type (enum: local, national, toll_free), record_type (string), requirements_types (arrayobject]), updated_at (string)

Retrieve a document requirement

Retrieve a document requirement record

GET /requirements/{id}

python
requirement = client.requirements.retrieve(
    "a9dad8d5-fdbd-49d7-aa23-39bb08a5ebaa",
)
print(requirement.data)

Returns: action (enum: both, branded_calling, ordering, porting), country_code (string), created_at (string), id (uuid), locality (string), phone_number_type (enum: local, national, toll_free), record_type (string), requirements_types (arrayobject]), updated_at (string)

Update requirement group for a sub number order

POST /sub_number_orders/{id}/requirement_group — Required: requirement_group_id

python
response = client.sub_number_orders.update_requirement_group(
    id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    requirement_group_id="a4b201f9-8646-4e54-a7d2-b2e403eeaf8c",
)
print(response.data)

Returns: country_code (string), created_at (date-time), customer_reference (string), id (uuid), is_block_sub_number_order (boolean), order_request_id (uuid), phone_number_type (string), phone_numbers (arrayobject]), phone_numbers_count (integer), record_type (string), regulatory_requirements (arrayobject]), requirements_met (boolean), status (string), updated_at (date-time)

List all user addresses

Returns a list of your user addresses.

GET /user_addresses

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

Returns: administrative_area (string), borough (string), business_name (string), country_code (string), created_at (string), customer_reference (string), extended_address (string), first_name (string), id (uuid), last_name (string), locality (string), neighborhood (string), phone_number (string), postal_code (string), record_type (string), street_address (string), updated_at (string)

Creates a user address

Creates a user address.

POST /user_addresses — Required: first_name, last_name, business_name, street_address, locality, country_code

Optional: administrative_area (string), borough (string), customer_reference (string), extended_address (string), neighborhood (string), phone_number (string), postal_code (string), skip_address_verification (boolean)

python
user_address = client.user_addresses.create(
    business_name="Toy-O'Kon",
    country_code="US",
    first_name="Alfred",
    last_name="Foster",
    locality="Austin",
    street_address="600 Congress Avenue",
)
print(user_address.data)

Returns: administrative_area (string), borough (string), business_name (string), country_code (string), created_at (string), customer_reference (string), extended_address (string), first_name (string), id (uuid), last_name (string), locality (string), neighborhood (string), phone_number (string), postal_code (string), record_type (string), street_address (string), updated_at (string)

Retrieve a user address

Retrieves the details of an existing user address.

GET /user_addresses/{id}

python
user_address = client.user_addresses.retrieve(
    "id",
)
print(user_address.data)

Returns: administrative_area (string), borough (string), business_name (string), country_code (string), created_at (string), customer_reference (string), extended_address (string), first_name (string), id (uuid), last_name (string), locality (string), neighborhood (string), phone_number (string), postal_code (string), record_type (string), street_address (string), updated_at (string)

List all Verified Numbers

Gets a paginated list of Verified Numbers.

GET /verified_numbers

python
page = client.verified_numbers.list()
page = page.data[0]
print(page.phone_number)

Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)

Request phone number verification

Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems.

POST /verified_numbers — Required: phone_number, verification_method

Optional: extension (string)

python
verified_number = client.verified_numbers.create(
    phone_number="+15551234567",
    verification_method="sms",
)
print(verified_number.phone_number)

Returns: phone_number (string), verification_method (string)

Retrieve a verified number

GET /verified_numbers/{phone_number}

python
verified_number_data_wrapper = client.verified_numbers.retrieve(
    "+15551234567",
)
print(verified_number_data_wrapper.data)

Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)

Delete a verified number

DELETE /verified_numbers/{phone_number}

python
verified_number_data_wrapper = client.verified_numbers.delete(
    "+15551234567",
)
print(verified_number_data_wrapper.data)

Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)

Submit verification code

POST /verified_numbers/{phone_number}/actions/verify — Required: verification_code

python
verified_number_data_wrapper = client.verified_numbers.actions.submit_verification_code(
    phone_number="+15551234567",
    verification_code="123456",
)
print(verified_number_data_wrapper.data)

Returns: phone_number (string), record_type (enum: verified_number), verified_at (string)