Make a Call

The Serverless Toolkit enables you with local development, project deployment, and other functionality via the Twilio CLI. To get up and running with these examples using Serverless Toolkit, follow this process:

1. From the CLI, run twilio serverless:init <your-service-name> --empty to bootstrap your local environment.
2. Navigate into your new project directory using cd <your-service-name>
3. In the /functions directory, create a new JavaScript file that is named respective to the purpose of the Function. For example, sms-reply.protected.js for a Protected Function intended to handle incoming SMS.
4. Populate the file using the code example of your choice and save.
   Note A Function can only export a single handler. You will want to create separate files if you want to run and/or deploy multiple examples at once.

Once your Function(s) code is written and saved, you can test it either by running it locally (and optionally tunneling requests to it via a tool like ngrok), or by deploying the Function and executing against the deployed url(s).

Run your Function in local development

Run twilio serverless:start from your CLI to start the project locally. The Function(s) in your project will be accesible from http://localhost:3000/sms-reply

• If you want to test a Function as a Twilio webhook, run:
  twilio phone-numbers:update <your Twilio phone number> --sms-url "http://localhost:3000/sms-reply"​
  This will automatically generate an ngrok tunnel from Twilio to your locally running Function, so you can start sending texts to it. You can apply the same process but with the voice-url flag instead if you want to test with Twilio Voice.
• If your code does not connect to Twilio Voice/Messages as a webhook, you can start your dev server and start an ngrok tunnel in the same command with the ngrok flag. For example: twilio serverless:start --ngrok=""

Deploy your Function

To deploy your Function and have access to live url(s), run twilio serverless:deploy from your CLI. This will deploy your Function(s) to Twilio under a development environment by default, where they can be accessed from:

https://<service-name>-<random-characters>-dev.twil.io/<function-path>

For example: https://incoming-sms-examples-3421-dev.twil.io/sms-reply

const { getExpectedTwilioSignature } = require('twilio/lib/webhooks/webhooks');

// Retrieve your auth token from the environment instead of hardcoding
const authToken = process.env.TWILIO_AUTH_TOKEN;

// Use the Twilio helper to generate your valid signature!
// The 1st argument is your Twilio auth token.
// The 2nd is the full URL of your Function including query params.
// The 3rd is any form encoded data being sent, which is none!
const xTwilioSignature = getExpectedTwilioSignature(
  authToken,
  'https://example-4321.twil.io/sms/send?Body=hello',
  {} // <- Leave this empty
);

// Print the signature to the console for use with your
// preferred HTTP client
console.log('xTwilioSignature: ', xTwilioSignature);

// For example, output will look like this:
// xTwilioSignature: a610Oi5WiDIHNrUsQYUvNCxKv7A=

Create a valid request

Once you've generated a valid X-Twilio-Signature value, it's time to use this as a header in a request to your Function. You can do so using a variety of tools, such as curl, Postman, and more. Be sure to:

• Set the URL of the Function, including the root of your Service, full path to the deployed Function, and your query parameters.
• Set the X-Twilio-Signature header for your request.

Using curl, the example request above would look like this:

curl -X GET 'http://test-4321.twil.io/sms/send?Body=hello' \
  -H 'X-Twilio-Signature: a610Oi5WiDIHNrUsQYUvNCxKv7A='