Programmable Voice Quickstart for Go

Before you can make a call from Go, you'll need to sign up for a Twilio account or log in to an account you already have.

The next thing you'll need is a voice-capable Twilio phone number. If you don't currently own a Twilio phone number with voice call functionality, you'll need to purchase one. After navigating to the Buy a Number page, check the "Voice" box and click "Search."

Expand image

You'll then see a list of available phone numbers and their capabilities. Find a number that suits your fancy and click "Buy" to add it to your account.

Now that you have a Twilio account and a programmable phone number, you have the basic tools you need to make a phone call.

Next, we'll use the Twilio module for Go to help communicate with Twilio's APIs. Let's install that now.

Before you can follow the rest of this tutorial, you'll need to have Go and the Twilio Go module installed.

You can check if you already have Go installed on your machine by opening up a terminal and running the following command:

go version

You should see something like:

1
$ go version
2
go version go1.19 darwin/amd64

If you don't have Go installed, head over to go.dev and download the appropriate installer for your system. Once you've installed Go, return to your terminal, and run the command above once again. If you don't see the installed Go version, you may need to relaunch your terminal.

Create a new Go project from your terminal using:

go mod init twilio-example

Once your project has been initialized, navigate into the newly created twilio-example directory and install the Twilio Go helper library module.

go get github.com/twilio/twilio-go

This will install the twilio-go module so that your Go code in the current directory can make use of it.

Let's put that Twilio Go library to good use.

With a single API request, we can make an outbound call from the Twilio phone number we just purchased. Open a new file called makecall.go and type or paste in the following code:

1
// Download the helper library from https://www.twilio.com/docs/go/install
2
package main
3

4
import (
5
	"fmt"
6
	"github.com/twilio/twilio-go"
7
	api "github.com/twilio/twilio-go/rest/api/v2010"
8
	"os"
9
)
10

11
func main() {
12
	// Find your Account SID and Auth Token at twilio.com/console
13
	// and set the environment variables. See http://twil.io/secure
14
	// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment
15
	client := twilio.NewRestClient()
16

17
	params := &api.CreateCallParams{}
18
	params.SetUrl("http://demo.twilio.com/docs/voice.xml")
19
	params.SetTo("+123456789")
20
	params.SetFrom("+987654321")
21

22
	resp, err := client.Api.CreateCall(params)
23
	if err != nil {
24
		fmt.Println(err.Error())
25
		os.Exit(1)
26
	} else {
27
		if resp.Sid != nil {
28
			fmt.Println(*resp.Sid)
29
		} else {
30
			fmt.Println(resp.Sid)
31
		}
32
	}
33
}

1
{
2
  "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
3
  "annotation": null,
4
  "answered_by": null,
5
  "api_version": "2010-04-01",
6
  "caller_name": null,
7
  "date_created": "Tue, 31 Aug 2010 20:36:28 +0000",
8
  "date_updated": "Tue, 31 Aug 2010 20:36:44 +0000",
9
  "direction": "inbound",
10
  "duration": "15",
11
  "end_time": "Tue, 31 Aug 2010 20:36:44 +0000",
12
  "forwarded_from": "+141586753093",
13
  "from": "+987654321",
14
  "from_formatted": "(415) 867-5308",
15
  "group_sid": null,
16
  "parent_call_sid": null,
17
  "phone_number_sid": "PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18
  "price": "-0.03000",
19
  "price_unit": "USD",
20
  "sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
21
  "start_time": "Tue, 31 Aug 2010 20:36:29 +0000",
22
  "status": "completed",
23
  "subresource_uris": {
24
    "notifications": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Notifications.json",
25
    "recordings": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings.json",
26
    "payments": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments.json",
27
    "events": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Events.json",
28
    "siprec": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Siprec.json",
29
    "streams": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Streams.json",
30
    "transcriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Transcriptions.json",
31
    "user_defined_message_subscriptions": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessageSubscriptions.json",
32
    "user_defined_messages": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/UserDefinedMessages.json"
33
  },
34
  "to": "+123456789",
35
  "to_formatted": "(415) 867-5309",
36
  "trunk_sid": null,
37
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json",
38
  "queue_time": "1000"
39
}

This code starts a phone call between the two phone numbers that we pass as arguments. The 'from' number is our Twilio number, and the 'to' number is who we want to call.

The URL argument points to some TwiML, which tells Twilio what to do next when our recipient answers their phone. This TwiML instructs Twilio to read a message using text to speech and then play an MP3.

Before this code works, though, we need to do prepare your environment a bit more to work with your Twilio account.

You'll notice that this code's main function creates a new Twilio client using the twilio.NewRestClient method, but no credentials are passed to it directly. The Twilio Go helper checks to see if your credentials are available as environment variables, and automatically consumes them for you.

To get and set these credentials, first go to https://www.twilio.com/console and log in. On this page, you'll find your unique Account SID and Auth Token, which you'll need any time you send messages through the Twilio client like this. You can reveal your auth token by clicking Show:

Expand image

Copy each value, and set them as environment variables in your terminal with the following commands (replacing the placeholders with your own values):

1
export TWILIO_ACCOUNT_SID=<your-account-sid>
2
export TWILIO_AUTH_TOKEN=<your-auth-token>

Remember that voice-enabled phone number you bought just a few minutes ago? Go ahead and update the existing call to params.SetFrom to use that number instead, making sure to use E.164 formatting:

[+][country code][phone number including area code]

Next, replace the phone number in params.SetTo with your mobile phone number. This number can be for any phone that can receive calls, but it's a good idea to test with your phone so that you can see the magic happen! As above, you should use E.164 formatting for this value.

Save your changes and run the code by running the following command from your terminal:

go run makecall.go

That's it! Your phone should ring with a call from your Twilio number, and you'll hear our short message for you. 😉

Next, we'll learn how to respond to a call made to your Twilio phone number. First, we'll need to get a Gin server up and running.

When your Twilio number receives an incoming phone call, it will send an HTTP request to a server you control. This callback mechanism is known as a webhook. When Twilio sends your application a request, it expects a response in the TwiML XML format that tells it how to respond to the call.

To handle incoming phone calls we'll need a lightweight web application to accept incoming HTTP requests from Twilio. While you can use any number of web frameworks to make and receive calls from your application, we'll use Go with the Gin framework in this quickstart.

On the command line in your current directory, run the following command:

go get -u github.com/gin-gonic/gin

Create a file called server.go and use the following code to create a server that can handle incoming messages.

1
package main
2

3
import (
4
	"net/http"
5

6
	"github.com/gin-gonic/gin"
7
	"github.com/twilio/twilio-go/twiml"
8
)
9

10
func main() {
11
	router := gin.Default()
12

13
	router.POST("/answer", func(context *gin.Context) {
14
		say := &twiml.VoiceSay{
15
			Message: "Hello from your pals at Twilio! Have fun.",
16
		}
17

18
		twimlResult, err := twiml.Voice([]twiml.Element{say})
19
		if err != nil {
20
			context.String(http.StatusInternalServerError, err.Error())
21
		} else {
22
			context.Header("Content-Type", "text/xml")
23
			context.String(http.StatusOK, twimlResult)
24
		}
25
	})
26

27
	router.Run(":1337")
28
}

Run this server with the following command:

go run server.go

Now, all you have to do is expose this server to Twilio.

Before you can instruct Twilio on what to do in response to an incoming call, you first need to expose your server to the public. When you run your local development server, the odds are very high it is only accessible from your local network. But don't worry—we'll show you a way to test your server.

Many Twilio products and services use webhooks to communicate with your application. For example, when Twilio receives an incoming call, it reaches out to a specific URL you provide to search for instructions on how to handle the response.

The small piece of code in server.go is an example of one instruction you can use to 'speak' back to the caller. We just have to find a way to expose this server to the public.

While there are many ways to make this code public (for example by deploying it to a host), we recommend a tool called ngrok. When you start ngrok, it provides a unique URL on the ngrok.io domain and forwards incoming requests to your local development environment.

The architecture looks like this:

Expand image

If you don't already use ngrok, head over to their download page and grab the appropriate binary for your operating system. Once downloaded, unzip the package.

If you're working on a Mac or Linux, you're all set. If you're on Windows, follow our guide on how to install and configure ngrok on Windows. For more info on ngrok, including some great tips and tricks, check out this in-depth blog post.

Once downloaded, make sure your server is running if it isn't already with:

go run server.go

Your local application must be running locally for ngrok to do its magic.

Then open a new terminal tab or window and start ngrok with this command:

ngrok http 1337

If your local server is running on a different port, replace 1337 with the correct port number.

You should see output similar to this:

Expand image

Copy your public URL from this output and paste it into your browser. You should see your Gin application's "Hello from your pals at Twilio!" message if you append /answer to that URL.

Now, you must take that public URL and configure this as a webhook for one of your phone numbers in the console. Go back to the console, select your phone number, change "A CALL COMES IN" to Webhook, and then put in the external URL to your service, such as https://069a61b7.ngrok.io/answer, as shown above.

Make sure to click save, and head back to your terminal. Make sure ngrok is still running in one tab, and in another, run go run server.go if it is not running already.

Make a phone call to your Twilio phone number. Within a few moments, you'll see an HTTP request in your ngrok console, and you'll hear a short message once the call connects.

And there you… go—you've successfully made and received a call with Go.

Now you know the basics of making and responding to phone calls with Go.

This app only used the <Say> TwiML verb to read a message to the caller using text to speech. With different TwiML verbs, you can create other powerful constructs and call flows. Try a few, such as <Record>, <Gather>, and <Conference>.

We can't wait to see what you build!