> ## 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.smb.history

> Ocorre quando o histórico de mensagens do WhatsApp Business App é sincronizado.

Use `whatsapp.smb.history` para manipular este evento no seu endpoint de webhook.

## Gatilhos

Ocorre quando o histórico de mensagens do WhatsApp Business App é sincronizado.

Inscreva-se em `whatsapp.smb.history` ao [configurar seu endpoint de webhook](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md).

Um evento de histórico pode conter `whatsappInboundMessage` para uma mensagem recebida, `whatsappMessage` para uma mensagem enviada ou apenas metadados de chunk. `phase` e `progress` são incluídos quando o evento é proveniente de um chunk de histórico da Meta. Não exija um objeto de mensagem em todos os eventos de histórico.

## Sintaxe

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

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

## 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. Comprimento mínimo: `6`. Comprimento máximo: `128`. |
| `type` | string | Sim | Sempre `whatsapp.smb.history`. |
| `apiVersion` | string | Sim | A versão da API usada para renderizar este evento. |
| `createTime` | string (date-time) | Sim | O momento em que este evento foi criado, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Ex.: `2022-06-01T12:00:00.000Z`. |

### Payload do evento

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `phase` | integer (int32) | Não | Incluído quando `type` é `whatsapp.smb.history` e o evento foi gerado a partir de um chunk de histórico da Meta. Identifica a fase de sincronização do chunk. |
| `progress` | integer (int32) | Não | Incluído quando `type` é `whatsapp.smb.history` e o evento foi gerado a partir de um chunk de histórico da Meta. Informa o progresso de sincronização do chunk. |
| `whatsappInboundMessage` | object | Não | Payload de `whatsappInboundMessage` específico do evento. |
| `whatsappMessage` | object | Não | Payload de `whatsappMessage` específico do evento. |

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

#### whatsappInboundMessage

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `id` | string | Sim | ID exclusivo do objeto. |
| `wamid` | string | Não | O ID da mensagem original na plataforma do WhatsApp. |
| `wabaId` | string | Não | ID da conta do WhatsApp Business. |
| `from` | string | Não | O número de telefone do cliente que enviou a mensagem para a empresa, no formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `fromUserId` | string | Não | O ID de usuário com escopo de negócio do WhatsApp (BSUID) do cliente. |
| `fromParentUserId` | string | Não | O ID de usuário principal com escopo de negócio do WhatsApp do cliente. |
| `customerProfile` | object | Não | As informações de perfil do cliente. |
| `to` | string | Não | O número de telefone do destinatário no formato [E.164](https://en.wikipedia.org/wiki/E.164). |
| `sendTime` | string (date-time) | Não | O momento em que esta mensagem foi enviada, formatado em [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339). Ex.: `2022-06-01T12:00:00.000Z`. |
| `type` | string | Não | Tipo de mensagem recebida do WhatsApp. Consulte também o [objeto de mensagens de webhook do WhatsApp](https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object).Valores: `text`, `image`, `video`, `audio`, `document`, `sticker`, `contacts`, `location`, `interactive`, `button`, `reaction`, `request_welcome`, `order`, `system`, `unsupported`. |
| `text` | object | Não | Quando a notificação descreve uma mensagem de texto, o objeto text fornece o corpo da mensagem de texto. |
| `image` | object | Não | Quando uma mensagem com mídia (`image` \| `document` \| `audio` \| `video` \| `sticker`) é recebida, o cliente da API do WhatsApp Business baixa a mídia. Assim que a mídia é baixada, uma notificação é enviada para o seu Webhook. Esta mensagem contém informações que identificam o objeto de mídia e permitem que você encontre e baixe o objeto. |
| `video` | object | Não | Quando uma mensagem com mídia (`image` \| `document` \| `audio` \| `video` \| `sticker`) é recebida, o cliente da API do WhatsApp Business baixa a mídia. Assim que a mídia é baixada, uma notificação é enviada para o seu Webhook. Esta mensagem contém informações que identificam o objeto de mídia e permitem que você encontre e baixe o objeto. |
| `audio` | object | Não | Quando uma mensagem com mídia (`image` \| `document` \| `audio` \| `video` \| `sticker`) é recebida, o cliente da API do WhatsApp Business baixa a mídia. Assim que a mídia é baixada, uma notificação é enviada para o seu Webhook. Esta mensagem contém informações que identificam o objeto de mídia e permitem que você encontre e baixe o objeto. |
| `document` | object | Não | Quando uma mensagem com mídia (`image` \| `document` \| `audio` \| `video` \| `sticker`) é recebida, o cliente da API do WhatsApp Business baixa a mídia. Assim que a mídia é baixada, uma notificação é enviada para o seu Webhook. Esta mensagem contém informações que identificam o objeto de mídia e permitem que você encontre e baixe o objeto. |
| `sticker` | object | Não | Quando uma mensagem com mídia (`image` \| `document` \| `audio` \| `video` \| `sticker`) é recebida, o cliente da API do WhatsApp Business baixa a mídia. Assim que a mídia é baixada, uma notificação é enviada para o seu Webhook. Esta mensagem contém informações que identificam o objeto de mídia e permitem que você encontre e baixe o objeto. |
| `interactive` | object | Não | Quando um cliente interage com a sua mensagem, este objeto é incluído no objeto message. |
| `location` | object | Não | Quando você recebe uma notificação da localização estática de um usuário, o objeto location fornece os detalhes da localização. |
| `button` | object | Não | Quando o campo de tipo de mensagem está definido como `button`, este objeto é incluído no objeto message. |
| `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. |
| `order` | object | Não | Quando um cliente faz um pedido, o tipo de mensagem é definido como `order` e este campo é incluído. |
| `system` | object | Não | Quando o tipo de mensagem está definido como `system`, este campo é incluído. Este objeto descreve uma alteração no número de telefone do usuário, uma alteração no BSUID ou uma possível alteração de identidade no WhatsApp. |
| `errors` | object\[] | Não | Os itens do array são descritos abaixo. |
| `context` | object | Não | Contexto da mensagem. |
| `referral` | object | Não | Quando um usuário envia uma mensagem para empresas usando botões de chamada para ação em [Anúncios de Clique para o WhatsApp](https://www.facebook.com/business/help/447934475640650) ou botões de chamada para ação de uma [Página do Facebook](https://www.facebook.com/help/977869848936797), este campo é incluído como um anexo. |
| `groupId` | string | Não | ID do grupo do WhatsApp. Este campo é incluído quando a mensagem recebida é enviada em um grupo do WhatsApp. |

> [accordion] whatsappInboundMessage.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] whatsappInboundMessage.text
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `body` | string | Não | Texto da mensagem. |

> [accordion] whatsappInboundMessage.image
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID da mídia. Pode ser usado para excluir a mídia se armazenada localmente no cliente. |
> | `link` | string | Não | A URL para baixar o arquivo de mídia. Observe que este link pode ser acessado diretamente por alguns minutos para a conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar este arquivo dentro de um mês. |
> | `caption` | string | Não | A legenda fornecida para a mídia. Presente apenas se especificada. |
> | `filename` | string | Não | Nome do arquivo no dispositivo do remetente. Isso estará presente apenas em mensagens de mídia `document`. |
> | `metadata` | object | Não | Metadados referentes à mídia `sticker`. |
> | `mime_type` | string | Não | Tipo MIME da mídia. |
> | `sha256` | string | Não | Checksum. |

> [accordion] whatsappInboundMessage.video
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID da mídia. Pode ser usado para excluir a mídia se armazenada localmente no cliente. |
> | `link` | string | Não | A URL para baixar o arquivo de mídia. Observe que este link pode ser acessado diretamente por alguns minutos para a conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar este arquivo dentro de um mês. |
> | `caption` | string | Não | A legenda fornecida para a mídia. Presente apenas se especificada. |
> | `filename` | string | Não | Nome do arquivo no dispositivo do remetente. Isso estará presente apenas em mensagens de mídia `document`. |
> | `metadata` | object | Não | Metadados referentes à mídia `sticker`. |
> | `mime_type` | string | Não | Tipo MIME da mídia. |
> | `sha256` | string | Não | Checksum. |

> [accordion] whatsappInboundMessage.audio
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID da mídia. Pode ser usado para excluir a mídia se armazenada localmente no cliente. |
> | `link` | string | Não | A URL para baixar o arquivo de mídia. Observe que este link pode ser acessado diretamente por alguns minutos para a conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar este arquivo dentro de um mês. |
> | `caption` | string | Não | A legenda fornecida para a mídia. Presente apenas se especificada. |
> | `filename` | string | Não | Nome do arquivo no dispositivo do remetente. Isso estará presente apenas em mensagens de mídia `document`. |
> | `metadata` | object | Não | Metadados referentes à mídia `sticker`. |
> | `mime_type` | string | Não | Tipo MIME da mídia. |
> | `sha256` | string | Não | Checksum. |

> [accordion] whatsappInboundMessage.document
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID da mídia. Pode ser usado para excluir a mídia caso esteja armazenada localmente no cliente. |
> | `link` | string | Não | A URL para baixar o arquivo de mídia. Observe que este link pode ser acessado diretamente em alguns minutos para a conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar esse arquivo dentro de um mês. |
> | `caption` | string | Não | A legenda fornecida para a mídia. Presente apenas se especificada. |
> | `filename` | string | Não | Nome do arquivo no dispositivo do remetente. Estará presente apenas em mensagens de mídia do tipo `document`. |
> | `metadata` | object | Não | Metadados pertencentes à mídia `sticker`. |
> | `mime_type` | string | Não | Tipo MIME da mídia. |
> | `sha256` | string | Não | Checksum. |

> [accordion] whatsappInboundMessage.sticker
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID da mídia. Pode ser usado para excluir a mídia caso esteja armazenada localmente no cliente. |
> | `link` | string | Não | A URL para baixar o arquivo de mídia. Observe que este link pode ser acessado diretamente em alguns minutos para a conveniência do consumidor, mas você deve sempre incluir um cabeçalho `X-API-Key` para baixar esse arquivo dentro de um mês. |
> | `caption` | string | Não | A legenda fornecida para a mídia. Presente apenas se especificada. |
> | `filename` | string | Não | Nome do arquivo no dispositivo do remetente. Estará presente apenas em mensagens de mídia do tipo `document`. |
> | `metadata` | object | Não | Metadados pertencentes à mídia `sticker`. |
> | `mime_type` | string | Não | Tipo MIME da mídia. |
> | `sha256` | string | Não | Checksum. |

> [accordion] whatsappInboundMessage.interactive
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `type` | string | Não | O tipo de mensagem interativa recebida.<ul><li>`button_reply`: Enviado quando um cliente clica em um botão.</li><li>`list_reply`: Enviado quando um cliente seleciona um item de uma lista.</li><li>`nfm_reply`: Enviado quando um cliente responde a um WhatsApp Flow (Next Feature Messaging).</li><li>`call_permission_reply`: Enviado quando um cliente responde a uma solicitação de permissão de chamada.</li></ul> |
> | `button_reply` | object | Não | Enviado quando um cliente clica em um botão. Retornado quando `type` for `button_reply`. |
> | `list_reply` | object | Não | Enviado quando um cliente seleciona um item de uma lista. Retornado quando `type` for `list_reply`. |
> | `nfm_reply` | object | Não | Enviado quando um cliente responde a um WhatsApp Flow (Next Feature Messaging). Retornado quando `type` for `nfm_reply`. |
> | `call_permission_reply` | object | Não | Enviado quando um cliente responde a uma solicitação de permissão de chamada. Retornado quando `type` for `call_permission_reply`. Isso ocorre quando o WhatsApp solicita aos usuários que concedam permissões de retorno de chamada após ligarem para a sua empresa. |

> [accordion] whatsappInboundMessage.interactive.button\_reply
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID exclusivo do botão clicado. |
> | `title` | string | Não | Título de um botão. |

> [accordion] whatsappInboundMessage.interactive.list\_reply
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID exclusivo do item de lista selecionado. |
> | `title` | string | Não | Título do item de lista selecionado. |
> | `description` | string | Não | Descrição da linha selecionada. |

> [accordion] whatsappInboundMessage.interactive.nfm\_reply
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `name` | string | Não | O nome do flow ou formulário que está sendo respondido. |
> | `response_json` | string | Não | String JSON contendo as respostas do usuário ao flow. Contém os valores dos campos do formulário e o token do flow. |
> | `body` | string | Não | O conteúdo do corpo da mensagem de resposta do flow. |

> [accordion] whatsappInboundMessage.interactive.call\_permission\_reply
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `response` | string | Não | A resposta do cliente à solicitação de permissão de chamada.<ul><li>`accept`: o usuário concedeu permissão para a empresa retornar a chamada</li><li>`reject`: o usuário rejeitou a permissão para a empresa retornar a chamada</li></ul> |
> | `expiration_timestamp` | integer (int64) | Não | O timestamp (em segundos) de quando a permissão de chamada expira. Presente apenas quando a resposta é "accept" e is\_permanent é false. |
> | `is_permanent` | boolean | Não | Indica se a permissão é permanente ou temporária.<ul><li>`true`: autorização permanente (sem expiração)</li><li>`false`: autorização temporária (expira no expiration\_timestamp)</li></ul> |

> [accordion] whatsappInboundMessage.location
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `latitude` | number (double) | Não | Latitude da localização enviada. |
> | `longitude` | number (double) | Não | Longitude da localização enviada. |
> | `address` | string | Não | Endereço da localização. |
> | `name` | string | Não | Nome da localização. |
> | `url` | string | Não | URL do site de onde o usuário baixou as informações da localização. |

> [accordion] whatsappInboundMessage.button
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `payload` | string | Não | O payload de um botão configurado pela empresa no qual o cliente clicou como parte de uma mensagem interativa. |
> | `text` | string | Não | Texto do botão. |

> [accordion] whatsappInboundMessage.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 como `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 a carga útil 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 informações de contato. |

> [accordion] whatsappInboundMessage.contacts\[].addresses\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `street` | string | Não | Número e nome da rua. |
> | `city` | string | Não | Nome da cidade. |
> | `state` | string | Não | Sigla do estado. |
> | `zip` | string | Não | CEP. |
> | `country` | string | Não | Nome completo do país. |
> | `country_code` | string | Não | Sigla do país em duas letras. |
> | `type` | string | Não | Os valores padrão são `HOME` e `WORK`. |

> [accordion] whatsappInboundMessage.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] whatsappInboundMessage.contacts\[].name
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `formatted_name` | string | Sim | Nome completo, como normalmente é exibido. |
> | `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] whatsappInboundMessage.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 do contato. |

> [accordion] whatsappInboundMessage.contacts\[].phones\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `phone` | string | Não | Preenchido automaticamente com o valor `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 | WhatsApp ID. |

> [accordion] whatsappInboundMessage.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] whatsappInboundMessage.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** quando você envia uma mensagem `reaction`. Defina-o como `""` se quiser remover o emoji. **Opcional** quando você recebeu uma mensagem de um usuário. Este campo é incluído quando um usuário reage a mensagens com um emoji. Caso contrário, indica que um usuário removeu o emoji. |

> [accordion] whatsappInboundMessage.order
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `catalog_id` | string | Não | O ID do catálogo. |
> | `product_items` | object\[] | Não | Os itens do array são descritos abaixo. |
> | `text` | string | Não | Mensagem de texto enviada junto com o pedido. |

> [accordion] whatsappInboundMessage.order.product\_items\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `product_retailer_id` | string | Não | O identificador de SKU do produto. |
> | `quantity` | integer (int32) | Não | Número de itens. |
> | `item_price` | number (double) | Não | Preço unitário do item. |
> | `currency` | string | Não | Moeda do preço. [Código de moeda ISO 4217](https://en.wikipedia.org/wiki/ISO_4217). |

> [accordion] whatsappInboundMessage.system
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `body` | string | Não | Descreve o evento de mensagem do sistema. Os casos de uso suportados são:<ul><li>Atualização de número de telefone: para quando um usuário muda de um número antigo para um novo.</li><li>Atualização de identidade: para quando a identidade de um usuário for alterada.</li></ul> |
> | `wa_id` | string | Não | Número de telefone fornecido pela Meta, sem o `+` inicial. Pode permanecer inalterado ou ser omitido para uma alteração de BSUID. |
> | `user_id` | string | Não | Novo ID de usuário no escopo do negócio (BSUID) fornecido pela Meta para uma alteração de número de telefone ou BSUID. Este campo preserva o nome original em snake\_case. |
> | `parent_user_id` | string | Não | Novo BSUID pai para uma alteração de número de telefone ou BSUID, somente quando ativado e fornecido pela Meta. Este campo preserva o nome original em snake\_case. |
> | `previous_user_id` | string | Não | ID de usuário anterior com escopo de negócios fornecido pela Meta. |
> | `previous_parent_user_id` | string | Não | BSUID pai anterior, apenas quando habilitado e fornecido pela Meta. |
> | `type` | string | Não | Os tipos compatíveis são:<ul><li>`user_changed_user_id`: notificação de que um usuário alterou seu BSUID. O número de telefone pode permanecer inalterado.</li><li>`user_changed_number`: para uma notificação de número alterado do usuário.</li><li>`user_identity_changed`: para notificação de identidade do usuário alterada.</li></ul> |
> | `user` | string | Não | \*\*Adicionado a Webhooks para atualizações de identidade.\*\*O novo ID de usuário do WhatsApp do cliente. |
> | `new_wa_id` | string | Não | \*\*Adicionado aos Webhooks para atualizações de número de telefone.\*\*Novo ID do WhatsApp do cliente. |

> [accordion] whatsappInboundMessage.errors\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `code` | string | Não | O código de erro. |
> | `title` | string | Não | O título do erro. |
> | `message` | string | Não | A mensagem de erro. |
> | `error_data` | object | Não | Um objeto de dados de erro com as seguintes propriedades:<ul><li>`details`: Uma string descrevendo o motivo do erro. Exemplo: `Message type is currently not supported.`.</li></ul> |

> [accordion] whatsappInboundMessage.context
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `forwarded` | boolean | Não | \*\*Adicionado aos Webhooks se a mensagem foi encaminhada.\*\*Definido como `true` se a mensagem recebida tiver sido encaminhada. |
> | `frequently_forwarded` | boolean | Não | \*\*Adicionado aos Webhooks se a mensagem tiver sido frequentemente encaminhada.\*\*Definido como `true` se a mensagem recebida tiver sido encaminhada mais de cinco vezes. |
> | `from` | string | Não | \*\*Adicionado aos Webhooks se a mensagem for uma resposta de entrada a uma mensagem enviada.\*\*O ID do WhatsApp (um número de telefone sem o prefixo '+') do remetente da mensagem enviada. |
> | `id` | string | Não | \*\*Opcional.\*\*O `wamid` para a mensagem enviada de uma resposta de entrada. O `wamid` é o ID da mensagem original na plataforma do WhatsApp. |
> | `referred_product` | object | Não | \*\*Obrigatório para Mensagens de Consulta de Produto.\*\*Especifica o produto sobre o qual o usuário está solicitando informações. Consulte também [Sell Products & Services](https://developers.facebook.com/docs/whatsapp/cloud-api/guides/sell-products-and-services). |

> [accordion] whatsappInboundMessage.context.referred\_product
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `catalog_id` | string | Não | O ID do catálogo. |
> | `product_retailer_id` | string | Não | O identificador SKU do produto. |

> [accordion] whatsappInboundMessage.referral
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `source_url` | string | Não | Especifica a URL direcionada pelo anúncio ou publicação em que o usuário clicou. Abrir esta URL leva você ao anúncio visualizado pelo seu usuário. |
> | `source_type` | string | Não | Especifica o tipo de origem do anúncio. Os valores suportados são "ad" ou "post". |
> | `source_id` | string | Não | Especifica o Meta ID de um anúncio ou publicação. |
> | `headline` | string | Não | Especifica o título utilizado no anúncio ou publicação que gerou a mensagem. |
> | `body` | string | Não | A descrição, ou corpo, do anúncio ou publicação que gerou a mensagem. |
> | `media_type` | string | Não | Mídia presente no anúncio ou publicação clicada pelo usuário. Os valores suportados são "image" ou "video". |
> | `image_url` | string | Não | \*\*Adicionado se media\_type for "image".\*\*Contém uma URL para a imagem original. |
> | `video_url` | string | Não | \*\*Adicionado se media\_type for "video".\*\*Contém uma URL para o vídeo. |
> | `thumbnail_url` | string | Não | \*\*Adicionado se media\_type for "video".\*\*Contém uma URL para a imagem em miniatura do vídeo clicado. |
> | `ctwa_clid` | string | Não | ID do clique gerado pela Meta para anúncios de clique para o WhatsApp. |

#### whatsappMessage

| Parâmetro | Tipo | Obrigatório | Descrição |
| - | - | - | - |
| `id` | string | Sim | ID exclusivo da mensagem. |
| `wamid` | string | Não | O ID original da mensagem 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 usado. |
| `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`. Veja também [Preços baseados em conversas](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 de `template` do WhatsApp. |
| `text` | object | Não | Objeto de texto da mensagem do WhatsApp. |
| `image` | object | Não | Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia compatíveis](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 [Tipos de mídia compatíveis](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `audio` | object | Não | Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia compatíveis](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 [Tipos de mídia compatíveis](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `sticker` | object | Não | Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Veja também [Tipos de mídia compatíveis](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). |
| `location` | object | Não | Use para mensagens de `location`. |
| `interactive` | object | Não | Use para mensagens de `interactive`. |
| `contacts` | object\[] | Não | Os itens do array são descritos abaixo. |
| `reaction` | object | Não | Quando um usuário reage a mensagens com um emoji, o tipo de mensagem é definido como `reaction`, e este campo é incluído. |
| `context` | object | Não | Usado para mencionar uma mensagem específica que você está respondendo. A resposta pode ser de qualquer tipo de mensagem. |
| `externalId` | string | Não | Uma string exclusiva (recomendada) para fazer referência ao objeto. Pode ser um número de pedido ou similar, e pode ser usada para reconciliar o objeto com seus sistemas internos. |
| `category` | string | Não | A categoria de Direct Send, como `utility` ou `authentication`, quando aplicável. |
| `ttlSeconds` | integer | Não | O tempo de vida da mensagem configurado para o 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`: Falha no envio de uma mensagem enviada pela sua empresa.</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 no 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). Ex.: `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). Ex.: `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). Ex.: `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). Ex.: `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). Ex.: `2022-06-01T12:00:00.000Z`. |
| `totalPrice` | number (double) | Não | Preço total desta mensagem. **Observação: é apenas um preço estimado quando o `status` é `accepted` ou `sent`. Ele se torna o preço final após a entrega da mensagem, ou seja, quando o `status` 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 cobrado final. |
| `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. **Observação: é apenas uma categoria de preço estimada quando o `status` é `accepted` ou `sent`. Ela se torna definitiva após a entrega da mensagem, ou seja, quando o `status` 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ços da mensagem.<ul><li>`PMP`: Aplica-se preço por mensagem.</li><li>`CBP`: Aplica-se preço baseado em conversas.</li></ul> |
| `pricingType` | string | Não | O tipo de precificação da mensagem. Este campo está disponível apenas no modo PMP (Per-Message Pricing).<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 de uma 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 [Tratamento de 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 apenas quando `bizType` for `verify`. |
| `bidPricingFlag` | boolean | Não | Verdadeiro quando a mensagem é identificada como uma mensagem de lance do Marketing Lite. Seu 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 que a primeira mensagem seja 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 [nível 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 do [nível gratuito](https://developers.facebook.com/docs/whatsapp/pricing#free-tier-conversations) mensal.</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 iniciada por uma empresa enviando um modelo categorizado como `AUTHENTICATION` para o cliente. Isso se aplica sempre que tiverem se passado mais de 24 horas desde a última mensagem do cliente.</li><li>`marketing`: Indica que a conversa foi iniciada por uma empresa enviando um modelo categorizado como `MARKETING` para o cliente. Isso se aplica sempre que tiverem se passado mais de 24 horas desde a última mensagem do cliente.</li><li>`utility`: Indica que a conversa foi iniciada por uma empresa enviando um modelo categorizado como `UTILITY` para o cliente. Isso se aplica sempre que tiverem se passado mais de 24 horas desde a última mensagem do cliente.</li><li>`service`: Indica que a conversa foi iniciada por uma empresa respondendo 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 formatos de idioma e idioma\_localidade (por exemplo, en e en\_US). Consulte [Idiomas compatíveis](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 com suporte): `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 type é `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 à URL de prefixo predefinida no modelo.</li><li>`copy_code`: refere-se a um botão de copiar código criado anteriormente que permite ao cliente copiar uma sequência de texto (definida quando o modelo é enviado em uma mensagem de modelo) para a área de transferência do dispositivo ao ser tocado pelo usuário do app.</li><li>`catalog`: refere-se a um botão de catálogo criado anteriormente que permite ao cliente visualizar seu catálogo de produtos.</li><li>`mpm`: refere-se a um botão de MPM (mensagem de vários 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, se o modelo usar vários botões. Os botões têm índice iniciado em zero; portanto, definir o valor como 0 fará com que o botão apareça primeiro, e outro botão com índice 1 aparecerá em seguida, etc.Mínimo: `0`. Máximo: `9`. |
> | `parameters` | object\[] | Não | **Obrigatório quando `type` = `button`, ou se 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 | Usado para componentes de `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 do 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, o limite de caracteres é de 60 caracteres. Para o componente de corpo, o limite de caracteres é de 1024 caracteres. Para botões de url, indica o sufixo fornecido pelo desenvolvedor que é anexado ao prefixo de URL predefinido no modelo. |
> | `payload` | string | Não | Obrigatório para botões `quick_reply`. Carga útil definida pelo desenvolvedor que é retornada quando o botão é clicado, além do texto de exibição no botão. |
> | `coupon_code` | string | Não | **Obrigatório quando `type` = `coupon_code`.** O código 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 é `IMAGE`.** |
> | `gif` | object | Não | **Obrigatório quando o formato de `HEADER` do modelo é `GIF`.** |
> | `video` | object | Não | **Obrigatório quando o formato de `HEADER` do modelo é `VIDEO`.** |
> | `document` | object | Não | **Obrigatório quando o formato de `HEADER` do modelo é `DOCUMENT`.** |
> | `limited_time_offer` | object | Não | Obrigatório se o modelo usar detalhes de expiração da oferta. |
> | `action` | object | Não | Obrigatório se o modelo usar botões de catálogo ou MPM (mensagem multiproduto). |
> | `order_status` | object | Não | Os campos do objeto estão listados abaixo. |
> | `location` | object | Não | **Obrigatório quando `type` = `location`.** |

> [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): é 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 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 (query strings) 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 especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use somente com mídias `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): é 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 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 (query strings) 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 especificada de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use somente com mídias `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): é 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 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 (query strings) 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 `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`. |

> [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): é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência. |
> | `link` | string | Não | \*\*Use isto ao enviar mídia diretamente do seu servidor.\*\*O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS.Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta (query strings) aleatórias à URL.Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. |
> | `caption` | string | Não | Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use apenas com mídia `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.** Tempo de expiração do código da oferta como um timestamp 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 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 em seu catálogo será usada. |
> | `sections` | object\[] | Não | Use para modelos MPM. Seções do produto. Você pode definir até 10 seções. |
> | `flow_token` | string | Não | Use para botões `FLOW`. Token de fluxo gerado pela empresa para servir como identificador. O padrão é `unused`. |
> | `flow_action_data` | object | Não | Use para botões `FLOW`. Objeto JSON com a carga de dados (payload) para a primeira tela. |
> | `order_details` | object | Não | Obrigatório para botões `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. Markdown não é compatível.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 `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. 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`, 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 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 | Validade deste pedido. |
> | `description` | string | Não | **Opcional.** Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo de 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 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 para o item a ser exibido para o usuário. |
> | `amount` | object | Sim | O preço por item. |
> | `sale_amount` | object | Não | O preço com desconto por item. Deve ser menor que o valor original. Se incluído, este campo 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.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#/)).Nota](https://docs.ycloud.com/reference/whatsapp_media-upload#/\)\).Nota): `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.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 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 do tipo `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\[].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 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 esta informação. O limite máximo é 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 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 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\[].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 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 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\[].parameters\[].action.order\_details.order.tax
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `offset` | integer (int32) | Sim | Deve ser `100` para `INR`. |
> | `value` | integer (int32) | Sim | Inteiro positivo representando o valor do montante multiplicado pelo 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\[].parameters\[].action.order\_details.order.shipping
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `offset` | integer (int32) | Sim | Deve ser `100` para `INR`. |
> | `value` | integer (int32) | Sim | Inteiro positivo representando o valor do montante multiplicado pelo 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 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 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.expiration
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `timestamp` | string | Sim | Uma string contendo o carimbo de data/hora (timestamp) UTC em segundos informando 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\[].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 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.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. Deve ser definido como `billdesk`, `razorpay`, `payu` ou `zaakpay`, se você tiver 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 deve exceder 60 caracteres. Esse 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 quaisquer informações correspondentes 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 quaisquer informações correspondentes 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 quaisquer informações correspondentes a um pedido específico. 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. O comprimento máximo aceito é de 40 caracteres, com comprimento mínimo superior a 0 caracteres. |
> | `notes` | object | Não | O objeto pode ser formado por pares de chave-valor com no máximo 15 chaves, e cada valor é limitado a 256 caracteres. |

> [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 a Zaakpay.Comprimento máximo: `180` caracteres. |
> | `extra2` | string | Não | Informações definidas pelo usuário sobre este pedido para a 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 aceito 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 aceito é `quick_pay`. Quando este campo é informado, ocultamos o botão "Review and Pay" e mostramos apenas o botão "Pay Now" no balão de detalhes do pedido. |
> | `catalog_id` | string | Não | Identificador exclusivo do catálogo do Facebook usado pela empresa. Se você não fornecer este campo, deverá fornecer os seguintes campos dentro do objeto items: `country_of_origin`, `importer_name` e `importer_address`. |
> | `items` | object\[] | Não | Matriz de itens no pedido. |
> | `subtotal` | object | Não | O valor **deve ser igual** à soma de `order.amount.value` \* `order.amount.quantity`. |
> | `tax` | object | Não | As informações de 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 deste pedido. |
> | `description` | string | Não | **Opcional.** Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo de caracteres é 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 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 é 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\[].parameters\[].order\_status.order.items\[].image
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | \*\*Use isso quando a mídia for enviada para os servidores do WhatsApp.\*\*Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (\[[https://docs.ycloud.com/reference/whatsapp\_media-upload#/](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 WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL.Observação: `id` ou `link` deve ser fornecido. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. |
> | `caption` | string | Não | Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável em `header` de mensagens de `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use apenas com mídia `document`. |

> [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 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 essa 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 representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [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 representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [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 representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [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 representando o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir 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 | 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 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 do 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 textual 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 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.template.components\[].cards\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `card_index` | integer (int32) | Não | **Obrigatório.** Ordem de base zero em que o cartão aparece no 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 do 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 acessar a URL gerada anexando o parâmetro text 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 são indexados a partir de zero; portanto, definir o valor como 0 fará com que o botão apareça primeiro, e outro botão com índice 1 aparecerá em seguida, e assim por diante.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 componente de cartão `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 do componente de 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 de modelo é `QUICK_REPLY`.</li><li>`coupon_code`: Usado quando o tipo de botão do componente de 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 de 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, o limite de caracteres é de 60 caracteres. Para o componente de corpo, o limite de caracteres é de 1024 caracteres. Para botões de URL, indica o sufixo fornecido pelo desenvolvedor que é anexado à URL de prefixo predefinida no modelo. |
> | `payload` | string | Não | Obrigatório para botões `quick_reply`. Payload definido pelo desenvolvedor 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 do `HEADER` do modelo for `IMAGE`.** |
> | `gif` | object | Não | **Obrigatório quando o formato do `HEADER` do modelo for `GIF`.** |
> | `video` | object | Não | **Obrigatório quando o formato do `HEADER` do modelo for `VIDEO`.** |
> | `document` | object | Não | **Obrigatório quando o formato do modelo `HEADER` for `DOCUMENT`.** |
> | `limited_time_offer` | object | Não | Obrigatório se o modelo usar detalhes de expiração da oferta. |
> | `action` | object | Não | Obrigatório se o modelo usar botões de catálogo ou MPM (mensagem multiproduto). |
> | `order_status` | object | Não | Os campos do objeto estão listados abaixo. |
> | `location` | object | Não | **Obrigatório quando `type` = `location`.** |

> [accordion] whatsappMessage.template.components\[].cards\[].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 envio 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): É necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência. |
> | `link` | string | Não | \*\*Use isto ao enviar mídia diretamente do seu servidor.\*\*O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS.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 aleatórias à URL.Nota: É 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 de 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 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 envio 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): É necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência. |
> | `link` | string | Não | \*\*Use isto ao enviar mídia diretamente do seu servidor.\*\*O protocolo e a URL da mídia a ser enviada. Use apenas com URLs HTTP/HTTPS.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 aleatórias à URL.Nota: É 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 de 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 especificada do tipo `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\[].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 especificada do tipo `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\[].cards\[].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 de 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. Rotulado como Content ID no Gerenciador de Comércio. A miniatura deste item será usada como a imagem de cabeçalho da mensagem. Se o objeto `parameters` for omitido, a imagem do produto do primeiro item do seu catálogo será usada. |
> | `sections` | object\[] | Não | Use para modelos MPM. Seções de produtos. Você pode definir até 10 seções. |
> | `flow_token` | string | Não | Usar para botões `FLOW`. Token de Flow gerado pela empresa para servir como identificador. O padrão é `unused`. |
> | `flow_action_data` | object | Não | Usar para botões `FLOW`. Objeto JSON com a carga útil 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. Não há suporte para Markdown.Comprimento máximo: `24`. |
> | `product_items` | object\[] | Não | Matriz de números de SKU de produtos. Há um mínimo de 1 produto por seção e um máximo de 30 produtos em todas as seções. |

> [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. No momento, o único valor suportado é `INR`. |
> | `order` | object | Sim | Fornece os itens `status`, `items`, `subtotal`, `tax`, etc. do pedido. |
> | `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 mercadorias que estão sendo pagas neste pedido. As opções atualmente suportadas são `digital-goods` e `physical-goods`. |
> | `payment_settings` | object\[] | Sim | Configurações de pagamento 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 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 impostos deste pedido. |
> | `shipping` | object | Não | O custo de frete do pedido. |
> | `discount` | object | Não | O valor do desconto para este pedido. |
> | `expiration` | object | Não | Vencimento deste pedido. |
> | `description` | string | Não | **Opcional.** Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo de caracteres é de 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 | Content ID 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 será usado para calcular o valor 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\[].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 `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome de 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 | Número 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 é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [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 | Número 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 é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [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 | Número 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 é 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for com incentivo, o comerciante precisa definir esta informação. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. |

> [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 da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisa definir essa informação. 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 da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisa definir essa informação. 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 da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisa definir essa informação. 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 | Texto explicativo 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 que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹ 12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido for incentivado, o comerciante precisará definir essas informações. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |

> [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`, caso tenha vinculado seu gateway de pagamento BillDesk, Razorpay, PayU ou Zaakpay para aceitar pagamentos. |
> | `configuration_name` | string | Sim | O nome da configuração de pagamento pré-configurada a ser usada para este pedido e não deve exceder 60 caracteres. Esse valor deve coincidir com uma configuração de pagamento configurada 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 quaisquer informações correspondentes 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 quaisquer informações correspondentes 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 quaisquer informações correspondentes 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 BillDesk.Comprimento máximo: `120` caracteres. |
> | `additional_info2` | string | Não | Informações definidas pelo usuário sobre este pedido para BillDesk.Comprimento máximo: `120` caracteres. |
> | `additional_info3` | string | Não | Informações definidas pelo usuário sobre este pedido para BillDesk.Comprimento máximo: `120` caracteres. |
> | `additional_info4` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. |
> | `additional_info5` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. |
> | `additional_info6` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. |
> | `additional_info7` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. |

> [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 a PayU.Comprimento máximo: `255` caracteres. |
> | `udf2` | string | Não | Informações definidas pelo usuário sobre este pedido para a PayU.Comprimento máximo: `255` caracteres. |
> | `udf3` | string | Não | Informações definidas pelo usuário sobre este pedido para a PayU.Comprimento máximo: `255` caracteres. |
> | `udf4` | string | Não | Informações definidas pelo usuário sobre este pedido para a 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 comprovante correspondente a este pedido, definido para sua referência interna. Suporta comprimento máximo de 40 caracteres com comprimento mínimo superior a 0 caracteres. |
> | `notes` | object | Não | O objeto pode ser em 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 a Zaakpay.Comprimento máximo: `180` caracteres. |
> | `extra2` | string | Não | Informações definidas pelo usuário sobre este pedido para a 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 | Array 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 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 de um item no pedido a partir do seu catálogo. |
> | `name` | string | Sim | O nome do item a ser exibido para o usuário. Não pode exceder 60 caracteres.Comprimento máximo: `60`. |
> | `image` | object | Não | Imagem personalizada para o 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\[].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` terá precedência. |
> | `link` | string | Não | \*\*Use isto ao enviar mídia diretamente do seu servidor.\*\*O protocolo e o URL da mídia a ser enviada. Use apenas 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 aleatórias ao 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 de `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\[].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 | Número inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do montante. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto utilizado 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\[].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 | Número inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do montante. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto utilizado 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\[].order\_status.order.subtotal
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `offset` | integer (int32) | Sim | Deve ser `100` para `INR`. |
> | `value` | integer (int32) | Sim | Número inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12,34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do 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\[].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 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\[].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 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\[].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 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\[].cards\[].components\[].parameters\[].order\_status.order.expiration
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `timestamp` | string | Sim | Uma string com timestamp UTC em segundos do momento em que o pedido deve expirar. O limite mínimo é de 300 segundos. |
> | `description` | string | Não | Explicação em texto para a expiração.Comprimento máximo: `120`. |

> [accordion] whatsappMessage.template.components\[].cards\[].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.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 com http\:// ou https\:// e formatação. Veja as opções de formatação disponíveis aqui. Se você incluir URLs em seu texto e desejar incluir 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 preferidas. É necessário incluir um hostname, pois endereços IP não serão correspondidos. 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 situações ocorrer:<ul><li>A empresa enviou um modelo de mensagem ao 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.\*\*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 apenas com URLs HTTP/HTTPS.Observação: a WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL.Observação: é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. |
> | `caption` | string | Não | Descreve a mídia `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use apenas com a 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 envio 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 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 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.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 envio 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 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 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.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 envio 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 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.sticker
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | \*\*Use isso quando a mídia for enviada para os servidores do WhatsApp.\*\*Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (\[[https://docs.ycloud.com/reference/whatsapp\_media-upload#/](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 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.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 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 `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.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 Reply Buttons.</li><li>`list`: Use para List Messages.</li><li>`cta_url`: Use para Call-To-Action (CTA) URL Button Messages.</li><li>`product`: Use para Single Product Messages.</li><li>`product_list`: Use para Multi-Product Messages.</li><li>`catalog_message`: Use para Catalog Messages.</li><li>`location_request_message`: Use para Location Request Messages.</li><li>`order_details`: Use para Order Details Messages.</li><li>`order_status`: Use para Order Status Messages.</li><li>`voice_call`: Use para Voice Call Messages.</li><li>`flow`: Use para Flow Messages.</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 (Reply Buttons). Você pode ter até 3 botões. |
> | `button` | string | Não | Obrigatório para Mensagens de Lista (List Messages). Conteúdo do botão. Não pode ser uma string vazia e deve ser exclusivo na mensagem. Emojis são suportados; markdown não. Tamanho máximo: 20 caracteres.Tamanho máximo: `20`. |
> | `catalog_id` | string | Não | Obrigatório para Mensagens de Produto Único e Mensagens de Vários Produtos. Identificador exclusivo do catálogo do Facebook vinculado à sua conta do WhatsApp Business. Esse ID pode ser recuperado 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 Vários Produtos. Identificador exclusivo do produto em um catálogo. |
> | `sections` | object\[] | Não | Obrigatório para Mensagens de Lista e Mensagens de Vários Produtos. Matriz de objetos de seção. Mínimo de 1, máximo de 10. |
> | `name` | string | Não | Nome da ação. Obrigatório para botões de Call-To-Action (CTA).<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 na mensagem. Emojis são suportados; markdown não. Tamanho máximo: 20 caracteres.Tamanho máximo: `20`. |
> | `id` | string | Não | Identificador exclusivo do botão. Este ID é retornado no webhook quando o botão é clicado pelo usuário. Tamanho máximo: 256 caracteres. Não é permitido ter espaços no início ou no fim ao definir o ID.Tamanho 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. Tamanho máximo: 24 caracteres.Tamanho máximo: `24`. |
> | `rows` | object\[] | Não | Contém uma lista de linhas. Você pode ter um total de 10 linhas em todas as suas seções. Cada linha deve ter um título (tamanho máximo: 24 caracteres) e um ID (tamanho máximo: 200 caracteres). Você pode adicionar uma descrição (tamanho máximo: 72 caracteres), mas ela é opcional. |
> | `product_items` | object\[] | Não | Obrigatório para mensagens de vários produtos. Matriz de objetos 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.interactive.action.sections\[].rows\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | ID exclusivo da linha. Tamanho máximo: 200 caracteres.Tamanho máximo: `200`. |
> | `title` | string | Não | Conteúdo do título da linha. Tamanho máximo: 24 caracteres.Tamanho máximo: `24`. |
> | `description` | string | Não | Conteúdo da descrição da linha. Tamanho máximo: 72 caracteres.Tamanho 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 CTA. Tamanho máximo: 20 bytes.Tamanho máximo: `20`. |
> | `url` | string | Não | URL do botão de URL CTA. |
> | `thumbnail_product_retailer_id` | string | Não | Número de SKU do item. 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!". Tamanho máximo: 20 caracteres.Tamanho máximo: `20`. |
> | `flow_action` | string | Não | Use para botões `flow`. `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 e só pode conter 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. |
> | `type` | string | Não | Obrigatório para botões `review_and_pay`. O tipo de mercadorias sendo pagas neste pedido. As opções suportadas atualmente são `digital-goods` e `physical-goods`. |
> | `beneficiaries` | object\[] | Não | Obrigatório para botões `review_and_pay`. Uma matriz de beneficiários para este pedido. Um beneficiário é o destinatário pretendido para o envio das mercadorias físicas no pedido. As informações do beneficiário não são exibidas aos usuários, mas são necessárias por motivos legais e de conformidade. |
> | `currency` | string | Não | Obrigatório para botões `review_and_pay`. A moeda deste pedido. Atualmente, o único valor suportado é `INR`. |
> | `total_amount` | object | Não | Obrigatório para botões `review_and_pay`. O valor total deste pedido. |
> | `order` | object | Não | Obrigatório para botões `review_and_pay` ou `review_order`.Para botões `review_and_pay`, fornece `status`, `items`, `subtotal`, `tax`, etc. do pedido.Para botões `review_order`, fornece apenas `status` e `description` do pedido. |
> | `payment_settings` | object\[] | Não | Obrigatório para botões `review_and_pay`. Configurações de pagamento para o pedido. |

> [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 está recebendo os bens materiais. 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, área 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 | Código postal 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 | Inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12.34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essas informações. 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 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 é enviado, ocultamos o botão "Review and Pay" e exibimos apenas o botão "Pay Now" no balão de detalhes do pedido. |
> | `catalog_id` | string | Não | Identificador exclusivo do catálogo do Facebook 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 deste pedido. |
> | `description` | string | Não | **Opcional.** Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo é de 120 caracteres.Comprimento máximo: `120`. |

> [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 do seu catálogo no pedido. |
> | `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#/)).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 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: é 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 em `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.interactive.action.parameters.order.items\[].amount
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `offset` | integer (int32) | Sim | Deve ser `100` para `INR`. |
> | `value` | integer (int32) | Sim | Inteiro positivo que representa o valor do montante multiplicado pelo 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 incentivado, o comerciante precisará definir essas informações. 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 | 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 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 incentivado, o comerciante precisará definir essas informações. 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 | Inteiro positivo que representa o valor do montante multiplicado pelo offset. Por exemplo, ₹12.34 tem o valor 1234. |
> | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é de 60 caracteres.Comprimento máximo: `60`. |
> | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisa definir essa informação. 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 tiver incentivo, o comerciante precisa definir essa informação. 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 tiver incentivo, o comerciante precisa definir essa informação. 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 tiver incentivo, o comerciante precisa definir essa informação. 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 ser definido como `billdesk`, `razorpay`, `payu` ou `zaakpay`, se você tiver 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 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.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 a 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 a 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. Tamanho máximo suportado de 40 caracteres, com tamanho mínimo superior a 0 caracteres. |
> | `notes` | object | Não | O objeto pode ser composto por pares de chave-valor com no máximo 15 chaves e cada valor limitado a 256 caracteres. |

> [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 a Zaakpay.Comprimento máximo: `180` caracteres. |
> | `extra2` | string | Não | Informações definidas pelo usuário sobre este pedido para 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 mensagens de lista, botões de resposta e mensagens de vários produtos.</li><li>`video`: usado para botões de resposta.</li><li>`image`: usado para botões de resposta.</li><li>`document`: usado para botões de resposta.</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`. Consulte 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 de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também [Tipos de mídia compatíveis](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 [Tipos de mídia compatíveis](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 isso quando a mídia for enviada para os servidores do WhatsApp.\*\*Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (\[[https://docs.ycloud.com/reference/whatsapp\_media-upload#/](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 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 WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL.Observação: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. |
> | `caption` | string | Não | Descreve a mídia de `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use apenas com a mídia de `document`. |

> [accordion] whatsappMessage.interactive.header.video
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | \*\*Use isso quando a mídia for enviada para os servidores do WhatsApp.\*\*Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (\[[https://docs.ycloud.com/reference/whatsapp\_media-upload#/](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 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 WhatsApp Cloud API armazena recursos de mídia em cache por 10 minutos. Para garantir o conteúdo mais recente, adicione strings de consulta aleatórias à URL.Observação: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. |
> | `caption` | string | Não | Descreve a mídia de `image`, `gif`, `video` ou `document` especificada. Não aplicável no `header` de mensagens de `template` ou `interactive`. |
> | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use apenas com a mídia de `document`. |

> [accordion] whatsappMessage.interactive.header.document
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `id` | string | Não | \*\*Use isso quando a mídia for enviada para os servidores do WhatsApp.\*\*Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (\[[https://docs.ycloud.com/reference/whatsapp\_media-upload#/](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 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 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 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.interactive.footer
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `text` | string | Não | O conteúdo do rodapé. Emojis e markdown são suportados. Links são suportados. Tamanho máximo: 60 caracteres.Tamanho máximo: `60`. |

> [accordion] whatsappMessage.contacts\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `addresses` | object\[] | Não | Os itens da matriz são descritos abaixo. |
> | `birthday` | string | Não | String formatada em `YYYY-MM-DD`. |
> | `emails` | object\[] | Não | Os itens da matriz 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 a carga útil do contato compartilhado. |
> | `origin` | string | Não | Definido como `contact_request` quando o usuário compartilhou o contato em resposta a uma mensagem request-contact-info. |

> [accordion] whatsappMessage.contacts\[].addresses\[]
>
> | Parâmetro | Tipo | Obrigatório | Descrição |
> | - | - | - | - |
> | `street` | string | Não | Número e nome da rua. |
> | `city` | string | Não | Nome da cidade. |
> | `state` | string | Não | Abreviação do estado. |
> | `zip` | string | Não | CEP. |
> | `country` | string | Não | Nome completo do país. |
> | `country_code` | string | Não | Código 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 corporativo 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 `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 do erro legível por humanos. |
> | `code` | string | Sim | Um código de erro. |
> | `type` | string | Não | Tipo de erro. |
> | `error_subcode` | string | Não | Código adicional sobre o erro. |
> | `error_user_msg` | string | Não | A mensagem a ser exibida ao usuário. O idioma da mensagem é baseado no locale 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 é baseado no locale 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 localizar os dados de log para depuração. |
> | `error_data` | string or object | Não | Dados adicionais sobre o erro. Uma string ou map.<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 map com a propriedade `details` descrevendo o motivo do erro.</li></ul> |

## Exemplo

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

> [accordion] Mensagem de histórico de entrada
>
> Uma mensagem de histórico de entrada usa whatsappInboundMessage. phase e progress relatam a sincronização do bloco de histórico.
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_example_smb_history_inbound",
>   "type": "whatsapp.smb.history",
>   "apiVersion": "v2",
>   "createTime": "2026-10-09T08:00:00.000Z",
>   "phase": 1,
>   "progress": 40,
>   "whatsappInboundMessage": {
>     "id": "INBOUND_MESSAGE_ID",
>     "wamid": "wamid.INBOUND_EXAMPLE",
>     "wabaId": "WABA_ID",
>     "from": "+12025550124",
>     "to": "+12025550123",
>     "type": "text",
>     "text": {
>       "body": "What time can I collect my order?"
>     },
>     "customerProfile": {
>       "name": "Example customer"
>     },
>     "sendTime": "2026-10-08T12:00:00.000Z"
>   }
> }
> ```

> [accordion] Mensagem de histórico de saída
>
> Uma mensagem de histórico de saída usa whatsappMessage. Não a encaminhe como uma mensagem de entrada.
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_example_smb_history_outbound",
>   "type": "whatsapp.smb.history",
>   "apiVersion": "v2",
>   "createTime": "2026-10-09T08:00:00.000Z",
>   "phase": 1,
>   "progress": 60,
>   "whatsappMessage": {
>     "id": "MESSAGE_ID",
>     "wamid": "wamid.EXAMPLE",
>     "wabaId": "WABA_ID",
>     "from": "+12025550124",
>     "to": "+12025550123",
>     "type": "text",
>     "text": {
>       "body": "Your order is ready for pickup."
>     },
>     "status": "sent",
>     "createTime": "2026-10-08T12:00:00.000Z",
>     "sendTime": "2026-10-08T12:00:00.000Z"
>   }
> }
> ```

> [accordion] Progresso de sincronização do histórico
>
> Um bloco de histórico apenas com metadados relata phase e progress sem nenhum dos objetos de mensagem. Não trate esta estrutura como uma carga útil de message-created ou message-echoes.
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_example_smb_history_progress",
>   "type": "whatsapp.smb.history",
>   "apiVersion": "v2",
>   "createTime": "2026-10-09T08:00:00.000Z",
>   "phase": 1,
>   "progress": 73
> }
> ```

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

> [accordion] Mensagem de texto de saída
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_eEVCy8eNqD9EvcFI",
>   "type": "whatsapp.smb.history",
>   "apiVersion": "v2",
>   "createTime": "2023-02-22T12:00:00.000Z",
>   "phase": 1,
>   "progress": 40,
>   "whatsappMessage": {
>     "id": "63f5d602367ea403f8175a6c",
>     "wamid": "wamid.BgNODYxN...",
>     "status": "sent",
>     "from": "BUSINESS-PHONE-NUMBER",
>     "to": "CUSTOMER-PHONE-NUMBER",
>     "toUserId": "US.13491208655302741918",
>     "toParentUserId": "US.11815799212886844830",
>     "wabaId": "WABA-ID",
>     "createTime": "2022-03-01T12:00:00.000Z",
>     "sendTime": "2022-03-01T12:00:01.000Z",
>     "bizType": "whatsapp",
>     "type": "text",
>     "text": {
>       "body": "Hi there! How can we help?"
>     },
>     "context": {
>       "message_id": "wamid.BgNODYxN..."
>     }
>   }
> }
> ```

> [accordion] Bloco de histórico somente com progresso
>
> ```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
> {
>   "id": "evt_progressOnly73",
>   "type": "whatsapp.smb.history",
>   "apiVersion": "v2",
>   "createTime": "2023-02-22T12:00:02.000Z",
>   "phase": 1,
>   "progress": 73
> }
> ```

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 sobre cenários, consulte os [exemplos anotados](https://docs.ycloud.com/pt/api-reference/guides/examples/webhook-examples/whatsapp-business-app-history-message-webhook-examples).


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