With just a few lines of code, your application can send and receive messages with WhatsApp using the Twilio API for WhatsApp.
This WhatsApp Quickstart will teach you how to do this using the Twilio Sandbox for WhatsApp, Go, the Twilio Go helper library, and the Gin web framework. In this Quickstart, you will learn how to:
Prefer to watch a video? The video below shows you how to use the Sandbox to send and receive WhatsApp messages.
Before you can send a WhatsApp message from your web language, you'll need to sign up for a Twilio account or sign into your existing account and activate the Twilio Sandbox for WhatsApp. The sandbox allows you to prototype with WhatsApp immediately using a shared phone number, without waiting for a dedicated number to be approved by WhatsApp.
To get started, navigate to the Twilio Sandbox for WhatsApp. Look for your unique sandbox keyword listed as "join <your sandbox keyword>" as shown in the image below.
Send this join message to the pre-provisioned Twilio WhatsApp phone number (+1-415-523-8886). For example, if your code is cheese-bags
, you would send the message "join cheese-bags". You'll then receive a confirmation message from Twilio that your sandbox can now be used to send and receive messages!
To disconnect from the sandbox, you can reply to the message from WhatsApp with sandbox stop
, or switch to a different sandbox by messaging join <other sandbox keyword>
.
To invite someone else to your sandbox, create a link with the following format containing the opt-in message and send it to them: whatsapp://send?phone=<Your Sandbox Number>&text=<your URL-encoded sandbox keyword>
You can also create a QR code with the link format above that users can scan on their phone to opt in to your sandbox.
Please be aware that the Twilio Sandbox for WhatsApp is meant for testing and discovery purposes only. It should not be used for production.
Before you can send any messages, you'll need to gather your Twilio account credentials. You can find these in the Twilio Console.
You can reveal your Auth Token by clicking Show:
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.
Copy the values from the previous step, and set them as environment variables in your terminal with the following commands (replacing the placeholders with your own values):
1export TWILIO_ACCOUNT_SID=<your-account-sid>2export TWILIO_AUTH_TOKEN=<your-auth-token>
Check out how to set environment variables for more information or other platform-specific syntax.
If you've gone through one of our other Go Quickstarts already and have Go and the Twilio Go helper library installed, you can skip this step and get to the rest of the tutorial.
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 version2go 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.
To send a message, use the following code and replace the input to params.SetTo
with the phone number for your personal WhatsApp account in the E.164 format. (If you haven't already, install WhatsApp on your device and register for an account.)
For params.SetFrom
, be sure to include the whatsapp:
channel identifier before the Sandbox number in E.164 format: whatsapp:+14155238886
.
1// Download the helper library from https://www.twilio.com/docs/go/install2package main34import (5"fmt"6"github.com/twilio/twilio-go"7api "github.com/twilio/twilio-go/rest/api/v2010"8"os"9)1011func main() {12// Find your Account SID and Auth Token at twilio.com/console13// and set the environment variables. See http://twil.io/secure14// Make sure TWILIO_ACCOUNT_SID and TWILIO_AUTH_TOKEN exists in your environment15client := twilio.NewRestClient()1617params := &api.CreateMessageParams{}18params.SetFrom("whatsapp:+14155238886")19params.SetTo("whatsapp:+15005550006")20params.SetBody("Hello there!")2122resp, err := client.Api.CreateMessage(params)23if err != nil {24fmt.Println(err.Error())25os.Exit(1)26} else {27if resp.Body != nil {28fmt.Println(*resp.Body)29} else {30fmt.Println(resp.Body)31}32}33}
1{2"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",3"api_version": "2010-04-01",4"body": "Hello there!",5"date_created": "Thu, 24 Aug 2023 05:01:45 +0000",6"date_sent": "Thu, 24 Aug 2023 05:01:45 +0000",7"date_updated": "Thu, 24 Aug 2023 05:01:45 +0000",8"direction": "outbound-api",9"error_code": null,10"error_message": null,11"from": "whatsapp:+14155238886",12"num_media": "0",13"num_segments": "1",14"price": null,15"price_unit": null,16"messaging_service_sid": "MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",17"sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",18"status": "queued",19"subresource_uris": {20"media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json"21},22"tags": {23"campaign_name": "Spring Sale 2022",24"message_type": "cart_abandoned"25},26"to": "whatsapp:+15005550006",27"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"28}
When someone replies to one of your messages, you will receive a webhook request from Twilio.
You can configure webhooks by connecting your Sandbox to an app you've already built for handling incoming messages, or build a new one for WhatsApp messages.
This webhook request also supports TwiML (the Twilio Markup Language) just like a regular Twilio SMS request.
To handle this request, you need to set up a web application and expose it to the internet. The Go Programmable Messaging Quickstart shows you how to respond to a message and generate TwiML in Go with Gin.
And—that's all there is to it; receiving and responding is exactly the same as you would do in any SMS app with our Messaging API. Cool, right?
Although these Quickstarts show you how to receive an SMS message, the webhook that Twilio will send will include the same parameters as an incoming SMS message, with the exception that To and From addresses will be set to the WhatsApp number receiving the message (whatsapp:<E.164 formatted Twilio phone number associated with your business>
) and the WhatsApp number sending the message (whatsapp:<User's E.164 phone number>
), respectively.
Because the Twilio WhatsApp API is essentially the same as the Twilio Programmable Messaging API, all of the documentation for that API applies to your apps sending and receiving messages with WhatsApp. To dive deeper with a WhatsApp integration, see the WhatsApp documentation overview as well as the API Reference.
Here are some areas you might like to explore next.
We can't wait to see what kind of WhatsApp integration you build!