whatsapp/card

---

Whatsapp/card is a structured template which can be used to send a series of related information. It must include a body and at least one additional field.

In the Media field of the template you create, provide the URL of the publicly hosted file.

If you are using a media in the card with a variable. Please submit a sample path of a publicly hosted image URL in the variable array. The combined URL must contain the file type. The combined URL must resolve to a publicly hosted file.

Example:

"media": ["https://twilio-cms-prod.s3.amazonaws.com/{{1}}"] would include a path sample in the variables definition. "variables": {"1": "images/library-logo-resource2x.width-1000.png"}

If you are using a call-to-action URL button in your card, the URL must resolve to a publicly accessible website. If there is a variable, a valid path sample should be included in the variables array. The combined URL should resolve to a publicly accessible website.

Example:

"url": ["https://www.twilio.com/{{1}}"] would include a path sample in the variables definition. "variables": {"1": "docs"}

---

Supported Channels

WhatsApp

---

Message Preview

Expand image

---

Data Parameters

body:

• Type: string
• Required: yes
• Variable Support: yes

• Description: body of card.

  • Maximum: 1024 characters

footer:

• Type: string
• Required: no
• Variable Support: no

• Description: footer of card.

  • Maximum: 60 characters

media:

• Type: string[]
• Required: no
• Variable Support: yes

• Description: The URL of the media to send with the message.

  • Supported and Accepted media types can be referenced here (MMS) and here (WhatsApp).
  • Cannot be present if header_text is present

header_text:

• Type: string
• Required: no
• Variable Support: yes

• Description: Bolded header text of card.

  • Maximum: 60 characters
  • Cannot be present if media is present

actions:

• Type: array[ actions ]
• Required: no
• Variable Support: See Common Components: actions definition

• Description: Buttons that recipients can tap on to act on the message:

  • Up to 2 buttons for PHONE or URL actions
  • Up to 3 buttons for QUICK_REPLY action

Create a WhatsApp Card Template

C#

Java

curl

_40

// Install the C# / .NET helper library from twilio.com/docs/csharp/install

_40

_40

using System;

_40

using Twilio;

_40

using Twilio.Rest.Content.V1;

_40

_40

TwilioClient.Init(accountSid, authToken);

_40

_40

// define the whatsapp/card

_40

var whatsappCard = new WhatsappCard.Builder();

_40

whatsappCard.WithBody("Congratulations, you have reached Elite status! Add code {{1}} for 10% off.");

_40

whatsappCard.WithHeaderText("This is a {{1}} card");

_40

whatsappCard.WithFooter("To unsubscribe, reply Stop");

_40

var cardAction1 = new CardAction.Builder()

_40

.WithType(CardActionType.Url)

_40

.WithUrl("https://www.twilio.com")

_40

.WithTitle("Order Online")

_40

.Build();

_40

var cardAction2 = new CardAction.Builder()

_40

.WithType(CardActionType.PhoneNumber)

_40

.WithPhone("+15551234567")

_40

.WithTitle("Call Us")

_40

.Build();

_40

whatsappCard.WithActions(new List<CardAction>() { cardAction1, cardAction2 });

_40

_40

// define all the content types to be part of the template

_40

var types = new Types.Builder();

_40

types.WithWhatsappCard(whatsappCard.Build());

_40

_40

// build the create request object

_40

var contentCreateRequest = new ContentCreateRequest.Builder();

_40

contentCreateRequest.WithTypes(types.Build());

_40

contentCreateRequest.WithLanguage("en");

_40

contentCreateRequest.WithFriendlyName("owl_coupon_code");

_40

contentCreateRequest.WithVariables(new Dictionary<string, string>() { {"1", "coupon_code"} });

_40

_40

// create the twilio template

_40

var contentTemplate = await CreateAsync(contentCreateRequest.Build());

_40

_40

Console.WriteLine($"Created Twilio Content Template SID: {contentTemplate.Sid}");

Output

_36

{

_36

"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

_36

"date_created": "2023-08-03T14:54:47Z",

_36

"date_updated": "2023-08-03T14:54:47Z",

_36

"friendly_name": "owl_coupon_code",

_36

"language": "en",

_36

"links": {

_36

"approval_create": "https://content.twilio.com/v1/Content/HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ApprovalRequests/whatsapp",

_36

"approval_fetch": "https://content.twilio.com/v1/Content/HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/ApprovalRequests"

_36

},

_36

"sid": "HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

_36

"types": {

_36

"whatsapp/card": {

_36

"actions": [

_36

{

_36

"title": "Order Online",

_36

"type": "URL",

_36

"url": "https://owlair.example.com/"

_36

},

_36

{

_36

"phone": "+1555554567",

_36

"title": "Call Us",

_36

"type": "PHONE_NUMBER"

_36

}

_36

],

_36

"body": "Congratulations, you have reached Elite status! Add code {{1}} for 10% off.",

_36

"footer": "To unsubscribe, reply Stop",

_36

"header_text": "This is a {{1}} card",

_36

"media": null

_36

}

_36

},

_36

"url": "https://content.twilio.com/v1/Content/HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",

_36

"variables": {

_36

"1": "coupon_code"

_36

}

_36

}