From telnyx-python
Set up Telnyx hosted SMS/RCS messaging, toll-free verification, and number migration with Python SDK examples for sending messages and deeplinks.
npx claudepluginhub team-telnyx/skillsThis skill uses the workspace's default tool permissions.
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
Generates design tokens/docs from CSS/Tailwind/styled-components codebases, audits visual consistency across 10 dimensions, detects AI slop in UI.
Records polished WebM UI demo videos of web apps using Playwright with cursor overlay, natural pacing, and three-phase scripting. Activates for demo, walkthrough, screen recording, or tutorial requests.
Delivers idiomatic Kotlin patterns for null safety, immutability, sealed classes, coroutines, Flows, extensions, DSL builders, and Gradle DSL. Use when writing, reviewing, refactoring, or designing Kotlin code.
pip install telnyx
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.
All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
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).
+13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.for item in page_result: to iterate through all pages automatically.POST /messages/rcs — Required: agent_id, to, messaging_profile_id, agent_message
Optional: mms_fallback (object), sms_fallback (object), type (enum: RCS), webhook_url (url)
response = client.messages.rcs.send(
agent_id="Agent007",
agent_message={},
messaging_profile_id="550e8400-e29b-41d4-a716-446655440000",
to="+13125551234",
)
print(response.data)
Returns: body (object), direction (string), encoding (string), from (object), id (string), messaging_profile_id (string), organization_id (string), received_at (date-time), record_type (string), to (array[object]), type (string), wait_seconds (float)
Generate a deeplink URL that can be used to start an RCS conversation with a specific agent.
GET /messages/rcs/deeplinks/{agent_id}
response = client.messages.rcs.generate_deeplink(
agent_id="550e8400-e29b-41d4-a716-446655440000",
)
print(response.data)
Returns: url (string)
GET /messaging/rcs/agents
page = client.messaging.rcs.agents.list()
page = page.data[0]
print(page.agent_id)
Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)
GET /messaging/rcs/agents/{id}
rcs_agent_response = client.messaging.rcs.agents.retrieve(
"id",
)
print(rcs_agent_response.data)
Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)
PATCH /messaging/rcs/agents/{id}
Optional: profile_id (uuid), webhook_failover_url (url), webhook_url (url)
rcs_agent_response = client.messaging.rcs.agents.update(
id="550e8400-e29b-41d4-a716-446655440000",
)
print(rcs_agent_response.data)
Returns: agent_id (string), agent_name (string), created_at (date-time), enabled (boolean), profile_id (uuid), updated_at (date-time), user_id (string), webhook_failover_url (url), webhook_url (url)
POST /messaging/rcs/bulk_capabilities — Required: agent_id, phone_numbers
response = client.messaging.rcs.list_bulk_capabilities(
agent_id="TestAgent",
phone_numbers=["+13125551234"],
)
print(response.data)
Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)
GET /messaging/rcs/capabilities/{agent_id}/{phone_number}
response = client.messaging.rcs.retrieve_capabilities(
phone_number="+13125550001",
agent_id="550e8400-e29b-41d4-a716-446655440000",
)
print(response.data)
Returns: agent_id (string), agent_name (string), features (array[string]), phone_number (string), record_type (enum: rcs.capabilities)
Adds a test phone number to an RCS agent for testing purposes.
PUT /messaging/rcs/test_number_invite/{id}/{phone_number}
response = client.messaging.rcs.invite_test_number(
phone_number="+13125550001",
id="550e8400-e29b-41d4-a716-446655440000",
)
print(response.data)
Returns: agent_id (string), phone_number (string), record_type (enum: rcs.test_number_invite), status (string)
GET /messaging_hosted_number_orders
page = client.messaging_hosted_number_orders.list()
page = page.data[0]
print(page.id)
Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)
POST /messaging_hosted_number_orders
Optional: messaging_profile_id (string), phone_numbers (array[string])
messaging_hosted_number_order = client.messaging_hosted_number_orders.create()
print(messaging_hosted_number_order.data)
Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)
POST /messaging_hosted_number_orders/eligibility_numbers_check — Required: phone_numbers
response = client.messaging_hosted_number_orders.check_eligibility(
phone_numbers=["string"],
)
print(response.phone_numbers)
Returns: phone_numbers (array[object])
GET /messaging_hosted_number_orders/{id}
messaging_hosted_number_order = client.messaging_hosted_number_orders.retrieve(
"id",
)
print(messaging_hosted_number_order.data)
Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)
Delete a messaging hosted number order and all associated phone numbers.
DELETE /messaging_hosted_number_orders/{id}
messaging_hosted_number_order = client.messaging_hosted_number_orders.delete(
"id",
)
print(messaging_hosted_number_order.data)
Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)
POST /messaging_hosted_number_orders/{id}/actions/file_upload
response = client.messaging_hosted_number_orders.actions.upload_file(
id="550e8400-e29b-41d4-a716-446655440000",
)
print(response.data)
Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)
Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint.
POST /messaging_hosted_number_orders/{id}/validation_codes — Required: verification_codes
response = client.messaging_hosted_number_orders.validate_codes(
id="550e8400-e29b-41d4-a716-446655440000",
verification_codes=[{
"code": "code",
"phone_number": "phone_number",
}],
)
print(response.data)
Returns: order_id (uuid), phone_numbers (array[object])
Create verification codes to validate numbers of the hosted order. The verification codes will be sent to the numbers of the hosted order.
POST /messaging_hosted_number_orders/{id}/verification_codes — Required: phone_numbers, verification_method
response = client.messaging_hosted_number_orders.create_verification_codes(
id="550e8400-e29b-41d4-a716-446655440000",
phone_numbers=["string"],
verification_method="sms",
)
print(response.data)
Returns: error (string), phone_number (string), type (enum: sms, call), verification_code_id (uuid)
DELETE /messaging_hosted_numbers/{id}
messaging_hosted_number = client.messaging_hosted_numbers.delete(
"id",
)
print(messaging_hosted_number.data)
Returns: id (uuid), messaging_profile_id (string | null), phone_numbers (array[object]), record_type (string), status (enum: carrier_rejected, compliance_review_failed, deleted, failed, incomplete_documentation, incorrect_billing_information, ineligible_carrier, loa_file_invalid, loa_file_successful, pending, provisioning, successful)
Get a list of previously-submitted tollfree verification requests
GET /messaging_tollfree/verification/requests
page = client.messaging_tollfree.verification.requests.list(
page=1,
page_size=1,
)
page = page.records[0]
print(page.id)
Returns: records (array[object]), total_records (integer)
Submit a new tollfree verification request
POST /messaging_tollfree/verification/requests — Required: businessName, corporateWebsite, businessAddr1, businessCity, businessState, businessZip, businessContactFirstName, businessContactLastName, businessContactEmail, businessContactPhone, messageVolume, phoneNumbers, useCase, useCaseSummary, productionMessageContent, optInWorkflow, optInWorkflowImageURLs, additionalInformation
Optional: ageGatedContent (boolean), businessAddr2 (string), businessRegistrationCountry (string | null), businessRegistrationNumber (string | null), businessRegistrationType (string | null), campaignVerifyAuthorizationToken (string | null), doingBusinessAs (string | null), entityType (object), helpMessageResponse (string | null), isvReseller (string | null), optInConfirmationResponse (string | null), optInKeywords (string | null), privacyPolicyURL (string | null), termsAndConditionURL (string | null), webhookUrl (string)
verification_request_egress = client.messaging_tollfree.verification.requests.create(
additional_information="additionalInformation",
business_addr1="600 Congress Avenue",
business_city="Austin",
business_contact_email="email@example.com",
business_contact_first_name="John",
business_contact_last_name="Doe",
business_contact_phone="+18005550100",
business_name="Telnyx LLC",
business_state="Texas",
business_zip="78701",
corporate_website="http://example.com",
message_volume="100,000",
opt_in_workflow="User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
opt_in_workflow_image_urls=[{
"url": "https://telnyx.com/sign-up"
}, {
"url": "https://telnyx.com/company/data-privacy"
}],
phone_numbers=[{
"phone_number": "+18773554398"
}, {
"phone_number": "+18773554399"
}],
production_message_content="Your Telnyx OTP is XXXX",
use_case="2FA",
use_case_summary="This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal",
)
print(verification_request_egress.id)
Returns: additionalInformation (string), ageGatedContent (boolean), businessAddr1 (string), businessAddr2 (string), businessCity (string), businessContactEmail (string), businessContactFirstName (string), businessContactLastName (string), businessContactPhone (string), businessName (string), businessRegistrationCountry (string), businessRegistrationNumber (string), businessRegistrationType (string), businessState (string), businessZip (string), campaignVerifyAuthorizationToken (string | null), corporateWebsite (string), doingBusinessAs (string), entityType (object), helpMessageResponse (string), id (uuid), isvReseller (string), messageVolume (object), optInConfirmationResponse (string), optInKeywords (string), optInWorkflow (string), optInWorkflowImageURLs (array[object]), phoneNumbers (array[object]), privacyPolicyURL (string), productionMessageContent (string), termsAndConditionURL (string), useCase (object), useCaseSummary (string), verificationRequestId (string), verificationStatus (object), webhookUrl (string)
Get a single verification request by its ID.
GET /messaging_tollfree/verification/requests/{id}
verification_request_status = client.messaging_tollfree.verification.requests.retrieve(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
print(verification_request_status.id)
Returns: additionalInformation (string), ageGatedContent (boolean), businessAddr1 (string), businessAddr2 (string), businessCity (string), businessContactEmail (string), businessContactFirstName (string), businessContactLastName (string), businessContactPhone (string), businessName (string), businessRegistrationCountry (string), businessRegistrationNumber (string), businessRegistrationType (string), businessState (string), businessZip (string), campaignVerifyAuthorizationToken (string | null), corporateWebsite (string), createdAt (date-time), doingBusinessAs (string), entityType (object), helpMessageResponse (string), id (uuid), isvReseller (string), messageVolume (object), optInConfirmationResponse (string), optInKeywords (string), optInWorkflow (string), optInWorkflowImageURLs (array[object]), phoneNumbers (array[object]), privacyPolicyURL (string), productionMessageContent (string), reason (string), termsAndConditionURL (string), updatedAt (date-time), useCase (object), useCaseSummary (string), verificationStatus (object), webhookUrl (string)
Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.
PATCH /messaging_tollfree/verification/requests/{id} — Required: businessName, corporateWebsite, businessAddr1, businessCity, businessState, businessZip, businessContactFirstName, businessContactLastName, businessContactEmail, businessContactPhone, messageVolume, phoneNumbers, useCase, useCaseSummary, productionMessageContent, optInWorkflow, optInWorkflowImageURLs, additionalInformation
Optional: ageGatedContent (boolean), businessAddr2 (string), businessRegistrationCountry (string | null), businessRegistrationNumber (string | null), businessRegistrationType (string | null), campaignVerifyAuthorizationToken (string | null), doingBusinessAs (string | null), entityType (object), helpMessageResponse (string | null), isvReseller (string | null), optInConfirmationResponse (string | null), optInKeywords (string | null), privacyPolicyURL (string | null), termsAndConditionURL (string | null), webhookUrl (string)
verification_request_egress = client.messaging_tollfree.verification.requests.update(
id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
additional_information="additionalInformation",
business_addr1="600 Congress Avenue",
business_city="Austin",
business_contact_email="email@example.com",
business_contact_first_name="John",
business_contact_last_name="Doe",
business_contact_phone="+18005550100",
business_name="Telnyx LLC",
business_state="Texas",
business_zip="78701",
corporate_website="http://example.com",
message_volume="100,000",
opt_in_workflow="User signs into the Telnyx portal, enters a number and is prompted to select whether they want to use 2FA verification for security purposes. If they've opted in a confirmation message is sent out to the handset",
opt_in_workflow_image_urls=[{
"url": "https://telnyx.com/sign-up"
}, {
"url": "https://telnyx.com/company/data-privacy"
}],
phone_numbers=[{
"phone_number": "+18773554398"
}, {
"phone_number": "+18773554399"
}],
production_message_content="Your Telnyx OTP is XXXX",
use_case="2FA",
use_case_summary="This is a use case where Telnyx sends out 2FA codes to portal users to verify their identity in order to sign into the portal",
)
print(verification_request_egress.id)
Returns: additionalInformation (string), ageGatedContent (boolean), businessAddr1 (string), businessAddr2 (string), businessCity (string), businessContactEmail (string), businessContactFirstName (string), businessContactLastName (string), businessContactPhone (string), businessName (string), businessRegistrationCountry (string), businessRegistrationNumber (string), businessRegistrationType (string), businessState (string), businessZip (string), campaignVerifyAuthorizationToken (string | null), corporateWebsite (string), doingBusinessAs (string), entityType (object), helpMessageResponse (string), id (uuid), isvReseller (string), messageVolume (object), optInConfirmationResponse (string), optInKeywords (string), optInWorkflow (string), optInWorkflowImageURLs (array[object]), phoneNumbers (array[object]), privacyPolicyURL (string), productionMessageContent (string), termsAndConditionURL (string), useCase (object), useCaseSummary (string), verificationRequestId (string), verificationStatus (object), webhookUrl (string)
Delete a verification request
A request may only be deleted when when the request is in the "rejected" state. * HTTP 200: request successfully deleted
HTTP 400: request exists but can't be deleted (i.e. not rejected)HTTP 404: request unknown or already deletedDELETE /messaging_tollfree/verification/requests/{id}
client.messaging_tollfree.verification.requests.delete(
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
Get the history of status changes for a verification request. Returns a paginated list of historical status changes including the reason for each change and when it occurred.
GET /messaging_tollfree/verification/requests/{id}/status_history
response = client.messaging_tollfree.verification.requests.retrieve_status_history(
id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
page_number=1,
page_size=1,
)
print(response.records)
Returns: records (array[object]), total_records (integer)
GET /messaging_url_domains
page = client.messaging_url_domains.list()
page = page.data[0]
print(page.id)
Returns: id (string), record_type (string), url_domain (string), use_case (string)