A node.js Twilio helper library.
This library works with node versions 6, 8 and above.
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.
End User Docs
For detailed usage information and API docs, head out here:
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 contact Twilio Support at email@example.com first. Twilio's Support staff are well-versed in all of the Twilio Helper Libraries, and usually reply within 24 hours.
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 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.\*
Please refer to our Contributing Guide for detailed information on how you can contribute.
Right now, the docs are maintained in static HTML in the
gh-pages branch of this repository. We hope to switch to a more robust documentation system soon, but for the time being, you can make documentation changes by editing index.html directly.