This is the API V2 documentation. To switch out of beta revert back to our API V1.

Open SidemenuDocs
Docs
Close Sidemenu
Choose:
NodePHPRubyPython
NodePHPRubyPython

Development Environment Setupdevelopment-environment-setup

Get up and running with our Client libraries and start developing your Telnyx integration.

Integrating Telnyx into your app or website can begin as soon as you create a Telnyx account, requiring only two steps: 1. Obtain your API key so Telnyx can authenticate your integration’s API requests 2. Install a Client library so your integration can interact with the Telnyx API


Step 1: Obtain your API keysstep-1--obtain-your-api-keys

Telnyx authenticates your API requests using your account’s API Key. If you do not include your key when making an API request, or use one that is incorrect or outdated, Telnyx returns an error.

Your API Keys are available in the "Auth"PORTAL section of the Portal. Once you create an API Key you must save it for future use. You will only see your API Key once, on creation.

We include YOUR_API_KEY in our code examples. Replace this text with your own API Key.

If you cannot see your API keys in the Portal, this means you do not have access to them. Only Telnyx account owners can access API Keys.

Step 2: Install a Client librarystep-2--install-a-client-library

You'll need to ensure that you have Node.js installed on your computer. If Node isn’t installed, follow the official installation instructionsTelnyx Developers for your operating system to install it. You can check this by running the following:

node --version

You’ll need to have npm installed (npm is installed with Node.js). You can check this by running:

npm --version

Install the Telnyx Node SDKTelnyx Developers by running the following:

npm install telnyx

Check out the Node API docsAPI, or see the source on GitHubTelnyx Developers.

Was this page helpful?was-this-page-helpful