The documentation for the Twilio API can be found here.
The Node library documentation can be found here.
Some Twilio features that are exposed in this library are in Beta or Developer Preview, and are not available to most accounts. Such products are explicitly documented as Beta/Developer Preview both in the Twilio docs and console, as well as through in-line code documentation here in the library.
twilio-node uses a modified version of Semantic Versioning for all changes. See this document for details.
This library works with node versions 6, 8 and above.
TypeScript is supported for TypeScript version 2.9 and above.
Check out these code examples in JavaScript and TypeScript to get up and running quickly.
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: TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN.
If your environment requires SSL decryption, you can set the path to CA bundle in the env var TWILIO_CA_BUNDLE.
The Dockerfile present in this repository and its respective twilio/twilio-node Docker image are currently used by Twilio for testing purposes only.
If you need help installing or using the library, please check the Twilio Support Help Center first, and file a support ticket if you don't find an answer to your question.
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:
npm installYou can run the existing tests to see if everything is okay by executing:
npm testTo run just one specific test file instead of the whole suite, provide a JavaScript regular expression that will match your spec file's name, like:
npm run test -- -m .\*client.\*