This mono repo hosts a collection of snippets that help to understand the power and ease of Twilio services. The code of these minimal demos is enriched with helpful comments to make the files as self-explaining as possible.
Before you can run this project, ensure that you have the following prerequisites:
-
Node.js and npm installed on your machine.
-
A SendGrid account. If you don't have one, sign up for free at SendGrid and obtain an API key.
-
A Twilio account. If you don't have one, sign up for free at Twilio and obtain your account SID, auth token, API key, and API secret.
-
A verified email sender in your SendGrid account. To set up a verified email sender, follow the instructions here.
Optional:
- ngrok to expose local ports to the internet
This project requires the usage of environment variables to configure certain services. To set up these variables, follow the steps below:
-
Copy the
sample.env
file and create a new file named.env
. -
Open the
.env
file and replace the placeholders with your actual API keys and credentials.SENDGRID_API_KEY="SG.xxxxxx" SENDGRID_EMAIL="demo@example.con" TWILIO_ACCOUNT_SID="xxxxxx" TWILIO_AUTH_TOKEN="xxxxxx" TWILIO_API_KEY="xxxxxx" TWILIO_API_SECRET="xxxxxx" TWILIO_SENDER="MSxxxxxx" # messaging service sid, only needed to send WhatsApp messages TWILIO_CONTENT_SID="xxxxx" # only needed to send initial WhatsApp messages TWILIO_IR_API_KEY="xxxxxx" TWILIO_IR_AUTH_TOKEN="xxxxxx" NGROK_SUBDOMAIN="xxxxxx" # only needed the expose localhost to the internet NGROK_TOKEN # only needed the expose localhost to the internet
- Replace
SG.xxxxxx
with your actual SendGrid API key. - Replace
demo@example.con
with the email associated with your SendGrid account. - Replace
xxxxxx
with your actual Twilio account SID, auth token, API key, API secret, IR API key, and IR auth token.
- Replace
-
Save the changes to the
.env
file