Send Template Message

Template namespace from GET /templates. Required when sending a template.

Name of template

Object, containing fields "policy" and "code".

policy - now "deterministic" is only available option;

code - one of supported language codes

Array of localizable parameters to be substituted into the template. Each parameter is object contains the following field:

type - section of parameters - header, body, footer, button

parameters - variables for section.

Each variable is an object that can contain the following fields:

type - can be text, currency, date_time, image, document, video or product

video- id (mediaId)

document

• id (mediaId)

• filename(optional)

image - object with field link (image url)

product - object with catalog_id and product_retailer_id (for catalog carousel product cards)

currency - object containing parameters currency_code and amount_1000.

• currency_code - Currency code as defined in ISO 4217.

• amount_1000 - Amount multiplied by 1000.

• fallback_value - Default text if localization fails.

date_time - If the date_time object is used, further definition of the date and time is required.

• component - The time is assembled from components (i.e., day of the week, month, hour, etc.) The time specified will be the same, regardless of the time zone the client is in.

• unix_epoch - The time to be displayed is dependent on the time zone the client is in.

• fallback_value - Default text if localization fails.

button - if button has parameter

• sub_type (url/quick_reply/copy_code)

• parameters (array to fill button variable)

• index - button position.

coupon_code - for COPY_CODE buttons use parameters with type coupon_code and coupon_code value.

limited_time_offer - for limited-time offer templates:

• parameters: [{type: limited_time_offer, limited_time_offer: {expiration_time_ms: }}]

• If limited_time_offer.has_expiration is true, include limited_time_offer parameters and a copy code button first; URL button required.

cards - filled in if you need to send the Carousel template

• card_index - card number

• components - array of card data

  Copy Text

  type -  header, body, footer, button parameters - variables for the section. sub_type - subtype for buttons index - button number

The number of parameters passed must match the number of parameters in the template

Force Marketing Messages API (POST marketing_messages). If omitted: auto for MARKETING category when the channel has mm_lite_enabled and mm_lite_available service settings.

Sets message_activity_sharing on the WABA payload (click tracking webhooks). Requires the MM Lite path. Ignored on Cloud API fallback.

Template message TTL in seconds (message_send_ttl_seconds). MARKETING via MM Lite: 43200–2592000. AUTHENTICATION: 30–900. UTILITY: 30–43200. AUTH/UTILITY also accept -1 (30-day custom TTL).

Required if phone and bsuid are not set

Chat ID from the message list. Examples: [email protected], RU.1504711984690866@lid, username@username, or [email protected] (group). Used instead of the phone parameter.

Required if chatId and bsuid are not set

Recipient identifier. Accepts a phone number starting with the country code, or a BSUID such as RU.1504711984690866.

Use chatId for full chat IDs: [email protected], bsuid@lid, username@username, or [email protected].

Optional alternative to phone/chatId

Recipient BSUID without the @lid suffix. Example: RU.1504711984690866.