> ## 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.echo_message.created > Ocorre quando uma mensagem de eco de saída é registrada para um Public REST API Agent. Use `whatsapp.echo_message.created` para processar este evento em seu endpoint de webhook. ## Gatilhos Ocorre quando uma mensagem de eco de saída é registrada para um Public REST API Agent. Inscreva-se em `whatsapp.echo_message.created` ao [configurar seu endpoint de webhook](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md). Este evento é limitado a Agentes integrados por meio da Public REST API. Use `whatsappMessage.id` ou `wamid` para correlacionar atualizações de status posteriores. O conteúdo da mensagem depende de `type`. ## Sintaxe A YCloud envia uma solicitação HTTP `POST` para o URL de webhook configurado. A estrutura a seguir mostra uma variante do payload. 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": "", "type": "whatsapp.echo_message.created", "apiVersion": "", "createTime": "", "whatsappMessage": { "id": "", "wamid": "", "wabaId": "", "from": "", "to": "", "recipientUserId": "", "type": "", "text": { "body": "" }, "status": "", "createTime": "", "sendTime": "" } } ``` ## Parâmetros Valide o cabeçalho HTTP `YCloud-Signature` antes de processar o corpo JSON. Consulte a [validação de assinatura](https://docs.ycloud.com/pt/api-reference/guides/api-fundamentals/configure-webhooks.md). ### Envelope do evento | Parâmetro | Tipo | Obrigatório | Descrição | | - | - | - | - | | `id` | string | Sim | ID exclusivo do evento. Tamanho mínimo: `6`. Tamanho máximo: `128`. | | `type` | string | Sim | Sempre `whatsapp.echo_message.created`. | | `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). Por exemplo, `2022-06-01T12:00:00.000Z`. | ### Payload do evento | Parâmetro | Tipo | Obrigatório | Descrição | | - | - | - | - | | `whatsappMessage` | object | Sim | Payload do `whatsappMessage` específico do evento. | Os quatro campos comuns do envelope são obrigatórios. Os campos do payload dependem da variante do evento. Em cada tabela de objetos, **Obrigatório** se aplica quando o objeto pai está presente. Campos opcionais podem ser omitidos; um exemplo não torna um campo obrigatório. #### whatsappMessage | Parâmetro | Tipo | Obrigatório | Descrição | | - | - | - | - | | `id` | string | Sim | ID da mensagem na YCloud. Use-o para correlacionar eventos de eco criados e atualizados. | | `wamid` | string | Não | O ID da mensagem original na plataforma do WhatsApp, quando disponível. | | `wabaId` | string | Não | ID da conta do WhatsApp Business do callback de origem, quando disponível. | | `from` | string | Não | Número de envio comercial no formato E.164, quando disponível. | | `to` | string | Não | Número do destinatário no formato E.164 quando o callback identificar o cliente pelo número de telefone. | | `recipientUserId` | string | Não | ID de usuário com escopo de negócios do WhatsApp do destinatário (BSUID), quando fornecido pelo callback. | | `parentRecipientUserId` | string | Não | ID de usuário pai com escopo de negócios do WhatsApp do destinatário, quando fornecido pelo callback. | | `type` | string | Não | Tipo de mensagem copiado de um callback de provedor compatível. Os valores atuais incluem text, interactive, image, video, audio, document, sticker, location, contacts e reaction. Os clientes devem tolerar valores futuros. | | `text` | object | Não | Objeto de Texto da Mensagem do WhatsApp. | | `image` | object | Não | Metadados de mídia copiados de um callback de eco do Meta Business Agent. | | `video` | object | Não | Metadados de mídia copiados de um callback de eco do Meta Business Agent. | | `audio` | object | Não | Metadados de mídia copiados de um callback de eco do Meta Business Agent. | | `document` | object | Não | Metadados de mídia copiados de um callback de eco do Meta Business Agent. | | `sticker` | object | Não | Metadados de mídia copiados de um callback de eco do Meta Business Agent. | | `location` | object | Não | Use para mensagens de `location`. | | `interactive` | object | Não | Usar para mensagens `interactive`. | | `contacts` | object\[] | Não | Os itens da matriz são descritos abaixo. | | `reaction` | object | Não | Quando um usuário reage a mensagens com um emoji, o tipo de mensagem é definido como `reaction` e este campo é incluído. | | `context` | object | Não | Usado para mencionar uma mensagem específica à qual você está respondendo. A resposta pode ser de qualquer tipo de mensagem. | | `status` | string | Não | Status da mensagem do WhatsApp. Um de `accepted`, `failed`, `sent`, `delivered`, `read`.

`accepted`: A solicitação de mensagens foi aceita pelo nosso sistema.
`failed`: Falha ao enviar uma mensagem enviada pela sua empresa.
`sent`: Uma mensagem enviada pela sua empresa está em trânsito nos sistemas do WhatsApp.
`delivered`: Uma mensagem enviada pela sua empresa foi entregue no dispositivo do usuário.
`read`: Uma mensagem enviada pela sua empresa foi lida pelo usuário.

A empresa enviou um modelo de mensagem para o usuário.
O usuário inicia uma conversa com um link "click to chat".
O usuário adiciona o número de telefone da empresa aos seus contatos e inicia uma conversa. Padrão: `false`.

| > [accordion] whatsappMessage.image > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | ID de mídia do provedor, quando fornecido pelo retorno de chamada. | > | `link` | string | Não | URL de mídia do provedor, quando fornecida pelo retorno de chamada. | > | `caption` | string | Não | Legenda da mídia, quando fornecida pelo callback. | > | `filename` | string | Não | Nome original do arquivo, quando fornecido pelo callback. | > | `mime_type` | string | Não | Tipo MIME do provedor copiado do callback. | > [accordion] whatsappMessage.video > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | ID de mídia do provedor, quando fornecido pelo callback. | > | `link` | string | Não | URL da mídia do provedor, quando fornecida pelo callback. | > | `caption` | string | Não | Legenda da mídia, quando fornecida pelo callback. | > | `filename` | string | Não | Nome original do arquivo, quando fornecido pelo callback. | > | `mime_type` | string | Não | Tipo MIME do provedor copiado do callback. | > [accordion] whatsappMessage.audio > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | ID de mídia do provedor, quando fornecido pelo callback. | > | `link` | string | Não | URL da mídia do provedor, quando fornecida pelo callback. | > | `caption` | string | Não | Legenda da mídia, quando fornecida pelo callback. | > | `filename` | string | Não | Nome original do arquivo, quando fornecido pelo callback. | > | `mime_type` | string | Não | Tipo MIME do provedor copiado do callback. | > [accordion] whatsappMessage.document > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | ID de mídia do provedor, quando fornecido pelo callback. | > | `link` | string | Não | URL da mídia do provedor, quando fornecida pelo callback. | > | `caption` | string | Não | Legenda da mídia, quando fornecida pelo callback. | > | `filename` | string | Não | Nome original do arquivo, quando fornecido pelo callback. | > | `mime_type` | string | Não | Tipo MIME do provedor copiado do callback. | > [accordion] whatsappMessage.sticker > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | ID de mídia do provedor, quando fornecido pelo callback. | > | `link` | string | Não | URL da mídia do provedor, quando fornecida pelo callback. | > | `caption` | string | Não | Legenda da mídia, quando fornecida pelo callback. | > | `filename` | string | Não | Nome original do arquivo, quando fornecido pelo callback. | > | `mime_type` | string | Não | Tipo MIME do provedor copiado do callback. | > [accordion] whatsappMessage.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.interactive > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `type` | string | Não | **Obrigatório.** O tipo de mensagem interativa que você deseja enviar.

`button`: use para botões de resposta (Reply Buttons).
`list`: use para mensagens de lista (List Messages).
`cta_url`: use para mensagens de botão com URL de Call-To-Action (CTA).
`product`: use para mensagens de produto único (Single Product Messages).
`product_list`: use para mensagens de vários produtos (Multi-Product Messages).
`catalog_message`: use para mensagens de catálogo (Catalog Messages).
`location_request_message`: use para mensagens de solicitação de localização (Location Request Messages).
`order_details`: use para mensagens de detalhes do pedido (Order Details Messages).
`order_status`: use para mensagens de status do pedido (Order Status Messages).
`voice_call`: use para mensagens de chamada de voz (Voice Call Messages).
`flow`: use para mensagens de fluxo (Flow Messages).

| > | `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 Reply Buttons. Você pode ter até 3 botões. | > | `button` | string | Não | Obrigatório para List Messages. Conteúdo do botão. Não pode ser uma string vazia e deve ser único dentro da mensagem. Emojis são suportados, markdown não. Comprimento máximo: 20 caracteres.Comprimento máximo: `20`. | > | `catalog_id` | string | Não | Obrigatório para Single Product Messages e Multi-Product Messages. Identificador exclusivo do catálogo do Facebook vinculado à sua conta do WhatsApp Business. Este ID pode ser recuperado por meio do [Meta Commerce Manager](https://business.facebook.com/commerce). | > | `product_retailer_id` | string | Não | Obrigatório para Single Product Messages e Multi-Product Messages. Identificador exclusivo do produto em um catálogo. | > | `sections` | object\[] | Não | Obrigatório para List Messages e Multi-Product Messages. Matriz de objetos de seção. Mínimo de 1, máximo de 10. | > | `name` | string | Não | Nome da ação. Obrigatório para botões de Call-To-Action (CTA).

`cta_url`: use para botões de URL de Call-To-Action (CTA).
`catalog_message`: use para Catalog Messages.
`send_location`: use para botões de Location Request.
`flow`: use para botões de Flow.
`review_and_pay`: use para botões de Order Details.
`review_order`: use para botões de Order Status.
`voice_call`: use para botões de Voice Call.

| > | `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 Reply Button). | > | `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. Comprimento máximo: 20 caracteres.Comprimento máximo: `20`. | > | `id` | string | Não | Identificador exclusivo para o seu botão. Este ID é retornado no webhook quando o botão é clicado pelo usuário. Comprimento máximo: 256 caracteres. Não pode conter espaços à esquerda ou à direita ao definir o ID.Comprimento máximo: `256`. | > [accordion] whatsappMessage.interactive.action.sections\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `title` | string | Não | **Obrigatório se a mensagem tiver mais de uma seção.** Título da seção. Comprimento máximo: 24 caracteres.Comprimento máximo: `24`. | > | `rows` | object\[] | Não | Contém uma lista de linhas. Você pode ter um total de 10 linhas em todas as suas seções. Cada linha deve ter um título (Comprimento máximo: 24 caracteres) e um ID (Comprimento máximo: 200 caracteres). Você pode adicionar uma descrição (Comprimento máximo: 72 caracteres), mas ela é opcional. | > | `product_items` | object\[] | Não | Obrigatório para Mensagens Multiproduto. Matriz de objetos de produto. Há um mínimo de 1 produto por seção e um máximo de 30 produtos em todas as seções. | > [accordion] whatsappMessage.interactive.action.sections\[].rows\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | ID exclusivo da linha. Comprimento máximo: 200 caracteres.Comprimento máximo: `200`. | > | `title` | string | Não | Conteúdo do título da linha. Comprimento máximo: 24 caracteres.Comprimento máximo: `24`. | > | `description` | string | Não | Conteúdo da descrição da linha. Comprimento máximo: 72 caracteres.Comprimento máximo: `72`. | > [accordion] whatsappMessage.interactive.action.sections\[].product\_items\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `product_retailer_id` | string | Não | Obrigatório para Mensagens Multiproduto. Identificador exclusivo do produto em um catálogo. | > [accordion] whatsappMessage.interactive.action.parameters > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `display_text` | string | Não | Texto do botão de URL de CTA. Comprimento máximo: 20 bytes.Comprimento máximo: `20`. | > | `url` | string | Não | URL do botão de URL de CTA. | > | `thumbnail_product_retailer_id` | string | Não | Número de SKU do item. Identificado como **Content ID** no [Commerce Manager](https://business.facebook.com/commerce). A miniatura deste item será usada como a imagem do cabeçalho da mensagem. | > | `flow_message_version` | string | Não | Use para botões de `flow`. O valor deve ser "3". | > | `flow_token` | string | Não | Use para botões de `flow`. Token do Flow gerado pela empresa para servir como identificador. O padrão é `unused`. | > | `flow_id` | string | Não | Condicionalmente obrigatório para botões de `flow`. ID exclusivo do Flow fornecido pelo WhatsApp. Não pode ser usado com o parâmetro `flow_name`. | > | `flow_name` | string | Não | Condicionalmente obrigatório para botões `flow`. O nome do Flow que você criou. Não pode ser usado com o parâmetro `flow_id`. Alterar o nome do Flow exigirá a atualização deste parâmetro para corresponder ao novo nome. | > | `flow_cta` | string | Não | Obrigatório para botões `flow`. Texto no botão de CTA. Por exemplo: "Open flow!". Comprimento máximo: 20 caracteres.Comprimento máximo: `20`. | > | `flow_action` | string | Não | Use para botões `flow`. `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_and_pay`. Identificador exclusivo do pedido fornecido pela empresa. Diferencia maiúsculas de minúsculas, não pode ser uma string vazia e pode conter apenas letras em inglês, números, sublinhados, traços ou pontos, e não deve exceder 35 caracteres.O `reference_id` deve ser exclusivo para cada mensagem de order\_details de uma determinada empresa. Se houver necessidade de enviar várias mensagens de 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 mercadoria que está sendo paga neste pedido. As opções atualmente suportadas são `digital-goods` e `physical-goods`. | > | `beneficiaries` | object\[] | Não | Obrigatório para botões `review_and_pay`. Uma matriz de beneficiários para este pedido. Um beneficiário é o destinatário pretendido para o envio das mercadorias físicas do 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 order `status`, `items`, `subtotal`, `tax`, etc.Para botões `review_order`, fornece apenas order `status` e `description`. | > | `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. Precisa 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 as mercadorias físicas. Não pode exceder 200 caracteres.Comprimento máximo: `200`. | > | `address_line1` | string | Sim | Endereço de entrega (número da porta/bloco, nome da rua, etc.). Não pode exceder 100 caracteres.Comprimento máximo: `100`. | > | `address_line2` | string | Não | Endereço de entrega (ponto de referência, bairro, etc.). Não pode exceder 100 caracteres.Comprimento máximo: `100`. | > | `city` | string | Sim | Nome da cidade. | > | `state` | string | Sim | Nome do estado. | > | `country` | string | Sim | Nome do país. Atualmente, o único valor suportado é `India`. | > | `postal_code` | string | Sim | CEP de 6 dígitos do endereço de entrega.Comprimento mínimo: `6`. Comprimento máximo: `6`. | > [accordion] whatsappMessage.interactive.action.parameters.total\_amount > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `offset` | integer (int32) | Sim | Deve ser `100` para `INR`. | > | `value` | integer (int32) | Sim | Número inteiro positivo que representa o valor da quantia multiplicado pelo deslocamento (offset). Por exemplo, ₹12,34 tem o valor 1234. | > | `description` | string | Não | Use somente para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. | > | `discount_program_name` | string | Não | Use somente para `discount`. Texto usado para definir pedidos incentivados. Se o pedido for incentivado, o comerciante precisa definir esta informação. O limite máximo é de 60 caracteres.Comprimento máximo: `60`. | > [accordion] whatsappMessage.interactive.action.parameters.order > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `status` | string | Não | O único valor suportado na mensagem `order_details` é `pending`. Em uma mensagem `order_status`, `status` pode ser: `pending`, `processing`, `partially_shipped`, `shipped`, `completed` ou `canceled`. | > | `type` | string | Não | O único valor suportado é `quick_pay`. Quando este campo é informado, ocultamos o botão "Review and Pay" e exibimos apenas o botão "Pay Now" no balão de detalhes do pedido. | > | `catalog_id` | string | Não | Identificador exclusivo do catálogo do Facebook usado pela empresa. Se você não fornecer este campo, deverá fornecer os seguintes campos dentro do objeto items: `country_of_origin`, `importer_name` e `importer_address`. | > | `items` | object\[] | Não | Matriz de itens no pedido. | > | `subtotal` | object | Não | O valor **deve ser igual** à soma de `order.amount.value` \* `order.amount.quantity`. | > | `tax` | object | Não | As informações fiscais para este pedido. | > | `shipping` | object | Não | O custo de frete do pedido. | > | `discount` | object | Não | O valor do desconto para este pedido. | > | `expiration` | object | Não | Expiração para este pedido. | > | `description` | string | Não | **Opcional.** Texto para compartilhar informações relacionadas ao status. Pode ser útil ao enviar cancelamento. O limite máximo é de 120 caracteres.Comprimento máximo: `120`. | > [accordion] whatsappMessage.interactive.action.parameters.order.items\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `retailer_id` | string | Não | ID de conteúdo de um item no pedido do seu catálogo. | > | `name` | string | Sim | O nome do item a ser exibido para o usuário. Não pode exceder 60 caracteres.Comprimento máximo: `60`. | > | `image` | object | Não | Imagem personalizada do item a ser exibida para o usuário. | > | `amount` | object | Sim | O preço por item. | > | `sale_amount` | object | Não | O preço com desconto por item. Deve ser menor que o valor original. Se incluído, este campo é 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.interactive.action.parameters.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): é 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 de `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`. | > | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use apenas com mídia de `document`. | > [accordion] whatsappMessage.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 representando o valor do montante multiplicado pelo deslocamento. 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.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 representando o valor do montante multiplicado por 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.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 representando o valor do montante multiplicado por 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.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 por 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.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 por offset. Por exemplo, ₹12.34 tem o valor 1234. | > | `description` | string | Não | Use apenas para `tax`, `shipping` ou `discount`. Descrição do valor. O limite máximo de caracteres é 60 caracteres.Comprimento máximo: `60`. | > | `discount_program_name` | string | Não | Use apenas para `discount`. Texto usado para definir pedidos com incentivo. Se o pedido tiver incentivo, o comerciante precisará definir essas informações. O limite máximo de caracteres é 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 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 é 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 é 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 carimbo de data/hora UTC em segundos de quando o pedido deve expirar. O limite mínimo é de 300 segundos. | > | `description` | string | Não | Explicação em texto para a expiração.Comprimento máximo: `120`. | > [accordion] whatsappMessage.interactive.action.parameters.payment\_settings\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `type` | string | Sim | Deve ser definido como `payment_gateway`. | > | `payment_gateway` | object | Sim | Um objeto que descreve as informações da conta de pagamento. | > [accordion] whatsappMessage.interactive.action.parameters.payment\_settings\[].payment\_gateway > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `type` | string | Sim | Tipo de pagamento. Deve definir isso como `billdesk`, `razorpay`, `payu` ou `zaakpay`, 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 o Zaakpay. Campos definidos pelo usuário (extra) são usados para armazenar qualquer informação correspondente a um pedido específico. Cada campo extra tem um limite máximo de 180 caracteres. | > [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 o BillDesk.Comprimento máximo: `120` caracteres. | > | `additional_info2` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. | > | `additional_info3` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. | > | `additional_info4` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. | > | `additional_info5` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. | > | `additional_info6` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. | > | `additional_info7` | string | Não | Informações definidas pelo usuário sobre este pedido para o BillDesk.Comprimento máximo: `120` caracteres. | > [accordion] whatsappMessage.interactive.action.parameters.payment\_settings\[].payment\_gateway.payu > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `udf1` | string | Não | Informações definidas pelo usuário sobre este pedido para o PayU.Comprimento máximo: `255` caracteres. | > | `udf2` | string | Não | Informações definidas pelo usuário sobre este pedido para o PayU.Comprimento máximo: `255` caracteres. | > | `udf3` | string | Não | Informações definidas pelo usuário sobre este pedido para o PayU.Comprimento máximo: `255` caracteres. | > | `udf4` | string | Não | Informações definidas pelo usuário sobre este pedido para o PayU.Comprimento máximo: `255` caracteres. | > [accordion] whatsappMessage.interactive.action.parameters.payment\_settings\[].payment\_gateway.razorpay > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `receipt` | string | Não | Número do recibo correspondente a este pedido, definido para sua referência interna. Suporta comprimento máximo de 40 caracteres, com comprimento mínimo maior que 0 caracteres. | > | `notes` | object | Não | O objeto pode ser composto por pares de chave-valor com no máximo 15 chaves, e cada valor é limitado a 256 caracteres. | > [accordion] whatsappMessage.interactive.action.parameters.payment\_settings\[].payment\_gateway.zaakpay > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `extra1` | string | Não | Informações definidas pelo usuário sobre este pedido para o Zaakpay.Comprimento máximo: `180` caracteres. | > | `extra2` | string | Não | Informações definidas pelo usuário sobre este pedido para o Zaakpay.Comprimento máximo: `180` caracteres. | > [accordion] whatsappMessage.interactive.body > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `text` | string | Não | O conteúdo do corpo da mensagem. Emojis e markdown são suportados. Comprimento máximo: 1024 caracteres.Comprimento máximo: `1024`. | > [accordion] whatsappMessage.interactive.header > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `type` | string | Não | **Obrigatório.** O tipo de cabeçalho que você deseja usar.

`text`: Usado para List Messages, Reply Buttons e Multi-Product Messages.
`video`: Usado para Reply Buttons.
`image`: Usado para Reply Buttons.
`document`: Usado para Reply Buttons.

| > | `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 [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). | > | `video` | object | Não | Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). | > | `document` | object | Não | Use para mensagens de `image`, `gif`, `video`, `audio`, `document` ou `sticker`. Consulte também [Supported Media Types](https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#supported-media-types). | > [accordion] whatsappMessage.interactive.header.image > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | \*\*Use 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): é necessá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: é 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 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 `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): é necessário fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência. | > | `link` | string | Não | \*\*Use isto ao enviar mídia diretamente do seu servidor.\*\*O protocolo e a URL da mídia a ser enviada. Use somente com URLs HTTP/HTTPS.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: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. | > | `caption` | string | Não | Descreve a mídia especificada do tipo `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`. | > | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use somente com mídias do tipo `document`. | > [accordion] whatsappMessage.interactive.header.document > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `id` | string | Não | \*\*Use isto quando a mídia for enviada para os servidores do WhatsApp.\*\*Forneça o ID do objeto de mídia obtido da API de upload de mídia do WhatsApp (\[[https://docs.ycloud.com/reference/whatsapp\_media-upload#/](https://docs.ycloud.com/reference/whatsapp_media-upload#/)]\([https://docs.ycloud.com/reference/whatsapp\_media-upload#/)).Nota](https://docs.ycloud.com/reference/whatsapp_media-upload#/\)\).Nota): é 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.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: é obrigatório fornecer `id` ou `link`. Se ambos forem fornecidos, `id` terá precedência e `link` será ignorado. | > | `caption` | string | Não | Descreve a mídia especificada do tipo `image`, `gif`, `video` ou `document`. Não aplicável no `header` de mensagens de `template` ou `interactive`. | > | `filename` | string | Não | Descreve o nome do arquivo para o documento específico. Use somente com mídias do tipo `document`. | > [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. Comprimento máximo: 60 caracteres.Comprimento máximo: `60`. | > [accordion] whatsappMessage.contacts\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `addresses` | object\[] | Não | Os itens 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 o payload do contato compartilhado. | > | `origin` | string | Não | Definido como `contact_request` quando o usuário compartilhou o contato em resposta a uma mensagem 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 | Sigla do estado. | > | `zip` | string | Não | CEP / Código postal. | > | `country` | string | Não | Nome completo do país. | > | `country_code` | string | Não | Sigla de duas letras do país. | > | `type` | string | Não | Os valores padrão são `HOME` e `WORK`. | > [accordion] whatsappMessage.contacts\[].emails\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `email` | string | Não | Endereço de e-mail. | > | `type` | string | Não | Os valores padrão são `HOME` e `WORK`. | > [accordion] whatsappMessage.contacts\[].name > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `formatted_name` | string | Sim | Nome completo, como aparece normalmente. | > | `first_name` | string | Não | Primeiro nome. | > | `last_name` | string | Não | Sobrenome. | > | `middle_name` | string | Não | Nome do meio. | > | `suffix` | string | Não | Sufixo do nome. | > | `prefix` | string | Não | Prefixo do nome. | > [accordion] whatsappMessage.contacts\[].org > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `company` | string | Não | Nome da empresa do contato. | > | `department` | string | Não | Nome do departamento do contato. | > | `title` | string | Não | Cargo ou título profissional 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 | WhatsApp ID. | > [accordion] whatsappMessage.contacts\[].urls\[] > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `url` | string | Não | URL. | > | `type` | string | Não | Os valores padrão são `HOME` e `WORK`. | > [accordion] whatsappMessage.reaction > > | Parâmetro | Tipo | Obrigatório | Descrição | > | - | - | - | - | > | `message_id` | string | Sim | Especifica o `wamid` da mensagem recebida que continha a reação. | > | `emoji` | string | Não | **Obrigatório** ao enviar uma mensagem de `reaction`. Defina como `""` se desejar remover o emoji. **Opcional** ao receber uma mensagem de um usuário. Este campo é incluído quando um usuário reage às 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. | ## Exemplo O JSON a seguir é o corpo entregue ao seu destinatário. IDs, números de telefone e outros valores de conta são apenas ilustrativos. > [accordion] Echo de texto de saída > > Armazene o texto de whatsappMessage.text.body. id e wamid vinculam eventos de status subsequentes. > > ```json theme={"theme":{"light":"github-light","dark":"github-dark"}} > { > "id": "evt_example_echo_text", > "type": "whatsapp.echo_message.created", > "apiVersion": "v2", > "createTime": "2026-09-09T02:00:00.000Z", > "whatsappMessage": { > "id": "MESSAGE_ID", > "wamid": "wamid.EXAMPLE", > "wabaId": "WABA_ID", > "from": "+12025550124", > "to": "+12025550123", > "recipientUserId": "GB.898232076600896", > "type": "text", > "text": { > "body": "Hello! How can I help you?" > }, > "status": "sent", > "createTime": "2026-09-09T02:00:00.000Z", > "sendTime": "2026-09-09T02:00:00.000Z" > } > } > ``` > [accordion] Eco de imagem de saída > > O conteúdo da mensagem varia de acordo com o tipo. Trate IDs de mídia como referências do provedor, não como URLs públicas de download. > > ```json theme={"theme":{"light":"github-light","dark":"github-dark"}} > { > "id": "evt_example_echo_image", > "type": "whatsapp.echo_message.created", > "apiVersion": "v2", > "createTime": "2026-09-09T02:00:00.000Z", > "whatsappMessage": { > "id": "IMAGE_MESSAGE_ID", > "wamid": "wamid.IMAGE_EXAMPLE", > "wabaId": "WABA_ID", > "from": "+12025550124", > "to": "+12025550123", > "recipientUserId": "GB.898232076600896", > "type": "image", > "image": { > "id": "MEDIA_ID", > "mime_type": "image/jpeg" > }, > "status": "sent", > "createTime": "2026-09-09T02:00:00.000Z", > "sendTime": "2026-09-09T02:00:00.000Z" > } > } > ``` Após verificar a assinatura e aceitar o evento de forma duradoura, retorne uma resposta `2xx`. Processe tarefas lentas de forma assíncrona. ```http theme={"theme":{"light":"github-light","dark":"github-dark"}} HTTP/1.1 200 OK ``` Para orientações detalhadas de cenários, consulte os [exemplos anotados](https://docs.ycloud.com/pt/api-reference/guides/examples/webhook-examples/whatsapp-echo-message-created). This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.