How do I install the Telnyx API skill?

Run npx skillmds@latest add lap-platform/telnyx-api in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

What does the Telnyx API skill do?

Telnyx API skill. Use when working with Telnyx for .well-known, 10dlc, access_ip_address. Covers 946 endpoints. It is listed under Integrations & APIs on SkillMD.

Is Telnyx API safe to use?

This skill has not completed SkillMD's automated safety review yet. Independent scanners report: SkillSpector: CAUTION, Skill Scanner: PASS. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Telnyx API?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Telnyx API free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Telnyx API?

Lap-Platform (@lap-platform) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Telnyx API by lap-platform — Agent Skill

Name: Telnyx API
Author: Lap-Platform

Telnyx API

API version: 2.0.0

Auth

Bearer bearer | OAuth2 | Bearer bearer | Bearer bearer

Base URL

https://api.telnyx.com/v2

Setup

Set Authorization header with your Bearer token
GET /.well-known/oauth-authorization-server -- verify access
POST /10dlc/brand -- create first brand

Endpoints

946 endpoints across 154 groups. See references/api-spec.lap for full details.

.well-known

Method	Path	Description
GET	/.well-known/oauth-authorization-server	Authorization server metadata
GET	/.well-known/oauth-protected-resource	Protected resource metadata

10dlc

Method	Path	Description
GET	/10dlc/brand	List Brands
POST	/10dlc/brand	Create Brand
GET	/10dlc/brand/feedback/{brandId}	Get Brand Feedback By Id
GET	/10dlc/brand/smsOtp/{referenceId}	Get Brand SMS OTP Status
DELETE	/10dlc/brand/{brandId}	Delete Brand
GET	/10dlc/brand/{brandId}	Get Brand
PUT	/10dlc/brand/{brandId}	Update Brand
POST	/10dlc/brand/{brandId}/2faEmail	Resend brand 2FA email
GET	/10dlc/brand/{brandId}/externalVetting	List External Vettings
POST	/10dlc/brand/{brandId}/externalVetting	Order Brand External Vetting
PUT	/10dlc/brand/{brandId}/externalVetting	Import External Vetting Record
PUT	/10dlc/brand/{brandId}/revet	Revet Brand
GET	/10dlc/brand/{brandId}/smsOtp	Get Brand SMS OTP Status by Brand ID
POST	/10dlc/brand/{brandId}/smsOtp	Trigger Brand SMS OTP
PUT	/10dlc/brand/{brandId}/smsOtp	Verify Brand SMS OTP
GET	/10dlc/campaign	List Campaigns
POST	/10dlc/campaign/acceptSharing/{campaignId}	Accept Shared Campaign
GET	/10dlc/campaign/usecase/cost	Get Campaign Cost
DELETE	/10dlc/campaign/{campaignId}	Deactivate campaign
GET	/10dlc/campaign/{campaignId}	Get campaign
PUT	/10dlc/campaign/{campaignId}	Update campaign
POST	/10dlc/campaign/{campaignId}/appeal	Submit campaign appeal for manual review
GET	/10dlc/campaign/{campaignId}/mnoMetadata	Get Campaign Mno Metadata
GET	/10dlc/campaign/{campaignId}/operationStatus	Get campaign operation status
GET	/10dlc/campaign/{campaignId}/osr/attributes	Get OSR campaign attributes
GET	/10dlc/campaign/{campaignId}/sharing	Get Sharing Status
POST	/10dlc/campaignBuilder	Submit Campaign
GET	/10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}	Qualify By Usecase
GET	/10dlc/enum/{endpoint}	Get Enum
GET	/10dlc/partnerCampaign/sharedByMe	List shared partner campaigns
GET	/10dlc/partnerCampaign/{campaignId}/sharing	Get Sharing Status
GET	/10dlc/partner_campaigns	List Shared Campaigns
GET	/10dlc/partner_campaigns/{campaignId}	Get Single Shared Campaign
PATCH	/10dlc/partner_campaigns/{campaignId}	Update Single Shared Campaign
POST	/10dlc/phoneNumberAssignmentByProfile	Assign Messaging Profile To Campaign
GET	/10dlc/phoneNumberAssignmentByProfile/{taskId}	Get Assignment Task Status
GET	/10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers	Get Phone Number Status
GET	/10dlc/phone_number_campaigns	List phone number campaigns
POST	/10dlc/phone_number_campaigns	Create New Phone Number Campaign
DELETE	/10dlc/phone_number_campaigns/{phoneNumber}	Delete Phone Number Campaign
GET	/10dlc/phone_number_campaigns/{phoneNumber}	Get Single Phone Number Campaign
PUT	/10dlc/phone_number_campaigns/{phoneNumber}	Create New Phone Number Campaign

access_ip_address

Method	Path	Description
GET	/access_ip_address	List all Access IP Addresses
POST	/access_ip_address	Create new Access IP Address
DELETE	/access_ip_address/{access_ip_address_id}	Delete access IP address
GET	/access_ip_address/{access_ip_address_id}	Retrieve an access IP address

access_ip_ranges

Method	Path	Description
GET	/access_ip_ranges	List all Access IP Ranges
POST	/access_ip_ranges	Create new Access IP Range
DELETE	/access_ip_ranges/{access_ip_range_id}	Delete access IP ranges

actions

Method	Path	Description
POST	/actions/purchase/esims	Purchase eSIMs
POST	/actions/register/sim_cards	Register SIM cards

addresses

Method	Path	Description
GET	/addresses	List all addresses
POST	/addresses	Creates an address
POST	/addresses/actions/validate	Validate an address
DELETE	/addresses/{id}	Deletes an address
GET	/addresses/{id}	Retrieve an address
POST	/addresses/{id}/actions/accept_suggestions	Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.

advanced_orders

Method	Path	Description
GET	/advanced_orders	List Advanced Orders
POST	/advanced_orders	Create Advanced Order
PATCH	/advanced_orders/{advanced-order-id}/requirement_group	Update Advanced Order
GET	/advanced_orders/{order_id}	Get Advanced Order

ai

Method	Path	Description
GET	/ai/assistants	List assistants
POST	/ai/assistants	Create an assistant
POST	/ai/assistants/import	Import assistants from external provider
GET	/ai/assistants/tests	List assistant tests with pagination
POST	/ai/assistants/tests	Create a new assistant test
GET	/ai/assistants/tests/test-suites	Get all test suite names
GET	/ai/assistants/tests/test-suites/{suite_name}/runs	Get test suite run history
POST	/ai/assistants/tests/test-suites/{suite_name}/runs	Trigger test suite execution
DELETE	/ai/assistants/tests/{test_id}	Delete an assistant test
GET	/ai/assistants/tests/{test_id}	Get assistant test by ID
PUT	/ai/assistants/tests/{test_id}	Update an assistant test
GET	/ai/assistants/tests/{test_id}/runs	Get test run history for a specific test
POST	/ai/assistants/tests/{test_id}/runs	Trigger a manual test run
GET	/ai/assistants/tests/{test_id}/runs/{run_id}	Get specific test run details
DELETE	/ai/assistants/{assistant_id}	Delete an assistant
GET	/ai/assistants/{assistant_id}	Get an assistant
POST	/ai/assistants/{assistant_id}	Update an assistant
DELETE	/ai/assistants/{assistant_id}/canary-deploys	Delete Canary Deploy
GET	/ai/assistants/{assistant_id}/canary-deploys	Get Canary Deploy
POST	/ai/assistants/{assistant_id}/canary-deploys	Create Canary Deploy
PUT	/ai/assistants/{assistant_id}/canary-deploys	Update Canary Deploy
POST	/ai/assistants/{assistant_id}/chat	Assistant Chat (BETA)
POST	/ai/assistants/{assistant_id}/chat/sms	Assistant Sms Chat
POST	/ai/assistants/{assistant_id}/clone	Clone Assistant
GET	/ai/assistants/{assistant_id}/scheduled_events	List scheduled events
POST	/ai/assistants/{assistant_id}/scheduled_events	Create a scheduled event
DELETE	/ai/assistants/{assistant_id}/scheduled_events/{event_id}	Delete a scheduled event
GET	/ai/assistants/{assistant_id}/scheduled_events/{event_id}	Get a scheduled event
GET	/ai/assistants/{assistant_id}/texml	Get assistant texml
POST	/ai/assistants/{assistant_id}/tools/{tool_id}/test	Test Assistant Tool
GET	/ai/assistants/{assistant_id}/versions	Get all versions of an assistant
DELETE	/ai/assistants/{assistant_id}/versions/{version_id}	Delete a specific assistant version
GET	/ai/assistants/{assistant_id}/versions/{version_id}	Get a specific assistant version
POST	/ai/assistants/{assistant_id}/versions/{version_id}	Update a specific assistant version
POST	/ai/assistants/{assistant_id}/versions/{version_id}/promote	Promote an assistant version to main
POST	/ai/audio/transcriptions	Transcribe speech to text
POST	/ai/chat/completions	Create a chat completion
GET	/ai/clusters	List all clusters
POST	/ai/clusters	Compute new clusters
DELETE	/ai/clusters/{task_id}	Delete a cluster
GET	/ai/clusters/{task_id}	Fetch a cluster
GET	/ai/clusters/{task_id}/graph	Fetch a cluster visualization
GET	/ai/conversations	List conversations
POST	/ai/conversations	Create a conversation
GET	/ai/conversations/insight-groups	Get Insight Template Groups
POST	/ai/conversations/insight-groups	Create Insight Template Group
DELETE	/ai/conversations/insight-groups/{group_id}	Delete Insight Template Group
GET	/ai/conversations/insight-groups/{group_id}	Get Insight Template Group
PUT	/ai/conversations/insight-groups/{group_id}	Update Insight Template Group
POST	/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign	Assign Insight Template To Group
DELETE	/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign	Unassign Insight Template From Group
GET	/ai/conversations/insights	Get Insight Templates
POST	/ai/conversations/insights	Create Insight Template
DELETE	/ai/conversations/insights/{insight_id}	Delete Insight Template
GET	/ai/conversations/insights/{insight_id}	Get Insight Template
PUT	/ai/conversations/insights/{insight_id}	Update Insight Template
DELETE	/ai/conversations/{conversation_id}	Delete a conversation
GET	/ai/conversations/{conversation_id}	Get a conversation
PUT	/ai/conversations/{conversation_id}	Update conversation metadata
GET	/ai/conversations/{conversation_id}/conversations-insights	Get insights for a conversation
POST	/ai/conversations/{conversation_id}/message	Create Message
GET	/ai/conversations/{conversation_id}/messages	Get conversation messages
GET	/ai/embeddings	Get Tasks by Status
POST	/ai/embeddings	Embed documents
GET	/ai/embeddings/buckets	List embedded buckets
DELETE	/ai/embeddings/buckets/{bucket_name}	Disable AI for an Embedded Bucket
GET	/ai/embeddings/buckets/{bucket_name}	Get file-level embedding statuses for a bucket
POST	/ai/embeddings/similarity-search	Search for documents
POST	/ai/embeddings/url	Embed URL content
GET	/ai/embeddings/{task_id}	Get an embedding task's status
GET	/ai/fine_tuning/jobs	List fine tuning jobs
POST	/ai/fine_tuning/jobs	Create a fine tuning job
GET	/ai/fine_tuning/jobs/{job_id}	Get a fine tuning job
POST	/ai/fine_tuning/jobs/{job_id}/cancel	Cancel a fine tuning job
GET	/ai/integrations	List Integrations
GET	/ai/integrations/connections	List User Integrations
DELETE	/ai/integrations/connections/{user_connection_id}	Delete Integration Connection
GET	/ai/integrations/connections/{user_connection_id}	Get User Integration connection By Id
GET	/ai/integrations/{integration_id}	List Integration By Id
GET	/ai/mcp_servers	List MCP Servers
POST	/ai/mcp_servers	Create MCP Server
DELETE	/ai/mcp_servers/{mcp_server_id}	Delete MCP Server
GET	/ai/mcp_servers/{mcp_server_id}	Get MCP Server
PUT	/ai/mcp_servers/{mcp_server_id}	Update MCP Server
GET	/ai/missions	List missions
POST	/ai/missions	Create mission
GET	/ai/missions/events	List recent events
GET	/ai/missions/runs	List recent runs
DELETE	/ai/missions/{mission_id}	Delete mission
GET	/ai/missions/{mission_id}	Get mission
PUT	/ai/missions/{mission_id}	Update mission
POST	/ai/missions/{mission_id}/clone	Clone mission
GET	/ai/missions/{mission_id}/knowledge-bases	List knowledge bases
POST	/ai/missions/{mission_id}/knowledge-bases	Create knowledge base
DELETE	/ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}	Delete knowledge base
GET	/ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}	Get knowledge base
PUT	/ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}	Update knowledge base
GET	/ai/missions/{mission_id}/mcp-servers	List MCP servers
POST	/ai/missions/{mission_id}/mcp-servers	Create MCP server
DELETE	/ai/missions/{mission_id}/mcp-servers/{mcp_server_id}	Delete MCP server
GET	/ai/missions/{mission_id}/mcp-servers/{mcp_server_id}	Get MCP server
PUT	/ai/missions/{mission_id}/mcp-servers/{mcp_server_id}	Update MCP server
GET	/ai/missions/{mission_id}/runs	List runs for mission
POST	/ai/missions/{mission_id}/runs	Start a run
GET	/ai/missions/{mission_id}/runs/{run_id}	Get run details
PATCH	/ai/missions/{mission_id}/runs/{run_id}	Update run
POST	/ai/missions/{mission_id}/runs/{run_id}/cancel	Cancel run
GET	/ai/missions/{mission_id}/runs/{run_id}/events	List events
POST	/ai/missions/{mission_id}/runs/{run_id}/events	Log event
GET	/ai/missions/{mission_id}/runs/{run_id}/events/{event_id}	Get event details
POST	/ai/missions/{mission_id}/runs/{run_id}/pause	Pause run
GET	/ai/missions/{mission_id}/runs/{run_id}/plan	Get plan
POST	/ai/missions/{mission_id}/runs/{run_id}/plan	Create initial plan
POST	/ai/missions/{mission_id}/runs/{run_id}/plan/steps	Add step(s) to plan
GET	/ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}	Get step details
PATCH	/ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}	Update step status
POST	/ai/missions/{mission_id}/runs/{run_id}/resume	Resume run
GET	/ai/missions/{mission_id}/runs/{run_id}/telnyx-agents	List linked Telnyx agents
POST	/ai/missions/{mission_id}/runs/{run_id}/telnyx-agents	Link Telnyx agent to run
DELETE	/ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id}	Unlink Telnyx agent
GET	/ai/missions/{mission_id}/tools	List tools
POST	/ai/missions/{mission_id}/tools	Create tool
DELETE	/ai/missions/{mission_id}/tools/{tool_id}	Delete tool
GET	/ai/missions/{mission_id}/tools/{tool_id}	Get tool
PUT	/ai/missions/{mission_id}/tools/{tool_id}	Update tool
GET	/ai/models	Get available models
POST	/ai/openai/embeddings	Create embeddings
GET	/ai/openai/embeddings/models	List embedding models
POST	/ai/summarize	Summarize file content

alphanumeric_sender_ids

Method	Path	Description
GET	/alphanumeric_sender_ids	List alphanumeric sender IDs
POST	/alphanumeric_sender_ids	Create an alphanumeric sender ID
DELETE	/alphanumeric_sender_ids/{id}	Delete an alphanumeric sender ID
GET	/alphanumeric_sender_ids/{id}	Retrieve an alphanumeric sender ID

audit_events

Method	Path	Description
GET	/audit_events	List Audit Logs

authentication_providers

Method	Path	Description
GET	/authentication_providers	List all SSO authentication providers
POST	/authentication_providers	Creates an authentication provider
DELETE	/authentication_providers/{id}	Deletes an authentication provider
GET	/authentication_providers/{id}	Retrieve an authentication provider
PATCH	/authentication_providers/{id}	Update an authentication provider

available_phone_number_blocks

Method	Path	Description
GET	/available_phone_number_blocks	List available phone number blocks

available_phone_numbers

Method	Path	Description
GET	/available_phone_numbers	List available phone numbers

balance

Method	Path	Description
GET	/balance	Get user balance details

billing_groups

Method	Path	Description
GET	/billing_groups	List all billing groups
POST	/billing_groups	Create a billing group
DELETE	/billing_groups/{id}	Delete a billing group
GET	/billing_groups/{id}	Get a billing group
PATCH	/billing_groups/{id}	Update a billing group

bulk_sim_card_actions

Method	Path	Description
GET	/bulk_sim_card_actions	List bulk SIM card actions
GET	/bulk_sim_card_actions/{id}	Get bulk SIM card action details

bundle_pricing

Method	Path	Description
GET	/bundle_pricing/billing_bundles	Retrieve Bundles
GET	/bundle_pricing/billing_bundles/{bundle_id}	Get Bundle By Id
GET	/bundle_pricing/user_bundles	Get User Bundles
POST	/bundle_pricing/user_bundles/bulk	Create User Bundles
GET	/bundle_pricing/user_bundles/unused	Get Unused User Bundles
DELETE	/bundle_pricing/user_bundles/{user_bundle_id}	Deactivate User Bundle
GET	/bundle_pricing/user_bundles/{user_bundle_id}	Get User Bundle by Id
GET	/bundle_pricing/user_bundles/{user_bundle_id}/resources	Get User Bundle Resources

call_control_applications

Method	Path	Description
GET	/call_control_applications	List call control applications
POST	/call_control_applications	Create a call control application
DELETE	/call_control_applications/{id}	Delete a call control application
GET	/call_control_applications/{id}	Retrieve a call control application
PATCH	/call_control_applications/{id}	Update a call control application

call_events

Method	Path	Description
GET	/call_events	List call events

calls

Method	Path	Description
POST	/calls	Dial
GET	/calls/{call_control_id}	Retrieve a call status
POST	/calls/{call_control_id}/actions/ai_assistant_add_messages	Add messages to AI Assistant
POST	/calls/{call_control_id}/actions/ai_assistant_start	Start AI Assistant
POST	/calls/{call_control_id}/actions/ai_assistant_stop	Stop AI Assistant
POST	/calls/{call_control_id}/actions/answer	Answer call
POST	/calls/{call_control_id}/actions/bridge	Bridge calls
PUT	/calls/{call_control_id}/actions/client_state_update	Update client state
POST	/calls/{call_control_id}/actions/enqueue	Enqueue call
POST	/calls/{call_control_id}/actions/fork_start	Forking start
POST	/calls/{call_control_id}/actions/fork_stop	Forking stop
POST	/calls/{call_control_id}/actions/gather	Gather
POST	/calls/{call_control_id}/actions/gather_stop	Gather stop
POST	/calls/{call_control_id}/actions/gather_using_ai	Gather using AI
POST	/calls/{call_control_id}/actions/gather_using_audio	Gather using audio
POST	/calls/{call_control_id}/actions/gather_using_speak	Gather using speak
POST	/calls/{call_control_id}/actions/hangup	Hangup call
POST	/calls/{call_control_id}/actions/leave_queue	Remove call from a queue
POST	/calls/{call_control_id}/actions/playback_start	Play audio URL
POST	/calls/{call_control_id}/actions/playback_stop	Stop audio playback
POST	/calls/{call_control_id}/actions/record_pause	Record pause
POST	/calls/{call_control_id}/actions/record_resume	Record resume
POST	/calls/{call_control_id}/actions/record_start	Recording start
POST	/calls/{call_control_id}/actions/record_stop	Recording stop
POST	/calls/{call_control_id}/actions/refer	SIP Refer a call
POST	/calls/{call_control_id}/actions/reject	Reject a call
POST	/calls/{call_control_id}/actions/send_dtmf	Send DTMF
POST	/calls/{call_control_id}/actions/send_sip_info	Send SIP info
POST	/calls/{call_control_id}/actions/siprec_start	SIPREC start
POST	/calls/{call_control_id}/actions/siprec_stop	SIPREC stop
POST	/calls/{call_control_id}/actions/speak	Speak text
POST	/calls/{call_control_id}/actions/streaming_start	Streaming start
POST	/calls/{call_control_id}/actions/streaming_stop	Streaming stop
POST	/calls/{call_control_id}/actions/suppression_start	Noise Suppression Start (BETA)
POST	/calls/{call_control_id}/actions/suppression_stop	Noise Suppression Stop (BETA)
POST	/calls/{call_control_id}/actions/switch_supervisor_role	Switch supervisor role
POST	/calls/{call_control_id}/actions/transcription_start	Transcription start
POST	/calls/{call_control_id}/actions/transcription_stop	Transcription stop
POST	/calls/{call_control_id}/actions/transfer	Transfer call

channel_zones

Method	Path	Description
GET	/channel_zones	List your voice channels for non-US zones
PUT	/channel_zones/{channel_zone_id}	Update voice channels for non-US Zones

charges_breakdown

Method	Path	Description
GET	/charges_breakdown	Get monthly charges breakdown

charges_summary

Method	Path	Description
GET	/charges_summary	Get monthly charges summary

comments

Method	Path	Description
GET	/comments	Retrieve all comments
POST	/comments	Create a comment
GET	/comments/{id}	Retrieve a comment
PATCH	/comments/{id}/read	Mark a comment as read

conferences

Method	Path	Description
GET	/conferences	List conferences
POST	/conferences	Create conference
GET	/conferences/{conference_id}/participants	List conference participants
GET	/conferences/{id}	Retrieve a conference
POST	/conferences/{id}/actions/end	End a conference
POST	/conferences/{id}/actions/gather_using_audio	Gather DTMF using audio prompt in a conference
POST	/conferences/{id}/actions/hold	Hold conference participants
POST	/conferences/{id}/actions/join	Join a conference
POST	/conferences/{id}/actions/leave	Leave a conference
POST	/conferences/{id}/actions/mute	Mute conference participants
POST	/conferences/{id}/actions/play	Play audio to conference participants
POST	/conferences/{id}/actions/record_pause	Conference recording pause
POST	/conferences/{id}/actions/record_resume	Conference recording resume
POST	/conferences/{id}/actions/record_start	Conference recording start
POST	/conferences/{id}/actions/record_stop	Conference recording stop
POST	/conferences/{id}/actions/send_dtmf	Send DTMF to conference participants
POST	/conferences/{id}/actions/speak	Speak text to conference participants
POST	/conferences/{id}/actions/stop	Stop audio being played on the conference
POST	/conferences/{id}/actions/unhold	Unhold conference participants
POST	/conferences/{id}/actions/unmute	Unmute conference participants
POST	/conferences/{id}/actions/update	Update conference participant
GET	/conferences/{id}/participants/{participant_id}	Retrieve a conference participant
PATCH	/conferences/{id}/participants/{participant_id}	Update a conference participant

connections

Method	Path	Description
GET	/connections	List connections
GET	/connections/{connection_id}/active_calls	List all active calls for given connection
GET	/connections/{id}	Retrieve a connection

country_coverage

Method	Path	Description
GET	/country_coverage	Get country coverage
GET	/country_coverage/countries/{country_code}	Get coverage for a specific country

credential_connections

Method	Path	Description
GET	/credential_connections	List credential connections
POST	/credential_connections	Create a credential connection
DELETE	/credential_connections/{id}	Delete a credential connection
GET	/credential_connections/{id}	Retrieve a credential connection
PATCH	/credential_connections/{id}	Update a credential connection
POST	/credential_connections/{id}/actions/check_registration_status	Check a Credential Connection Registration Status

custom_storage_credentials

Method	Path	Description
DELETE	/custom_storage_credentials/{connection_id}	Delete a stored credential
GET	/custom_storage_credentials/{connection_id}	Retrieve a stored credential
POST	/custom_storage_credentials/{connection_id}	Create a custom storage credential
PUT	/custom_storage_credentials/{connection_id}	Update a stored credential

customer_service_records

Method	Path	Description
GET	/customer_service_records	List customer service records
POST	/customer_service_records	Create a customer service record
POST	/customer_service_records/phone_number_coverages	Verify CSR phone number coverage
GET	/customer_service_records/{customer_service_record_id}	Get a customer service record

detail_records

Method	Path	Description
GET	/detail_records	Search detail records

dialogflow_connections

Method	Path	Description
DELETE	/dialogflow_connections/{connection_id}	Delete stored Dialogflow Connection
GET	/dialogflow_connections/{connection_id}	Retrieve stored Dialogflow Connection
POST	/dialogflow_connections/{connection_id}	Create a Dialogflow Connection
PUT	/dialogflow_connections/{connection_id}	Update stored Dialogflow Connection

document_links

Method	Path	Description
GET	/document_links	List all document links

documents

Method	Path	Description
GET	/documents	List all documents
POST	/documents	Upload a document
DELETE	/documents/{id}	Delete a document
GET	/documents/{id}	Retrieve a document
PATCH	/documents/{id}	Update a document
GET	/documents/{id}/download	Download a document
GET	/documents/{id}/download_link	Generate a temporary download link for a document

dynamic_emergency_addresses

Method	Path	Description
GET	/dynamic_emergency_addresses	List dynamic emergency addresses
POST	/dynamic_emergency_addresses	Create a dynamic emergency address.
DELETE	/dynamic_emergency_addresses/{id}	Delete a dynamic emergency address
GET	/dynamic_emergency_addresses/{id}	Get a dynamic emergency address

dynamic_emergency_endpoints

Method	Path	Description
GET	/dynamic_emergency_endpoints	List dynamic emergency endpoints
POST	/dynamic_emergency_endpoints	Create a dynamic emergency endpoint.
DELETE	/dynamic_emergency_endpoints/{id}	Delete a dynamic emergency endpoint
GET	/dynamic_emergency_endpoints/{id}	Get a dynamic emergency endpoint

external_connections

Method	Path	Description
GET	/external_connections	List all External Connections
POST	/external_connections	Creates an External Connection
GET	/external_connections/log_messages	List all log messages
DELETE	/external_connections/log_messages/{id}	Dismiss a log message
GET	/external_connections/log_messages/{id}	Retrieve a log message
DELETE	/external_connections/{id}	Deletes an External Connection
GET	/external_connections/{id}	Retrieve an External Connection
PATCH	/external_connections/{id}	Update an External Connection
GET	/external_connections/{id}/civic_addresses	List all civic addresses and locations
GET	/external_connections/{id}/civic_addresses/{address_id}	Retrieve a Civic Address
PATCH	/external_connections/{id}/locations/{location_id}	Update a location's static emergency address
GET	/external_connections/{id}/phone_numbers	List all phone numbers
GET	/external_connections/{id}/phone_numbers/{phone_number_id}	Retrieve a phone number
PATCH	/external_connections/{id}/phone_numbers/{phone_number_id}	Update a phone number
GET	/external_connections/{id}/releases	List all Releases
GET	/external_connections/{id}/releases/{release_id}	Retrieve a Release request
GET	/external_connections/{id}/uploads	List all Upload requests
POST	/external_connections/{id}/uploads	Creates an Upload request
POST	/external_connections/{id}/uploads/refresh	Refresh the status of all Upload requests
GET	/external_connections/{id}/uploads/status	Get the count of pending upload requests
GET	/external_connections/{id}/uploads/{ticket_id}	Retrieve an Upload request
POST	/external_connections/{id}/uploads/{ticket_id}/retry	Retry an Upload request

fax_applications

Method	Path	Description
GET	/fax_applications	List all Fax Applications
POST	/fax_applications	Creates a Fax Application
DELETE	/fax_applications/{id}	Deletes a Fax Application
GET	/fax_applications/{id}	Retrieve a Fax Application
PATCH	/fax_applications/{id}	Update a Fax Application

faxes

Method	Path	Description
GET	/faxes	View a list of faxes
POST	/faxes	Send a fax
DELETE	/faxes/{id}	Delete a fax
GET	/faxes/{id}	View a fax
POST	/faxes/{id}/actions/cancel	Cancel a fax
POST	/faxes/{id}/actions/refresh	Refresh a fax

fqdn_connections

Method	Path	Description
GET	/fqdn_connections	List FQDN connections
POST	/fqdn_connections	Create an FQDN connection
DELETE	/fqdn_connections/{id}	Delete an FQDN connection
GET	/fqdn_connections/{id}	Retrieve an FQDN connection
PATCH	/fqdn_connections/{id}	Update an FQDN connection

fqdns

Method	Path	Description
GET	/fqdns	List FQDNs
POST	/fqdns	Create an FQDN
DELETE	/fqdns/{id}	Delete an FQDN
GET	/fqdns/{id}	Retrieve an FQDN
PATCH	/fqdns/{id}	Update an FQDN

global_ip_allowed_ports

Method	Path	Description
GET	/global_ip_allowed_ports	List all Global IP Allowed Ports

global_ip_assignment_health

Method	Path	Description
GET	/global_ip_assignment_health	Global IP Assignment Health Check Metrics

global_ip_assignments

Method	Path	Description
GET	/global_ip_assignments	List all Global IP assignments
POST	/global_ip_assignments	Create a Global IP assignment
DELETE	/global_ip_assignments/{id}	Delete a Global IP assignment
GET	/global_ip_assignments/{id}	Retrieve a Global IP
PATCH	/global_ip_assignments/{id}	Update a Global IP assignment

global_ip_assignments_usage

Method	Path	Description
GET	/global_ip_assignments_usage	Global IP Assignment Usage Metrics

global_ip_health_check_types

Method	Path	Description
GET	/global_ip_health_check_types	List all Global IP Health check types

global_ip_health_checks

Method	Path	Description
GET	/global_ip_health_checks	List all Global IP health checks
POST	/global_ip_health_checks	Create a Global IP health check
DELETE	/global_ip_health_checks/{id}	Delete a Global IP health check
GET	/global_ip_health_checks/{id}	Retrieve a Global IP health check

global_ip_latency

Method	Path	Description
GET	/global_ip_latency	Global IP Latency Metrics

global_ip_protocols

Method	Path	Description
GET	/global_ip_protocols	List all Global IP Protocols

global_ip_usage

Method	Path	Description
GET	/global_ip_usage	Global IP Usage Metrics

global_ips

Method	Path	Description
GET	/global_ips	List all Global IPs
POST	/global_ips	Create a Global IP
DELETE	/global_ips/{id}	Delete a Global IP
GET	/global_ips/{id}	Retrieve a Global IP

inbound_channels

Method	Path	Description
GET	/inbound_channels	List your voice channels for US Zone
PATCH	/inbound_channels	Update voice channels for US Zone

inexplicit_number_orders

Method	Path	Description
GET	/inexplicit_number_orders	List inexplicit number orders
POST	/inexplicit_number_orders	Create an inexplicit number order
GET	/inexplicit_number_orders/{id}	Retrieve an inexplicit number order

integration_secrets

Method	Path	Description
GET	/integration_secrets	List integration secrets
POST	/integration_secrets	Create a secret
DELETE	/integration_secrets/{id}	Delete an integration secret

inventory_coverage

Method	Path	Description
GET	/inventory_coverage	Create an inventory coverage request

invoices

Method	Path	Description
GET	/invoices	List invoices
GET	/invoices/{id}	Get invoice by ID

ip_connections

Method	Path	Description
GET	/ip_connections	List Ip connections
POST	/ip_connections	Create an Ip connection
DELETE	/ip_connections/{id}	Delete an Ip connection
GET	/ip_connections/{id}	Retrieve an Ip connection
PATCH	/ip_connections/{id}	Update an Ip connection

ips

Method	Path	Description
GET	/ips	List Ips
POST	/ips	Create an Ip
DELETE	/ips/{id}	Delete an Ip
GET	/ips/{id}	Retrieve an Ip
PATCH	/ips/{id}	Update an Ip

ledger_billing_group_reports

Method	Path	Description
POST	/ledger_billing_group_reports	Create a ledger billing group report
GET	/ledger_billing_group_reports/{id}	Get a ledger billing group report

legacy

Method	Path	Description
GET	/legacy/reporting/batch_detail_records/messaging	Get all MDR detailed report requests
POST	/legacy/reporting/batch_detail_records/messaging	Create a new MDR detailed report request
DELETE	/legacy/reporting/batch_detail_records/messaging/{id}	Delete a MDR detailed report request
GET	/legacy/reporting/batch_detail_records/messaging/{id}	Get a specific MDR detailed report request
GET	/legacy/reporting/batch_detail_records/speech_to_text	Get all Speech to Text batch report requests
POST	/legacy/reporting/batch_detail_records/speech_to_text	Create a new Speech to Text batch report request
DELETE	/legacy/reporting/batch_detail_records/speech_to_text/{id}	Delete a Speech to Text batch report request
GET	/legacy/reporting/batch_detail_records/speech_to_text/{id}	Get a specific Speech to Text batch report request
GET	/legacy/reporting/batch_detail_records/voice	Get all CDR report requests
POST	/legacy/reporting/batch_detail_records/voice	Create a new CDR report request
GET	/legacy/reporting/batch_detail_records/voice/fields	Get available CDR report fields
DELETE	/legacy/reporting/batch_detail_records/voice/{id}	Delete a CDR report request
GET	/legacy/reporting/batch_detail_records/voice/{id}	Get a specific CDR report request
GET	/legacy/reporting/usage_reports/messaging	List MDR usage reports
POST	/legacy/reporting/usage_reports/messaging	Create a new legacy usage V2 MDR report request
DELETE	/legacy/reporting/usage_reports/messaging/{id}	Delete a V2 legacy usage MDR report request
GET	/legacy/reporting/usage_reports/messaging/{id}	Get an MDR usage report
GET	/legacy/reporting/usage_reports/number_lookup	List telco data usage reports
POST	/legacy/reporting/usage_reports/number_lookup	Submit telco data usage report
DELETE	/legacy/reporting/usage_reports/number_lookup/{id}	Delete telco data usage report
GET	/legacy/reporting/usage_reports/number_lookup/{id}	Get telco data usage report by ID
GET	/legacy/reporting/usage_reports/speech_to_text	Get speech to text usage report
GET	/legacy/reporting/usage_reports/voice	List CDR usage reports
POST	/legacy/reporting/usage_reports/voice	Create a new legacy usage V2 CDR report request
DELETE	/legacy/reporting/usage_reports/voice/{id}	Delete a V2 legacy usage CDR report request
GET	/legacy/reporting/usage_reports/voice/{id}	Get a CDR usage report

list

Method	Path	Description
GET	/list	List All Numbers using Channel Billing
GET	/list/{channel_zone_id}	List Numbers using Channel Billing for a specific Zone

managed_accounts

Method	Path	Description
GET	/managed_accounts	Lists accounts managed by the current user.
POST	/managed_accounts	Create a new managed account.
GET	/managed_accounts/allocatable_global_outbound_channels	Display information about allocatable global outbound channels for the current user.
GET	/managed_accounts/{id}	Retrieve a managed account
PATCH	/managed_accounts/{id}	Update a managed account
POST	/managed_accounts/{id}/actions/disable	Disables a managed account
POST	/managed_accounts/{id}/actions/enable	Enables a managed account
PATCH	/managed_accounts/{id}/update_global_channel_limit	Update the amount of allocatable global outbound channels allocated to a specific managed account.

media

Method	Path	Description
GET	/media	List uploaded media
POST	/media	Upload media
DELETE	/media/{media_name}	Deletes stored media
GET	/media/{media_name}	Retrieve stored media
PUT	/media/{media_name}	Update stored media
GET	/media/{media_name}/download	Download stored media

messages

Method	Path	Description
POST	/messages	Send a message
POST	/messages/alphanumeric_sender_id	Send a message using an alphanumeric sender ID
GET	/messages/group/{message_id}	Retrieve group MMS messages
POST	/messages/group_mms	Send a group MMS message
POST	/messages/long_code	Send a long code message
POST	/messages/number_pool	Send a message using number pool
POST	/messages/rcs	Send an RCS message
GET	/messages/rcs/deeplinks/{agent_id}	Generate RCS deeplink
POST	/messages/schedule	Schedule a message
POST	/messages/short_code	Send a short code message
POST	/messages/whatsapp	Send a Whatsapp message
DELETE	/messages/{id}	Cancel a scheduled message
GET	/messages/{id}	Retrieve a message

messaging

Method	Path	Description
GET	/messaging/rcs/agents	List all RCS agents
GET	/messaging/rcs/agents/{id}	Retrieve an RCS agent

…(truncated)

Telnyx API

File contents

Telnyx API

Auth

Base URL

Setup

Endpoints

.well-known

10dlc

access_ip_address

access_ip_ranges

actions

addresses

advanced_orders

ai

alphanumeric_sender_ids

audit_events

authentication_providers

available_phone_number_blocks

available_phone_numbers

balance

billing_groups

bulk_sim_card_actions

bundle_pricing

call_control_applications

call_events

calls

channel_zones

charges_breakdown

charges_summary

comments

conferences

connections

country_coverage

credential_connections

custom_storage_credentials

customer_service_records

detail_records

dialogflow_connections

document_links

documents

dynamic_emergency_addresses

dynamic_emergency_endpoints

external_connections

fax_applications

faxes

fqdn_connections

fqdns

global_ip_allowed_ports

global_ip_assignment_health

global_ip_assignments

global_ip_assignments_usage

global_ip_health_check_types

global_ip_health_checks

global_ip_latency

global_ip_protocols

global_ip_usage

global_ips

inbound_channels

inexplicit_number_orders

integration_secrets

inventory_coverage

invoices

ip_connections

ips

ledger_billing_group_reports

legacy

list

managed_accounts

media

messages

messaging

Related skills

Frequently asked questions

How do I install the Telnyx API skill?

What does the Telnyx API skill do?

Is Telnyx API safe to use?

Which AI agents work with Telnyx API?

Is Telnyx API free to use?

Who published Telnyx API?