whatsapp.smb.message.echoes

Use whatsapp.smb.message.echoes para manipular este evento em seu endpoint de webhook.

Gatilhos

Ocorre quando uma mensagem enviada a partir do aplicativo WhatsApp Business é sincronizada como um eco. Assine whatsapp.smb.message.echoes ao configurar seu endpoint de webhook.

Sintaxe

A YCloud envia uma solicitação HTTP POST para a URL de webhook configurada. A estrutura a seguir mostra uma variante do payload. Os valores entre colchetes angulares são marcadores de posição; seus tipos estão listados em Parâmetros. Campos opcionais e outras variantes são descritos abaixo.

{
  "id": "<ID>",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappMessage": {
    "id": "<ID>",
    "wamid": "<WAMID>",
    "wabaId": "<WABA_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "type": "<TYPE>",
    "text": {
      "body": "<BODY>"
    },
    "status": "<STATUS>",
    "createTime": "<CREATE_TIME>",
    "sendTime": "<SEND_TIME>",
    "toUserId": "<TO_USER_ID>",
    "toParentUserId": "<TO_PARENT_USER_ID>",
    "customerProfile": {
      "username": "<USERNAME>"
    }
  }
}

Parâmetros

Valide o cabeçalho HTTP YCloud-Signature antes de processar o corpo JSON. Consulte validação de assinatura.

Envelope do evento

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`.
`type`	string	Sim	Sempre `whatsapp.smb.message.echoes`.
`apiVersion`	string	Sim	A versão da API usada para renderizar este evento.
`createTime`	string (date-time)	Sim	O momento em que este evento foi criado, formatado em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.

Payload do evento

Parâmetro	Tipo	Obrigatório	Descrição
`whatsappMessage`	object	Não	Payload específico do evento `whatsappMessage`.

Os quatro campos de envelope comuns são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objetos, Obrigatório se aplica quando o objeto pai estiver presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório.

whatsappMessage

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Sim	ID exclusivo da mensagem.
`wamid`	string	Não	O ID da mensagem original na plataforma do WhatsApp.
`wabaId`	string	Sim	ID da conta do WhatsApp Business.
`from`	string	Sim	O número de telefone do remetente no formato E.164.
`to`	string	Não	O número de telefone do destinatário no formato E.164.
`recipient`	string	Não	O valor do destinatário enviado na solicitação quando um BSUID ou BSUID pai foi usado.
`recipientUserId`	string	Não	O ID de usuário com escopo comercial do WhatsApp (BSUID) do destinatário.
`toUserId`	string	Não	Alias de `recipientUserId` mantido para compatibilidade.
`parentRecipientUserId`	string	Não	O ID de usuário pai com escopo comercial do WhatsApp do destinatário.
`toParentUserId`	string	Não	Alias de `parentRecipientUserId` mantido para compatibilidade.
`customerProfile`	object	Não	As informações de perfil do destinatário, incluindo o nome de usuário do WhatsApp quando disponível.
`conversation`	object	Não	O WhatsApp define uma conversa como uma sessão de mensagens de 24 horas entre uma pessoa e uma empresa. Este campo está presente após o status da mensagem mudar para `sent`. Consulte também Preços baseados em conversas.
`type`	string	Não	Tipo de mensagem de saída do WhatsApp. Consulte também mensagens do WhatsApp. Valores: `template`, `text`, `image`, `audio`, `video`, `document`, `sticker`, `location`, `interactive`, `contacts`, `reaction`.
`template`	object	Não	Use para enviar uma mensagem de `template` do WhatsApp.
`text`	object	Não	Objeto de mensagem de texto do WhatsApp.
`image`	object	Não	Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.
`video`	object	Não	Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.
`audio`	object	Não	Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.
`document`	object	Não	Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.
`sticker`	object	Não	Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.
`location`	object	Não	Use para mensagens de `location`.
`interactive`	object	Não	Use para mensagens de `interactive`.
`contacts`	object[]	Não	Os itens do array são descritos abaixo.
`reaction`	object	Não	Quando um usuário reage a mensagens com um emoji, o tipo de mensagem é definido como `reaction` e este campo é incluído.
`context`	object	Não	Usado para mencionar uma mensagem específica que você está respondendo. A resposta pode ser de qualquer tipo de mensagem.
`externalId`	string	Não	Uma string exclusiva (recomendada) para referenciar o objeto. Pode ser um número de pedido ou similar, e pode ser usada para reconciliar o objeto com seus sistemas internos.
`category`	string	Não	A categoria de Direct Send, como `utility` ou `authentication`, quando aplicável.
`ttlSeconds`	integer	Não	O tempo de vida da mensagem de Direct Send configurado em segundos, quando aplicável.
`status`	string	Não	Status da mensagem do WhatsApp. Um de `accepted`, `failed`, `sent`, `delivered`, `read`. `accepted`: A solicitação de mensagens foi aceita pelo nosso sistema. `failed`: Uma mensagem enviada pela sua empresa falhou ao ser enviada. `sent`: Uma mensagem enviada pela sua empresa está em trânsito nos sistemas do WhatsApp. `delivered`: Uma mensagem enviada pela sua empresa foi entregue ao dispositivo do usuário. `read`: Uma mensagem enviada pela sua empresa foi lida pelo usuário.
`errorCode`	string	Não	Código de erro quando o status da mensagem é `failed`.
`errorMessage`	string	Não	Mensagem de erro quando o status da mensagem é `failed`.
`createTime`	string (date-time)	Não	A data e hora em que esta mensagem foi criada, formatada no padrão RFC 3339. Por exemplo, `2022-06-01T12:00:00.000Z`.
`updateTime`	string (date-time)	Não	A data e hora em que esta mensagem foi atualizada, formatada no padrão RFC 3339. Por exemplo, `2022-06-01T12:00:00.000Z`.
`sendTime`	string (date-time)	Não	A data e hora em que o `status` desta mensagem mudou para `sent`, formatada no padrão RFC 3339. Por exemplo, `2022-06-01T12:00:00.000Z`.
`deliverTime`	string (date-time)	Não	A data e hora em que o `status` desta mensagem mudou para `delivered`, formatada no padrão RFC 3339. Por exemplo, `2022-06-01T12:00:00.000Z`.
`readTime`	string (date-time)	Não	A data e hora em que esta mensagem `status` mudou para `read`, formatada em RFC 3339. Ex.: `2022-06-01T12:00:00.000Z`.
`totalPrice`	number (double)	Não	Preço total desta mensagem. Observação: é apenas um preço estimado quando o `status` é `accepted` ou `sent`. Ele se torna o preço final após a entrega da mensagem, ou seja, quando o `status` é `delivered` ou `read`. Para mensagens de Preço Máximo, o valor no momento do envio é uma estimativa. Use o evento whatsapp.message.updated delivered/read para a cobrança final; maxBid não é o valor final cobrado.
`currency`	string	Não	Moeda do preço. Código de moeda ISO 4217.
`regionCode`	string	Não	O código de região do número de telefone do destinatário.
`pricingCategory`	string	Não	A categoria de preço da mensagem. Observação: é apenas uma categoria de preço estimada quando o `status` é `accepted` ou `sent`. Ela se torna definitiva após a entrega da mensagem, ou seja, quando o `status` é `delivered` ou `read`. Valores: `referral_conversion`, `authentication`, `authentication_international`, `marketing`, `marketing_lite`, `utility`, `service`, `marketing_lite_bidding`.
`pricingModel`	string	Não	O modelo de preços da mensagem. `PMP`: aplica-se a precificação por mensagem. `CBP`: aplica-se a precificação baseada em conversas.
`pricingType`	string	Não	O tipo de preço da mensagem. Este campo está disponível apenas no modo PMP (Per-Message Pricing). `regular`: indica que a mensagem é cobrável. `free_customer_service`: indica que a mensagem é gratuita por ter sido uma mensagem de modelo de utilidade ou uma mensagem sem modelo enviada dentro de uma janela de atendimento ao cliente. `free_entry_point`: indica que a mensagem é gratuita por fazer parte de uma conversa de ponto de entrada gratuito.
`whatsappApiError`	object	Não	O objeto de erro original retornado pelo WhatsApp. Consulte Como tratar erros, Códigos de erro da Cloud API.
`bizType`	string	Não	Pode estar vazio ou ser um de `whatsapp` ou `verify`. O padrão é `whatsapp`. `whatsapp`: indica que a mensagem foi enviada por meio do produto WhatsApp. `verify`: indica que a mensagem foi enviada por meio do produto Verify.
`verificationId`	string	Não	O ID de verificação. Incluído somente quando `bizType` for `verify`.
`bidPricingFlag`	boolean	Não	True quando a mensagem for identificada como uma mensagem de lance do Marketing Lite. Seu pricingCategory é marketing_lite_bidding.

whatsappMessage.customerProfile

Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	Não	Nome da conta do WhatsApp.
`username`	string	Não	Nome de usuário do WhatsApp.

whatsappMessage.conversation

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	ID exclusivo do objeto.
`type`	string	Não	Tipo de conversa. Há uma cobrança quando a primeira mensagem da empresa dessa conversa é entregue, iniciando a sessão de conversa de 24 horas. Dessa forma, o tipo de conversa pode ser `null` antes de a primeira mensagem ser entregue. `FREE_ENTRY`: conversas originadas de um ponto de entrada gratuito. `FREE_TIER`: conversas dentro do nível gratuito mensal. `REGULAR`: quaisquer conversas que não tenham se originado de um ponto de entrada gratuito ou que estejam acima do limite do nível gratuito mensal.
`originType`	string	Não	Indica a categoria da conversa. Isso também pode ser chamado de ponto de entrada da conversa. `referral_conversion`: indica uma conversa de ponto de entrada gratuito. `authentication`: indica que a conversa foi iniciada por uma empresa enviando um modelo categorizado como `AUTHENTICATION` para o cliente. Isso se aplica sempre que tiverem passado mais de 24 horas desde a última mensagem do cliente. `marketing`: indica que a conversa foi iniciada por uma empresa enviando um modelo categorizado como `MARKETING` para o cliente. Isso se aplica sempre que tiverem passado mais de 24 horas desde a última mensagem do cliente. `utility`: indica que a conversa foi iniciada por uma empresa enviando um modelo categorizado como `UTILITY` para o cliente. Isso se aplica sempre que tiverem passado mais de 24 horas desde a última mensagem do cliente. `service`: indica que a conversa foi iniciada por uma empresa respondendo a um cliente dentro de uma janela de atendimento ao cliente.
`expireTime`	string (date-time)	Não	Data em que a conversa expira, formatada em RFC 3339. Por exemplo, `2022-06-01T12:00:00.000Z`.

whatsappMessage.template

Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome do modelo.
`language`	object	Sim	Contém um objeto de idioma. Especifica o idioma em que o modelo pode ser renderizado.
`components`	object[]	Não	Obrigatório quando o modelo especificado contiver variáveis ou mídia. Matriz de objetos de componente contendo os parâmetros da mensagem.

whatsappMessage.template.language

Parâmetro	Tipo	Obrigatório	Descrição
`code`	string	Sim	O código do idioma ou localidade a ser usado. Aceita os formatos idioma e idioma_localidade (por exemplo, en e en_US). Consulte Idiomas compatíveis para ver todos os códigos.
`policy`	string	Não	A política de idioma que a mensagem deve seguir. Padrão (e única opção suportada): `deterministic`, o que significa que o WhatsApp entrega o modelo de mensagem exatamente no idioma e localidade solicitados.

whatsappMessage.template.components[]

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Tipo de componente. Valores: `header`, `body`, `button`, `limited_time_offer`, `carousel`, `order_status`.
`sub_type`	string	Não	Obrigatório quando o tipo for `button`. Tipo de botão. `quick_reply`: Refere-se a um botão de resposta rápida criado anteriormente que permite ao cliente retornar uma mensagem predefinida. `url`: Refere-se a um botão de URL criado anteriormente que permite ao cliente acessar o URL gerado anexando o parâmetro de texto ao prefixo de URL predefinido no modelo. `copy_code`: Refere-se a um botão de copiar código criado anteriormente que permite ao cliente copiar uma sequência de texto (definida quando o modelo é enviado em uma mensagem de modelo) para a área de transferência do dispositivo quando tocado pelo usuário do aplicativo. `catalog`: Refere-se a um botão de catálogo criado anteriormente que permite ao cliente visualizar seu catálogo de produtos. `mpm`: Refere-se a um botão MPM (mensagem multiproduto) criado anteriormente que permite ao cliente navegar por produtos e seções. `flow`: Refere-se a um botão de fluxo criado anteriormente que permite ao cliente interagir com um flow. `order_details`: Refere-se a um botão de detalhes do pedido criado anteriormente que permite ao cliente visualizar os detalhes de um pedido.
`index`	integer (int32)	Não	Obrigatório quando `type` = `button`. Não utilizado para os outros tipos. Indica a ordem em que o botão deve aparecer, caso o modelo utilize múltiplos botões. Os botões têm índice baseado em zero, portanto definir o valor como 0 fará com que o botão apareça primeiro, e outro botão com índice 1 aparecerá em seguida, etc. Mínimo: `0`. Máximo: `9`.
`parameters`	object[]	Não	Obrigatório quando `type` = `button`, ou houver variáveis no componente correspondente do modelo, ou se o formato do `HEADER` do modelo for mídia (`IMAGE`, `VIDEO` ou `DOCUMENT`). Matriz de objetos de parâmetro com o conteúdo da mensagem.
`cards`	object[]	Não	Use para componentes `carousel`. Fornece componentes de cartão que contêm os parâmetros da mensagem.

whatsappMessage.template.components[].parameters[]

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Não	Obrigatório. Tipo de parâmetro do componente. `text`: Usado quando o tipo de componente do modelo for `BODY`, ou o formato do componente `HEADER` for `TEXT`. `image`: Usado quando o componente `HEADER` do modelo for `IMAGE`. `gif`: Usado quando o componente `HEADER` do modelo for `GIF`. `video`: Usado quando o componente `HEADER` do modelo for `VIDEO`. `document`: Usado quando o componente `HEADER` do modelo for `DOCUMENT`. `payload`: Usado quando o tipo de botão do componente do modelo for `QUICK_REPLY`. `coupon_code`: Usado quando o tipo de botão do componente do modelo for `COPY_CODE`. `limited_time_offer`: Usado quando o tipo de componente do modelo for `LIMITED_TIME_OFFER`. `action`: Usado quando o tipo de botão do componente do modelo for `CATALOG`, `MPM`, `FLOW` ou `ORDER_DETAILS`. `order_status`: Usado quando a subcategoria do modelo for `ORDER_STATUS`. `location`: Usado quando o componente `HEADER` do modelo for `LOCATION`.
`text`	string	Não	Obrigatório quando `type` = `text`. O texto da mensagem. Para o componente de cabeçalho, o limite de caracteres é de 60 caracteres. Para o componente de corpo, o limite de caracteres é de 1024 caracteres. Para botões de URL, indica o sufixo fornecido pelo desenvolvedor que é anexado ao prefixo de URL predefinido no modelo.
`payload`	string	Não	Obrigatório para botões `quick_reply`. Carga útil definida pelo desenvolvedor que é retornada quando o botão é clicado, além do texto de exibição no botão.
`coupon_code`	string	Não	Obrigatório quando `type` = `coupon_code`. O código de cupom a ser copiado quando o cliente toca no botão.
`image`	object	Não	Obrigatório quando o formato do `HEADER` do modelo for `IMAGE`.
`gif`	object	Não	Obrigatório quando o formato do `HEADER` do modelo for `GIF`.
`video`	object	Não	Obrigatório quando o formato do `HEADER` do modelo for `VIDEO`.
`document`	object	Não	Obrigatório quando o formato do `HEADER` do modelo for `DOCUMENT`.
`limited_time_offer`	object	Não	Obrigatório se o modelo usar detalhes de expiração da oferta.
`action`	object	Não	Obrigatório se o modelo usar botões de catálogo ou MPM (mensagem de vários produtos).
`order_status`	object	Não	Os campos do objeto estão listados abaixo.
`location`	object	Não	Obrigatório quando `type` = `location`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com a mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com a mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`expiration_time_ms`	integer (int64)	Não	Obrigatório. Tempo de expiração do código da oferta como um carimbo de data/hora do UNIX em milissegundos.

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

Parâmetro	Tipo	Obrigatório	Descrição
`thumbnail_product_retailer_id`	string	Não	Opcional. Use para mensagens de modelo de catálogo e MPM. Número do SKU do item. Rotulado como ID de Conteúdo no Gerenciador de Comércio. A miniatura deste item será usada como a imagem de cabeçalho da mensagem. Se o objeto `parameters` for omitido, a imagem do primeiro item do seu catálogo será usada.
`sections`	object[]	Não	Use para modelos MPM. Seções de produtos. Você pode definir até 10 seções.
`flow_token`	string	Não	Use para botões `FLOW`. Token de Flow gerado pela empresa para servir como identificador. O padrão é `unused`.
`flow_action_data`	object	Não	Use para botões `FLOW`. Objeto JSON com a carga de dados para a primeira tela.
`order_details`	object	Não	Obrigatório para botões `order_details`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`title`	string	Não	Texto do título da seção. Máximo de 24 caracteres. Não há suporte para Markdown. Comprimento máximo: `24`.
`product_items`	object[]	Não	Matriz de números de SKU de produtos. Há um mínimo de 1 produto por seção e um máximo de 30 produtos em todas as seções.

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

Parâmetro	Tipo	Obrigatório	Descrição
`product_retailer_id`	string	Não	Número de SKU do item que você deseja que apareça na seção. Os números de SKU são rotulados como Content ID no Commerce Manager.

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

Parâmetro	Tipo	Obrigatório	Descrição
`currency`	string	Sim	A moeda para este pedido. Atualmente, o único valor suportado é `INR`.
`order`	object	Sim	Fornece `status`, `items`, `subtotal`, `tax` etc. do pedido.
`reference_id`	string	Sim	Identificador exclusivo para o pedido fornecido pela empresa. Diferencia maiúsculas de minúsculas, não pode ser uma string vazia, pode conter apenas letras em inglês, números, sublinhados, traços ou pontos, e não deve exceder 35 caracteres. O `reference_id` deve ser exclusivo para cada mensagem de order_details de uma determinada empresa. Se houver a necessidade de enviar várias mensagens de order_details para o mesmo pedido, recomenda-se incluir um número sequencial no reference_id (por exemplo, “BM345A-12”) para garantir a exclusividade do reference_id.
`total_amount`	object	Sim	O valor total do pedido.
`type`	string	Sim	O tipo de mercadorias que estão sendo pagas neste pedido. As opções atualmente suportadas são `digital-goods` e `physical-goods`.
`payment_settings`	object[]	Sim	Configurações de pagamento para o pedido.

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

Parâmetro	Tipo	Obrigatório	Descrição
`status`	string	Não	O único valor suportado na mensagem de `order_details` é `pending`. Em uma mensagem de `order_status`, `status` pode ser: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` ou `canceled`.
`type`	string	Não	O único valor suportado é `quick_pay`. Quando este campo é informado, ocultamos o botão “Revisar e pagar” e exibimos apenas o botão “Pagar agora” no balão de detalhes do pedido.
`catalog_id`	string	Não	Identificador exclusivo do catálogo do Facebook usado pela empresa. Se você não fornecer este campo, deverá fornecer os seguintes campos dentro do objeto items: `country_of_origin`, `importer_name` e `importer_address`.
`items`	object[]	Não	Matriz de itens no pedido.
`subtotal`	object	Não	O valor deve ser igual à soma de `order.amount.value` * `order.amount.quantity`.
`tax`	object	Não	As informações fiscais deste pedido.
`shipping`	object	Não	O custo de frete do pedido.
`discount`	object	Não	O valor do desconto para este pedido.
`expiration`	object	Não	Vencimento para este pedido.
`description`	string	Não	Opcional. Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo de caracteres é de 120 caracteres. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`retailer_id`	string	Não	ID do conteúdo de um item no pedido a partir do seu catálogo.
`name`	string	Sim	O nome do item a ser exibido para o usuário. Não pode exceder 60 caracteres. Comprimento máximo: `60`.
`image`	object	Não	Imagem personalizada do item a ser exibida para o usuário.
`amount`	object	Sim	O preço por item.
`sale_amount`	object	Não	O preço com desconto por item. Deve ser menor que o valor original. Se incluído, este campo será usado para calcular o valor do subtotal.
`quantity`	integer (int32)	Sim	O número de itens no pedido.
`country_of_origin`	string	Não	Obrigatório se `catalog_id` não estiver presente. O país de origem do produto.
`importer_name`	string	Não	Obrigatório se `catalog_id` não estiver presente. Nome da empresa importadora.
`importer_address`	string	Não	Obrigatório se `catalog_id` não estiver presente. Endereço da empresa importadora.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia de `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Número inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos incentivados. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Número inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos incentivados. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Número inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos incentivados. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Número inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essa informação. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essa informação. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`timestamp`	string	Sim	Uma string de timestamp UTC em segundos do momento em que o pedido deve expirar. O limite mínimo é 300 segundos.
`description`	string	Não	Explicação em texto para a expiração. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essa informação. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Deve ser definido como `payment_gateway`.
`payment_gateway`	object	Sim	Um objeto que descreve informações da conta de pagamento.

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

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Tipo de pagamento. Deve definir isto como `billdesk`, `razorpay`, `payu` ou `zaakpay`, se você vinculou seu gateway de pagamento BillDesk, Razorpay, PayU ou Zaakpay para aceitar pagamentos.
`configuration_name`	string	Sim	O nome da configuração de pagamento pré-configurada a ser usada para este pedido, não devendo exceder 60 caracteres. Este valor deve corresponder a uma configuração de pagamento definida no Gerenciador do WhatsApp Business. Comprimento máximo: `60`.
`billdesk`	object	Não	Informações adicionais para o BillDesk. Campos definidos pelo usuário (extra) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo extra tem um limite máximo de 120 caracteres.
`payu`	object	Não	Informações adicionais para o PayU. Campos definidos pelo usuário (udf) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo UDF tem um limite máximo de 255 caracteres.
`razorpay`	object	Não	Informações adicionais para o Razorpay.
`zaakpay`	object	Não	Informações adicionais para o Zaakpay. Campos definidos pelo usuário (extra) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo extra tem um limite máximo de 180 caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`additional_info1`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info2`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info3`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info4`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info5`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info6`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info7`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`udf1`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf2`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf3`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf4`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`receipt`	string	Não	Número do recibo correspondente a este pedido, definido para sua referência interna. Suporta comprimento máximo de 40 caracteres e mínimo maior que 0 caracteres.
`notes`	object	Não	O objeto pode conter pares chave-valor com no máximo 15 chaves, e cada valor é limitado a 256 caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`extra1`	string	Não	Informações definidas pelo usuário sobre este pedido para o Zaakpay. Comprimento máximo: `180` caracteres.
`extra2`	string	Não	Informações definidas pelo usuário sobre este pedido para o Zaakpay. Comprimento máximo: `180` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`reference_id`	string	Não	Identificador exclusivo do pedido fornecido pela empresa.
`order`	object	Não	Fornece apenas `status` e `description` deste pedido para mensagens de `order_status`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`status`	string	Não	O único valor suportado na mensagem `order_details` é `pending`. Em uma mensagem `order_status`, `status` pode ser: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` ou `canceled`.
`type`	string	Não	O único valor suportado é `quick_pay`. Quando esse campo é informado, ocultamos o botão “Review and Pay” e exibimos apenas o botão “Pay Now” no balão de detalhes do pedido.
`catalog_id`	string	Não	Identificador exclusivo do catálogo do Facebook usado pela empresa. Se você não fornecer esse campo, deverá fornecer os seguintes campos dentro do objeto items: `country_of_origin`, `importer_name` e `importer_address`.
`items`	object[]	Não	Matriz de itens no pedido.
`subtotal`	object	Não	O valor deve ser igual à soma de `order.amount.value` * `order.amount.quantity`.
`tax`	object	Não	As informações fiscais deste pedido.
`shipping`	object	Não	O custo de frete do pedido.
`discount`	object	Não	O valor de desconto deste pedido.
`expiration`	object	Não	Expiração deste pedido.
`description`	string	Não	Opcional. Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo é de 120 caracteres. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`retailer_id`	string	Não	ID de conteúdo para um item no pedido a partir do seu catálogo.
`name`	string	Sim	O nome do item a ser exibido para o usuário. Não pode exceder 60 caracteres. Comprimento máximo: `60`.
`image`	object	Não	Imagem personalizada do item a ser exibida para o usuário.
`amount`	object	Sim	O preço por item.
`sale_amount`	object	Não	O preço com desconto por item. Deve ser menor que o valor original. Se incluído, este campo é usado para calcular o valor do subtotal.
`quantity`	integer (int32)	Sim	O número de itens no pedido.
`country_of_origin`	string	Não	Obrigatório se `catalog_id` não estiver presente. O país de origem do produto.
`importer_name`	string	Não	Obrigatório se `catalog_id` não estiver presente. Nome da empresa importadora.
`importer_address`	string	Não	Obrigatório se `catalog_id` não estiver presente. Endereço da empresa importadora.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isso quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isso ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use somente com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use somente com a mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor da quantia multiplicado pelo offset. Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use somente para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use somente para `discount`. Texto usado para definir pedidos incentivados. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`timestamp`	string	Sim	Uma string com timestamp UTC em segundos do momento em que o pedido deve expirar. O limite mínimo é de 300 segundos.
`description`	string	Não	Explicação em texto para a expiração. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`latitude`	number (double)	Sim	Latitude da localização.
`longitude`	number (double)	Sim	Longitude da localização.
`name`	string	Não	Nome da localização.
`address`	string	Não	Endereço da localização. Exibido apenas se `name` estiver presente.

whatsappMessage.template.components[].cards[]

Parâmetro	Tipo	Obrigatório	Descrição
`card_index`	integer (int32)	Não	Obrigatório. Ordem de base zero na qual o cartão aparece dentro do carrossel de cartões. 0 indica o primeiro cartão, 1 indica o segundo cartão etc. Mínimo: `0`. Máximo: `9`.
`components`	object[]	Não	Componente de cartão.

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

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Tipo de componente. Valores: `header`, `body`, `button`.
`sub_type`	string	Não	Obrigatório quando o tipo for `button`. Tipo de botão. `quick_reply`: Refere-se a um botão de resposta rápida criado anteriormente que permite ao cliente retornar uma mensagem predefinida. `url`: Refere-se a um botão de URL criado anteriormente que permite ao cliente visitar a URL gerada anexando o parâmetro de texto ao prefixo de URL predefinido no modelo.
`index`	integer (int32)	Não	Obrigatório quando `type` = `button`. Não usado para os outros tipos. Indica a ordem em que o botão deve aparecer, caso o modelo use vários botões. Os botões têm índice baseado em zero, portanto, definir o valor como 0 fará com que o botão apareça primeiro, e outro botão com índice 1 aparecerá em seguida, etc. Mínimo: `0`. Máximo: `9`.
`parameters`	object[]	Não	Obrigatório quando `type` = `button`, ou houver variáveis no componente de modelo correspondente, ou o formato do componente de card `HEADER` for mídia (`IMAGE`, `VIDEO`). Matriz de objetos de parâmetro com o conteúdo da mensagem.

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

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Não	Obrigatório. Tipo de parâmetro do componente. `text`: Usado quando o tipo do componente de modelo for `BODY` ou o formato do componente `HEADER` for `TEXT`. `image`: Usado quando o componente de modelo `HEADER` for `IMAGE`. `gif`: Usado quando o componente de modelo `HEADER` for `GIF`. `video`: Usado quando o componente de modelo `HEADER` for `VIDEO`. `document`: Usado quando o componente de modelo `HEADER` for `DOCUMENT`. `payload`: Usado quando o tipo de botão do componente de modelo for `QUICK_REPLY`. `coupon_code`: Usado quando o tipo de botão do componente de modelo for `COPY_CODE`. `limited_time_offer`: Usado quando o tipo do componente de modelo for `LIMITED_TIME_OFFER`. `action`: Usado quando o tipo de botão do componente de modelo for `CATALOG`, `MPM`, `FLOW` ou `ORDER_DETAILS`. `order_status`: Usado quando a subcategoria do modelo for `ORDER_STATUS`. `location`: Usado quando o componente de modelo `HEADER` for `LOCATION`.
`text`	string	Não	Obrigatório quando `type` = `text`. O texto da mensagem. Para o componente de cabeçalho, o limite é de 60 caracteres. Para o componente de corpo, o limite é de 1024 caracteres. Para botões de URL, indica o sufixo fornecido pelo desenvolvedor que é anexado ao prefixo de URL predefinido no modelo.
`payload`	string	Não	Obrigatório para botões `quick_reply`. Payload definido pelo desenvolvedor que é retornado quando o botão é clicado, além do texto de exibição no botão.
`coupon_code`	string	Não	Obrigatório quando `type` = `coupon_code`. O código do cupom a ser copiado quando o cliente toca no botão.
`image`	object	Não	Obrigatório quando o formato de `HEADER` do modelo for `IMAGE`.
`gif`	object	Não	Obrigatório quando o formato de `HEADER` do modelo for `GIF`.
`video`	object	Não	Obrigatório quando o formato de `HEADER` do modelo for `VIDEO`.
`document`	object	Não	Obrigatório quando o formato do modelo `HEADER` for `DOCUMENT`.
`limited_time_offer`	object	Não	Obrigatório se o modelo usar detalhes de expiração da oferta.
`action`	object	Não	Obrigatório se o modelo usar botões de catálogo ou MPM (mensagem multiproduto).
`order_status`	object	Não	Os campos do objeto estão listados abaixo.
`location`	object	Não	Obrigatório quando `type` = `location`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isso quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isso ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use somente com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia de `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use somente com mídia de `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isso quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isso ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use somente com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia de `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use somente com mídia de `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for carregada nos servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia de `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for carregada nos servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia de `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`expiration_time_ms`	integer (int64)	Não	Obrigatório. Tempo de expiração do código da oferta como um carimbo de data/hora UNIX em milissegundos.

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

Parâmetro	Tipo	Obrigatório	Descrição
`thumbnail_product_retailer_id`	string	Não	Opcional. Use para mensagens de modelo de catálogo e MPM. Número do SKU do item. Rotulado como Content ID no Gerenciador de Comércio. A miniatura deste item será usada como a imagem de cabeçalho da mensagem. Se o objeto `parameters` for omitido, a imagem do produto do primeiro item do seu catálogo será usada.
`sections`	object[]	Não	Use para modelos MPM. Seções do produto. Você pode definir até 10 seções.
`flow_token`	string	Não	Use para botões `FLOW`. Token de fluxo gerado pela empresa para servir como identificador. O padrão é `unused`.
`flow_action_data`	object	Não	Use para botões `FLOW`. Objeto JSON com a carga de dados para a primeira tela.
`order_details`	object	Não	Obrigatório para botões `order_details`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`title`	string	Não	Texto do título da seção. Máximo de 24 caracteres. Não há suporte para Markdown. Comprimento máximo: `24`.
`product_items`	object[]	Não	Matriz de números SKU do produto. Há um mínimo de 1 produto por seção e um máximo de 30 produtos em todas as seções.

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

Parâmetro	Tipo	Obrigatório	Descrição
`product_retailer_id`	string	Não	Número SKU do item que você deseja que apareça na seção. Os números SKU são rotulados como Content ID no Commerce Manager.

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

Parâmetro	Tipo	Obrigatório	Descrição
`currency`	string	Sim	A moeda deste pedido. Atualmente, o único valor suportado é `INR`.
`order`	object	Sim	Fornece `status`, `items`, `subtotal`, `tax` do pedido, etc.
`reference_id`	string	Sim	Identificador exclusivo para o pedido fornecido pela empresa. Diferencia maiúsculas de minúsculas, não pode ser uma string vazia e só pode conter letras do alfabeto inglês, números, sublinhados, traços ou pontos, e não deve exceder 35 caracteres. O `reference_id` deve ser exclusivo para cada mensagem de order_details de uma determinada empresa. Se houver necessidade de enviar várias mensagens de order_details para o mesmo pedido, é recomendável incluir um número sequencial no reference_id (por exemplo, “BM345A-12”) para garantir a exclusividade do reference_id.
`total_amount`	object	Sim	O valor total do pedido.
`type`	string	Sim	O tipo de mercadoria que está sendo paga neste pedido. As opções atualmente suportadas são `digital-goods` e `physical-goods`.
`payment_settings`	object[]	Sim	Configurações de pagamento do pedido.

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

Parâmetro	Tipo	Obrigatório	Descrição
`status`	string	Não	O único valor suportado na mensagem `order_details` é `pending`. Em uma mensagem `order_status`, o `status` pode ser: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` ou `canceled`.
`type`	string	Não	O único valor suportado é `quick_pay`. Quando este campo é passado, ocultamos o botão “Review and Pay” e exibimos apenas o botão “Pay Now” no balão de detalhes do pedido.
`catalog_id`	string	Não	Identificador exclusivo do catálogo do Facebook usado pela empresa. Se você não fornecer este campo, deverá fornecer os seguintes campos dentro do objeto de itens: `country_of_origin`, `importer_name` e `importer_address`.
`items`	object[]	Não	Matriz de itens no pedido.
`subtotal`	object	Não	O valor deve ser igual à soma de `order.amount.value` * `order.amount.quantity`.
`tax`	object	Não	As informações fiscais deste pedido.
`shipping`	object	Não	O custo de frete do pedido.
`discount`	object	Não	O valor do desconto para este pedido.
`expiration`	object	Não	Vencimento deste pedido.
`description`	string	Não	Opcional. Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo é de 120 caracteres. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`retailer_id`	string	Não	ID do conteúdo para um item no pedido do seu catálogo.
`name`	string	Sim	O nome do item a ser exibido para o usuário. Não pode exceder 60 caracteres. Comprimento máximo: `60`.
`image`	object	Não	Imagem personalizada para o item a ser exibido para o usuário.
`amount`	object	Sim	O preço por item.
`sale_amount`	object	Não	O preço com desconto por item. Deve ser menor que o valor original. Se incluído, este campo é usado para calcular o valor do subtotal.
`quantity`	integer (int32)	Sim	A quantidade de itens no pedido.
`country_of_origin`	string	Não	Obrigatório se `catalog_id` não estiver presente. O país de origem do produto.
`importer_name`	string	Não	Obrigatório se `catalog_id` não estiver presente. Nome da empresa importadora.
`importer_address`	string	Não	Obrigatório se `catalog_id` não estiver presente. Endereço da empresa importadora.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Número inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Número inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Número inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`timestamp`	string	Sim	Uma string de carimbo de data/hora (timestamp) UTC em segundos indicando quando o pedido deve expirar. O limite mínimo é de 300 segundos.
`description`	string	Não	Explicação em texto para a expiração. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Deve ser definido como `payment_gateway`.
`payment_gateway`	object	Sim	Um objeto que descreve as informações da conta de pagamento.

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

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Tipo de pagamento. Deve definir isto como `billdesk`, `razorpay`, `payu` ou `zaakpay`, caso tenha vinculado seu gateway de pagamento BillDesk, Razorpay, PayU ou Zaakpay para aceitar pagamentos.
`configuration_name`	string	Sim	O nome da configuração de pagamento pré-configurada a ser usada para este pedido, não podendo exceder 60 caracteres. Este valor deve corresponder a uma configuração de pagamento definida no WhatsApp Business Manager. Comprimento máximo: `60`.
`billdesk`	object	Não	Informações adicionais para BillDesk. Campos definidos pelo usuário (extra) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo extra possui um limite máximo de 120 caracteres.
`payu`	object	Não	Informações adicionais para PayU. Campos definidos pelo usuário (udf) são usados para armazenar qualquer informação correspondente a um determinado pedido. Cada campo UDF tem um limite máximo de 255 caracteres.
`razorpay`	object	Não	Informações adicionais para Razorpay.
`zaakpay`	object	Não	Informações adicionais para Zaakpay. Campos definidos pelo usuário (extra) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo extra possui um limite máximo de 180 caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`additional_info1`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info2`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info3`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info4`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info5`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info6`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.
`additional_info7`	string	Não	Informações definidas pelo usuário sobre este pedido para o BillDesk. Comprimento máximo: `120` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`udf1`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf2`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf3`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf4`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`receipt`	string	Não	Número do recibo correspondente a este pedido, definido para sua referência interna. Suporta comprimento máximo de 40 caracteres com comprimento mínimo maior que 0 caracteres.
`notes`	object	Não	O objeto pode ser composto por pares de chave-valor com no máximo 15 chaves, e cada valor é limitado a 256 caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`extra1`	string	Não	Informações definidas pelo usuário sobre este pedido para o Zaakpay. Comprimento máximo: `180` caracteres.
`extra2`	string	Não	Informações definidas pelo usuário sobre este pedido para o Zaakpay. Comprimento máximo: `180` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`reference_id`	string	Não	Identificador exclusivo do pedido fornecido pela empresa.
`order`	object	Não	Fornece apenas `status` e `description` deste pedido para mensagens `order_status`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`status`	string	Não	O único valor suportado na mensagem `order_details` é `pending`. Em uma mensagem `order_status`, `status` pode ser: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` ou `canceled`.
`type`	string	Não	O único valor suportado é `quick_pay`. Quando este campo é informado, ocultamos o botão “Review and Pay” e mostramos apenas o botão “Pay Now” no balão de detalhes do pedido.
`catalog_id`	string	Não	Identificador exclusivo do catálogo do Facebook usado pela empresa. Se você não fornecer este campo, deverá fornecer os seguintes campos dentro do objeto items: `country_of_origin`, `importer_name` e `importer_address`.
`items`	object[]	Não	Matriz de itens no pedido.
`subtotal`	object	Não	O valor deve ser igual à soma de `order.amount.value` * `order.amount.quantity`.
`tax`	object	Não	As informações de tributos deste pedido.
`shipping`	object	Não	O custo de frete do pedido.
`discount`	object	Não	O valor do desconto para este pedido.
`expiration`	object	Não	Expiração para este pedido.
`description`	string	Não	Opcional. Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo de caracteres é de 120 caracteres. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`retailer_id`	string	Não	ID de conteúdo de um item do pedido a partir do seu catálogo.
`name`	string	Sim	O nome do item a ser exibido para o usuário. Não pode exceder 60 caracteres. Comprimento máximo: `60`.
`image`	object	Não	Imagem personalizada para o item a ser exibido para o usuário.
`amount`	object	Sim	O preço por item.
`sale_amount`	object	Não	O preço com desconto por item. Deve ser menor que o valor original. Se incluído, este campo é usado para calcular o valor do subtotal.
`quantity`	integer (int32)	Sim	O número de itens no pedido.
`country_of_origin`	string	Não	Obrigatório se `catalog_id` não estiver presente. O país de origem do produto.
`importer_name`	string	Não	Obrigatório se `catalog_id` não estiver presente. Nome da empresa importadora.
`importer_address`	string	Não	Obrigatório se `catalog_id` não estiver presente. Endereço da empresa importadora.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Nota: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` tem precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do montante. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do montante. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do montante. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`timestamp`	string	Sim	Uma string com timestamp UTC em segundos do momento em que o pedido deve expirar. O limite mínimo é de 300 segundos.
`description`	string	Não	Explicação em texto para a expiração. Tamanho máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`latitude`	number (double)	Sim	Latitude do local.
`longitude`	number (double)	Sim	Longitude do local.
`name`	string	Não	Nome do local.
`address`	string	Não	Endereço do local. Exibido apenas se `name` estiver presente.

whatsappMessage.text

Parâmetro	Tipo	Obrigatório	Descrição
`body`	string	Sim	Obrigatório para mensagens de texto. O texto da mensagem que pode conter URLs iniciadas por http:// ou https:// e formatação. Consulte as opções de formatação disponíveis aqui. Se você incluir URLs no seu texto e quiser exibir uma caixa de prévia em mensagens de texto (preview_url: true), certifique-se de que a URL comece com http:// ou https:// — URLs com https:// são preferíveis. Você deve incluir um hostname, pois endereços IP não serão aceitos. Tamanho máximo: 4096 caracteres. Tamanho máximo: `4096`.
`preview_url`	boolean	Não	Por padrão, o WhatsApp reconhece URLs e as torna clicáveis, mas você também pode incluir uma caixa de prévia com mais informações sobre o link. Defina este campo como true se quiser incluir uma caixa de prévia de URL. Na maioria das vezes, o destinatário verá uma URL clicável quando você enviar uma URL, definir preview_url como true e fornecer um objeto body com um link http ou https. As prévias de URL só são renderizadas após a ocorrência de uma das seguintes situações: A empresa enviou um modelo de mensagem para o usuário. O usuário inicia uma conversa com um link “conversa em um clique”. O usuário adiciona o número de telefone da empresa aos seus contatos e inicia uma conversa. Padrão: `false`.

whatsappMessage.image

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`.

whatsappMessage.video

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione query strings aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com a mídia `document`.

whatsappMessage.audio

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione query strings aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com a mídia `document`.

whatsappMessage.document

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione query strings aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no caso de mensagens de `header`, `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia de `document`.

whatsappMessage.sticker

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use somente com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada de `image`, `gif`, `video` ou `document`. Não aplicável no caso de mensagens de `header`, `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia de `document`.

whatsappMessage.location

Parâmetro	Tipo	Obrigatório	Descrição
`latitude`	number (double)	Sim	Latitude da localização.
`longitude`	number (double)	Sim	Longitude da localização.
`name`	string	Não	Nome da localização.
`address`	string	Não	Endereço da localização. Exibido apenas se `name` estiver presente.

whatsappMessage.interactive

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Não	Obrigatório. O tipo de mensagem interativa que você deseja enviar. `button`: use para botões de resposta. `list`: use para mensagens de lista. `cta_url`: use para mensagens de botão com URL de chamada para ação (CTA). `product`: use para mensagens de produto único. `product_list`: use para mensagens de vários produtos. `catalog_message`: use para mensagens de catálogo. `location_request_message`: use para mensagens de solicitação de localização. `order_details`: use para mensagens de detalhes do pedido. `order_status`: use para mensagens de status do pedido. `voice_call`: use para mensagens de chamada de voz. `flow`: use para mensagens de fluxo.
`action`	object	Não	Obrigatório. Ação que você deseja que o usuário execute após ler a mensagem `interactive`.
`body`	object	Não	Opcional para o tipo `product`. Obrigatório para outros tipos de mensagem.
`header`	object	Não	Obrigatório para o tipo `product_list`. Opcional para outros tipos.
`footer`	object	Não	Opcional. Um objeto com o rodapé da mensagem.

whatsappMessage.interactive.action

Parâmetro	Tipo	Obrigatório	Descrição
`buttons`	object[]	Não	Obrigatório para Botões de resposta. Você pode ter até 3 botões.
`button`	string	Não	Obrigatório para Mensagens de lista. Conteúdo do botão. Não pode ser uma string vazia e deve ser exclusivo dentro da mensagem. Emojis são suportados, markdown não. Comprimento máximo: 20 caracteres. Comprimento máximo: `20`.
`catalog_id`	string	Não	Obrigatório para Mensagens de produto único e Mensagens de vários produtos. Identificador exclusivo do catálogo do Facebook vinculado à sua conta do WhatsApp Business. Este ID pode ser obtido por meio do Meta Commerce Manager.
`product_retailer_id`	string	Não	Obrigatório para Mensagens de produto único e Mensagens de vários produtos. Identificador exclusivo do produto em um catálogo.
`sections`	object[]	Não	Obrigatório para Mensagens de lista e Mensagens de vários produtos. Matriz de objetos de seção. Mínimo de 1, máximo de 10.
`name`	string	Não	Nome da ação. Obrigatório para botões de Call-To-Action (CTA). `cta_url`: Use para botões de URL de Call-To-Action (CTA). `catalog_message`: Use para Mensagens de catálogo. `send_location`: Use para botões de Solicitação de localização. `flow`: Use para botões de Flow. `review_and_pay`: Use para botões de Detalhes do pedido. `review_order`: Use para botões de Status do pedido. `voice_call`: Use para botões de Chamada de voz.
`parameters`	object	Não	Parâmetros da ação. Obrigatório para botões de Call-To-Action (CTA).

whatsappMessage.interactive.action.buttons[]

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Não	O único tipo suportado é `reply` (para Botão de resposta).
`reply`	object	Não	Os campos do objeto estão listados abaixo.

whatsappMessage.interactive.action.buttons[].reply

Parâmetro	Tipo	Obrigatório	Descrição
`title`	string	Não	Título do botão. Não pode ser uma string vazia e deve ser exclusivo dentro da mensagem. Emojis são suportados, markdown não. Comprimento máximo: 20 caracteres. Comprimento máximo: `20`.
`id`	string	Não	Identificador exclusivo do seu botão. Este ID é retornado no webhook quando o botão é clicado pelo usuário. Comprimento máximo: 256 caracteres. Não é permitido ter espaços no início ou no fim ao definir o ID. Comprimento máximo: `256`.

whatsappMessage.interactive.action.sections[]

Parâmetro	Tipo	Obrigatório	Descrição
`title`	string	Não	Obrigatório se a mensagem tiver mais de uma seção. Título da seção. Comprimento máximo: 24 caracteres. Comprimento máximo: `24`.
`rows`	object[]	Não	Contém uma lista de linhas. Você pode ter um total de 10 linhas em todas as suas seções. Cada linha deve ter um título (Comprimento máximo: 24 caracteres) e um ID (Comprimento máximo: 200 caracteres). Você pode adicionar uma descrição (Comprimento máximo: 72 caracteres), mas ela é opcional.
`product_items`	object[]	Não	Obrigatório para Mensagens Multi-Product. Matriz de objetos de produto. Há um mínimo de 1 produto por seção e um máximo de 30 produtos em todas as seções.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	ID exclusivo da linha. Comprimento máximo: 200 caracteres. Comprimento máximo: `200`.
`title`	string	Não	Conteúdo do título da linha. Comprimento máximo: 24 caracteres. Comprimento máximo: `24`.
`description`	string	Não	Conteúdo da descrição da linha. Comprimento máximo: 72 caracteres. Comprimento máximo: `72`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`product_retailer_id`	string	Não	Obrigatório para Mensagens Multi-Product. Identificador exclusivo do produto em um catálogo.

whatsappMessage.interactive.action.parameters

Parâmetro	Tipo	Obrigatório	Descrição
`display_text`	string	Não	Texto do botão de URL CTA. Comprimento máximo: 20 bytes. Comprimento máximo: `20`.
`url`	string	Não	URL do botão de URL CTA.
`thumbnail_product_retailer_id`	string	Não	Número de SKU do item. Identificado como Content ID no Gerenciador de Comércio. A miniatura deste item será usada como a imagem do cabeçalho da mensagem.
`flow_message_version`	string	Não	Use para botões `flow`. O valor deve ser “3”.
`flow_token`	string	Não	Use para botões `flow`. Token do Flow que é gerado pela empresa para servir como um identificador. O padrão é `unused`.
`flow_id`	string	Não	Condicionalmente obrigatório para botões `flow`. ID exclusivo do Flow fornecido pelo WhatsApp. Não pode ser usado com o parâmetro `flow_name`.
`flow_name`	string	Não	Condicionalmente obrigatório para botões `flow`. O nome do Flow que você criou. Não pode ser usado com o parâmetro `flow_id`. Alterar o nome do Flow exigirá a atualização deste parâmetro para coincidir com o novo nome.
`flow_cta`	string	Não	Obrigatório para botões `flow`. Texto no botão CTA. Por exemplo: “Open flow!”. Comprimento máximo: 20 caracteres. Comprimento máximo: `20`.
`flow_action`	string	Não	Use para botões `flow`. Pode ser `navigate` ou `data_exchange`. O padrão é `navigate`.
`flow_action_payload`	object	Não	Obrigatório se `flow_action` for `navigate`. Caso contrário, deve ser omitido.
`reference_id`	string	Não	Obrigatório para botões `review_ e _pay`. Identificador exclusivo para o pedido fornecido pela empresa. Diferencia maiúsculas de minúsculas, não pode ser uma string vazia e pode conter apenas letras em inglês, números, sublinhados, traços ou pontos, e não deve exceder 35 caracteres. O `reference_id` deve ser exclusivo para cada mensagem de order_details para uma determinada empresa. Se houver a necessidade de enviar várias mensagens de order_details para o mesmo pedido, recomenda-se incluir um número sequencial no reference_id (por exemplo, “BM345A-12”) para garantir a exclusividade do reference_id.
`type`	string	Não	Obrigatório para botões `review_and_pay`. O tipo de mercadoria que está sendo paga neste pedido. As opções atualmente suportadas são `digital-goods` e `physical-goods`.
`beneficiaries`	object[]	Não	Obrigatório para botões `review_and_pay`. Uma matriz de beneficiários para este pedido. Um beneficiário é o destinatário pretendido para o envio das mercadorias físicas no pedido. As informações do beneficiário não são exibidas aos usuários, mas são necessárias por motivos legais e de conformidade.
`currency`	string	Não	Obrigatório para botões `review_and_pay`. A moeda deste pedido. Atualmente, o único valor suportado é `INR`.
`total_amount`	object	Não	Obrigatório para botões `review_and_pay`. O valor total deste pedido.
`order`	object	Não	Obrigatório para botões `review_and_pay` ou `review_order`. Para botões `review_and_pay`, fornece `status`, `items`, `subtotal`, `tax`, etc. do pedido. Para botões `review_order`, fornece apenas `status` e `description` do pedido.
`payment_settings`	object[]	Não	Obrigatório para botões `review_and_pay`. Configurações de pagamento para o pedido.

whatsappMessage.interactive.action.parameters.flow_action_payload

Parâmetro	Tipo	Obrigatório	Descrição
`screen`	string	Não	O ID da tela exibida primeiro. Deve ser uma tela de entry .
`data`	object	Não	Dados de entrada opcionais para a primeira tela do Flow. Se fornecido, deve ser um objeto não vazio.

whatsappMessage.interactive.action.parameters.beneficiaries[]

Parâmetro	Tipo	Obrigatório	Descrição
`name`	string	Sim	Nome da pessoa física ou jurídica que recebe as mercadorias físicas. Não pode exceder 200 caracteres. Comprimento máximo: `200`.
`address_line1`	string	Sim	Endereço de entrega (número da porta/torre, nome da rua, etc.). Não pode exceder 100 caracteres. Comprimento máximo: `100`.
`address_line2`	string	Não	Endereço de entrega (ponto de referência, bairro, etc.). Não pode exceder 100 caracteres. Comprimento máximo: `100`.
`city`	string	Sim	Nome da cidade.
`state`	string	Sim	Nome do estado.
`country`	string	Sim	Nome do país. Atualmente, o único valor suportado é `India`.
`postal_code`	string	Sim	CEP de 6 dígitos do endereço de entrega. Comprimento mínimo: `6`. Comprimento máximo: `6`.

whatsappMessage.interactive.action.parameters.total_amount

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos incentivados. Se o pedido for incentivado, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

whatsappMessage.interactive.action.parameters.order

Parâmetro	Tipo	Obrigatório	Descrição
`status`	string	Não	O único valor suportado na mensagem de `order_details` é `pending`. Em uma mensagem de `order_status`, o `status` pode ser: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` ou `canceled`.
`type`	string	Não	O único valor suportado é `quick_pay`. Quando este campo é enviado, ocultamos o botão “Review and Pay” e exibimos apenas o botão “Pay Now” no balão de detalhes do pedido.
`catalog_id`	string	Não	Identificador exclusivo do catálogo do Facebook sendo usado pela empresa. Se você não fornecer este campo, deverá fornecer os seguintes campos dentro do objeto items: `country_of_origin`, `importer_name` e `importer_address`.
`items`	object[]	Não	Matriz de itens no pedido.
`subtotal`	object	Não	O valor deve ser igual à soma de `order.amount.value` * `order.amount.quantity`.
`tax`	object	Não	As informações fiscais para este pedido.
`shipping`	object	Não	O custo de frete do pedido.
`discount`	object	Não	O valor do desconto para este pedido.
`expiration`	object	Não	Expiração para este pedido.
`description`	string	Não	Opcional. Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo é de 120 caracteres. Comprimento máximo: `120`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`retailer_id`	string	Não	ID do conteúdo de um item no pedido do seu catálogo.
`name`	string	Sim	O nome do item a ser exibido para o usuário. Não pode exceder 60 caracteres. Comprimento máximo: `60`.
`image`	object	Não	Imagem personalizada do item a ser exibida para o usuário.
`amount`	object	Sim	O preço por item.
`sale_amount`	object	Não	O preço com desconto por item. Deve ser menor que o valor original. Se incluído, este campo é usado para calcular o valor do subtotal.
`quantity`	integer (int32)	Sim	A quantidade de itens no pedido.
`country_of_origin`	string	Não	Obrigatório se `catalog_id` não estiver presente. O país de origem do produto.
`importer_name`	string	Não	Obrigatório se `catalog_id` não estiver presente. Nome da empresa importadora.
`importer_address`	string	Não	Obrigatório se `catalog_id` não estiver presente. Endereço da empresa importadora.

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

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use somente com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia especificada `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use somente para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

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

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use somente para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

whatsappMessage.interactive.action.parameters.order.subtotal

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

whatsappMessage.interactive.action.parameters.order.tax

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor multiplicado pelo offset. Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

whatsappMessage.interactive.action.parameters.order.shipping

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor multiplicado pelo offset. Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

whatsappMessage.interactive.action.parameters.order.discount

Parâmetro	Tipo	Obrigatório	Descrição
`offset`	integer (int32)	Sim	Deve ser `100` para `INR`.
`value`	integer (int32)	Sim	Inteiro positivo que representa o valor multiplicado pelo offset. Por exemplo, ₹12.34 tem o valor 1234.
`description`	string	Não	Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.
`discount_program_name`	string	Não	Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres. Comprimento máximo: `60`.

whatsappMessage.interactive.action.parameters.order.expiration

Parâmetro	Tipo	Obrigatório	Descrição
`timestamp`	string	Sim	Uma string de carimbo de data/hora UTC em segundos correspondente ao momento em que o pedido deve expirar. O limite mínimo é de 300 segundos.
`description`	string	Não	Explicação em texto para a expiração. Comprimento máximo: `120`.

whatsappMessage.interactive.action.parameters.payment_settings[]

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Deve ser definido como `payment_gateway`.
`payment_gateway`	object	Sim	Um objeto que descreve as informações da conta de pagamento.

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

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Sim	Tipo de pagamento. Deve definir isto como `billdesk`, `razorpay`, `payu` ou `zaakpay`, se você vinculou seu gateway de pagamento BillDesk, Razorpay, PayU ou Zaakpay para aceitar pagamentos.
`configuration_name`	string	Sim	O nome da configuração de pagamento pré-configurada a ser usada para este pedido e não deve exceder 60 caracteres. Este valor deve corresponder a uma configuração de pagamento definida no Gerenciador do WhatsApp Business. Comprimento máximo: `60`.
`billdesk`	object	Não	Informações adicionais para BillDesk. Campos definidos pelo usuário (extra) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo extra tem um limite máximo de 120 caracteres.
`payu`	object	Não	Informações adicionais para PayU. Campos definidos pelo usuário (udf) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo UDF tem um limite máximo de 255 caracteres.
`razorpay`	object	Não	Informações adicionais para Razorpay.
`zaakpay`	object	Não	Informações adicionais para Zaakpay. Campos definidos pelo usuário (extra) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo extra tem um limite máximo de 180 caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`additional_info1`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info2`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info3`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info4`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info5`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info6`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.
`additional_info7`	string	Não	Informações definidas pelo usuário sobre este pedido para BillDesk. Comprimento máximo: `120` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`udf1`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf2`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf3`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.
`udf4`	string	Não	Informações definidas pelo usuário sobre este pedido para o PayU. Comprimento máximo: `255` caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`receipt`	string	Não	Número do comprovante correspondente a este pedido, definido para sua referência interna. Suporta comprimento máximo de 40 caracteres, com comprimento mínimo maior que 0 caracteres.
`notes`	object	Não	O objeto pode ser formado por pares de chave-valor com no máximo 15 chaves, e cada valor é limitado a 256 caracteres.

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

Parâmetro	Tipo	Obrigatório	Descrição
`extra1`	string	Não	Informações definidas pelo usuário sobre este pedido para o Zaakpay. Comprimento máximo: `180` caracteres.
`extra2`	string	Não	Informações definidas pelo usuário sobre este pedido para o Zaakpay. Comprimento máximo: `180` caracteres.

whatsappMessage.interactive.body

Parâmetro	Tipo	Obrigatório	Descrição
`text`	string	Não	O conteúdo do corpo da mensagem. Emojis e markdown são suportados. Comprimento máximo: 1024 caracteres. Comprimento máximo: `1024`.

whatsappMessage.interactive.header

Parâmetro	Tipo	Obrigatório	Descrição
`type`	string	Não	Obrigatório. O tipo de cabeçalho que você deseja usar. `text`: usado para mensagens de lista, botões de resposta e mensagens multiproduto. `video`: usado para botões de resposta. `image`: usado para botões de resposta. `document`: usado para botões de resposta.
`text`	string	Não	Texto para o cabeçalho. A formatação permite emojis, mas não markdown. Comprimento máximo: `60`.
`image`	object	Não	Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.
`video`	object	Não	Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.
`document`	object	Não	Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também Tipos de mídia suportados.

whatsappMessage.interactive.header.image

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use somente com mídias do tipo `document`.

whatsappMessage.interactive.header.video

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use somente com mídias do tipo `document`.

whatsappMessage.interactive.header.document

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Não	Use isto quando a mídia for enviada para os servidores do WhatsApp. Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (https://docs.ycloud.com/reference/whatsapp_media-upload#/). Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência.
`link`	string	Não	Use isto ao enviar mídia diretamente do seu servidor. O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS. Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL. Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado.
`caption`	string	Não	Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`.
`filename`	string	Não	Descreve o nome do arquivo para o documento específico. Use apenas com mídia de `document`.

whatsappMessage.interactive.footer

Parâmetro	Tipo	Obrigatório	Descrição
`text`	string	Não	O conteúdo do rodapé. Emojis e markdown são suportados. Links são suportados. Tamanho máximo: 60 caracteres. Comprimento máximo: `60`.

whatsappMessage.contacts[]

Parâmetro	Tipo	Obrigatório	Descrição
`addresses`	object[]	Não	Os itens do array são descritos abaixo.
`birthday`	string	Não	String formatada de `YYYY-MM-DD`.
`emails`	object[]	Não	Os itens do array são descritos abaixo.
`name`	object	Sim	Nome completo do contato formatado como um objeto name.
`org`	object	Não	Informações sobre a organização do contato formatadas como um objeto org.
`phones`	object[]	Não	Número(s) de telefone do contato formatado(s) como um objeto phone.
`urls`	object[]	Não	URL(s) do contato formatada(s) como um objeto urls.
`vcard`	string	Não	vCard opcional fornecido com o payload do contato compartilhado.
`origin`	string	Não	Definido como `contact_request` quando o usuário compartilhou o contato em resposta a uma mensagem de solicitação de dados de contato.

whatsappMessage.contacts[].addresses[]

Parâmetro	Tipo	Obrigatório	Descrição
`street`	string	Não	Nome e número da rua.
`city`	string	Não	Nome da cidade.
`state`	string	Não	Sigla ou abreviação do estado.
`zip`	string	Não	CEP/Código postal.
`country`	string	Não	Nome completo do país.
`country_code`	string	Não	Sigla de duas letras do país.
`type`	string	Não	Os valores padrão são `HOME` e `WORK`.

whatsappMessage.contacts[].emails[]

Parâmetro	Tipo	Obrigatório	Descrição
`email`	string	Não	Endereço de e-mail.
`type`	string	Não	Os valores padrão são `HOME` e `WORK`.

whatsappMessage.contacts[].name

Parâmetro	Tipo	Obrigatório	Descrição
`formatted_name`	string	Sim	Nome completo, como aparece normalmente.
`first_name`	string	Não	Primeiro nome.
`last_name`	string	Não	Sobrenome.
`middle_name`	string	Não	Nome do meio.
`suffix`	string	Não	Sufixo do nome.
`prefix`	string	Não	Prefixo do nome.

whatsappMessage.contacts[].org

Parâmetro	Tipo	Obrigatório	Descrição
`company`	string	Não	Nome da empresa do contato.
`department`	string	Não	Nome do departamento do contato.
`title`	string	Não	Cargo profissional do contato.

whatsappMessage.contacts[].phones[]

Parâmetro	Tipo	Obrigatório	Descrição
`phone`	string	Não	Preenchido automaticamente com o valor de `wa_id` como um número de telefone formatado.
`type`	string	Não	Os valores padrão são `CELL`, `MAIN`, `IPHONE`, `HOME` e `WORK`.
`wa_id`	string	Não	ID do WhatsApp.

whatsappMessage.contacts[].urls[]

Parâmetro	Tipo	Obrigatório	Descrição
`url`	string	Não	URL.
`type`	string	Não	Os valores padrão são `HOME` e `WORK`.

whatsappMessage.reaction

Parâmetro	Tipo	Obrigatório	Descrição
`message_id`	string	Sim	Especifica o `wamid` da mensagem recebida que continha a reação.
`emoji`	string	Não	Obrigatório ao enviar uma mensagem de `reaction`. Defina-o como `""` se quiser remover o emoji. Opcional ao receber uma mensagem de um usuário. Este campo é incluído quando um usuário reage a mensagens com um emoji. Caso contrário, indica que um usuário removeu o emoji.

whatsappMessage.context

Parâmetro	Tipo	Obrigatório	Descrição
`message_id`	string	Não	Especifica o `wamid` da mensagem à qual você está respondendo. `wamid` é o ID da mensagem original na plataforma do WhatsApp.

whatsappMessage.whatsappApiError

Parâmetro	Tipo	Obrigatório	Descrição
`message`	string	Sim	Uma descrição do erro legível por humanos.
`code`	string	Sim	Um código de erro.
`type`	string	Não	Tipo de erro.
`error_subcode`	string	Não	Código adicional sobre o erro.
`error_user_msg`	string	Não	A mensagem a ser exibida para o usuário. O idioma da mensagem é baseado no locale da solicitação da API.
`error_user_title`	string	Não	O título da caixa de diálogo, se exibida. O idioma da mensagem é baseado no locale da solicitação da API.
`fbtrace_id`	string	Não	Identificador interno de suporte. Ao relatar um bug relacionado a uma chamada da Graph API, inclua o fbtrace_id para nos ajudar a encontrar dados de log para depuração.
`error_data`	string or object	Não	Dados adicionais sobre o erro. Uma string ou map. Para APIs de modelo, este campo é uma string que descreve o motivo do erro. Para APIs de mensagem, este campo é um map com a propriedade `details` descrevendo o motivo do erro.

Exemplo

O seguinte JSON é o corpo entregue ao seu receptor. IDs, números de telefone e outros valores de conta são ilustrativos.

Mensagem de texto do WhatsApp Business App

Este evento sincroniza uma mensagem enviada a partir do aplicativo WhatsApp Business ou de um dispositivo complementar compatível. Leia seu conteúdo em whatsappMessage.

{
  "id": "evt_example_smb_echoes",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2026-10-09T08:00:00.000Z",
  "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",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.ENT.11815799212886844830",
    "customerProfile": {
      "username": "example_customer"
    }
  }
}

Mensagem de imagem de saída

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "image",
    "image": {
      "link": "https://example.com/sample",
      "id": "592623615738103"
    }
  }
}

Mensagem de vídeo de saída

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "video",
    "video": {
      "link": "https://example.com/sample",
      "id": "592623615738103"
    }
  }
}

Mensagem de áudio de saída

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "audio",
    "audio": {
      "link": "https://example.com/sample",
      "id": "592623615738103"
    }
  }
}

Mensagem de documento de saída

{
  "id": "evt_eEVCy8eNqD9EvcFI",
  "type": "whatsapp.smb.message.echoes",
  "apiVersion": "v2",
  "createTime": "2023-02-22T12:00:00.000Z",
  "whatsappMessage": {
    "id": "63f5d602367ea403f8175a6c",
    "wamid": "wamid.BgNODYxN...",
    "status": "sent",
    "from": "BUSINESS-PHONE-NUMBER",
    "to": "CUSTOMER-PHONE-NUMBER",
    "toUserId": "US.13491208655302741918",
    "toParentUserId": "US.1181579921288684483",
    "customerProfile": {
      "username": "@joee"
    },
    "wabaId": "WABA-ID",
    "createTime": "2022-03-01T12:00:00.000Z",
    "sendTime": "2022-03-01T12:00:01.000Z",
    "bizType": "whatsapp",
    "type": "document",
    "document": {
      "link": "https://example.com/sample",
      "id": "592623615738103",
      "caption": "图片"
    }
  }
}

Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta 2xx. Processe tarefas lentas de forma assíncrona.

HTTP/1.1 200 OK

Para orientações detalhadas de cenários, consulte exemplos anotados.

Primeiros passos

Guias

Endpoints

Webhook reference

whatsapp.smb.message.echoes

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappMessage

Exemplo

​Gatilhos

​Sintaxe

​Parâmetros

​Envelope do evento

​Payload do evento

​whatsappMessage

​Exemplo

Gatilhos

Sintaxe

Parâmetros

Envelope do evento

Payload do evento

whatsappMessage

Exemplo