> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# whatsapp.message.updated

> Ocorre quando o status de uma mensagem de saída do WhatsApp é atualizado e o status muda para `sent`, `failed`, `delivered` ou `read`.

Use `whatsapp.message.updated` para processar este evento em seu endpoint de webhook.

## Gatilhos

Ocorre quando o status de uma mensagem de saída do WhatsApp é atualizado e o status muda para `sent`, `failed`, `delivered` ou `read`.

Assine `whatsapp.message.updated` ao [configurar seu endpoint de webhook](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

Use `whatsappMessage` para atualizações de mensagens individuais. Atualizações de status de mensagens em grupo podem incluir `whatsappGroup`. Roteie o payload antes de ler os campos específicos da mensagem.

## Sintaxe

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

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "<ID>",
  "type": "whatsapp.message.updated",
  "apiVersion": "<API_VERSION>",
  "createTime": "<CREATE_TIME>",
  "whatsappMessage": {
    "id": "<ID>",
    "wabaId": "<WABA_ID>",
    "from": "<FROM>",
    "to": "<TO>",
    "type": "<TYPE>",
    "status": "<STATUS>",
    "pricingCategory": "<PRICING_CATEGORY>",
    "bidPricingFlag": "<BID_PRICING_FLAG_VALUE>",
    "totalPrice": "<TOTAL_PRICE_VALUE>",
    "currency": "<CURRENCY>"
  }
}
```

## Parâmetros

Valide o cabeçalho HTTP `YCloud-Signature` antes de processar o corpo JSON. Consulte [validação de assinatura](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

### 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.message.updated`. |
| `apiVersion` | string | Sim | A versão da API utilizada para renderizar este evento. |
| `createTime` | string (date-time) | Sim | O momento em que este evento foi criado, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). 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`. |
| `whatsappGroup` | object | Não | Payload específico do evento `whatsappGroup`. |

Os quatro campos comuns do envelope 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 correspondente está 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](https://en.wikipedia.org/wiki/E.164). |
| `to` | string | Não | O número de telefone do destinatário no formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `recipient` | string | Não | O valor do destinatário enviado na solicitação quando um BSUID ou BSUID pai foi utilizado. |
| `recipientUserId` | string | Não | O ID de usuário com escopo de negócios do WhatsApp (BSUID) do destinatário. |
| `toUserId` | string | Não | Alias de `recipientUserId` mantido para fins de compatibilidade. |
| `parentRecipientUserId` | string | Não | O ID de usuário pai com escopo de negócios do WhatsApp do destinatário. |
| `toParentUserId` | string | Não | Alias de `parentRecipientUserId` mantido para fins de 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 [Conversation-Based Pricing](https://developers.facebook.com/docs/whatsapp/pricing). |
| `type` | string | Não | Tipo de mensagem de saída do WhatsApp. Veja também [mensagens do WhatsApp](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages).Valores: `template`, `text`, `image`, `audio`, `video`, `document`, `sticker`, `location`, `interactive`, `contacts`, `reaction`. |
| `template` | object | Não | Use para enviar uma mensagem `template` do WhatsApp. |
| `text` | object | Não | Objeto de mensagem de texto do WhatsApp. |
| `image` | object | Não | Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia suportados](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `video` | object | Não | Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia suportados](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `audio` | object | Não | Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia suportados](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `document` | object | Não | Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia suportados](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `sticker` | object | Não | Use para mensagens `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia suportados](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `location` | object | Não | Use para mensagens `location`. |
| `interactive` | object | Não | Use para mensagens `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 à qual 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 Direct Send, como `utility` ou `authentication`, quando aplicável. |
| `ttlSeconds` | integer | Não | O tempo de vida configurado da mensagem Direct Send em segundos, quando aplicável. |
| `status` | string | Não | Status da mensagem do WhatsApp. Um de `accepted`, `failed`, `sent`, `delivered`, `read`.<ul><li>`accepted`: a solicitação de envio de mensagem foi aceita pelo nosso sistema.</li><li>`failed`: uma mensagem enviada pela sua empresa falhou ao ser enviada.</li><li>`sent`: uma mensagem enviada pela sua empresa está em trânsito nos sistemas do WhatsApp.</li><li>`delivered`: uma mensagem enviada pela sua empresa foi entregue ao dispositivo do usuário.</li><li>`read`: uma mensagem enviada pela sua empresa foi lida pelo usuário.</li></ul> |
| `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 | O momento em que esta mensagem foi criada, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por exemplo, `2022-06-01T12:00:00.000Z`. |
| `updateTime` | string (date-time) | Não | O momento em que esta mensagem foi atualizada, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por exemplo, `2022-06-01T12:00:00.000Z`. |
| `sendTime` | string (date-time) | Não | O momento em que o `status` desta mensagem mudou para `sent`, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por exemplo, `2022-06-01T12:00:00.000Z`. |
| `deliverTime` | string (date-time) | Não | O momento em que o `status` desta mensagem mudou para `delivered`, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por exemplo, `2022-06-01T12:00:00.000Z`. |
| `readTime` | string (date-time) | Não | O momento em que o `status` desta mensagem mudou para `read`, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Por exemplo, `2022-06-01T12:00:00.000Z`. |
| `totalPrice` | number (double) | Não | Preço total desta mensagem. **Nota: É apenas um preço estimado quando o `status` for `accepted` ou `sent`. Torna-se o preço final após a entrega da mensagem, ou seja, quando o `status` for `delivered` ou `read`.**Para mensagens com 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](https://en.wikipedia.org/wiki/ISO_4217). |
| `regionCode` | string | Não | O [código de região](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) do número de telefone do destinatário. |
| `pricingCategory` | string | Não | A categoria de preço da mensagem. **Nota: É apenas uma categoria de preço estimada quando o `status` for `accepted` ou `sent`. Torna-se definitiva após a entrega da mensagem, ou seja, quando o `status` for `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ço da mensagem.<ul><li>`PMP`: Aplica-se o preço por mensagem (Per-message pricing).</li><li>`CBP`: Aplica-se o preço baseado em conversas (Conversation-based pricing).</li></ul> |
| `pricingType` | string | Não | O tipo de preço da mensagem. Este campo só está disponível no modo PMP (Preço por Mensagem).<ul><li>`regular`: Indica que a mensagem é cobrável.</li><li>`free_customer_service`: Indica que a mensagem é gratuita por se tratar de uma mensagem de modelo de utilidade ou mensagem sem modelo enviada dentro de uma janela de atendimento ao cliente.</li><li>`free_entry_point`: Indica que a mensagem é gratuita por fazer parte de uma conversa de ponto de entrada gratuito.</li></ul> |
| `whatsappApiError` | object | Não | O objeto de erro original retornado pelo WhatsApp. Consulte [Como lidar com erros](https://developers.facebook.com/docs/graph-api/guides/error-handling), [Códigos de erro da Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes). |
| `bizType` | string | Não | Pode estar vazio ou ser um dos seguintes: `whatsapp` ou `verify`. O padrão é `whatsapp`.<ul><li>`whatsapp`: indica que a mensagem é enviada por meio do produto **WhatsApp**.</li><li>`verify`: indica que a mensagem é enviada por meio do produto **Verify**.</li></ul> |
| `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. Sua pricingCategory é marketing\_lite\_bidding. |

> [accordion] 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. |

> [accordion] 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 comercial desta 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.<ul><li>`FREE_ENTRY`: conversas originadas de um [ponto de entrada gratuito](https://developers.facebook.com/docs/whatsapp/pricing#free-entry-point-conversations).</li><li>`FREE_TIER`: conversas dentro do [limite gratuito](https://developers.facebook.com/docs/whatsapp/pricing#free-tier-conversations) mensal.</li><li>`REGULAR`: quaisquer conversas que não tenham se originado de um [ponto de entrada gratuito](https://developers.facebook.com/docs/whatsapp/pricing#free-entry-point-conversations) ou que estejam acima do [limite gratuito](https://developers.facebook.com/docs/whatsapp/pricing#free-tier-conversations) mensal concedido.</li></ul> |
> | `originType` | string | Não | Indica a [categoria da conversa](https://developers.facebook.com/docs/whatsapp/pricing#conversation-categories). Isso também pode ser chamado de ponto de entrada da conversa.<ul><li>`referral_conversion`: indica uma [conversa de ponto de entrada gratuito](https://developers.facebook.com/docs/whatsapp/pricing#free-entry-point-conversations).</li><li>`authentication`: indica que a conversa foi aberta por uma empresa ao enviar 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.</li><li>`marketing`: indica que a conversa foi aberta por uma empresa ao enviar 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.</li><li>`utility`: indica que a conversa foi aberta por uma empresa ao enviar 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.</li><li>`service`: indica que a conversa foi aberta por uma empresa ao responder a um cliente dentro de uma [janela de atendimento ao cliente](https://developers.facebook.com/docs/whatsapp/pricing#customer-service-windows).</li></ul> |
> | `expireTime` | string (date-time) | Não | Data em que a conversa expira, formatada em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Ex.: `2022-06-01T12:00:00.000Z`. |

> [accordion] 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 no qual 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. |

> [accordion] 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 com suporte](https://developers.facebook.com/documentation/business-messaging/whatsapp/templates/supported-languages) 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 na localidade solicitados. |

> [accordion] 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.<ul><li>`quick_reply`: Refere-se a um botão de resposta rápida criado anteriormente que permite ao cliente retornar uma mensagem predefinida.</li><li>`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.</li><li>`copy_code`: Refere-se a um botão de copiar código criado anteriormente que permite ao cliente copiar uma cadeia de texto (definida quando o modelo é enviado em uma mensagem de modelo) para a área de transferência do dispositivo ao ser tocado pelo usuário do aplicativo.</li><li>`catalog`: Refere-se a um botão de catálogo criado anteriormente que permite ao cliente visualizar o seu catálogo de produtos.</li><li>`mpm`: Refere-se a um botão de MPM (mensagem de múltiplos produtos) criado anteriormente que permite ao cliente navegar por produtos e seções.</li><li>`flow`: Refere-se a um botão de fluxo criado anteriormente que permite ao cliente interagir com um [flow](https://developers.facebook.com/docs/whatsapp/flows).</li><li>`order_details`: Refere-se a um botão de detalhes do pedido criado anteriormente que permite ao cliente visualizar os detalhes de um pedido.</li></ul> |
> | `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 são indexados a partir de zero, portanto, definir o valor como 0 fará com que o botão apareça primeiro, 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 quando houver variáveis no componente de modelo correspondente, 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 contendo os parâmetros da mensagem. |

> [accordion] whatsappMessage.template.components\[].parameters\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `type` | string | Não | **Obrigatório.** Tipo de parâmetro de componente.<ul><li>`text`: Usado quando o tipo de componente do modelo é `BODY`, ou o formato do componente `HEADER` é `TEXT`.</li><li>`image`: Usado quando o componente `HEADER` do modelo é `IMAGE`.</li><li>`gif`: Usado quando o componente `HEADER` do modelo é `GIF`.</li><li>`video`: Usado quando o componente `HEADER` do modelo é `VIDEO`.</li><li>`document`: Usado quando o componente `HEADER` do modelo é `DOCUMENT`.</li><li>`payload`: Usado quando o tipo de botão do componente do modelo é `QUICK_REPLY`.</li><li>`coupon_code`: Usado quando o tipo de botão do componente do modelo é `COPY_CODE`.</li><li>`limited_time_offer`: Usado quando o tipo de componente do modelo é `LIMITED_TIME_OFFER`.</li><li>`action`: Usado quando o tipo de botão do componente do modelo é `CATALOG`, `MPM`, `FLOW`, ou `ORDER_DETAILS`.</li><li>`order_status`: Usado quando a subcategoria do modelo é `ORDER_STATUS`.</li><li>`location`: Usado quando o componente `HEADER` do modelo é `LOCATION`.</li></ul> |
> | `text` | string | Não | **Obrigatório quando `type` = `text`.** O texto da mensagem. Para o componente de cabeçalho (header), o limite de caracteres é 60 caracteres. Para o componente de corpo (body), o limite de caracteres é 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 de dados (payload) 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 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 de `HEADER` do modelo for `DOCUMENT`.** |
> | `limited_time_offer` | object | Não | Obrigatório se o modelo usar detalhes de expiração de 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`.** |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 `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`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 `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`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 `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`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 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`. |

> [accordion] whatsappMessage.template.components\[].parameters\[].limited\_time\_offer
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `expiration_time_ms` | integer (int64) | Não | **Obrigatório.** Horário de expiração do código da oferta como um carimbo de data/hora UNIX em milissegundos. |

> [accordion] 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 de SKU do item. Rotulado como ID de conteúdo no Commerce Manager. 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 de `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 de `FLOW`. Objeto JSON com a carga de dados para a primeira tela. |
> | `order_details` | object | Não | Obrigatório para botões de `order_details`. |

> [accordion] 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 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. |

> [accordion] 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](https://business.facebook.com/commerce). |

> [accordion] whatsappMessage.template.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 o pedido `status`, `items`, `subtotal`, `tax`, 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, pode conter apenas 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 order\_details de uma determinada empresa. Caso seja necessário enviar várias mensagens order\_details para o mesmo pedido, recomenda-se incluir um número de sequência 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 para o pedido. |

> [accordion] 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 `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 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 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 caracteres é de 120 caracteres.Comprimento máximo: `120`. |

> [accordion] 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 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. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 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: é 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 especificada do tipo `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`. |

> [accordion] 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 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`. |

> [accordion] 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 | 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 com incentivo, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 | 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 com incentivo, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 | 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 com incentivo, o comerciante precisará definir essa informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 | 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 com incentivo, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 for com incentivo, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] whatsappMessage.template.components\[].parameters\[].action.order\_details.order.expiration
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `timestamp` | string | Sim | Uma string contendo o 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`. |

> [accordion] 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 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 for com incentivo, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 as informações da conta de pagamento. |

> [accordion] whatsappMessage.template.components\[].parameters\[].action.order\_details.payment\_settings\[].payment\_gateway
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `type` | string | Sim | Tipo de pagamento. É obrigatório definir como `billdesk`, `razorpay`, `payu` ou `zaakpay` caso você 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 devendo 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 determinado pedido. 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 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 determinado pedido. Cada campo extra tem um limite máximo de 180 caracteres. |

> [accordion] 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 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. |

> [accordion] 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 PayU.Comprimento máximo: `255` caracteres. |
> | `udf2` | string | Não | Informações definidas pelo usuário sobre este pedido para PayU.Comprimento máximo: `255` caracteres. |
> | `udf3` | string | Não | Informações definidas pelo usuário sobre este pedido para PayU.Comprimento máximo: `255` caracteres. |
> | `udf4` | string | Não | Informações definidas pelo usuário sobre este pedido para PayU.Comprimento máximo: `255` caracteres. |

> [accordion] 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 tamanho máximo de 40 caracteres com tamanho mínimo maior que 0 caracteres. |
> | `notes` | object | Não | O objeto pode conter pares de chave-valor com no máximo 15 chaves, e cada valor é limitado a 256 caracteres. |

> [accordion] 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. |

> [accordion] 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 `order_status`. |

> [accordion] 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`, o `status` pode ser: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` ou `canceled`. |
> | `type` | string | Não | O único valor compatível é `quick_pay`. Quando este campo é transmitido, 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 de impostos 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`. |

> [accordion] whatsappMessage.template.components\[].parameters\[].order\_status.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 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. |

> [accordion] whatsappMessage.template.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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 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 Cloud API do WhatsApp 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 `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 apenas com mídia `document`. |

> [accordion] 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 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 com incentivo, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 incentivados. Se o pedido for incentivado, o comerciante deve definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 incentivados. Se o pedido for incentivado, o comerciante deve definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 incentivados. Se o pedido for incentivado, o comerciante deve definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 tiver incentivo, o comerciante precisa definir essas informações. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 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 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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`. |

> [accordion] 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. |

> [accordion] whatsappMessage.template.components\[].cards\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `card_index` | integer (int32) | Não | **Obrigatório.** Ordem indexada em 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. |

> [accordion] 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.<ul><li>`quick_reply`: Refere-se a um botão de resposta rápida criado anteriormente que permite ao cliente retornar uma mensagem predefinida.</li><li>`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.</li></ul> |
> | `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, outro botão com índice 1 aparecerá em seguida e assim por diante.Mínimo: `0`. Máximo: `9`. |
> | `parameters` | object\[] | Não | **Obrigatório quando `type` = `button`, ou se houver variáveis no componente de modelo correspondente, ou se o formato do componente de card `HEADER` for mídia (`IMAGE`, `VIDEO`).** Matriz de objetos de parâmetro com o conteúdo da mensagem. |

> [accordion] 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.<ul><li>`text`: Usado quando o tipo de componente do modelo for `BODY` ou quando o formato do componente `HEADER` for `TEXT`.</li><li>`image`: Usado quando o componente `HEADER` do modelo for `IMAGE`.</li><li>`gif`: Usado quando o componente `HEADER` do modelo for `GIF`.</li><li>`video`: Usado quando o componente `HEADER` do modelo for `VIDEO`.</li><li>`document`: Usado quando o componente `HEADER` do modelo for `DOCUMENT`.</li><li>`payload`: Usado quando o tipo de botão do componente do modelo for `QUICK_REPLY`.</li><li>`coupon_code`: Usado quando o tipo de botão do componente do modelo for `COPY_CODE`.</li><li>`limited_time_offer`: Usado quando o tipo de componente do modelo for `LIMITED_TIME_OFFER`.</li><li>`action`: Usado quando o tipo de botão do componente do modelo for `CATALOG`, `MPM`, `FLOW` ou `ORDER_DETAILS`.</li><li>`order_status`: Usado quando a subcategoria do modelo for `ORDER_STATUS`.</li><li>`location`: Usado quando o componente `HEADER` do modelo for `LOCATION`.</li></ul> |
> | `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 anexado à URL de prefixo predefinida 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 `HEADER` do modelo for `IMAGE`.** |
> | `gif` | object | Não | **Obrigatório quando o formato `HEADER` do modelo for `GIF`.** |
> | `video` | object | Não | **Obrigatório quando o formato `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 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`.** |

> [accordion] 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.\*\*Informe 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 apenas com URLs HTTP/HTTPS.Observação: a Cloud API do WhatsApp 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 mídia `document`. |

> [accordion] 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.\*\*Informe 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 apenas com URLs HTTP/HTTPS.Observação: a Cloud API do WhatsApp 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 mídia `document`. |

> [accordion] 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 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](https://docs.ycloud.com/reference/whatsapp_media-upload#/\)\).Observação): é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, o `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, o `id` terá precedência e o `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 apenas com mídia de `document`. |

> [accordion] 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 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](https://docs.ycloud.com/reference/whatsapp_media-upload#/\)\).Observação): é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, o `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, o `id` terá precedência e o `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 apenas com mídia de `document`. |

> [accordion] 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 timestamp UNIX em milissegundos. |

> [accordion] 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 SKU do item. Identificado 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 produto 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 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`. |

> [accordion] 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. Markdown não é suportado.Comprimento máximo: `24`. |
> | `product_items` | object\[] | Não | Array 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. |

> [accordion] 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 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](https://business.facebook.com/commerce). |

> [accordion] 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 do 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 order\_details de uma determinada empresa. Se houver a necessidade de enviar várias mensagens order\_details para o mesmo pedido, recomenda-se incluir um número de sequência 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. |

> [accordion] 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 é 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 que está 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 de impostos para este pedido. |
> | `shipping` | object | Não | O custo de envio do pedido. |
> | `discount` | object | Não | O valor do desconto para este 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 cancelamentos. O limite máximo de caracteres é 120 caracteres.Comprimento máximo: `120`. |

> [accordion] whatsappMessage.template.components\[].cards\[].components\[].parameters\[].action.order\_details.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 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 do 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. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 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 em cache recursos de mídia 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 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`. |

> [accordion] 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 | Inteiro positivo que representa o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem 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 precisa definir essas informações. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 | Inteiro positivo que representa o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem 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 precisa definir essas informações. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 | Inteiro positivo que representa o valor do montante multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem 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 precisa definir essas informações. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 precisará definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] whatsappMessage.template.components\[].cards\[].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 é de 300 segundos. |
> | `description` | string | Não | Explicação em texto para a expiração.Comprimento máximo: `120`. |

> [accordion] 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 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 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 precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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. |

> [accordion] 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 isso 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. |

> [accordion] 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 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. |

> [accordion] 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. |

> [accordion] 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 chave-valor com no máximo 15 chaves e cada valor limitado a 256 caracteres. |

> [accordion] 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. |

> [accordion] 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`. |

> [accordion] 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 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 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`. |

> [accordion] whatsappMessage.template.components\[].cards\[].components\[].parameters\[].order\_status.order.items\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `retailer_id` | string | Não | ID do 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. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Nota](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 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.Nota: 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 (query strings) aleatórias à URL.Nota: `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 somente com mídia `document`. |

> [accordion] 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 que representa o valor da quantia 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 caracteres é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use somente para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 que representa o valor da quantia 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 caracteres é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use somente para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 que representa o valor da quantia 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 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`. |

> [accordion] 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 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`. |

> [accordion] 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 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`. |

> [accordion] 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 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`. |

> [accordion] whatsappMessage.template.components\[].cards\[].components\[].parameters\[].order\_status.order.expiration
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `timestamp` | string | Sim | Uma string de carimbo de data/hora UTC em segundos de 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`. |

> [accordion] 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. |

> [accordion] whatsappMessage.text
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `body` | string | Sim | Obrigatório para mensagens de texto. O texto da mensagem de texto 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 adicionar uma caixa de pré-visualização 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. É necessário incluir um hostname, pois endereços IP não serão reconhecidos. Comprimento máximo: 4096 caracteres.Comprimento 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é-visualização com mais informações sobre o link. Defina este campo como true se quiser incluir uma caixa de pré-visualização 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é-visualizações de URL só são renderizadas após uma das seguintes condições ser atendida:<ul><li>A empresa enviou um modelo de mensagem para o usuário.</li><li>O usuário inicia uma conversa por meio de um link "conversa em um clique".</li><li>O usuário adiciona o número de telefone da empresa aos seus contatos e inicia uma conversa. Padrão: `false`.</li></ul> |

> [accordion] 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.\*\*Informe o ID do objeto de mídia obtido na API de upload de mídia do WhatsApp (\[[https://docs.ycloud.com/reference/whatsapp\_media-upload#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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ídias diretamente do seu servidor.\*\*O protocolo e a URL da mídia a ser enviada. Use somente com URLs HTTP/HTTPS.Observação: a Cloud API do WhatsApp 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 apenas com mídia `document`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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ídias 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 `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 apenas com mídia `document`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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ídias 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 `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 apenas com mídia `document`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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ídias 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 `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 a mídia `document`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 `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 a mídia `document`. |

> [accordion] 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. |

> [accordion] whatsappMessage.interactive
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `type` | string | Não | **Obrigatório.** O tipo de mensagem interativa que você deseja enviar.<ul><li>`button`: use para Botões de resposta.</li><li>`list`: use para Mensagens de lista.</li><li>`cta_url`: use para Mensagens de botão de URL Call-To-Action (CTA).</li><li>`product`: use para Mensagens de produto único.</li><li>`product_list`: use para Mensagens de vários produtos.</li><li>`catalog_message`: use para Mensagens de catálogo.</li><li>`location_request_message`: use para Mensagens de solicitação de localização.</li><li>`order_details`: use para Mensagens de detalhes do pedido.</li><li>`order_status`: use para Mensagens de status do pedido.</li><li>`voice_call`: use para Mensagens de chamada de voz.</li><li>`flow`: use para Mensagens de fluxo.</li></ul> |
> | `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. |

> [accordion] 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 múltiplos produtos. Identificador exclusivo do catálogo do Facebook vinculado à sua conta do WhatsApp Business. Este ID pode ser obtido por meio do [Gerenciador de Comércio da Meta](https://business.facebook.com/commerce). |
> | `product_retailer_id` | string | Não | Obrigatório para Mensagens de produto único e Mensagens de múltiplos produtos. Identificador exclusivo do produto em um catálogo. |
> | `sections` | object\[] | Não | Obrigatório para Mensagens de lista e Mensagens de múltiplos 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).<ul><li>`cta_url`: Use para botões de URL de Call-To-Action (CTA).</li><li>`catalog_message`: Use para Mensagens de catálogo.</li><li>`send_location`: Use para botões de Solicitação de localização.</li><li>`flow`: Use para botões de Flow.</li><li>`review_and_pay`: Use para botões de Detalhes do pedido.</li><li>`review_order`: Use para botões de Status do pedido.</li><li>`voice_call`: Use para botões de Chamada de voz.</li></ul> |
> | `parameters` | object | Não | Parâmetros da ação. Obrigatório para botões de Call-To-Action (CTA). |

> [accordion] 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. |

> [accordion] 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 para o seu botão. Este ID é retornado no webhook quando o botão é clicado pelo usuário. Comprimento máximo: 256 caracteres. Não é permitido incluir espaços no início ou no fim ao definir o ID.Comprimento máximo: `256`. |

> [accordion] 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 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 é opcional. |
> | `product_items` | object\[] | Não | Obrigatório para mensagens de vários produtos. 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. |

> [accordion] 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`. |

> [accordion] whatsappMessage.interactive.action.sections\[].product\_items\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `product_retailer_id` | string | Não | Obrigatório para mensagens de vários produtos. Identificador exclusivo do produto em um catálogo. |

> [accordion] whatsappMessage.interactive.action.parameters
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `display_text` | string | Não | Texto do botão de URL de CTA. Comprimento máximo: 20 bytes.Comprimento máximo: `20`. |
> | `url` | string | Não | URL do botão de URL de CTA. |
> | `thumbnail_product_retailer_id` | string | Não | Número de SKU do item. Rotulado como **Content ID** no [Commerce Manager](https://business.facebook.com/commerce). A miniatura deste item será usada como a imagem de 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 corresponder ao novo nome. |
> | `flow_cta` | string | Não | Obrigatório para botões `flow`. Texto no botão de 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 do 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 necessidade de enviar várias mensagens de order\_details para o mesmo pedido, é recomendável incluir um número de sequência 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 mercadorias sendo pagas 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 para este pedido. Atualmente, o único valor suportado é `INR`. |
> | `total_amount` | object | Não | Obrigatório para botões `review_and_pay`. O valor total para este 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. |

> [accordion] 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. |

> [accordion] 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`. |

> [accordion] 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 | Número 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 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 60 caracteres.Comprimento máximo: `60`. |

> [accordion] whatsappMessage.interactive.action.parameters.order
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `status` | string | Não | O único valor compatível 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 compatível é `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 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 | 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`. |

> [accordion] whatsappMessage.interactive.action.parameters.order.items\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `retailer_id` | string | Não | ID de 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 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. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Nota](https://docs.ycloud.com/reference/whatsapp_media-upload#/\)\).Nota): Deve ser fornecido `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.Nota: A Cloud API do WhatsApp armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL.Nota: Deve ser fornecido `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. |
> | `caption` | string | Não | Descreve a mídia especificada do tipo `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`. |

> [accordion] 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 | Número 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 for incentivado, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 | Número 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 for incentivado, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 | Número 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 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 com incentivo, o comerciante precisa definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 é 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 com incentivo, o comerciante precisa definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 é 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 com incentivo, o comerciante precisa definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 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 é 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 com incentivo, o comerciante precisa definir essas informações. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |

> [accordion] whatsappMessage.interactive.action.parameters.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 é de 300 segundos. |
> | `description` | string | Não | Explicação em texto para a expiração.Comprimento máximo: `120`. |

> [accordion] 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. |

> [accordion] whatsappMessage.interactive.action.parameters.payment\_settings\[].payment\_gateway
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `type` | string | Sim | Tipo de pagamento. Deve definir isso como `billdesk`, `razorpay`, `payu` ou `zaakpay`, caso tenha vinculado o 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 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 tem um limite máximo de 180 caracteres. |

> [accordion] 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. |

> [accordion] 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. |

> [accordion] whatsappMessage.interactive.action.parameters.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. Comprimento máximo suportado de 40 caracteres com comprimento mínimo maior que 0 caracteres. |
> | `notes` | object | Não | O objeto pode ser composto por pares chave-valor com no máximo 15 chaves e cada valor limitado a 256 caracteres. |

> [accordion] 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. |

> [accordion] 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`. |

> [accordion] whatsappMessage.interactive.header
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `type` | string | Não | **Obrigatório.** O tipo de cabeçalho que você gostaria de usar.<ul><li>`text`: Usado para List Messages, Reply Buttons e Multi-Product Messages.</li><li>`video`: Usado para Reply Buttons.</li><li>`image`: Usado para Reply Buttons.</li><li>`document`: Usado para Reply Buttons.</li></ul> |
> | `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 de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
> | `video` | object | Não | Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
> | `document` | object | Não | Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 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: é 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 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`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 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: é 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 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`. |

> [accordion] 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#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Observação](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 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: é 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 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`. |

> [accordion] whatsappMessage.interactive.footer
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `text` | string | Não | O conteúdo do rodapé. Suporta emojis e markdown. Suporta links. Comprimento máximo: 60 caracteres.Comprimento máximo: `60`. |

> [accordion] 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 em `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 da 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 (request-contact-info). |

> [accordion] 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 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`. |

> [accordion] 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`. |

> [accordion] 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. |

> [accordion] 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 comercial do contato. |

> [accordion] 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. |

> [accordion] 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`. |

> [accordion] 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 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 o usuário removeu o emoji. |

> [accordion] whatsappMessage.context
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `message_id` | string | Não | Especifica o `wamid` da mensagem que você está respondendo. `wamid` é o ID da mensagem original na plataforma do WhatsApp. |

> [accordion] whatsappMessage.whatsappApiError
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `message` | string | Sim | Uma descrição legível por humanos do erro. |
> | `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 ao usuário. O idioma da mensagem baseia-se na localidade da requisição da API. |
> | `error_user_title` | string | Não | O título da caixa de diálogo, se exibida. O idioma da mensagem baseia-se na localidade da requisição da API. |
> | `fbtrace_id` | string | Não | Identificador de suporte interno. 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 mapa.<ul><li>Para APIs de modelo, este campo é uma string que descreve o motivo do erro.</li><li>Para APIs de mensagem, este campo é um mapa com a propriedade `details` descrevendo o motivo do erro.</li></ul> |

#### whatsappGroup

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `wabaId` | string | Não | ID da conta do WhatsApp Business. |
| `displayPhoneNumber` | string | Não | O número de telefone de exibição dos metadados do webhook do WhatsApp. |
| `phoneNumberId` | string | Não | ID do número de telefone do WhatsApp. |
| `field` | string | Não | Campo do webhook do WhatsApp que gerou o evento de grupo.Valores: `group_lifecycle_update`, `group_participants_update`, `group_settings_update`, `group_status_update`, `messages`. |
| `type` | string | Não | Tipo de evento específico de grupo do WhatsApp.Valores: `group_create`, `group_delete`, `group_participants_add`, `group_participants_remove`, `group_join_request_created`, `group_join_request_revoked`, `group_settings_update`, `group_suspend`, `group_suspend_cleared`, `message_status`. |
| `requestId` | string | Não | O ID da solicitação retornado por uma operação assíncrona da API de grupos. |
| `status` | string | Não | Status do webhook de grupo do WhatsApp.Valores: `created`, `failed`, `deleted`, `added`, `removed`, `left`, `requested`, `revoked`, `updated`, `suspended`, `suspend_cleared`, `sent`, `delivered`, `read`, `expired`. |
| `groupId` | string | Não | ID do grupo do WhatsApp. |
| `messageId` | string | Não | ID da mensagem de grupo da YCloud. Presente apenas quando o evento de status está vinculado a uma mensagem de grupo de saída salva. |
| `inviteLink` | string | Não | O link de convite do grupo. |
| `reason` | string | Não | O motivo de um evento de participante, solicitação de entrada ou remoção. |
| `initiatedBy` | string | Não | Indica quem iniciou um evento de remoção de participante.Valores: `business`, `participant`. |
| `joinRequestId` | string | Não | O ID da solicitação de entrada. |
| `waId` | string | Não | ID de usuário do WhatsApp para um evento de participante único. |
| `recipientUserId` | string | Não | ID de usuário com escopo de empresa (business-scoped) para um evento de participante único. |
| `parentRecipientUserId` | string | Não | ID de usuário pai com escopo de empresa (parent business-scoped) para um evento de participante único. |
| `customerProfile` | object | Não | Informações do perfil do cliente no WhatsApp. |
| `subject` | string | Não | O assunto do grupo. |
| `description` | string | Não | A descrição do grupo. |
| `joinApprovalMode` | string | Não | Modo de aprovação de entrada no grupo do WhatsApp.<ul><li>`approval_required`: novos membros devem ser aprovados antes de entrar.</li><li>`auto_approve`: novos membros podem entrar sem aprovação.</li></ul> |
| `addedParticipants` | object\[] | Não | Participantes adicionados ao grupo. |
| `removedParticipants` | object\[] | Não | Participantes removidos do grupo. |
| `failedParticipants` | object\[] | Não | Participantes que não puderam ser adicionados ou removidos. |
| `settings` | object\[] | Não | Detalhes da atualização das configurações do grupo. |
| `errors` | object\[] | Não | Erros retornados pelo WhatsApp. |
| `contacts` | object\[] | Não | Contatos incluídos em webhooks de status de mensagens de grupo. |
| `statuses` | object\[] | Não | Detalhes do status da mensagem de grupo. |
| `webhookTime` | string (date-time) | Não | O momento em que o WhatsApp disparou este webhook. |
| `dedupeKey` | string | Não | Chave de idempotência para desduplicação de eventos de webhook de grupo. |

> [accordion] whatsappGroup.customerProfile
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | Nome do perfil do WhatsApp. |
> | `username` | string | Não | Nome de usuário do WhatsApp. |

> [accordion] whatsappGroup.addedParticipants\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `input` | string | Não | A entrada original do participante. |
> | `waId` | string | Não | ID de usuário do WhatsApp. |
> | `recipientUserId` | string | Não | ID de usuário no escopo da empresa. |
> | `parentRecipientUserId` | string | Não | ID de usuário no escopo da empresa principal. |
> | `customerProfile` | object | Não | Informações do perfil do cliente no WhatsApp. |
> | `errors` | object\[] | Não | Erros retornados pelo WhatsApp para este participante. |

> [accordion] whatsappGroup.addedParticipants\[].customerProfile
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | Nome do perfil do WhatsApp. |
> | `username` | string | Não | Nome de usuário do WhatsApp. |

> [accordion] whatsappGroup.removedParticipants\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `input` | string | Não | A entrada original do participante. |
> | `waId` | string | Não | ID de usuário do WhatsApp. |
> | `recipientUserId` | string | Não | ID de usuário no escopo da empresa. |
> | `parentRecipientUserId` | string | Não | ID de usuário no escopo da empresa principal. |
> | `customerProfile` | object | Não | Informações do perfil do cliente no WhatsApp. |
> | `errors` | object\[] | Não | Erros retornados pelo WhatsApp para este participante. |

> [accordion] whatsappGroup.removedParticipants\[].customerProfile
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | Nome do perfil do WhatsApp. |
> | `username` | string | Não | Nome de usuário do WhatsApp. |

> [accordion] whatsappGroup.failedParticipants\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `input` | string | Não | A entrada original do participante. |
> | `waId` | string | Não | ID de usuário do WhatsApp. |
> | `recipientUserId` | string | Não | ID de usuário no escopo da empresa. |
> | `parentRecipientUserId` | string | Não | ID de usuário no escopo da empresa principal. |
> | `customerProfile` | object | Não | Informações do perfil do cliente no WhatsApp. |
> | `errors` | object\[] | Não | Erros retornados pelo WhatsApp para este participante. |

> [accordion] whatsappGroup.failedParticipants\[].customerProfile
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | Nome do perfil do WhatsApp. |
> | `username` | string | Não | Nome de usuário do WhatsApp. |

> [accordion] whatsappGroup.settings\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | Nome da configuração.Valores: `profile_picture`, `group_subject`, `group_description`. |
> | `text` | string | Não | Valor de texto para atualizações de assunto ou descrição. |
> | `updateSuccessful` | boolean | Não | Indica se a atualização da configuração foi bem-sucedida. |
> | `mimeType` | string | Não | Tipo MIME para atualizações de foto de perfil. |
> | `sha256` | string | Não | Hash SHA-256 para atualizações de foto de perfil. |
> | `errors` | object\[] | Não | Erros retornados pelo WhatsApp para esta configuração. |

> [accordion] whatsappGroup.contacts\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `customerProfile` | object | Não | Informações do perfil do cliente no WhatsApp. |
> | `waId` | string | Não | ID de usuário do WhatsApp. |
> | `recipientUserId` | string | Não | ID de usuário com escopo de negócios (business-scoped user ID). |
> | `parentRecipientUserId` | string | Não | ID de usuário pai com escopo de negócios (parent business-scoped user ID). |

> [accordion] whatsappGroup.contacts\[].customerProfile
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | Nome do perfil do WhatsApp. |
> | `username` | string | Não | Nome de usuário do WhatsApp. |

> [accordion] whatsappGroup.statuses\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID da mensagem do WhatsApp. |
> | `status` | string | Não | Status da mensagem.Valores: `sent`, `delivered`, `read`, `failed`, `expired`. |
> | `timestamp` | integer (int64) | Não | Carimbo de data/hora Unix indicando quando o status da mensagem foi atualizado. |
> | `recipientId` | string | Não | ID do grupo destinatário. |
> | `recipientType` | string | Não | Tipo de destinatário.Valores: `group`. |
> | `recipientParticipantId` | string | Não | ID de usuário do WhatsApp do participante destinatário. |
> | `recipientUserId` | string | Não | ID de usuário com escopo de negócios do participante destinatário. |
> | `parentRecipientUserId` | string | Não | ID de usuário pai com escopo de negócios do participante destinatário. |
> | `conversation` | object | Não | Objeto de conversa do WhatsApp incluído nos webhooks de status de mensagem de grupo. |
> | `pricing` | object | Não | Informações de preço incluídas nos webhooks de status de mensagem de grupo. |
> | `errors` | object\[] | Não | Erros retornados pelo WhatsApp. |

> [accordion] whatsappGroup.statuses\[].conversation
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID da conversa. |
> | `expirationTimestamp` | integer (int64) | Não | Carimbo de data/hora Unix indicando quando a conversa expira. |
> | `origin` | object | Não | Os campos do objeto estão listados abaixo. |

> [accordion] whatsappGroup.statuses\[].conversation.origin
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `type` | string | Não | Tipo de origem da conversa. |

> [accordion] whatsappGroup.statuses\[].pricing
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `billable` | boolean | Não | Se a mensagem é faturável. |
> | `pricingModel` | string | Não | Modelo de preços. |
> | `type` | string | Não | Tipo de cobrança. |
> | `category` | string | Não | Categoria bruta de preço do grupo relatada pela Meta. A YCloud não expõe o mapeamento interno do MM Lite neste campo de webhook.Valores: `group_marketing`, `group_utility`, `group_service`. |

## Exemplo

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

> [accordion] Cobrança final para uma mensagem Max Price entregue
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_example_max_price_delivery",
>   "type": "whatsapp.message.updated",
>   "apiVersion": "v2",
>   "createTime": "2026-11-03T08:00:00.000Z",
>   "whatsappMessage": {
>     "id": "message_example_max_price",
>     "wabaId": "<WABA_ID>",
>     "from": "+12025550124",
>     "to": "+12025550123",
>     "type": "template",
>     "status": "delivered",
>     "pricingCategory": "marketing_lite_bidding",
>     "bidPricingFlag": true,
>     "totalPrice": 0.045,
>     "currency": "USD"
>   }
> }
> ```

> [accordion] Elegibilidade para taxa internacional de autenticação
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_djeIQXaQPQyUcRFi",
>   "type": "whatsapp.message.updated",
>   "apiVersion": "v2",
>   "createTime": "2024-07-01T00:00:00.000Z",
>   "whatsappMessage": {
>     "id": "63f5d602367ea403f8175a6c",
>     "wamid": "wamid.BgNODYxN...",
>     "wabaId": "whatsapp-business-account-id",
>     "from": "+12025550124",
>     "to": "+12025550123",
>     "status": "sent",
>     "type": "template",
>     "template": {
>       "name": "login_otp",
>       "language": {
>         "code": "862031",
>         "policy": "deterministic"
>       }
>     },
>     "conversation": {
>       "id": "8078ed05301c40a08d3d1845c94ca18b",
>       "originType": "authentication",
>       "expireTime": "2024-07-01T00:00:00.000Z"
>     },
>     "pricingCategory": "authentication_international",
>     "totalPrice": 0.085,
>     "currency": "USD",
>     "sendTime": "2024-07-01T00:00:00.000Z"
>   }
> }
> ```

> [accordion] Mensagem enviada
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_eEVCy8eNqD9EvcFI",
>   "type": "whatsapp.message.updated",
>   "apiVersion": "v2",
>   "createTime": "2023-02-22T12:00:00.000Z",
>   "whatsappMessage": {
>     "id": "63f5d602367ea403f8175a6c",
>     "wamid": "wamid.BgNODYxN...",
>     "recipientUserId": "US.13491208655302741918",
>     "parentRecipientUserId": "US.ENT.11815799212886844830",
>     "customerProfile": {
>       "name": "Pablo M."
>     },
>     "status": "sent",
>     "pricingCategory": "marketing",
>     "totalPrice": 0.0,
>     "currency": "USD",
>     "createTime": "2022-03-01T12:00:00.000Z",
>     "sendTime": "2022-03-01T12:00:01.000Z",
>     "bizType": "whatsapp",
>     "type": "text",
>     "text": {
>       "body": "Hi there! How can we help?"
>     },
>     "externalId": "EXTERNAL-ID",
>     "wabaId": "WABA_ID",
>     "from": "+12025550123"
>   }
> }
> ```

> [accordion] Mensagem entregue
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_eEVCy8eNqD9EvcFI",
>   "type": "whatsapp.message.updated",
>   "apiVersion": "v2",
>   "createTime": "2023-02-22T12:00:00.000Z",
>   "whatsappMessage": {
>     "id": "63f5d602367ea403f8175a6c",
>     "wamid": "wamid.BgNODYxN...",
>     "recipientUserId": "US.13491208655302741918",
>     "parentRecipientUserId": "US.ENT.11815799212886844830",
>     "customerProfile": {
>       "name": "Pablo M.",
>       "username": "@pablomorales"
>     },
>     "status": "delivered",
>     "pricingModel": "PMP",
>     "pricingType": "regular",
>     "pricingCategory": "marketing",
>     "totalPrice": 0.0,
>     "currency": "USD",
>     "createTime": "2022-03-01T12:00:00.000Z",
>     "sendTime": "2022-03-01T12:00:01.000Z",
>     "deliverTime": "2022-03-01T12:00:02.000Z",
>     "bizType": "whatsapp",
>     "type": "text",
>     "text": {
>       "body": "Hi there! How can we help?"
>     },
>     "externalId": "EXTERNAL-ID",
>     "wabaId": "WABA_ID",
>     "from": "+12025550123"
>   }
> }
> ```

> [accordion] Mensagem lida
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_eEVCy8eNqD9EvcFI",
>   "type": "whatsapp.message.updated",
>   "apiVersion": "v2",
>   "createTime": "2023-02-22T12:00:00.000Z",
>   "whatsappMessage": {
>     "id": "63f5d602367ea403f8175a6c",
>     "wamid": "wamid.BgNODYxN...",
>     "recipientUserId": "US.13491208655302741918",
>     "parentRecipientUserId": "US.ENT.11815799212886844830",
>     "customerProfile": {
>       "name": "Pablo M.",
>       "username": "@pablomorales"
>     },
>     "status": "read",
>     "pricingModel": "PMP",
>     "pricingType": "regular",
>     "pricingCategory": "marketing",
>     "totalPrice": 0.0,
>     "currency": "USD",
>     "createTime": "2022-03-01T12:00:00.000Z",
>     "sendTime": "2022-03-01T12:00:01.000Z",
>     "deliverTime": "2022-03-01T12:00:02.000Z",
>     "readTime": "2022-03-01T12:00:02.000Z",
>     "bizType": "whatsapp",
>     "type": "text",
>     "text": {
>       "body": "Hi there! How can we help?"
>     },
>     "externalId": "EXTERNAL-ID",
>     "wabaId": "WABA_ID",
>     "from": "+12025550123"
>   }
> }
> ```

> [accordion] Falha na mensagem
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_eEVCy8eNqD9EvcFI",
>   "type": "whatsapp.message.updated",
>   "apiVersion": "v2",
>   "createTime": "2023-02-22T12:00:00.000Z",
>   "whatsappMessage": {
>     "id": "63f5d602367ea403f8175a6c",
>     "wamid": "wamid.BgNODYxN...",
>     "recipientUserId": "US.13491208655302741918",
>     "parentRecipientUserId": "US.ENT.11815799212886844830",
>     "status": "failed",
>     "errorCode": "100",
>     "errorMessage": "Parameter Invalid",
>     "whatsappApiError": {
>       "message": "(#100) Invalid parameter",
>       "type": "OAuthException",
>       "code": "100",
>       "fbtrace_id": "AwmiSOCojlAkqvjCTjGt37r",
>       "error_data": {
>         "messaging_product": "whatsapp",
>         "details": "Parameter Invalid"
>       }
>     },
>     "pricingCategory": "marketing",
>     "totalPrice": 0.0,
>     "currency": "USD",
>     "bizType": "whatsapp",
>     "type": "text",
>     "text": {
>       "body": "Hi there! How can we help?"
>     },
>     "externalId": "EXTERNAL-ID",
>     "wabaId": "WABA_ID",
>     "from": "+12025550123"
>   }
> }
> ```

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

```http theme={"theme":{"light":"github-light","dark":"github-dark"}}
HTTP/1.1 200 OK
```

Para orientações detalhadas de cenários, consulte [exemplos anotados](https://docs.ycloud.com/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-account-updated-webhook-examples), [exemplos anotados](https://docs.ycloud.com/pt/api-reference/guides/examples/webhook-examples/whatsapp-message-updated-webhook-examples).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.