SKILL.md
Full skill instructions
Telnyx Verify - Python
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.
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)
Trigger Call verification
POST /verifications/call — Required: phone_number, verify_profile_id
create_verification_response = client.verifications.trigger_call(
phone_number="+13035551234",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(create_verification_response.data)
Trigger Flash call verification
POST /verifications/flashcall — Required: phone_number, verify_profile_id
create_verification_response = client.verifications.trigger_flashcall(
phone_number="+13035551234",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(create_verification_response.data)
Trigger SMS verification
POST /verifications/sms — Required: phone_number, verify_profile_id
create_verification_response = client.verifications.trigger_sms(
phone_number="+13035551234",
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(create_verification_response.data)
Retrieve verification
GET /verifications/{verification_id}
verification = client.verifications.retrieve(
"12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verification.data)
Verify verification code by ID
POST /verifications/{verification_id}/actions/verify
verify_verification_code_response = client.verifications.actions.verify(
verification_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verify_verification_code_response.data)
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)
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)
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)
Create a Verify profile
Creates a new Verify profile to associate verifications with.
POST /verify_profiles — Required: name
verify_profile_data = client.verify_profiles.create(
name="Test Profile",
)
print(verify_profile_data.data)
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)
Update Verify profile
PATCH /verify_profiles/{verify_profile_id}
verify_profile_data = client.verify_profiles.update(
verify_profile_id="12ade33a-21c0-473b-b055-b3c836e1c292",
)
print(verify_profile_data.data)
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)
Retrieve Verify profile message templates
List all Verify profile message templates.
GET /verify_profiles/templates
response = client.verify_profiles.retrieve_templates()
print(response.data)
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)
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)