Installation
pip install telnyx
Setup
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.
Lookup phone number data
Returns information about the provided phone number.
GET /number_lookup/{phone_number}
number_lookup = client.number_lookup.retrieve(
phone_number="+18665552368",
)
print(number_lookup.data)
Returns: caller_name (object), carrier (object), country_code (string), fraud (string | null), national_format (string), phone_number (string), portability (object), record_type (string)
List verifications by phone number
GET /verifications/by_phone_number/{phone_number}
by_phone_numbers = client.verifications.by_phone_number.list(
"+13035551234",
)
print(by_phone_numbers.data)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Verify verification code by phone number
POST /verifications/by_phone_number/{phone_number}/actions/verify — Required: code, verify_profile_id
verify_verification_code_response = client.verifications.by_phone_number.actions.verify(
phone_number="+13035551234",
code="17686",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verify_verification_code_response.data)
Returns: phone_number (string), response_code (enum: accepted, rejected)
Trigger Call verification
POST /verifications/call — Required: phone_number, verify_profile_id
Optional: custom_code (string | null), extension (string | null), timeout_secs (integer)
create_verification_response = client.verifications.trigger_call(
phone_number="+13035551234",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(create_verification_response.data)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Trigger Flash call verification
POST /verifications/flashcall — Required: phone_number, verify_profile_id
Optional: timeout_secs (integer)
create_verification_response = client.verifications.trigger_flashcall(
phone_number="+13035551234",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(create_verification_response.data)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Trigger SMS verification
POST /verifications/sms — Required: phone_number, verify_profile_id
Optional: custom_code (string | null), timeout_secs (integer)
create_verification_response = client.verifications.trigger_sms(
phone_number="+13035551234",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(create_verification_response.data)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Trigger WhatsApp verification
POST /verifications/whatsapp — Required: phone_number, verify_profile_id
Optional: custom_code (string | null), timeout_secs (integer)
create_verification_response = client.verifications.trigger_whatsapp_verification(
phone_number="+13035551234",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(create_verification_response.data)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Retrieve verification
GET /verifications/{verification_id}
verification = client.verifications.retrieve(
"12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verification.data)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Verify verification code by ID
POST /verifications/{verification_id}/actions/verify
Optional: code (string), status (enum: accepted, rejected)
verify_verification_code_response = client.verifications.actions.verify(
verification_id="12ade33a-21c0-473b-b055-b3c836e1c292",
code="12345",
)
print(verify_verification_code_response.data)
Returns: phone_number (string), response_code (enum: accepted, rejected)
List all Verify profiles
Gets a paginated list of Verify profiles.
GET /verify_profiles
page = client.verify_profiles.list()
page = page.data[0]
print(page.id)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
Create a Verify profile
Creates a new Verify profile to associate verifications with.
POST /verify_profiles — Required: name
Optional: call (object), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), language (string), sms (object), webhook_failover_url (string), webhook_url (string), whatsapp (object)
verify_profile_data = client.verify_profiles.create(
name="Test Profile",
)
print(verify_profile_data.data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
Retrieve Verify profile message templates
List all Verify profile message templates.
GET /verify_profiles/templates
response = client.verify_profiles.retrieve_templates()
print(response.data)
Returns: id (uuid), text (string)
Create message template
Create a new Verify profile message template.
POST /verify_profiles/templates — Required: text
message_template = client.verify_profiles.create_template(
text="Your {{app_name}} verification code is: {{code}}.",
)
print(message_template.data)
Returns: id (uuid), text (string)
Update message template
Update an existing Verify profile message template.
PATCH /verify_profiles/templates/{template_id} — Required: text
message_template = client.verify_profiles.update_template(
template_id="12ade33a-21c0-473b-b055-b3c836e1c292",
text="Your {{app_name}} verification code is: {{code}}.",
)
print(message_template.data)
Returns: id (uuid), text (string)
Retrieve Verify profile
Gets a single Verify profile.
GET /verify_profiles/{verify_profile_id}
verify_profile_data = client.verify_profiles.retrieve(
"12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verify_profile_data.data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
Update Verify profile
PATCH /verify_profiles/{verify_profile_id}
Optional: call (object), daily_spend_limit (number), daily_spend_limit_enabled (boolean), language (string), name (string), sms (object), webhook_failover_url (string), webhook_url (string), whatsapp (object)
verify_profile_data = client.verify_profiles.update(
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verify_profile_data.data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
Delete Verify profile
DELETE /verify_profiles/{verify_profile_id}
verify_profile_data = client.verify_profiles.delete(
"12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verify_profile_data.data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)