The default branch name for this repository has been changed to
main as of 07/27/2020.
The documentation for the Twilio API can be found here.
The Node library documentation can be found here.
Supported Node.js Versions
This library supports the following Node.js implementations:
- Node.js 6
- Node.js 8
- Node.js 10
- Node.js 12
- Node.js 14
TypeScript is supported for TypeScript version 2.9 and above.
twilio-node supports credential storage in environment variables. If no credentials are provided when instantiating the Twilio client (e.g.,
const client = require('twilio')();), the values in following env vars will be used:
If your environment requires SSL decryption, you can set the path to CA bundle in the env var
twilio-node supports lazy loading required modules for faster loading time. Lazy loading is disabled by default. To enable lazy loading, simply instantiate the Twilio client with the
lazyLoading flag set to
var accountSid = processenvTWILIO_ACCOUNT_SID; // Your Account SID from www.twilio.com/consolevar authToken = processenvTWILIO_AUTH_TOKEN; // Your Auth Token from www.twilio.com/consoleconst client = accountSid authTokenlazyLoading: true;
Specify Region and/or Edge
To take advantage of Twilio's Global Infrastructure, specify the target Region and/or Edge for the client:
var accountSid = processenvTWILIO_ACCOUNT_SID; // Your Account SID from www.twilio.com/consolevar authToken = processenvTWILIO_AUTH_TOKEN; // Your Auth Token from www.twilio.com/consoleconst client = accountSid authTokenregion: 'au1'edge: 'sydney';
Alternatively, specify the edge and/or region after constructing the Twilio client:
const client = accountSid authToken;clientregion = 'au1';clientedge = 'sydney';
This will result in the
hostname transforming from
Enable Debug Logging
There are two ways to enable debug logging in the default HTTP client. You can create an environment variable called
TWILIO_LOG_LEVEL and set it to
debug or you can set the logLevel variable on the client as debug:
var accountSid = processenvTWILIO_ACCOUNT_SID; // Your Account SID from www.twilio.com/consolevar authToken = processenvTWILIO_AUTH_TOKEN; // Your Auth Token from www.twilio.com/consoleconst client = accountSid authTokenlogLevel: 'debug';
You can also set the logLevel variable on the client after constructing the Twilio client:
const client = accountSid authToken;clientlogLevel = 'debug';
For an example on how to handle exceptions in this helper library, please see the Twilio documentation.
Using a Custom HTTP Client
To use a custom HTTP client with this helper library, please see the Twilio documentation.
Dockerfile present in this repository and its respective
twilio/twilio-node Docker image are currently used by Twilio for testing purposes only.
If you've instead found a bug in the library or would like new features added, go ahead and open issues or pull requests against this repo!
Bug fixes, docs, and library improvements are always welcome. Please refer to our Contributing Guide for detailed information on how you can contribute.
⚠️ Please be aware that a large share of the files are auto-generated by our backend tool. You are welcome to suggest changes and submit PRs illustrating the changes. However, we'll have to make the changes in the underlying tool. You can find more info about this in the Contributing Guide.
If you're not familiar with the GitHub pull request/contribution process, this is a nice tutorial.
If you want to familiarize yourself with the project, you can start by forking the repository and cloning it in your local development environment. The project requires Node.js to be installed on your machine.
After cloning the repository, install the dependencies by running the following command in the directory of your cloned repository:
You can run the existing tests to see if everything is okay by executing:
npm run test -- -m .\*client.\*