whatsapp.smb.history

Use whatsapp.smb.history to handle this event at your webhook endpoint.

Triggers

Occurs when WhatsApp Business App message history is synchronized. Subscribe to whatsapp.smb.history when you configure your webhook endpoint. A history event can contain whatsappInboundMessage for an inbound message, whatsappMessage for an outbound message, or only chunk metadata. phase and progress are included when the event comes from a Meta history chunk. Do not require a message object in every history event.

Syntax

YCloud sends an HTTP POST request to your configured webhook URL. The following shape shows one payload variant. Angle-bracket values are placeholders; their types are listed under Parameters. Optional fields and other variants are described below.

{
  "id": "<ID>",
  "type": "whatsapp.smb.history",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "phase": "<PHASE_VALUE>",
  "progress": "<PROGRESS_VALUE>",
  "whatsappInboundMessage": {
    "id": "<ID>",
    "wamid": "<WAMID>",
    "wabaId": "<WABA_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "type": "<TYPE>",
    "text": {
      "body": "<BODY>"
    },
    "customerProfile": {
      "name": "<NAME>"
    },
    "sendTime": "<SEND_TIME>"
  }
}

Parameters

Validate the YCloud-Signature HTTP header before you process the JSON body. See signature validation.

Event envelope

Parameter	Type	Required	Description
`id`	string	Yes	Unique ID for the event. Minimum length: `6`. Maximum length: `128`.
`type`	string	Yes	Always `whatsapp.smb.history`.
`apiVersion`	string	Yes	The API version used to render this event.
`createTime`	string (date-time)	Yes	The time at which this event was created, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.

Event payload

Parameter	Type	Required	Description
`phase`	integer (int32)	No	Included when `type` is `whatsapp.smb.history` and the event was generated from a Meta history chunk. Identifies the chunk’s synchronization phase.
`progress`	integer (int32)	No	Included when `type` is `whatsapp.smb.history` and the event was generated from a Meta history chunk. Reports the chunk’s synchronization progress.
`whatsappInboundMessage`	object	No	Event-specific `whatsappInboundMessage` payload.
`whatsappMessage`	object	No	Event-specific `whatsappMessage` payload.

The four common envelope fields are required. Payload fields depend on the event variant. In each object table, Required applies when its parent object is present. Optional fields can be omitted; a sample does not make a field required.

whatsappInboundMessage

Parameter	Type	Required	Description
`id`	string	Yes	Unique ID for the object.
`wamid`	string	No	The original message ID on WhatsApp’s platform.
`wabaId`	string	No	WhatsApp Business Account ID.
`from`	string	No	The customer’s phone number who sent the message to the business, formatted in E.164 format.
`fromUserId`	string	No	The customer’s WhatsApp Business-scoped user ID (BSUID).
`fromParentUserId`	string	No	The customer’s parent WhatsApp Business-scoped user ID.
`customerProfile`	object	No	The customer’s profile information.
`to`	string	No	The recipient’s phone number in E.164 format.
`sendTime`	string (date-time)	No	The time at which this message is sent, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.
`type`	string	No	WhatsApp inbound message type. See also WhatsApp webhook messages object. Values: `text`, `image`, `video`, `audio`, `document`, `sticker`, `contacts`, `location`, `interactive`, `button`, `reaction`, `request_welcome`, `order`, `system`, `unsupported`.
`text`	object	No	When the notification describes a text message, the text object provides the body of the text message.
`image`	object	No	When a message with media (`image` \| `document` \| `audio` \| `video` \| `sticker`) is received, the WhatsApp Business API client will download the media. Once the media is downloaded, a notification is sent to your Webhook. This message contains information that identifies the media object and enables you to find and download the object.
`video`	object	No	When a message with media (`image` \| `document` \| `audio` \| `video` \| `sticker`) is received, the WhatsApp Business API client will download the media. Once the media is downloaded, a notification is sent to your Webhook. This message contains information that identifies the media object and enables you to find and download the object.
`audio`	object	No	When a message with media (`image` \| `document` \| `audio` \| `video` \| `sticker`) is received, the WhatsApp Business API client will download the media. Once the media is downloaded, a notification is sent to your Webhook. This message contains information that identifies the media object and enables you to find and download the object.
`document`	object	No	When a message with media (`image` \| `document` \| `audio` \| `video` \| `sticker`) is received, the WhatsApp Business API client will download the media. Once the media is downloaded, a notification is sent to your Webhook. This message contains information that identifies the media object and enables you to find and download the object.
`sticker`	object	No	When a message with media (`image` \| `document` \| `audio` \| `video` \| `sticker`) is received, the WhatsApp Business API client will download the media. Once the media is downloaded, a notification is sent to your Webhook. This message contains information that identifies the media object and enables you to find and download the object.
`interactive`	object	No	When a customer has interacted with your message, this object is included in the message object.
`location`	object	No	When you receive a notification of a user’s static location, the location object provides the details of the location.
`button`	object	No	When the message type field is set to `button`, this object is included in the message object.
`contacts`	object[]	No	Array items are described below.
`reaction`	object	No	When a user reacts to messages with an emoji, the message type is set to `reaction`, and this field is included.
`order`	object	No	When a customer places an order, the message type is set to `order`, and this field is included.
`system`	object	No	When the message type is set to `system`, this field is included. This object describes a user phone number change, a BSUID change, or a possible identity change on WhatsApp.
`errors`	object[]	No	Array items are described below.
`context`	object	No	Message context.
`referral`	object	No	When a user messages businesses using call-to-actions buttons on Ads that Click to WhatsApp or a Facebook Page call-to-action buttons, this field is included as an attachment.
`groupId`	string	No	WhatsApp group ID. This field is included when the inbound message is sent in a WhatsApp group.

whatsappInboundMessage.customerProfile

Parameter	Type	Required	Description
`name`	string	No	Name of the WhatsApp account.
`username`	string	No	WhatsApp username.

whatsappInboundMessage.text

Parameter	Type	Required	Description
`body`	string	No	Message text.

whatsappInboundMessage.image

Parameter	Type	Required	Description
`id`	string	No	ID of the media. Can be used to delete the media if stored locally on the client.
`link`	string	No	The url to download the media file. Note that This link can be directly accessed in a few minutes for the convenience of the consumer, but you should always include an `X-API-Key` header to download this file within a month.
`caption`	string	No	The provided caption for the media. Only present if specified.
`filename`	string	No	Filename on the sender’s device. This will only be present in `document` media messages.
`metadata`	object	No	Metadata pertaining to `sticker` media.
`mime_type`	string	No	Mime type of the media.
`sha256`	string	No	Checksum.

whatsappInboundMessage.video

Parameter	Type	Required	Description
`id`	string	No	ID of the media. Can be used to delete the media if stored locally on the client.
`link`	string	No	The url to download the media file. Note that This link can be directly accessed in a few minutes for the convenience of the consumer, but you should always include an `X-API-Key` header to download this file within a month.
`caption`	string	No	The provided caption for the media. Only present if specified.
`filename`	string	No	Filename on the sender’s device. This will only be present in `document` media messages.
`metadata`	object	No	Metadata pertaining to `sticker` media.
`mime_type`	string	No	Mime type of the media.
`sha256`	string	No	Checksum.

whatsappInboundMessage.audio

Parameter	Type	Required	Description
`id`	string	No	ID of the media. Can be used to delete the media if stored locally on the client.
`link`	string	No	The url to download the media file. Note that This link can be directly accessed in a few minutes for the convenience of the consumer, but you should always include an `X-API-Key` header to download this file within a month.
`caption`	string	No	The provided caption for the media. Only present if specified.
`filename`	string	No	Filename on the sender’s device. This will only be present in `document` media messages.
`metadata`	object	No	Metadata pertaining to `sticker` media.
`mime_type`	string	No	Mime type of the media.
`sha256`	string	No	Checksum.

whatsappInboundMessage.document

Parameter	Type	Required	Description
`id`	string	No	ID of the media. Can be used to delete the media if stored locally on the client.
`link`	string	No	The url to download the media file. Note that This link can be directly accessed in a few minutes for the convenience of the consumer, but you should always include an `X-API-Key` header to download this file within a month.
`caption`	string	No	The provided caption for the media. Only present if specified.
`filename`	string	No	Filename on the sender’s device. This will only be present in `document` media messages.
`metadata`	object	No	Metadata pertaining to `sticker` media.
`mime_type`	string	No	Mime type of the media.
`sha256`	string	No	Checksum.

whatsappInboundMessage.sticker

Parameter	Type	Required	Description
`id`	string	No	ID of the media. Can be used to delete the media if stored locally on the client.
`link`	string	No	The url to download the media file. Note that This link can be directly accessed in a few minutes for the convenience of the consumer, but you should always include an `X-API-Key` header to download this file within a month.
`caption`	string	No	The provided caption for the media. Only present if specified.
`filename`	string	No	Filename on the sender’s device. This will only be present in `document` media messages.
`metadata`	object	No	Metadata pertaining to `sticker` media.
`mime_type`	string	No	Mime type of the media.
`sha256`	string	No	Checksum.

whatsappInboundMessage.interactive

Parameter	Type	Required	Description
`type`	string	No	The type of interactive message received. `button_reply`: Sent when a customer clicks a button. `list_reply`: Sent when a customer selects an item from a list. `nfm_reply`: Sent when a customer responds to a WhatsApp Flow (Next Feature Messaging). `call_permission_reply`: Sent when a customer responds to a call permission request.
`button_reply`	object	No	Sent when a customer clicks a button. Returned when `type` is `button_reply`.
`list_reply`	object	No	Sent when a customer selects an item from a list. Returned when `type` is `list_reply`.
`nfm_reply`	object	No	Sent when a customer responds to a WhatsApp Flow (Next Feature Messaging). Returned when `type` is `nfm_reply`.
`call_permission_reply`	object	No	Sent when a customer responds to a call permission request. Returned when `type` is `call_permission_reply`. This occurs when WhatsApp prompts users to grant callback permissions after they call your business.

whatsappInboundMessage.interactive.button_reply

Parameter	Type	Required	Description
`id`	string	No	Unique ID of the clicked button.
`title`	string	No	Title of a button.

whatsappInboundMessage.interactive.list_reply

Parameter	Type	Required	Description
`id`	string	No	Unique ID of the selected list item.
`title`	string	No	Title of the selected list item.
`description`	string	No	Description of the selected row.

whatsappInboundMessage.interactive.nfm_reply

Parameter	Type	Required	Description
`name`	string	No	The name of the flow or form being replied to.
`response_json`	string	No	JSON string containing the user’s responses to the flow. Contains form field values and flow token.
`body`	string	No	The body content of the flow reply message.

whatsappInboundMessage.interactive.call_permission_reply

Parameter	Type	Required	Description
`response`	string	No	The customer’s response to the call permission request. `accept`: User granted permission for business to call back `reject`: User rejected permission for business to call back
`expiration_timestamp`	integer (int64)	No	The timestamp (in seconds) when the call permission expires. Only present when response is “accept” and is_permanent is false.
`is_permanent`	boolean	No	Whether the permission is permanent or temporary. `true`: Permanent authorization (no expiration) `false`: Temporary authorization (expires at expiration_timestamp)

whatsappInboundMessage.location

Parameter	Type	Required	Description
`latitude`	number (double)	No	Latitude of location being sent.
`longitude`	number (double)	No	Longitude of location being sent.
`address`	string	No	Address of the location.
`name`	string	No	Name of the location.
`url`	string	No	URL for the website where the user downloaded the location information.

whatsappInboundMessage.button

Parameter	Type	Required	Description
`payload`	string	No	The payload for a button set up by the business that a customer clicked as part of an interactive message.
`text`	string	No	Button text.

whatsappInboundMessage.contacts[]

Parameter	Type	Required	Description
`addresses`	object[]	No	Array items are described below.
`birthday`	string	No	`YYYY-MM-DD` formatted string.
`emails`	object[]	No	Array items are described below.
`name`	object	Yes	Full contact name formatted as a name object.
`org`	object	No	Contact organization information formatted as an org object.
`phones`	object[]	No	Contact phone number(s) formatted as a phone object.
`urls`	object[]	No	Contact URL(s) formatted as a urls object.
`vcard`	string	No	Optional vCard supplied with the shared contact payload.
`origin`	string	No	Set to `contact_request` when the user shared the contact in response to a request-contact-info message.

whatsappInboundMessage.contacts[].addresses[]

Parameter	Type	Required	Description
`street`	string	No	Street number and name.
`city`	string	No	City name.
`state`	string	No	State abbreviation.
`zip`	string	No	ZIP code.
`country`	string	No	Full country name.
`country_code`	string	No	Two-letter country abbreviation.
`type`	string	No	Standard values are `HOME` and `WORK`.

whatsappInboundMessage.contacts[].emails[]

Parameter	Type	Required	Description
`email`	string	No	Email address.
`type`	string	No	Standard values are `HOME` and `WORK`.

whatsappInboundMessage.contacts[].name

Parameter	Type	Required	Description
`formatted_name`	string	Yes	Full name, as it normally appears.
`first_name`	string	No	First name.
`last_name`	string	No	Last name.
`middle_name`	string	No	Middle name.
`suffix`	string	No	Name suffix.
`prefix`	string	No	Name prefix.

whatsappInboundMessage.contacts[].org

Parameter	Type	Required	Description
`company`	string	No	Name of the contact’s company.
`department`	string	No	Name of the contact’s department.
`title`	string	No	Contact’s business title.

whatsappInboundMessage.contacts[].phones[]

Parameter	Type	Required	Description
`phone`	string	No	Automatically populated with the `wa_id` value as a formatted phone number.
`type`	string	No	Standard Values are `CELL`, `MAIN`, `IPHONE`, `HOME`, and `WORK`.
`wa_id`	string	No	WhatsApp ID.

whatsappInboundMessage.contacts[].urls[]

Parameter	Type	Required	Description
`url`	string	No	URL.
`type`	string	No	Standard values are `HOME` and `WORK`.

whatsappInboundMessage.reaction

Parameter	Type	Required	Description
`message_id`	string	Yes	Specifies the `wamid` of the message received that contained the reaction.
`emoji`	string	No	Required when you send a `reaction` message. Set it to `""` if you want to remove the emoji. Optional when you received a message from a user. This field is included when a user reacts to messages with an emoji. Otherwise, it indicates a user removed the emoji.

whatsappInboundMessage.order

Parameter	Type	Required	Description
`catalog_id`	string	No	The catalog ID.
`product_items`	object[]	No	Array items are described below.
`text`	string	No	Text message sent along with the order.

whatsappInboundMessage.order.product_items[]

Parameter	Type	Required	Description
`product_retailer_id`	string	No	The product SKU identifier.
`quantity`	integer (int32)	No	Number of item.
`item_price`	number (double)	No	Unitary price of item.
`currency`	string	No	Price currency. ISO 4217 currency code.

whatsappInboundMessage.system

Parameter	Type	Required	Description
`body`	string	No	Describes the system message event. Supported use cases are: Phone number update: for when a user changes from an old number to a new number. Identity update: for when a user identity has changed.
`wa_id`	string	No	Phone number supplied by Meta, without the leading `+`. It can be unchanged or omitted for a BSUID change.
`user_id`	string	No	New business-scoped user ID supplied by Meta for a phone number or BSUID change. This field preserves the original snake_case name.
`parent_user_id`	string	No	New Parent BSUID for a phone number or BSUID change, only when enabled and supplied by Meta. This field preserves the original snake_case name.
`previous_user_id`	string	No	Previous business-scoped user ID supplied by Meta.
`previous_parent_user_id`	string	No	Previous Parent BSUID, only when enabled and supplied by Meta.
`type`	string	No	Supported types are: `user_changed_user_id`: notification that a user changed their BSUID. The phone number can remain unchanged. `user_changed_number`: for a user changed number notification. `user_identity_changed`: for user identity changed notification.
`user`	string	No	Added to Webhooks for identity updates. The new WhatsApp user ID of the customer.
`new_wa_id`	string	No	Added to Webhooks for phone number updates. New WhatsApp ID of the customer.

whatsappInboundMessage.errors[]

Parameter	Type	Required	Description
`code`	string	No	The error code.
`title`	string	No	The error title.
`message`	string	No	The error message.
`error_data`	object	No	An error data object with the following properties: `details`: A string describing the reason for the error. Example: `Message type is currently not supported.`.

whatsappInboundMessage.context

Parameter	Type	Required	Description
`forwarded`	boolean	No	Added to Webhooks if message was forwarded. Set to `true` if the received message has been forwarded.
`frequently_forwarded`	boolean	No	Added to Webhooks if message has been frequently forwarded. Set to `true` if the received message has been forwarded more than five times.
`from`	string	No	Added to Webhooks if message is an inbound reply to a sent message. The WhatsApp ID (a phone number without the ’+’ prefix) of the sender of the sent message.
`id`	string	No	Optional. The `wamid` for the sent message for an inbound reply. `wamid` is the original message ID on WhatsApp’s platform.
`referred_product`	object	No	Required for Product Inquiry Messages. Specifies the product the user is requesting information about. See also Sell Products & Services.

whatsappInboundMessage.context.referred_product

Parameter	Type	Required	Description
`catalog_id`	string	No	The catalog ID.
`product_retailer_id`	string	No	The product SKU identifier.

whatsappInboundMessage.referral

Parameter	Type	Required	Description
`source_url`	string	No	Specifies the URL that leads to the ad or post clicked by the user. Opening this URL takes you to the ad viewed by your user.
`source_type`	string	No	Specifies the type of the ad’s source. Supported values are “ad” or “post”.
`source_id`	string	No	Specifies the Meta ID for an ad or post.
`headline`	string	No	Specifies the headline used in the ad or post that generated the message.
`body`	string	No	The description, or body, from the ad or post that generated the message.
`media_type`	string	No	Media present in the ad or post the user clicked. Supported values are “image” or “video”.
`image_url`	string	No	Added if media_type is “image”. Contains a URL to the raw image.
`video_url`	string	No	Added if media_type is “video”. Contains a URL to the video.
`thumbnail_url`	string	No	Added if media_type is “video”. Contains a URL to the thumbnail image of the clicked video.
`ctwa_clid`	string	No	Click ID generated by Meta for ads that click to WhatsApp.

whatsappMessage

Parameter	Type	Required	Description
`id`	string	Yes	Unique ID of the message.
`wamid`	string	No	The original message ID on WhatsApp’s platform.
`wabaId`	string	Yes	WhatsApp Business Account ID.
`from`	string	Yes	The sender’s phone number in E.164 format.
`to`	string	No	The recipient’s phone number in E.164 format.
`recipient`	string	No	The recipient value submitted in the request when a BSUID or parent BSUID was used.
`recipientUserId`	string	No	The recipient’s WhatsApp Business-scoped user ID (BSUID).
`toUserId`	string	No	Alias of `recipientUserId` kept for compatibility.
`parentRecipientUserId`	string	No	The recipient’s parent WhatsApp Business-scoped user ID.
`toParentUserId`	string	No	Alias of `parentRecipientUserId` kept for compatibility.
`customerProfile`	object	No	The recipient’s profile information, including WhatsApp username when available.
`conversation`	object	No	WhatsApp defines a conversation as a 24-hour session of messaging between a person and a business. This field is present after the message status changes to `sent`. See also Conversation-Based Pricing.
`type`	string	No	WhatsApp outbound message type. See also WhatsApp messages. Values: `template`, `text`, `image`, `audio`, `video`, `document`, `sticker`, `location`, `interactive`, `contacts`, `reaction`.
`template`	object	No	Use for sending a WhatsApp `template` message.
`text`	object	No	WhatsApp Message Text Object.
`image`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.
`video`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.
`audio`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.
`document`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.
`sticker`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.
`location`	object	No	Use for `location` messages.
`interactive`	object	No	Use for `interactive` messages.
`contacts`	object[]	No	Array items are described below.
`reaction`	object	No	When a user reacts to messages with an emoji, the message type is set to `reaction`, and this field is included.
`context`	object	No	Used to mention a specific message you are replying to. The reply can be any message type.
`externalId`	string	No	A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.
`category`	string	No	The Direct Send category, such as `utility` or `authentication`, when applicable.
`ttlSeconds`	integer	No	The configured Direct Send message lifetime in seconds, when applicable.
`status`	string	No	WhatsApp message status. One of `accepted`, `failed`, `sent`, `delivered`, `read`. `accepted`: The messaging request is accepted by our system. `failed`: A message sent by your business failed to send. `sent`: A message sent by your business is in transit within WhatsApp’s systems. `delivered`: A message sent by your business was delivered to the user’s device. `read`: A message sent by your business was read by the user.
`errorCode`	string	No	Error code when the message status is `failed`.
`errorMessage`	string	No	Error message when the message status is `failed`.
`createTime`	string (date-time)	No	The time at which this message is created, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.
`updateTime`	string (date-time)	No	The time at which this message is updated, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.
`sendTime`	string (date-time)	No	The time at which this message `status` changed to `sent`, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.
`deliverTime`	string (date-time)	No	The time at which this message `status` changed to `delivered`, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.
`readTime`	string (date-time)	No	The time at which this message `status` changed to `read`, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.
`totalPrice`	number (double)	No	Total price of this message. Note: It’s only an estimated price when the `status` is `accepted` or `sent`. It becomes the final price after the message is delivered, i.e., the `status` is `delivered` or `read`. For Max Price messages, the send-time amount is an estimate. Use the delivered/read whatsapp.message.updated event for the final charge; maxBid is not the final charged amount.
`currency`	string	No	Price currency. ISO 4217 currency code.
`regionCode`	string	No	The region code of the recipient phone number.
`pricingCategory`	string	No	The pricing category of the message. Note: It’s only an estimated pricing category when the `status` is `accepted` or `sent`. It becomes final after the message is delivered, i.e., the `status` is `delivered` or `read`. Values: `referral_conversion`, `authentication`, `authentication_international`, `marketing`, `marketing_lite`, `utility`, `service`, `marketing_lite_bidding`.
`pricingModel`	string	No	The pricing model of the message. `PMP`: Per-message pricing applies. `CBP`: Conversation-based pricing applies.
`pricingType`	string	No	The pricing type of the message. This field is only available in PMP (Per-Message Pricing) mode. `regular`: Indicates the message is billable. `free_customer_service`: Indicates the message is free because it was either a utility template message or non-template message sent within a customer service window. `free_entry_point`: Indicates the message is free because it is part of a free-entry point conversation.
`whatsappApiError`	object	No	The original error object returned by WhatsApp. See Handling Errors, Cloud API Error Codes.
`bizType`	string	No	This can be either empty or one of `whatsapp`, or `verify`. Defaults to `whatsapp`. `whatsapp`: Indicates that the message is sent via the WhatsApp product. `verify`: Indicates that the message is sent via the Verify product.
`verificationId`	string	No	The verification ID. Included only when `bizType` is `verify`.
`bidPricingFlag`	boolean	No	True when the message is identified as a Marketing Lite bidding message. Its pricingCategory is marketing_lite_bidding.

whatsappMessage.customerProfile

Parameter	Type	Required	Description
`name`	string	No	Name of the WhatsApp account.
`username`	string	No	WhatsApp username.

whatsappMessage.conversation

Parameter	Type	Required	Description
`id`	string	No	Unique ID for the object.
`type`	string	No	Conversation type. There is a charge when the first business message of this conversation is delivered, initiating the 24-hour conversation session. As such, the conversation type can be `null` before the first message is delivered. `FREE_ENTRY`: Conversations originating from a free entry point. `FREE_TIER`: Conversations within the monthly free tier. `REGULAR`: Any conversations that did not originate from a free entry point or are above the monthly free tier allotment.
`originType`	string	No	Indicates conversation category. This can also be referred to as a conversation entry point. `referral_conversion`: Indicates a free entry point conversation. `authentication`: Indicates the conversation was opened by a business sending template categorized as `AUTHENTICATION` to the customer. This applies any time it has been more than 24 hours since the last customer message. `marketing`: Indicates the conversation was opened by a business sending template categorized as `MARKETING` to the customer. This applies any time it has been more than 24 hours since the last customer message. `utility`: Indicates the conversation was opened by a business sending template categorized as `UTILITY` to the customer. This applies any time it has been more than 24 hours since the last customer message. `service`: Indicates that the conversation opened by a business replying to a customer within a customer service window.
`expireTime`	string (date-time)	No	Date when the conversation expires, formatted in RFC 3339. e.g., `2022-06-01T12:00:00.000Z`.

whatsappMessage.template

Parameter	Type	Required	Description
`name`	string	Yes	Name of the template.
`language`	object	Yes	Contains a language object. Specifies the language the template may be rendered in.
`components`	object[]	No	Required when the specified template contains variables or media. Array of component objects containing the parameters of the message.

whatsappMessage.template.language

Parameter	Type	Required	Description
`code`	string	Yes	The code of the language or locale to use. Accepts both language and language_locale formats (e.g., en and en_US). See Supported Languages for all codes.
`policy`	string	No	The language policy the message should follow. Default (and only supported option): `deterministic`, which means that WhatsApp delivers the message template in exactly the language and locale asked for.

whatsappMessage.template.components[]

Parameter	Type	Required	Description
`type`	string	Yes	Component type. Values: `header`, `body`, `button`, `limited_time_offer`, `carousel`, `order_status`.
`sub_type`	string	No	Required when type is `button`. Type of button. `quick_reply`: Refers to a previously created quick reply button that allows for the customer to return a predefined message. `url`: Refers to a previously created url button that allows the customer to visit the URL generated by appending the text parameter to the predefined prefix URL in the template. `copy_code`: Refers to a previously created copy code button that allows the customer to copy a text string (defined when the template is sent in a template message) to the device’s clipboard when tapped by the app user. `catalog`: Refers to a previously created catalog button that allows the customer to view your product catalog. `mpm`: Refers to a previously created MPM (multi-product message) button that allows the customer to browser products and sections. `flow`: Refers to a previously created flow button that allows the customer to interact with a flow. `order_details`: Refers to a previously created order details button that allows the customer to view the details of an order.
`index`	integer (int32)	No	Required when `type` = `button`. Not used for the other types. Indicates order in which button should appear, if the template uses multiple buttons. Buttons are zero-indexed, so setting value to 0 will cause the button to appear first, and another button with an index of 1 will appear next, etc. Minimum: `0`. Maximum: `9`.
`parameters`	object[]	No	Required when `type` = `button`, or there are variables in the corresponding template component, or the template `HEADER` format is media (`IMAGE`, `VIDEO`, or `DOCUMENT`). Array of parameter objects with the content of the message.
`cards`	object[]	No	Use for `carousel` components. Provides card components containing the parameters of the message.

whatsappMessage.template.components[].parameters[]

Parameter	Type	Required	Description
`type`	string	No	Required. Component parameter type. `text`: Used when the template component type is `BODY`, or the `HEADER` component format is `TEXT`. `image`: Used when the template `HEADER` component is `IMAGE`. `gif`: Used when the template `HEADER` component is `GIF`. `video`: Used when the template `HEADER` component is `VIDEO`. `document`: Used when the template `HEADER` component is `DOCUMENT`. `payload`: Used when the template component button type is `QUICK_REPLY`. `coupon_code`: Used when the template component button type is `COPY_CODE`. `limited_time_offer`: Used when the template component type is `LIMITED_TIME_OFFER`. `action`: Used when the template component button type is `CATALOG`, `MPM`, `FLOW`, or `ORDER_DETAILS`. `order_status`: Used when the template subcategory is `ORDER_STATUS`. `location`: Used when the template `HEADER` component is `LOCATION`.
`text`	string	No	Required when `type` = `text`. The message’s text. For the header component, the character limit is 60 characters. For the body component, the character limit is 1024 characters. For url buttons, it indicates the developer-provided suffix that is appended to the predefined prefix URL in the template.
`payload`	string	No	Required for `quick_reply` buttons. Developer-defined payload that is returned when the button is clicked in addition to the display text on the button.
`coupon_code`	string	No	Required when `type` = `coupon_code`. The coupon code to be copied when the customer taps the button.
`image`	object	No	Required when the template `HEADER` format is `IMAGE`.
`gif`	object	No	Required when the template `HEADER` format is `GIF`.
`video`	object	No	Required when the template `HEADER` format is `VIDEO`.
`document`	object	No	Required when the template `HEADER` format is `DOCUMENT`.
`limited_time_offer`	object	No	Required if template uses offer expiration details.
`action`	object	No	Required if template uses catalog or MPM (multi-product message) buttons.
`order_status`	object	No	Object fields are listed below.
`location`	object	No	Required when `type` = `location`.

whatsappMessage.template.components[].parameters[].image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].parameters[].gif

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].parameters[].video

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].parameters[].document

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].parameters[].limited_time_offer

Parameter	Type	Required	Description
`expiration_time_ms`	integer (int64)	No	Required. Offer code expiration time as a UNIX timestamp in milliseconds.

whatsappMessage.template.components[].parameters[].action

Parameter	Type	Required	Description
`thumbnail_product_retailer_id`	string	No	Optional. Use for catalog and MPM template messages. Item SKU number. Labeled as Content ID in the Commerce Manager. The thumbnail of this item will be used as the message’s header image. If the `parameters` object is omitted, the product image of the first item in your catalog will be used.
`sections`	object[]	No	Use for MPM templates. Product sections. You can define up to 10 sections.
`flow_token`	string	No	Use for `FLOW` buttons. Flow token that is generated by the business to serve as an identifier. Defaults to `unused`.
`flow_action_data`	object	No	Use for `FLOW` buttons. JSON object with the data payload for the first screen.
`order_details`	object	No	Required for `order_details` buttons.

whatsappMessage.template.components[].parameters[].action.sections[]

Parameter	Type	Required	Description
`title`	string	No	Section title text. Maximum 24 characters. Markdown is not supported. Maximum length: `24`.
`product_items`	object[]	No	Array of product SKU numbers. There is a minimum of 1 product per section and a maximum of 30 products across all sections.

whatsappMessage.template.components[].parameters[].action.sections[].product_items[]

Parameter	Type	Required	Description
`product_retailer_id`	string	No	SKU number of the item you want to appear in the section. SKU numbers are labeled as Content ID in the Commerce Manager.

whatsappMessage.template.components[].parameters[].action.order_details

Parameter	Type	Required	Description
`currency`	string	Yes	The currency for this order. Currently the only supported value is `INR`.
`order`	object	Yes	Provides order `status`, `items`, `subtotal`, `tax`, etc.
`reference_id`	string	Yes	Unique identifier for the order provided by the business. It is case sensitive and cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters. The `reference_id` must be unique for each order_details message for a given business. If there is a need to send multiple order_details messages for the same order, it is recommended to include a sequence number in the reference_id (for example, “BM345A-12”) to ensure reference_id uniqueness.
`total_amount`	object	Yes	The total amount of the order.
`type`	string	Yes	The type of goods being paid for in this order. Current supported options are `digital-goods` and `physical-goods`.
`payment_settings`	object[]	Yes	Payment settings for the order.

whatsappMessage.template.components[].parameters[].action.order_details.order

Parameter	Type	Required	Description
`status`	string	No	Only supported value in the `order_details` message is `pending`. In an `order_status` message, `status` can be: `pending`, `processing`, `partially_shipped`, `shipped`, `completed`, or `canceled`.
`type`	string	No	Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.
`catalog_id`	string	No	Unique identifier of the Facebook catalog being used by the business. If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`.
`items`	object[]	No	Array of items in the order.
`subtotal`	object	No	The value must be equal to sum of `order.amount.value` * `order.amount.quantity`.
`tax`	object	No	The tax information for this order.
`shipping`	object	No	The shipping cost of the order.
`discount`	object	No	The discount amount for this order.
`expiration`	object	No	Expiration for this order.
`description`	string	No	Optional. Text for sharing status related information. Could be useful while sending cancellation. Max character limit is 120 characters. Maximum length: `120`.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[]

Parameter	Type	Required	Description
`retailer_id`	string	No	Content ID for an item in the order from your catalog.
`name`	string	Yes	The item’s name to be displayed to the user. Cannot exceed 60 characters. Maximum length: `60`.
`image`	object	No	Custom image for the item to be displayed to the user.
`amount`	object	Yes	The price per item.
`sale_amount`	object	No	The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount.
`quantity`	integer (int32)	Yes	The number of items in the order.
`country_of_origin`	string	No	Required if `catalog_id` is not present. The country of origin of the product.
`importer_name`	string	No	Required if `catalog_id` is not present. Name of the importer company.
`importer_address`	string	No	Required if `catalog_id` is not present. Address of importer company.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[].image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[].amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.items[].sale_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.subtotal

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.tax

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.shipping

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.discount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.order.expiration

Parameter	Type	Required	Description
`timestamp`	string	Yes	A string of UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds.
`description`	string	No	Text explanation for expiration. Maximum length: `120`.

whatsappMessage.template.components[].parameters[].action.order_details.total_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[]

Parameter	Type	Required	Description
`type`	string	Yes	Must be set to `payment_gateway`.
`payment_gateway`	object	Yes	An object that describes payment account information.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway

Parameter	Type	Required	Description
`type`	string	Yes	Payment type. Must set this to `billdesk`, `razorpay`, `payu`, or `zaakpay`, if you have linked your BillDesk, Razorpay, PayU, or Zaakpay payment gateway to accept payments.
`configuration_name`	string	Yes	The name of the pre-configured payment configuration to use for this order and must not exceed 60 characters. This value must match with a payment configuration set up on the WhatsApp Business Manager. Maximum length: `60`.
`billdesk`	object	No	Additional info for BillDesk. User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 120.
`payu`	object	No	Additional info for PayU. User-defined fields (udf) are used to store any information corresponding to a particular order. Each UDF field has a maximum character limit of 255.
`razorpay`	object	No	Additional info for Razorpay.
`zaakpay`	object	No	Additional info for Zaakpay. User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 180.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.billdesk

Parameter	Type	Required	Description
`additional_info1`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info2`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info3`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info4`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info5`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info6`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info7`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.payu

Parameter	Type	Required	Description
`udf1`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf2`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf3`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf4`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.razorpay

Parameter	Type	Required	Description
`receipt`	string	No	Receipt number that corresponds to this order, set for your internal reference. Maximum length of 40 characters supported with minimum length greater than 0 characters.
`notes`	object	No	The object can be key value pairs with maximum 15 keys and each value limits to 256 characters.

whatsappMessage.template.components[].parameters[].action.order_details.payment_settings[].payment_gateway.zaakpay

Parameter	Type	Required	Description
`extra1`	string	No	User-defined information about this order for Zaakpay. Maximum length: `180` characters.
`extra2`	string	No	User-defined information about this order for Zaakpay. Maximum length: `180` characters.

whatsappMessage.template.components[].parameters[].order_status

Parameter	Type	Required	Description
`reference_id`	string	No	Unique identifier for the order provided by the business.
`order`	object	No	Provides only `status` and `description` of this order for `order_status` messages.

whatsappMessage.template.components[].parameters[].order_status.order

Parameter	Type	Required	Description
`status`	string	No	Only supported value in the `order_details` message is `pending`. In an `order_status` message, `status` can be: `pending`, `processing`, `partially_shipped`, `shipped`, `completed`, or `canceled`.
`type`	string	No	Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.
`catalog_id`	string	No	Unique identifier of the Facebook catalog being used by the business. If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`.
`items`	object[]	No	Array of items in the order.
`subtotal`	object	No	The value must be equal to sum of `order.amount.value` * `order.amount.quantity`.
`tax`	object	No	The tax information for this order.
`shipping`	object	No	The shipping cost of the order.
`discount`	object	No	The discount amount for this order.
`expiration`	object	No	Expiration for this order.
`description`	string	No	Optional. Text for sharing status related information. Could be useful while sending cancellation. Max character limit is 120 characters. Maximum length: `120`.

whatsappMessage.template.components[].parameters[].order_status.order.items[]

Parameter	Type	Required	Description
`retailer_id`	string	No	Content ID for an item in the order from your catalog.
`name`	string	Yes	The item’s name to be displayed to the user. Cannot exceed 60 characters. Maximum length: `60`.
`image`	object	No	Custom image for the item to be displayed to the user.
`amount`	object	Yes	The price per item.
`sale_amount`	object	No	The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount.
`quantity`	integer (int32)	Yes	The number of items in the order.
`country_of_origin`	string	No	Required if `catalog_id` is not present. The country of origin of the product.
`importer_name`	string	No	Required if `catalog_id` is not present. Name of the importer company.
`importer_address`	string	No	Required if `catalog_id` is not present. Address of importer company.

whatsappMessage.template.components[].parameters[].order_status.order.items[].image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].parameters[].order_status.order.items[].amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.items[].sale_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.subtotal

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.tax

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.shipping

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.discount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].parameters[].order_status.order.expiration

Parameter	Type	Required	Description
`timestamp`	string	Yes	A string of UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds.
`description`	string	No	Text explanation for expiration. Maximum length: `120`.

whatsappMessage.template.components[].parameters[].location

Parameter	Type	Required	Description
`latitude`	number (double)	Yes	Latitude of the location.
`longitude`	number (double)	Yes	Longitude of the location.
`name`	string	No	Name of the location.
`address`	string	No	Address of the location. Only displayed if `name` is present.

whatsappMessage.template.components[].cards[]

Parameter	Type	Required	Description
`card_index`	integer (int32)	No	Required. Zero-indexed order in which card appears within the card carousel. 0 indicates first card, 1 indicates second card, etc. Minimum: `0`. Maximum: `9`.
`components`	object[]	No	Card component.

whatsappMessage.template.components[].cards[].components[]

Parameter	Type	Required	Description
`type`	string	Yes	Component type. Values: `header`, `body`, `button`.
`sub_type`	string	No	Required when type is `button`. Type of button. `quick_reply`: Refers to a previously created quick reply button that allows for the customer to return a predefined message. `url`: Refers to a previously created url button that allows the customer to visit the URL generated by appending the text parameter to the predefined prefix URL in the template.
`index`	integer (int32)	No	Required when `type` = `button`. Not used for the other types. Indicates order in which button should appear, if the template uses multiple buttons. Buttons are zero-indexed, so setting value to 0 will cause the button to appear first, and another button with an index of 1 will appear next, etc. Minimum: `0`. Maximum: `9`.
`parameters`	object[]	No	Required when `type` = `button`, or there are variables in the corresponding template component, or the card component `HEADER` format is media (`IMAGE`, `VIDEO`). Array of parameter objects with the content of the message.

whatsappMessage.template.components[].cards[].components[].parameters[]

Parameter	Type	Required	Description
`type`	string	No	Required. Component parameter type. `text`: Used when the template component type is `BODY`, or the `HEADER` component format is `TEXT`. `image`: Used when the template `HEADER` component is `IMAGE`. `gif`: Used when the template `HEADER` component is `GIF`. `video`: Used when the template `HEADER` component is `VIDEO`. `document`: Used when the template `HEADER` component is `DOCUMENT`. `payload`: Used when the template component button type is `QUICK_REPLY`. `coupon_code`: Used when the template component button type is `COPY_CODE`. `limited_time_offer`: Used when the template component type is `LIMITED_TIME_OFFER`. `action`: Used when the template component button type is `CATALOG`, `MPM`, `FLOW`, or `ORDER_DETAILS`. `order_status`: Used when the template subcategory is `ORDER_STATUS`. `location`: Used when the template `HEADER` component is `LOCATION`.
`text`	string	No	Required when `type` = `text`. The message’s text. For the header component, the character limit is 60 characters. For the body component, the character limit is 1024 characters. For url buttons, it indicates the developer-provided suffix that is appended to the predefined prefix URL in the template.
`payload`	string	No	Required for `quick_reply` buttons. Developer-defined payload that is returned when the button is clicked in addition to the display text on the button.
`coupon_code`	string	No	Required when `type` = `coupon_code`. The coupon code to be copied when the customer taps the button.
`image`	object	No	Required when the template `HEADER` format is `IMAGE`.
`gif`	object	No	Required when the template `HEADER` format is `GIF`.
`video`	object	No	Required when the template `HEADER` format is `VIDEO`.
`document`	object	No	Required when the template `HEADER` format is `DOCUMENT`.
`limited_time_offer`	object	No	Required if template uses offer expiration details.
`action`	object	No	Required if template uses catalog or MPM (multi-product message) buttons.
`order_status`	object	No	Object fields are listed below.
`location`	object	No	Required when `type` = `location`.

whatsappMessage.template.components[].cards[].components[].parameters[].image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].cards[].components[].parameters[].gif

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].cards[].components[].parameters[].video

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].cards[].components[].parameters[].document

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].cards[].components[].parameters[].limited_time_offer

Parameter	Type	Required	Description
`expiration_time_ms`	integer (int64)	No	Required. Offer code expiration time as a UNIX timestamp in milliseconds.

whatsappMessage.template.components[].cards[].components[].parameters[].action

Parameter	Type	Required	Description
`thumbnail_product_retailer_id`	string	No	Optional. Use for catalog and MPM template messages. Item SKU number. Labeled as Content ID in the Commerce Manager. The thumbnail of this item will be used as the message’s header image. If the `parameters` object is omitted, the product image of the first item in your catalog will be used.
`sections`	object[]	No	Use for MPM templates. Product sections. You can define up to 10 sections.
`flow_token`	string	No	Use for `FLOW` buttons. Flow token that is generated by the business to serve as an identifier. Defaults to `unused`.
`flow_action_data`	object	No	Use for `FLOW` buttons. JSON object with the data payload for the first screen.
`order_details`	object	No	Required for `order_details` buttons.

whatsappMessage.template.components[].cards[].components[].parameters[].action.sections[]

Parameter	Type	Required	Description
`title`	string	No	Section title text. Maximum 24 characters. Markdown is not supported. Maximum length: `24`.
`product_items`	object[]	No	Array of product SKU numbers. There is a minimum of 1 product per section and a maximum of 30 products across all sections.

whatsappMessage.template.components[].cards[].components[].parameters[].action.sections[].product_items[]

Parameter	Type	Required	Description
`product_retailer_id`	string	No	SKU number of the item you want to appear in the section. SKU numbers are labeled as Content ID in the Commerce Manager.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details

Parameter	Type	Required	Description
`currency`	string	Yes	The currency for this order. Currently the only supported value is `INR`.
`order`	object	Yes	Provides order `status`, `items`, `subtotal`, `tax`, etc.
`reference_id`	string	Yes	Unique identifier for the order provided by the business. It is case sensitive and cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters. The `reference_id` must be unique for each order_details message for a given business. If there is a need to send multiple order_details messages for the same order, it is recommended to include a sequence number in the reference_id (for example, “BM345A-12”) to ensure reference_id uniqueness.
`total_amount`	object	Yes	The total amount of the order.
`type`	string	Yes	The type of goods being paid for in this order. Current supported options are `digital-goods` and `physical-goods`.
`payment_settings`	object[]	Yes	Payment settings for the order.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order

Parameter	Type	Required	Description
`status`	string	No	Only supported value in the `order_details` message is `pending`. In an `order_status` message, `status` can be: `pending`, `processing`, `partially_shipped`, `shipped`, `completed`, or `canceled`.
`type`	string	No	Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.
`catalog_id`	string	No	Unique identifier of the Facebook catalog being used by the business. If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`.
`items`	object[]	No	Array of items in the order.
`subtotal`	object	No	The value must be equal to sum of `order.amount.value` * `order.amount.quantity`.
`tax`	object	No	The tax information for this order.
`shipping`	object	No	The shipping cost of the order.
`discount`	object	No	The discount amount for this order.
`expiration`	object	No	Expiration for this order.
`description`	string	No	Optional. Text for sharing status related information. Could be useful while sending cancellation. Max character limit is 120 characters. Maximum length: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[]

Parameter	Type	Required	Description
`retailer_id`	string	No	Content ID for an item in the order from your catalog.
`name`	string	Yes	The item’s name to be displayed to the user. Cannot exceed 60 characters. Maximum length: `60`.
`image`	object	No	Custom image for the item to be displayed to the user.
`amount`	object	Yes	The price per item.
`sale_amount`	object	No	The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount.
`quantity`	integer (int32)	Yes	The number of items in the order.
`country_of_origin`	string	No	Required if `catalog_id` is not present. The country of origin of the product.
`importer_name`	string	No	Required if `catalog_id` is not present. Name of the importer company.
`importer_address`	string	No	Required if `catalog_id` is not present. Address of importer company.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[].image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[].amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.items[].sale_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.subtotal

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.tax

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.shipping

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.discount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.order.expiration

Parameter	Type	Required	Description
`timestamp`	string	Yes	A string of UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds.
`description`	string	No	Text explanation for expiration. Maximum length: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.total_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[]

Parameter	Type	Required	Description
`type`	string	Yes	Must be set to `payment_gateway`.
`payment_gateway`	object	Yes	An object that describes payment account information.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway

Parameter	Type	Required	Description
`type`	string	Yes	Payment type. Must set this to `billdesk`, `razorpay`, `payu`, or `zaakpay`, if you have linked your BillDesk, Razorpay, PayU, or Zaakpay payment gateway to accept payments.
`configuration_name`	string	Yes	The name of the pre-configured payment configuration to use for this order and must not exceed 60 characters. This value must match with a payment configuration set up on the WhatsApp Business Manager. Maximum length: `60`.
`billdesk`	object	No	Additional info for BillDesk. User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 120.
`payu`	object	No	Additional info for PayU. User-defined fields (udf) are used to store any information corresponding to a particular order. Each UDF field has a maximum character limit of 255.
`razorpay`	object	No	Additional info for Razorpay.
`zaakpay`	object	No	Additional info for Zaakpay. User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 180.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.billdesk

Parameter	Type	Required	Description
`additional_info1`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info2`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info3`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info4`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info5`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info6`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info7`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.payu

Parameter	Type	Required	Description
`udf1`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf2`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf3`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf4`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.razorpay

Parameter	Type	Required	Description
`receipt`	string	No	Receipt number that corresponds to this order, set for your internal reference. Maximum length of 40 characters supported with minimum length greater than 0 characters.
`notes`	object	No	The object can be key value pairs with maximum 15 keys and each value limits to 256 characters.

whatsappMessage.template.components[].cards[].components[].parameters[].action.order_details.payment_settings[].payment_gateway.zaakpay

Parameter	Type	Required	Description
`extra1`	string	No	User-defined information about this order for Zaakpay. Maximum length: `180` characters.
`extra2`	string	No	User-defined information about this order for Zaakpay. Maximum length: `180` characters.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status

Parameter	Type	Required	Description
`reference_id`	string	No	Unique identifier for the order provided by the business.
`order`	object	No	Provides only `status` and `description` of this order for `order_status` messages.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order

Parameter	Type	Required	Description
`status`	string	No	Only supported value in the `order_details` message is `pending`. In an `order_status` message, `status` can be: `pending`, `processing`, `partially_shipped`, `shipped`, `completed`, or `canceled`.
`type`	string	No	Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.
`catalog_id`	string	No	Unique identifier of the Facebook catalog being used by the business. If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`.
`items`	object[]	No	Array of items in the order.
`subtotal`	object	No	The value must be equal to sum of `order.amount.value` * `order.amount.quantity`.
`tax`	object	No	The tax information for this order.
`shipping`	object	No	The shipping cost of the order.
`discount`	object	No	The discount amount for this order.
`expiration`	object	No	Expiration for this order.
`description`	string	No	Optional. Text for sharing status related information. Could be useful while sending cancellation. Max character limit is 120 characters. Maximum length: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[]

Parameter	Type	Required	Description
`retailer_id`	string	No	Content ID for an item in the order from your catalog.
`name`	string	Yes	The item’s name to be displayed to the user. Cannot exceed 60 characters. Maximum length: `60`.
`image`	object	No	Custom image for the item to be displayed to the user.
`amount`	object	Yes	The price per item.
`sale_amount`	object	No	The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount.
`quantity`	integer (int32)	Yes	The number of items in the order.
`country_of_origin`	string	No	Required if `catalog_id` is not present. The country of origin of the product.
`importer_name`	string	No	Required if `catalog_id` is not present. Name of the importer company.
`importer_address`	string	No	Required if `catalog_id` is not present. Address of importer company.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[].image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[].amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.items[].sale_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.subtotal

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.tax

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.shipping

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.discount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.template.components[].cards[].components[].parameters[].order_status.order.expiration

Parameter	Type	Required	Description
`timestamp`	string	Yes	A string of UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds.
`description`	string	No	Text explanation for expiration. Maximum length: `120`.

whatsappMessage.template.components[].cards[].components[].parameters[].location

Parameter	Type	Required	Description
`latitude`	number (double)	Yes	Latitude of the location.
`longitude`	number (double)	Yes	Longitude of the location.
`name`	string	No	Name of the location.
`address`	string	No	Address of the location. Only displayed if `name` is present.

whatsappMessage.text

Parameter	Type	Required	Description
`body`	string	Yes	Required for text messages. The text of the text message which can contain URLs which begin with http:// or https:// and formatting. See available formatting options here. If you include URLs in your text and want to include a preview box in text messages (preview_url: true), make sure the URL starts with http:// or https:// — https:// URLs are preferred. You must include a hostname, since IP addresses will not be matched. Maximum length: 4096 characters. Maximum length: `4096`.
`preview_url`	boolean	No	By default, WhatsApp recognizes URLs and makes them clickable, but you can also include a preview box with more information about the link. Set this field to true if you want to include a URL preview box. The majority of the time, the receiver will see a URL they can click on when you send an URL, set preview_url to true, and provide a body object with a http or https link. URL previews are only rendered after one of the following has happened: The business has sent a message template to the user. The user initiates a conversation with a “click to chat” link. The user adds the business phone number to their address book and initiates a conversation. Default: `false`.

whatsappMessage.image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.video

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.audio

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.document

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.sticker

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.location

Parameter	Type	Required	Description
`latitude`	number (double)	Yes	Latitude of the location.
`longitude`	number (double)	Yes	Longitude of the location.
`name`	string	No	Name of the location.
`address`	string	No	Address of the location. Only displayed if `name` is present.

whatsappMessage.interactive

Parameter	Type	Required	Description
`type`	string	No	Required. The type of interactive message you want to send. `button`: Use for Reply Buttons. `list`: Use for List Messages. `cta_url`: Use for Call-To-Action (CTA) URL Button Messages. `product`: Use for Single Product Messages. `product_list`: Use for Multi-Product Messages. `catalog_message`: Use for Catalog Messages. `location_request_message`: Use for Location Request Messages. `order_details`: Use for Order Details Messages. `order_status`: Use for Order Status Messages. `voice_call`: Use for Voice Call Messages. `flow`: Use for Flow Messages.
`action`	object	No	Required. Action you want the user to perform after reading the `interactive` message.
`body`	object	No	Optional for type `product`. Required for other message types.
`header`	object	No	Required for type `product_list`. Optional for other types.
`footer`	object	No	Optional. An object with the footer of the message.

whatsappMessage.interactive.action

Parameter	Type	Required	Description
`buttons`	object[]	No	Required for Reply Buttons. You can have up to 3 buttons.
`button`	string	No	Required for List Messages. Button content. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Maximum length: 20 characters. Maximum length: `20`.
`catalog_id`	string	No	Required for Single Product Messages and Multi-Product Messages. Unique identifier of the Facebook catalog linked to your WhatsApp Business Account. This ID can be retrieved via the Meta Commerce Manager.
`product_retailer_id`	string	No	Required for Single Product Messages and Multi-Product Messages. Unique identifier of the product in a catalog.
`sections`	object[]	No	Required for List Messages and Multi-Product Messages. Array of section objects. Minimum of 1, maximum of 10.
`name`	string	No	Action name. Required for Call-To-Action (CTA) buttons. `cta_url`: Use for Call-To-Action (CTA) URL buttons. `catalog_message`: Use for Catalog Messages. `send_location`: Use for Location Request buttons. `flow`: Use for Flow buttons. `review_and_pay`: Use for Order Details buttons. `review_order`: Use for Order Status buttons. `voice_call`: Use for Voice Call buttons.
`parameters`	object	No	Action parameters. Required for Call-To-Action (CTA) buttons.

whatsappMessage.interactive.action.buttons[]

Parameter	Type	Required	Description
`type`	string	No	Only supported type is `reply` (for Reply Button).
`reply`	object	No	Object fields are listed below.

whatsappMessage.interactive.action.buttons[].reply

Parameter	Type	Required	Description
`title`	string	No	Button title. It cannot be an empty string and must be unique within the message. Emojis are supported, markdown is not. Maximum length: 20 characters. Maximum length: `20`.
`id`	string	No	Unique identifier for your button. This ID is returned in the webhook when the button is clicked by the user. Maximum length: 256 characters. You cannot have leading or trailing spaces when setting the ID. Maximum length: `256`.

whatsappMessage.interactive.action.sections[]

Parameter	Type	Required	Description
`title`	string	No	Required if the message has more than one section. Title of the section. Maximum length: 24 characters. Maximum length: `24`.
`rows`	object[]	No	Contains a list of rows. You can have a total of 10 rows across your sections. Each row must have a title (Maximum length: 24 characters) and an ID (Maximum length: 200 characters). You can add a description (Maximum length: 72 characters), but it is optional.
`product_items`	object[]	No	Required for Multi-Product Messages. Array of product objects. There is a minimum of 1 product per section and a maximum of 30 products across all sections.

whatsappMessage.interactive.action.sections[].rows[]

Parameter	Type	Required	Description
`id`	string	No	Unique row ID. Maximum length: 200 characters. Maximum length: `200`.
`title`	string	No	Row title content. Maximum length: 24 characters. Maximum length: `24`.
`description`	string	No	Row description content. Maximum length: 72 characters. Maximum length: `72`.

whatsappMessage.interactive.action.sections[].product_items[]

Parameter	Type	Required	Description
`product_retailer_id`	string	No	Required for Multi-Product Messages. Unique identifier of the product in a catalog.

whatsappMessage.interactive.action.parameters

Parameter	Type	Required	Description
`display_text`	string	No	Text of the CTA URL button. Maximum length: 20 bytes. Maximum length: `20`.
`url`	string	No	URL of the CTA URL button.
`thumbnail_product_retailer_id`	string	No	Item SKU number. Labeled as Content ID in the Commerce Manager. The thumbnail of this item will be used as the message’s header image.
`flow_message_version`	string	No	Use for `flow` buttons. Value must be “3”.
`flow_token`	string	No	Use for `flow` buttons. Flow token that is generated by the business to serve as an identifier. Defaults to `unused`.
`flow_id`	string	No	Conditionally required for `flow` buttons. Unique ID of the Flow provided by WhatsApp. Cannot be used with the `flow_name` parameter.
`flow_name`	string	No	Conditionally required for `flow` buttons. The name of the Flow that you created. Cannot be used with the `flow_id` parameter. Changing the Flow name will require updating this parameter to match the new name.
`flow_cta`	string	No	Required for `flow` buttons. Text on the CTA button. For example: “Open flow!”. Maximum length: 20 characters. Maximum length: `20`.
`flow_action`	string	No	Use for `flow` buttons. Either `navigate` or `data_exchange`. Defaults to `navigate`.
`flow_action_payload`	object	No	Required if `flow_action` is `navigate`. Should be omitted otherwise.
`reference_id`	string	No	Required for `review_and_pay` buttons. Unique identifier for the order provided by the business. It is case sensitive and cannot be an empty string and can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters. The `reference_id` must be unique for each order_details message for a given business. If there is a need to send multiple order_details messages for the same order, it is recommended to include a sequence number in the reference_id (for example, “BM345A-12”) to ensure reference_id uniqueness.
`type`	string	No	Required for `review_and_pay` buttons. The type of goods being paid for in this order. Current supported options are `digital-goods` and `physical-goods`.
`beneficiaries`	object[]	No	Required for `review_and_pay` buttons. An array of beneficiaries for this order. A beneficiary is an intended recipient for shipping the physical goods in the order. Beneficiary information isn’t shown to users but is needed for legal and compliance reasons.
`currency`	string	No	Required for `review_and_pay` buttons. The currency for this order. Currently the only supported value is `INR`.
`total_amount`	object	No	Required for `review_and_pay` buttons. The total amount for this order.
`order`	object	No	Required for `review_and_pay` or `review_order` buttons. For `review_and_pay` buttons, provides order `status`, `items`, `subtotal`, `tax`, etc. For `review_order` buttons, provides only order `status` and `description`.
`payment_settings`	object[]	No	Required for `review_and_pay` buttons. Payment settings for the order.

whatsappMessage.interactive.action.parameters.flow_action_payload

Parameter	Type	Required	Description
`screen`	string	No	The ID of the screen displayed first. It needs to be an entry screen.
`data`	object	No	Optional input data for the first screen of the Flow. If provided, this must be a non-empty object.

whatsappMessage.interactive.action.parameters.beneficiaries[]

Parameter	Type	Required	Description
`name`	string	Yes	Name of the individual or business receiving the physical goods. Cannot exceed 200 characters. Maximum length: `200`.
`address_line1`	string	Yes	Shipping address (Door/Tower Number, Street Name etc.). Cannot exceed 100 characters. Maximum length: `100`.
`address_line2`	string	No	Shipping address (Landmark, Area, etc.). Cannot exceed 100 characters. Maximum length: `100`.
`city`	string	Yes	Name of the city.
`state`	string	Yes	Name of the state.
`country`	string	Yes	Name of the country. Currently the only supported value is `India`.
`postal_code`	string	Yes	6-digit zipcode of shipping address. Minimum length: `6`. Maximum length: `6`.

whatsappMessage.interactive.action.parameters.total_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.interactive.action.parameters.order

Parameter	Type	Required	Description
`status`	string	No	Only supported value in the `order_details` message is `pending`. In an `order_status` message, `status` can be: `pending`, `processing`, `partially_shipped`, `shipped`, `completed`, or `canceled`.
`type`	string	No	Only supported value is `quick_pay`. When this field is passed in we hide the “Review and Pay” button and only show the “Pay Now” button in the order details bubble.
`catalog_id`	string	No	Unique identifier of the Facebook catalog being used by the business. If you do not provide this field, you must provide the following fields inside the items object: `country_of_origin`, `importer_name`, and `importer_address`.
`items`	object[]	No	Array of items in the order.
`subtotal`	object	No	The value must be equal to sum of `order.amount.value` * `order.amount.quantity`.
`tax`	object	No	The tax information for this order.
`shipping`	object	No	The shipping cost of the order.
`discount`	object	No	The discount amount for this order.
`expiration`	object	No	Expiration for this order.
`description`	string	No	Optional. Text for sharing status related information. Could be useful while sending cancellation. Max character limit is 120 characters. Maximum length: `120`.

whatsappMessage.interactive.action.parameters.order.items[]

Parameter	Type	Required	Description
`retailer_id`	string	No	Content ID for an item in the order from your catalog.
`name`	string	Yes	The item’s name to be displayed to the user. Cannot exceed 60 characters. Maximum length: `60`.
`image`	object	No	Custom image for the item to be displayed to the user.
`amount`	object	Yes	The price per item.
`sale_amount`	object	No	The discounted price per item. This should be less than the original amount. If included, this field is used to calculate the subtotal amount.
`quantity`	integer (int32)	Yes	The number of items in the order.
`country_of_origin`	string	No	Required if `catalog_id` is not present. The country of origin of the product.
`importer_name`	string	No	Required if `catalog_id` is not present. Name of the importer company.
`importer_address`	string	No	Required if `catalog_id` is not present. Address of importer company.

whatsappMessage.interactive.action.parameters.order.items[].image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.interactive.action.parameters.order.items[].amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.interactive.action.parameters.order.items[].sale_amount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.interactive.action.parameters.order.subtotal

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.interactive.action.parameters.order.tax

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.interactive.action.parameters.order.shipping

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.interactive.action.parameters.order.discount

Parameter	Type	Required	Description
`offset`	integer (int32)	Yes	Must be `100` for `INR`.
`value`	integer (int32)	Yes	Positive integer representing the amount value multiplied by offset. For example, ₹12.34 has value 1234.
`description`	string	No	Use only for `tax`, `shipping`, or `discount`. Description of the amount. Max character limit is 60 characters. Maximum length: `60`.
`discount_program_name`	string	No	Use only for `discount`. Text used for defining incentivised orders. If order is incentivised, the merchant needs to define this information. Max character limit is 60 characters. Maximum length: `60`.

whatsappMessage.interactive.action.parameters.order.expiration

Parameter	Type	Required	Description
`timestamp`	string	Yes	A string of UTC timestamp in seconds of time when order should expire. Minimum threshold is 300 seconds.
`description`	string	No	Text explanation for expiration. Maximum length: `120`.

whatsappMessage.interactive.action.parameters.payment_settings[]

Parameter	Type	Required	Description
`type`	string	Yes	Must be set to `payment_gateway`.
`payment_gateway`	object	Yes	An object that describes payment account information.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway

Parameter	Type	Required	Description
`type`	string	Yes	Payment type. Must set this to `billdesk`, `razorpay`, `payu`, or `zaakpay`, if you have linked your BillDesk, Razorpay, PayU, or Zaakpay payment gateway to accept payments.
`configuration_name`	string	Yes	The name of the pre-configured payment configuration to use for this order and must not exceed 60 characters. This value must match with a payment configuration set up on the WhatsApp Business Manager. Maximum length: `60`.
`billdesk`	object	No	Additional info for BillDesk. User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 120.
`payu`	object	No	Additional info for PayU. User-defined fields (udf) are used to store any information corresponding to a particular order. Each UDF field has a maximum character limit of 255.
`razorpay`	object	No	Additional info for Razorpay.
`zaakpay`	object	No	Additional info for Zaakpay. User-defined fields (extra) are used to store any information corresponding to a particular order. Each extra field has a maximum character limit of 180.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.billdesk

Parameter	Type	Required	Description
`additional_info1`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info2`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info3`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info4`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info5`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info6`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.
`additional_info7`	string	No	User-defined information about this order for BillDesk. Maximum length: `120` characters.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.payu

Parameter	Type	Required	Description
`udf1`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf2`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf3`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.
`udf4`	string	No	User-defined information about this order for PayU. Maximum length: `255` characters.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.razorpay

Parameter	Type	Required	Description
`receipt`	string	No	Receipt number that corresponds to this order, set for your internal reference. Maximum length of 40 characters supported with minimum length greater than 0 characters.
`notes`	object	No	The object can be key value pairs with maximum 15 keys and each value limits to 256 characters.

whatsappMessage.interactive.action.parameters.payment_settings[].payment_gateway.zaakpay

Parameter	Type	Required	Description
`extra1`	string	No	User-defined information about this order for Zaakpay. Maximum length: `180` characters.
`extra2`	string	No	User-defined information about this order for Zaakpay. Maximum length: `180` characters.

whatsappMessage.interactive.body

Parameter	Type	Required	Description
`text`	string	No	The body content of the message. Emojis and markdown are supported. Maximum length: 1024 characters. Maximum length: `1024`.

whatsappMessage.interactive.header

Parameter	Type	Required	Description
`type`	string	No	Required. The header type you would like to use. `text`: Used for List Messages, Reply Buttons, and Multi-Product Messages. `video`: Used for Reply Buttons. `image`: Used for Reply Buttons. `document`: Used for Reply Buttons.
`text`	string	No	Text for the header. Formatting allows emojis, but not markdown. Maximum length: `60`.
`image`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.
`video`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.
`document`	object	No	Use for `image`, `gif`, `video`, `audio`, `document`, or `sticker` messages. See also Supported Media Types.

whatsappMessage.interactive.header.image

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.interactive.header.video

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.interactive.header.document

Parameter	Type	Required	Description
`id`	string	No	Use this when media is uploaded to WhatsApp servers. Provide the media object ID obtained from WhatsApp media upload API (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence.
`link`	string	No	Use this when sending media directly from your server. The protocol and URL of the media to be sent. Use only with HTTP/HTTPS URLs. Note: WhatsApp Cloud API caches media resources for 10 minutes. To ensure latest content, add random query strings to the URL. Note: Either `id` or `link` must be provided. If both are provided, `id` takes precedence and `link` will be ignored.
`caption`	string	No	Describes the specified `image`, `gif`, `video`, or `document` media. Not applicable in the `header` of `template` or `interactive` messages.
`filename`	string	No	Describes the filename for the specific document. Use only with `document` media.

whatsappMessage.interactive.footer

Parameter	Type	Required	Description
`text`	string	No	The footer content. Emojis and markdown are supported. Links are supported. Maximum length: 60 characters. Maximum length: `60`.

whatsappMessage.contacts[]

Parameter	Type	Required	Description
`addresses`	object[]	No	Array items are described below.
`birthday`	string	No	`YYYY-MM-DD` formatted string.
`emails`	object[]	No	Array items are described below.
`name`	object	Yes	Full contact name formatted as a name object.
`org`	object	No	Contact organization information formatted as an org object.
`phones`	object[]	No	Contact phone number(s) formatted as a phone object.
`urls`	object[]	No	Contact URL(s) formatted as a urls object.
`vcard`	string	No	Optional vCard supplied with the shared contact payload.
`origin`	string	No	Set to `contact_request` when the user shared the contact in response to a request-contact-info message.

whatsappMessage.contacts[].addresses[]

Parameter	Type	Required	Description
`street`	string	No	Street number and name.
`city`	string	No	City name.
`state`	string	No	State abbreviation.
`zip`	string	No	ZIP code.
`country`	string	No	Full country name.
`country_code`	string	No	Two-letter country abbreviation.
`type`	string	No	Standard values are `HOME` and `WORK`.

whatsappMessage.contacts[].emails[]

Parameter	Type	Required	Description
`email`	string	No	Email address.
`type`	string	No	Standard values are `HOME` and `WORK`.

whatsappMessage.contacts[].name

Parameter	Type	Required	Description
`formatted_name`	string	Yes	Full name, as it normally appears.
`first_name`	string	No	First name.
`last_name`	string	No	Last name.
`middle_name`	string	No	Middle name.
`suffix`	string	No	Name suffix.
`prefix`	string	No	Name prefix.

whatsappMessage.contacts[].org

Parameter	Type	Required	Description
`company`	string	No	Name of the contact’s company.
`department`	string	No	Name of the contact’s department.
`title`	string	No	Contact’s business title.

whatsappMessage.contacts[].phones[]

Parameter	Type	Required	Description
`phone`	string	No	Automatically populated with the `wa_id` value as a formatted phone number.
`type`	string	No	Standard Values are `CELL`, `MAIN`, `IPHONE`, `HOME`, and `WORK`.
`wa_id`	string	No	WhatsApp ID.

whatsappMessage.contacts[].urls[]

Parameter	Type	Required	Description
`url`	string	No	URL.
`type`	string	No	Standard values are `HOME` and `WORK`.

whatsappMessage.reaction

Parameter	Type	Required	Description
`message_id`	string	Yes	Specifies the `wamid` of the message received that contained the reaction.
`emoji`	string	No	Required when you send a `reaction` message. Set it to `""` if you want to remove the emoji. Optional when you received a message from a user. This field is included when a user reacts to messages with an emoji. Otherwise, it indicates a user removed the emoji.

whatsappMessage.context

Parameter	Type	Required	Description
`message_id`	string	No	Specifies the `wamid` of the message your are replying to. `wamid` is the original message ID on WhatsApp’s platform.

whatsappMessage.whatsappApiError

Parameter	Type	Required	Description
`message`	string	Yes	A human-readable description of the error.
`code`	string	Yes	An error code.
`type`	string	No	Error type.
`error_subcode`	string	No	Additional code about the error.
`error_user_msg`	string	No	The message to display to the user. The language of the message is based on the locale of the API request.
`error_user_title`	string	No	The title of the dialog, if shown. The language of the message is based on the locale of the API request.
`fbtrace_id`	string	No	Internal support identifier. When reporting a bug related to a Graph API call, include the fbtrace_id to help us find log data for debugging.
`error_data`	string or object	No	Additional data about the error. A string or map. For template APIs, this field is a string describing the reason for the error. For message APIs, this field is a map with property `details` describing the reason for the error.

Example

The following JSON is the body delivered to your receiver. IDs, phone numbers, and other account values are illustrative.

Inbound history message

An inbound history message uses whatsappInboundMessage. phase and progress report synchronization of the history chunk.

{
  "id": "evt_example_smb_history_inbound",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "phase": 1,
  "progress": 40,
  "whatsappInboundMessage": {
    "id": "INBOUND_MESSAGE_ID",
    "wamid": "wamid.INBOUND_EXAMPLE",
    "wabaId": "WABA_ID",
    "from": "+12025550124",
    "to": "+12025550123",
    "type": "text",
    "text": {
      "body": "What time can I collect my order?"
    },
    "customerProfile": {
      "name": "Example customer"
    },
    "sendTime": "2026-10-08T12:00:00.000Z"
  }
}

Outbound history message

An outbound history message uses whatsappMessage. Do not route it as an inbound message.

{
  "id": "evt_example_smb_history_outbound",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "phase": 1,
  "progress": 60,
  "whatsappMessage": {
    "id": "MESSAGE_ID",
    "wamid": "wamid.EXAMPLE",
    "wabaId": "WABA_ID",
    "from": "+12025550124",
    "to": "+12025550123",
    "type": "text",
    "text": {
      "body": "Your order is ready for pickup."
    },
    "status": "sent",
    "createTime": "2026-10-08T12:00:00.000Z",
    "sendTime": "2026-10-08T12:00:00.000Z"
  }
}

History synchronization progress

A metadata-only history chunk reports phase and progress without either message object. Do not treat this shape as a message-created or message-echoes payload.

{
  "id": "evt_example_smb_history_progress",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "phase": 1,
  "progress": 73
}

Inbound Text message

{
  "id": "evt_eEkn26qar3nOB8md",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "phase": 1,
  "progress": 40,
  "whatsappInboundMessage": {
    "id": "63f872f6741c165b4342a751",
    "wamid": "wamid.HBgNODi...",
    "wabaId": "WABA-ID",
    "from": "CUSTOMER-PHONE-NUMBER",
    "fromUserId": "US.13491208655302741918",
    "fromParentUserId": "US.11815799212886844830",
    "customerProfile": {
      "name": "Joe",
      "username": "@JoeWick"
    },
    "to": "BUSINESS-PHONE-NUMBER",
    "sendTime": "2023-02-22T12:00:00.000Z",
    "type": "text",
    "text": {
      "body": "OK"
    },
    "context": {
      "from": "+12025550124",
      "id": "wamid.HBgNODr..."
    }
  }
}

Outbound Text message

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "phase": 1,
  "progress": 40,
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.11815799212886844830",
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "text",
    "text": {
      "body": "Hi there! How can we help?"
    },
    "context": {
      "message_id": "wamid.BgNODYxN..."
    }
  }
}

Progress-only history chunk

{
  "id": "evt_progressOnly73",
  "type": "whatsapp.smb.history",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:02.000Z",
  "phase": 1,
  "progress": 73
}

After verifying the signature and durably accepting the event, return a 2xx response. Process slow work asynchronously.

HTTP/1.1 200 OK

For scenario walkthroughs, see annotated examples.

Getting Started

Guides

Endpoints

Webhook reference

Triggers

Syntax

Parameters

Event envelope

Event payload

whatsappInboundMessage

whatsappMessage

Example

​Triggers

​Syntax

​Parameters

​Event envelope

​Event payload

​whatsappInboundMessage

​whatsappMessage

​Example

Triggers

Syntax

Parameters

Event envelope

Event payload

whatsappInboundMessage

whatsappMessage

Example