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.
Info
WhatsApp card cannot have both a Text Header and Media Header
Info
On WhatsApp, a card must be approved as a template before it can be sent. If you use variables with whatsapp/card, then additional approval steps are required.
If a whatsapp/card template is created with media and with variables and you plan to submit this template to WhatsApp for approval, a valid media sample is required. Static media urls should resolve to publicly hosted media files. Variable media urls should include a valid media URL suffix in the variable declaration.
Only one type of media can be sent per approved variable WhatsApp card template. WhatsApp classifies approved templates into 1 of 3 types of media headers (Image, Video, Document) based on the sample that was submitted. Once the template has been approved another type of media header cannot be sent using the template.
Ex. If a template is approved with an image then a video cannot be sent using the same template.
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"}
Warning
- If the template's body starts or ends with a variable or has two variables next to each other, the template will not be approved by WhatsApp without a sample variable. For additional information about variables see here.
- Update the phone number to a valid phone number in the actions array below when creating your template. This template will fail to send otherwise.
- VOICE_CALL is currently a private beta feature in select regions.
- If the content template is being sent in session over WhatsApp without approval, only 3 buttons are allowed.
- On WhatsApp, a card must be approved as a template before it can be sent. Additional approval steps are required if you use variables with
twilio/card. A valid media sample is required if atwilio/cardtemplate is created with media and/or variables and you plan to submit this template to WhatsApp for approval. Static media urls should resolve to publicly hosted media files. Variable media urls should include a valid media URL suffix in the variable declaration. - Only one type of media can be sent per approved variable WhatsApp card template. WhatsApp classifies approved templates into 1 of 3 types of media headers (Image, Video, Document) based on the sample that was submitted. Once the template has been approved another type of media header cannot be sent using the template.
- For example, if a template is approved with an image, you can't send a video using that same template.
- If the template's body starts or ends with a variable or has two variables next to each other, the template won't be approved by WhatsApp without a sample variable. For additional information about variables, see Using Variables with Content Templates.
- When creating your template, ensure that the phone number in the actions array below is valid. Otherwise, the template will fail to send.
- WhatsApp footers translate to subtitles in
twilio/cards. - Template approval is required if multiple buttons are present.