API de Gerenciamento do WhatsApp Business

Modelos de código de cupom

Os modelos de código de cupom são modelos de marketing que mostram um botão único de copiar código. Quando o cliente toca no botão, o código é copiado para a área de transferência.

Limitações

Os modelos de código de cupom não são compatíveis com o WhatsApp Web para clientes.
Os códigos têm limite de 15 caracteres.
O texto do botão não pode ser personalizado.
Os modelos podem ter apenas um botão de copiar código.

Criar modelos de código de cupom

Use o ponto de extremidade em WhatsApp Business Account > Message Templates para criar modelos de código de cupom.

Sintaxe da solicitação

POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/message_templates

Corpo da publicação

{
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "MARKETING",
  "components": [
    ... // Additional components, if using
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type":"COPY_CODE",
          "example": "<EXAMPLE>"
        },
        ... // Additional buttons, if using
      ]
    }
  ]
}

Propriedades

Espaço reservado Descrição Valor de exemplo

Espaço reservado	Descrição	Valor de exemplo
`<NAME>` String	Obrigatório. O nome do modelo. Máximo de 512 caracteres.	`fall2023_promotion`
`<LANGUAGE>` Enumeração	Obrigatório. O código de localidade e idioma do modelo.	`en_US`
`<EXAMPLE>` String	Obrigatório. O código do cupom que deve ser copiado quando o cliente toca no botão. Máximo de 15 caracteres.	`25OFF`

<NAME>

String

Obrigatório.

O nome do modelo.

Máximo de 512 caracteres.

fall2023_promotion

<LANGUAGE>

Enumeração

Obrigatório.

O código de localidade e idioma do modelo.

en_US

<EXAMPLE>

String

Obrigatório.

O código do cupom que deve ser copiado quando o cliente toca no botão.

Máximo de 15 caracteres.

25OFF

Resposta

Se o processo for bem-sucedido, a API enviará a seguinte resposta:

{
   "category" : "<CATEGORY>",
   "id" : "<ID>",
   "status" : "<STATUS>"
}

Propriedades de resposta

Espaço reservado Descrição Valor de exemplo

Espaço reservado	Descrição	Valor de exemplo
`<CATEGORY>` Enumeração	A categoria do modelo.	`MARKETING`
`<ID>` String numérica	O ID do modelo.	`1924084211297547`
`<STATUS>` Enumeração	Status do modelo	`PENDING`

<CATEGORY>

Enumeração

A categoria do modelo.

MARKETING

<ID>

String numérica

O ID do modelo.

1924084211297547

<STATUS>

Enumeração

Status do modelo

PENDING

Exemplo de solicitação

curl 'https://graph.facebook.com/v21.0/102290129340398/message_templates' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer EAAJB...' \
-d '
{
  "name": "coupon_code_fall2023_25off",
  "language": "en_US",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Our Fall Sale is on!"
    },
    {
      "type": "BODY",
      "text": "Shop now through November and use code {{1}} to get {{2}} off of all merchandise!",
      "example": {
        "body_text": [
          [
            "25OFF",
            "25%"
          ]
        ]
      }
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Unsubscribe"
        },
        {
          "type": "COPY_CODE",
          "example": "250FF"
        }
      ]
    }
  ]
}'

Exemplo de resposta

{
  "category" : "MARKETING",
  "id" : "1924084211297547",
  "status" : "PENDING"
}

Enviar modelos de cupom

Use a API de Nuvem para enviar modelos de código de cupom aprovados em mensagens. Consulte Enviar modelos de código de cupom.