whatsapp/authentication

The whatsapp/authentication content type allows companies to deliver a WhatsApp-approved one-time password button. Unlike other templates, the body is preset by WhatsApp. Some modifications can be made by specifying certain parameters. However, custom authentication templates aren't allowed.

(information)

Info

When sending whatsapp/authentication content templates, a single variable must be defined at send time and set to the one-time passcode.
whatsapp/authentication content templates must be approved by WhatsApp before they can be sent to customers.

Supported channels

Message preview

WhatsApp message with verification code 1234, expires in 40 minutes.

Data parameters

Parameter	Type	Required	Variable support	Description
`add_security_recommendation`	Boolean	No	No	Optional field to add the message "For your security, do not share this code" or the translated language's equivalent. This field defaults to `TRUE`.
`code_expiration_minutes`	integer	No	No	The amount of time you want to inform the customer that the one-time passcode is available for. Adds a footer message stating "This code expires in x minutes," where x is the number specified. Only whole numbers from 1–90 are allowed.
`actions`	array	Yes	No	Buttons that recipients can tap on to act on the message.

`actions` properties

To learn more about the actions parameter, see common components.

Property	Parameters
`COPY_CODE`	`type`: `COPY_CODE`. `copy_code_text`: Must be specified. Meta will use approved localized wording.

Code examples and responses

Create a WhatsApp OTP button template

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function createContent() {
14  const content = await client.content.v1.contents.create({
15    friendly_name: "whatsapp_otp",
16    language: "en",
17    types: {
18      "whatsapp/authentication": {
19        add_security_recommendation: true,
20        code_expiration_minutes: 30,
21        actions: [
22          {
23            type: "COPY_CODE",
24            copy_code_text: "Copy verification code",
25          },
26        ],
27      },
28    },
29  });
30
31  console.log(content.dateCreated);
32}
33
34createContent();

Response

1{
2  "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "whatsapp_otp",
5  "language": "en",
6  "variables": {
7    "name": "foo"
8  },
9  "types": {
10    "whatsapp/authentication": {
11      "add_security_recommendation": true,
12      "code_expiration_minutes": 30,
13      "actions": [
14        {
15          "type": "COPY_CODE",
16          "copy_code_text": "Copy verification code"
17        }
18      ]
19    }
20  },
21  "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
22  "date_created": "2015-07-30T19:00:00Z",
23  "date_updated": "2015-07-30T19:00:00Z",
24  "links": {
25    "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp",
26    "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests"
27  }
28}

How to send different types of WhatsApp Authentication Templates

Copy codeOne-tap autofillZero-tap

Copy code is the default authentication template. Copy code templates include a button that copies an OTP code to the user's clipboard.

Create the whatsapp/authentication template.
Follow the steps to send the template.

One-tap autofill lets your customers authenticate by clicking a button in WhatsApp that triggers an activity that opens your app and delivers the password or code to it.

Ensure you have the proper configuration with a functioning handshake and app key signing hash.
Create the whatsapp/authentication template.
Go to the WhatsApp Manager. You can do this from the WhatsApp Senders page in the Twilio Console or by following the steps to open WhatsApp Manager here.
Click Manage Templates. Find the whatsapp/authentication template that you created. The format is name_of_template_content_sid.
Edit the template to include the one-tap fields.
Follow the steps to send the template.

Zero-tap authentication templates allow your users to receive one-time passwords or codes through WhatsApp without having to leave your app. If the zero-tap process fails, the code is still delivered in the WhatsApp chat.

Ensure you have the proper configuration with a functioning handshake and app key signing hash.
Create the whatsapp/authentication template.
Go to the WhatsApp Manager. You can do this from the WhatsApp Senders page in the Twilio Console or by following the steps to open WhatsApp Manager here.
Click Manage Templates. Find the whatsapp/authentication template you created. The format is name_of_template_content_sid.
Edit the template to include the zero-tap fields.
Follow the steps to send the template.

Send WhatsApp authentication templates created with content templates

To send a whatsapp/authentication template, send it like any other content template, but include a content variable containing the one-time password (OTP) you want to send. The body field is preset and the template includes a pre-existing content variable for the OTP.

The OTP that you send must be fewer than 15 characters long.

--data-urlencode "ContentVariables={"1": "12345"}" \

Sending WhatsApp authentication templates

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function createMessage() {
14  const message = await client.messages.create({
15    contentSid: "HXXXXXXXXXX",
16    contentVariables: JSON.stringify({ 1: "123456" }),
17    from: "whatsapp:+18551234568",
18    messagingServiceSid: "MGXXXXXXXXXXX",
19    to: "whatsapp:+18551234567",
20  });
21
22  console.log(message.body);
23}
24
25createMessage();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "api_version": "2010-04-01",
4  "body": "Hello! 👍",
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:+18551234568",
12  "num_media": "0",
13  "num_segments": "1",
14  "price": null,
15  "price_unit": null,
16  "messaging_service_sid": "MGXXXXXXXXXXX",
17  "sid": "SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
18  "status": "queued",
19  "subresource_uris": {
20    "media": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Media.json"
21  },
22  "to": "whatsapp:+18551234567",
23  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages/SMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
24}

whatsapp/authentication

Info

Supported channels

Message preview

Data parameters

actions properties

Code examples and responses

Response

How to send different types of WhatsApp Authentication Templates

Send WhatsApp authentication templates created with content templates

Response

`actions` properties