This is the current API V1 documentation. Explore our API V2 if you’d like to test new features.

Open SidemenuDocs
Docs
Close Sidemenu

Authenticationauthentication

Log in to your Mission Control PortalTelnyx Developers account and navigate to the "Auth" section to view your API Tokens in the Auth V1 tab.

API User and Tokenapi-user-and-token

API User may either be your Portal email address or your 24-character API Access Key. You can find your API Access Key and API Token under AuthPORTAL in the Portal.

In the "Auth V1" tab add an API Token if you have not done so already. Once you have your API User and Token, you may use them as header values in HTTP requests.

Example User and Token Request Headerexample-user-and-token-request-header

x-api-user: example@telnyx.com
x-api-token: MY_TOKEN

Example Authorization Request Headerexample-authorization-request-header

Authorization: Token MY_TOKEN

IP Authenticationip-authentication

CNAM and LRN Data endpoints that do not use HTTP will require IP authentication. You'll need to add IPs to a connection. You can then create a data profile through the Portal Telco Data interfacePORTAL and choose IP Address as the authentication method, and then select the connection with the IPs you’d like to whitelist. You can read more on how to authenticate specific endpoints in the CNAM DataAPI and LRN DataAPI overviews.

Sending SMSsending-sms

An API token isn't required to send SMS. Create a new Messaging profile to obtain a Messaging Profile secret to add to your HTTP headers. More in-depth information on sending SMS can be found in the Messaging section.

Example SMS (Send) Request Headerexample-sms--send--request-header

x-profile-secret: YOUR_MESSAGING_PROFILE_SECRET

Glossaryglossary

API User Your Portal account email address or API Access Key
API Access Key Access key used in place of your Portal email address as the API User
API Token Token generated within your Telnyx account to use with API requests
IP Authentication Uses IP addresses as the authentication method, as opposed to token-based authentication
Profile Secret Messaging Profile token used to authenticate SMS send requests