Telnyx

Fetch message body by id.

Fetch Mdr message body

Get a credential

Get the details of an existing On-demand Credential.

Get a Private Wireless Gateway

Retrieve information about a Private Wireless Gateway.

Get a Wireless Detail Record (WDR) Report

Returns one specific WDR report

Get all outbound voice profiles

Get all outbound voice profiles belonging to the user that match the given filters.

Get all Private Wireless Gateways

Get all Private Wireless Gateways belonging to the user.

Get all Wireless Detail Records (WDRs) Reports

Returns the WDR Reports that match the given parameters.

Get OTA update

This API returns the details of an Over the Air (OTA) update.

Get User

Retrieve WhatsApp user information.

getCdrRequests

Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling all messaging records.

getMdrRequest

Fetch single messaging detail report by id.

getRequest

Fetch single whatsapp detail report by id.

getRequests

Fetch all previous requests for WhatsApp detail reports. WhatsApp detail reports are reports for pulling all WhatsApp records.

getUsageAggregationsSync

Generate and fetch WhatsApp usage aggregations synchronously. This endpoint will both generate and fetch the WhatsApp aggregations over a specified time period.

getUsageReport

Fetch a single messaging usage report by id

getUsageReports

Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown

getUsageReportSync

Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.

getUsageReportSync_1

Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.

List all addresses

Returns a list of your addresses.

List all billing groups

List all comments for a portout request

Returns a list of comments for a portout request.

List all comments of a porting order

Returns a list of all comments of a porting order.

List all credentials

List all On-demand Credentials.

List all document links

List all documents links ordered by created_at descending.

List all documents

List all documents ordered by created_at descending.

List all exception types

Returns a list of all possible exception types for a porting order.

List all Fax Applications

This endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. You can adjust which applications are listed by using filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.

List all Notifications Events

Returns a list of your notifications events.

List all Notifications Events Conditions

Returns a list of your notifications events conditions.

List all Notifications Profiles

Returns a list of your notifications profiles.

List all porting activation jobs

Returns a list of your porting activation jobs.

List all porting phone numbers

Returns a list of your porting phone numbers.

List all requirement types

List all requirement types ordered by created_at descending

List all requirements

List all requirements with filtering, sorting, and pagination

List all SSO authentication providers

Returns a list of your SSO authentication providers.

List all tags

Returns a list of tags used on Credentials

List all TeXML Applications

Returns a list of your TeXML Applications.

List all Verify profiles

Gets a paginated list of Verify profiles.

List call control applications

Return a list of call control applications.

List call events

Filters call events by given filter parameters. Events are ordered by `event_timestamp`. If filter for `call_leg_id` or `call_session_id` is not present, it only filters events from the last 24 hours. **Note**: Only one `filter[event_timestamp]` can be passed.

List conference participants

Lists conference participants

List conferences

Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by `expires_at`.

List connections

Returns a list of your connections irrespective of type.

List credential connections

Returns a list of your credential connections.

List FQDN connections

Returns a list of your FQDN connections.

List FQDNs

Get all FQDNs belonging to the user that match the given filters.

List Ip connections

Returns a list of your IP connections.

List Ips

Get all IPs belonging to the user that match the given filters.

List messaging hosted number orders

List messaging profile metrics

List messaging profiles

List messaging URL domains

List notification channels

List notification channels.

List notification settings

List notification settings.

List number block orders

Get a paginated list of number block orders.

List number order documents

Gets a paginated list of number order documents.

List number reservations

Gets a paginated list of phone number reservations.

List OTA updates

List phone numbers associated with a messaging profile

List phone numbers with messaging settings

List phone numbers with voice settings

List recordings

Lists recordings for the authenticated user

List short codes

List short codes associated with a messaging profile

List sub number orders

Get a paginated list of sub number orders.

List verifications by phone number

Lists accounts managed by the current user.

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.

Lists the phone number blocks jobs

Lists the phone numbers jobs

Retrieve a billing group

Retrieve a call control application

Retrieves the details of an existing call control application.

Retrieve a call from a queue

Retrieve an existing call from an existing queue

Retrieve a call queue

Retrieve an existing call queue

Retrieve a call status

Returns the status of a call (data is available 10 minutes after call ended).

Retrieve a comment

Retrieve a conference

Retrieve an existing conference

Retrieve a connection

Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.

Retrieve a credential connection

Retrieves the details of an existing credential connection.

Retrieve a document

Retrieve a document.

Retrieve a document requirement

Retrieve a document requirement record

Retrieve a Fax Application

Return the details of an existing Fax Application inside the 'data' attribute of the response.

Retrieve a ledger billing group report

Retrieve a list of portout requests

Returns the portout requests according to filters

Retrieve a managed account

Retrieves the details of a single managed account.

Retrieve a porting activation job

Returns a porting activation job.

Retrieve a porting order

Retrieves the details of an existing porting order.

Retrieve a portout request

Returns the portout request based on the ID provided

Retrieve a requirement types

Retrieve a requirement type by id

Retrieve a TeXML Application

Retrieves the details of an existing TeXML Application.

Retrieve all comments

Retrieve an address

Retrieves the details of an existing address.

Retrieve an authentication provider

Retrieves the details of an existing authentication provider.

Retrieve an FQDN

Return the details regarding a specific FQDN.

Retrieve an FQDN connection

Retrieves the details of an existing FQDN connection.

Retrieve an Ip

Return the details regarding a specific IP.

Retrieve an Ip connection

Retrieves the details of an existing ip connection.

Retrieve calls from a queue

Retrieve the list of calls in an existing queue

Retrieve stored media

Returns the information about a stored media file.

Retrieve user balance details

Retrieve your inbound channels

Returns the inbound channels for your account. Inbound channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.