Whatsapp Custom Templates Messages
Custom Template Object
Parameter | Type | Description |
---|---|---|
*template_id | String | Template ID configured for WhatsApp template (HSM). This should be registered and approved by D7. You can create a new Whatsapp Template here |
*language | String | Specifies the code of language the template may be rendered in. Supported languages |
body_parameter_values | Dict | The Object of the body parameter values. Only required if your body text have variables. |
media | Object | Includes the parameters of template header |
buttons | Object | Details of the button object. |
carousel | Object | Carousel template object |
limited_time_offer | Object | LTO Template Object |
Parameter | Type | Description |
---|---|---|
*media_type | String | Type of the attachment you want to send through your template. Valid: text, image, audio, document, video |
*media_url | String | URL for the attachment. Required except the media type is location/text. |
*text_header_title | String | Required only if approved template having text header and a parameter included in header text. |
*location | Object | Details of the location object, if media type is location |
Parameter | Type | Description |
---|---|---|
*quick_replies | Array(Object) | List of quick_replies button object. This is required if you wants to add quick reply buttons in your message. |
*actions | Array(object) | List of actions button object. This is required if you wants to add call to action buttons in your message. |
*coupon_code | Array(Object) | List of coupon code button object. This is required if you wants to add coupon code buttons in your message. |
Parameter | Type | Description |
---|---|---|
*button_index | String | Position index of the button. Required if you have quick reply in your template. |
*button_payload | String | Developer-defined payload that will be returned when the button is clicked. |
Parameter | Type | Description |
---|---|---|
*action_type | String | Type of action that whats to do while clicking the button. Supported Values: Dial and URL. |
*action_index | String | Position index of the button. Required if you have either url or dial button in your template. |
*action_payload | String | Developer-defined payload that will be returned when the button is clicked. For Dial Its a phone number and For URL it is a url. |
Parameter | Type | Description |
---|---|---|
*index | String | Position index of the button. Required if you have copy code button in your template. |
*type | String | Type of the coupen code |
*coupon_code | String | The coupon code to be copied when the customer taps the button. |