Open documentation ↗Overview
SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
Telnyx API is a phone API from telnyx.com. Requests are authenticated with a bearer token. It is served over HTTPS. Its OpenAPI description documents 361 endpoints.
At a glance
- Authentication
- Bearer token
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Phone
- Base URL
https://api.telnyx.com/v2- Version
- 2.0.0
- Endpoints
- 361
- OpenAPI
- Specification ↗
- Spec updated
- 2021-08-23
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.telnyx.com/v2/addresses" \
-H "Accept: application/json" \
-H "Authorization: Bearer YOUR_TOKEN"const response = await fetch("https://api.telnyx.com/v2/addresses", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.telnyx.com/v2/addresses",
headers={
"Accept": "application/json",
"Authorization": "Bearer YOUR_TOKEN",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| POST | /actions/bulk/telephony_credentials | Creates several credentials |
| PATCH | /actions/bulk/telephony_credentials | Update several credentials |
| DELETE | /actions/bulk/telephony_credentials | Delete several credentials |
| PUT | /actions/network_preferences/sim_cards | Bulk Network Preferences for SIM cards |
| POST | /actions/register/sim_cards | Register SIM cards |
| POST | /actions/{action}/telephony_credentials | Perform activate or deactivate action on all credentials filtered by the provided tag. |
| GET | /addresses | List all addresses |
| POST | /addresses | Creates an address |
| POST | /addresses/actions/validate | Validate an address |
| GET | /addresses/{id} | Retrieve an address |
| DELETE | /addresses/{id} | Deletes an address |
| GET | /authentication_providers | List all SSO authentication providers |
| POST | /authentication_providers | Creates an authentication provider |
| GET | /authentication_providers/{id} | Retrieve an authentication provider |
| PATCH | /authentication_providers/{id} | Update a authentication provider |
| DELETE | /authentication_providers/{id} | Deletes an authentication provider |
| GET | /available_phone_number_blocks | List available phone number blocks |
| GET | /available_phone_numbers | List available phone numbers |
| GET | /balance | Retrieve user balance details |
| GET | /billing_groups | List all billing groups |
| POST | /billing_groups | Create a billing group |
| GET | /billing_groups/{id} | Retrieve a billing group |
| PATCH | /billing_groups/{id} | Update a billing group |
| DELETE | /billing_groups/{id} | Delete a billing group |
| GET | /call_control_applications | List call control applications |
| POST | /call_control_applications | Create a call control application |
| GET | /call_control_applications/{id} | Retrieve a call control application |
| PATCH | /call_control_applications/{id} | Update a call control application |
| DELETE | /call_control_applications/{id} | Delete a call control application |
| GET | /call_events | List call events |
| POST | /calls | Dial |
| GET | /calls/{call_control_id} | Retrieve a call status |
| POST | /calls/{call_control_id}/actions/answer | Answer call |
| POST | /calls/{call_control_id}/actions/bridge | Bridge calls |
| 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_stop | Gather stop |
| 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/speak | Speak text |
| 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 |
| 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 |
| 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/dial_participant | Dial a new participant into 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_start | Conference recording start |
| POST | /conferences/{id}/actions/record_stop | Conference recording stop |
| 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 | /connections | List connections |
| GET | /connections/{id} | Retrieve a connection |
| GET | /credential_connections | List credential connections |
| POST | /credential_connections | Create a credential connection |
| GET | /credential_connections/{id} | Retrieve a credential connection |
| PATCH | /credential_connections/{id} | Update a credential connection |
| DELETE | /credential_connections/{id} | Delete a credential connection |
| GET | /detail_records | Search detail records |
| GET | /document_links | List all document links |
| GET | /documents | List all documents |
| POST | /documents | Upload a document |
| GET | /documents/{id} | Retrieve a document |
| PATCH | /documents/{id} | Update a document |
| DELETE | /documents/{id} | Delete a document |
| GET | /documents/{id}/download | Download a document |
| GET | /fax_applications | List all Fax Applications |
| POST | /fax_applications | Creates a Fax Application |
| GET | /fax_applications/{id} | Retrieve a Fax Application |
| PATCH | /fax_applications/{id} | Update a Fax Application |
| DELETE | /fax_applications/{id} | Deletes a Fax Application |
| GET | /faxes | View a list of faxes |
| POST | /faxes | Send a fax |
| GET | /faxes/{id} | View a fax |
| DELETE | /faxes/{id} | Delete a fax |
Showing the first 100 of 361 endpoints; the full list is in the documentation.
Questions
Does the Telnyx API API need an API key?
Yes. The Telnyx API API uses Bearer token authentication; the documentation explains how to get credentials.
Does the Telnyx API API support HTTPS?
Yes, the Telnyx API API is served over HTTPS.
How many endpoints does the Telnyx API API have?
Its OpenAPI description lists 361 endpoints in version 2.0.0. The first 100 are shown on this page.
What are alternatives to the Telnyx API API?
Other Phone APIs include Twilio - Accounts, ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management, Twilio - Api, Mobility API, Twilio - Autopilot.
Similar phone APIs
Compare alternatives →
Twilio - Accounts
PhoneThis is the public Twilio REST API.
ETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management
PhoneETSI GS MEC 010-2 - Part 2: Application lifecycle, rules and requirements management described using OpenAPI.
Twilio - Api
PhoneThis is the public Twilio REST API.
Mobility API
PhoneTransit API can be used to obtain time-aggregated data representing moving the people between various spatial points within the Czech Republic. Having A - 'from' and B - 'to' points, the API can return count of people traveling from A to B or people that are from A and traveling to B, etc. The mobility data is based on moving mobile stations in O2 mobile network.
Twilio - Autopilot
PhoneThis is the public Twilio REST API.
Socio-demo API
PhoneSocio-demo API can be used to obtain time-aggregated data representing groups of people on the given location in the Czech Republic. Having a location, the API can return count of people belonging to age group or gender aggregated by hours. The socio-demo data is based on presence of mobile stations in O2 mobile network.
Listed from APIs.guru (CC0).