Referências de API

Cadastrar modelos.

post https://api-cerberus-kong.socialminer.tech/api/Templates

INTRODUÇÃO

Os modelos podem ser criados para envio de mensagens padronizadas. Todo modelo criado passa por um processo de validação na Meta, que pode aprovar ou rejeitar o tempate cadastrado.

LIMITAÇÕES

Veja as limitações em Meta.

LOCALIZAÇÃO

Ao criar um modelo de mensagem, você pode adicionar um idioma específico. A lista dos idiomas suportados pode ser verificada em Meta - Supported Languages.

CRIAR MODELOS

Sintaxe da solicitação

POST api/Templates

Corpo da solicitação

{
  "name": "<NAME>",
  "category": "<CATEGORY>",
  "allow_category_change": <ALLOW_CATEGORY_CHANGE>,
  "language": "<LANGUAGE>",
  "components": [<COMPONENTS>]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<NAME>Obrigatório.
O nome do modelo.
Máximo de 512 caracteres.		modelo_cupom_oferta
<CATEGORY>Obrigatório.
A categoria do modelo.
Consulte categorias de modelo.		MARKETING
<ALLOW_CATEGORY_CHANGE>
Opcional.
Defina como "true" para permitir a atribuição automática de categoria. Se esse valor for omitido, o modelo poderá ser rejeitado por categorização incorreta.
Consulte categorização automática.		true
<LANGUAGE>Obrigatório.
O código de localidade e idioma do modelo
Consulte linguagens permitidas.		pt_BR
<COMPONENTS>Obrigatório.
Componentes que fazem parte do modelo.
Consulte componentes do modelo.		Consulte componentes do modelo

Resposta

Se a solicitação for bem-sucedida, a API responderá com o ID, o status e a categoria do modelo recém-criado. Os detalhes de aprovação do template podem ser consultados através da documentação da Meta.

Sintaxe

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

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<ID>O ID do modelo.572279198452421
<STATUS>O status do modelo.PENDING
<CATEGORY>A categoria do modelo designada por você ou atribuída por nós.MARKETING

Categorias do modelo

Os modelos precisam ser categorizados usando uma das categorias a seguir. As categorias influenciam no preço, e a opção definida por você será validada no momento da criação do modelo.

  • AUTHENTICATION
  • MARKETING
  • UTILITY

Categorização automática

É possível incluir a propriedade allow_category_change na sua solicitação para que atribuamos automaticamente uma categoria com base no conteúdo do seu modelo. Isso pode evitar que o status do seu modelo seja imediatamente definido como REJECTED devido à categorização incorreta.

Só é possível solicitar a categorização automática no momento da criação do modelo.

Componentes do modelo

Os modelos são feitos de quatro componentes principais, definidos no momento da criação: cabeçalho, corpo, rodapé e botões. Escolha os componentes dos modelos com base nas necessidades dos seus negócios. O único componente obrigatório é o corpo.

Alguns componentes são compatíveis com variáveis, cujos valores você pode fornecer ao disparar um modelo de mensagem. Quando as variáveis forem usadas, será preciso incluir valores de exemplo para elas no momento da criação do modelo.

Saiba mais na documentação da Meta.

Cabeçalhos

Os cabeçalhos são componentes opcionais que aparecem na parte superior dos modelos de mensagem. Eles são compatíveis com texto, mídia (imagens, vídeos, documentos) e localizações. Os modelos podem ter apenas um componente de cabeçalho.

Cabeçalhos com texto

Sintaxe
{
  "type": "HEADER",
  "format": "TEXT",
  "text": "<TEXT>",

    # Obrigatório caso <TEXT> string contenha variaveis
  "example": {
    "header_text": [
      "<HEADER_TEXT>"
    ]
  }
}
Propriedades
Espaço reservadoDescriçãoValor de exemplo
<HEADER_TEXT>Exemplo de cabeçalho com texto.Promoção de Verão
<TEXT> Texto a ser exibido no cabeçalho do modelo enviado. Compatível com 1 variável.

Se a string contiver uma variável, você deverá incluir a propriedade example e um valor de exemplo.
Pode ter, no máximo, 60 caracteres.		Nossa {{1}} está disponível!

Cabeçalhos com mídia

O cabeçalho com mídia pode ser uma imagem, um vídeo ou um documento, como um PDF. A sintaxe para definir um cabeçalho com mídia é a mesma para todos os tipos de mídia.

Sintaxe
{
  "type": "HEADER",
  "format": "<FORMAT>",
  "example": {
    "header_handle": [
      "<HEADER_HANDLE>"
    ]
  }
}
Propriedades
Espaço reservadoDescriçãoValor de exemplo
<FORMAT>Indica o tipo de ativo de mídia. Defina como IMAGE, VIDEO ou DOCUMENT.IMAGE
<HEADER_HANDLE>URL da midia a ser carregada.https://wake.tech/wp-content/uploads/2023/07/Wake-Experience-Logo-300x135.png

Cabeçalhos com localização

Os cabeçalhos com localização aparecem como mapas genéricos na parte superior do modelo e são úteis para rastreamento de pedidos, atualizações sobre entregas, embarque e desembarque no transporte por caronas, localização de lojas físicas etc. Quando o usuário toca neles, o app de mapas padrão do usuário é aberto e carrega a localização especificada. As localizações são especificadas quando você envia o modelo usando a API de disparo de mensagens.

Os cabeçalhos com localização só podem ser usados em modelos categorizados como UTILITY ou MARKETING. A localização em tempo real não é compatível.

Sintaxe
{
  "type": "HEADER",
  "format": "LOCATION"
}
Propriedades

Os valores de propriedade não podem ser personalizados.

Corpo

Os componentes do tipo corpo são somente de texto e são obrigatórios em todos os modelos. Os modelos podem ter apenas um componente de corpo.

Sintaxe

{
  "type": "BODY",
  "text": "<TEXT>",
  
  # Obrigatório caso <TEXT> string contenha variaveis
  "example": {
    "body_text": [
      [
        <BODY_TEXT>
      ]
    ]
  }
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<TEXT>String de texto. Compatível com mais de uma variável.
Se a string contiver variáveis, você deverá incluir a propriedade example e valores de exemplo.
Pode ter, no máximo, 1.024 caracteres.		Compre agora no {{1}} e use código {{2}} para ganhar {{3}} de desconto em todos os produtos.
<BODY_TEXT>Matriz de exemplos de strings. O número de strings deve corresponder ao número de variáveis incluídas na string."final de novembro","100CODE","100%"

Rodapé

Os rodapés são componentes opcionais somente de texto que são exibidos imediatamente após o componente corpo. Os modelos podem ter apenas um componente de rodapé.

Sintaxe

{
  "type": "FOOTER",
  "text": "<TEXT>"
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<TEXT>Texto a ser exibido no rodapé do modelo enviado.
Pode ter, no máximo, 60 caracteres.		Use os botões abaixo para gerenciar suas inscrições de negócio

Botões

Os botões são componentes interativos opcionais que executam ações específicas quando tocados. Os modelos podem combinar até 10 componentes de botão no total, embora haja limitações para botões do mesmo tipo, bem como para combinações.

Os botões são definidos em um único objeto do componente de botão, agrupados em uma matriz de buttons. Por exemplo, este modelo usa um botão de número de telefone e um botão URL:

{
  "type": "BUTTONS",
  "buttons": [
    {
      "type": "PHONE_NUMBER",
      "text": "Ligar",
      "phone_number": "15550051310"
    },
    {
      "type": "URL",
      "text": "Compre agora",
      "url": "https://www.lojateste.com/shop/"
    }
  ]
}

Se o modelo tiver mais de três botões, dois deles aparecerão na mensagem entregue e os restantes serão substituídos por um botão Ver todas as opções. Os botões restantes são exibidos quando o usuário toca em Ver todas as opções.

Botões de número de telefone

Botões de número de telefone ligam para os telefones comerciais especificados quando o usuário do app clica neles. Os modelos podem ter apenas um componente de botão de número de telefone.

Sintaxe
{
  "type": "PHONE_NUMBER",
  "text": "<TEXT>",
  "phone_number": "<PHONE_NUMBER>"
}
Propriedades
Espaço reservadoDescriçãoValor de exemplo
<TEXT>Texto da etiqueta do botão.
Pode ter, no máximo, 25 caracteres.		Telefonar
<PHONE_NUMBER>String alfanumérica. O número de telefone comercial a ser chamado (número de telefone de exibição) quando o usuário toca no botão.
Pode ter, no máximo, 20 caracteres.		15550051310

Botões URL

Botões URL carregam a URL especificada no navegador da web padrão do dispositivo quando o usuário do app clica neles. Os modelos podem ter até dois botões URL.

Sintaxe
{
  "type": "URL",
  "text": "<TEXT>",
  "url": "<URL>",

  # Obrigatório caso <URL> contenha uma variavel
  "example": [
    "<EXAMPLE>"
  ]
}
Propriedades
Espaço reservadoDescriçãoValor de exemplo
<TEXT>Texto da etiqueta do botão. Compatível com 1 variável.
Se usar uma variável, você deverá incluir a propriedade "example" e um valor de exemplo.
Pode ter, no máximo, 25 caracteres.		Compre Agora
<URL>URL do site que é carregada no navegador da web para celular padrão do dispositivo quando o usuário do app toca no botão.
Compatível com 1 variável, adicionada ao final da string da URL.
Pode ter, no máximo, 2.000 caracteres.		https://www.lojateste.com/shop?promo={{1}}
<EXAMPLE>URL do site. Compatível com 1 variável.
Se usar uma variável, adicione um exemplo de propriedade de variável ao final da string da URL. A URL é carregada no navegador da web para celular padrão do dispositivo quando o cliente toca no botão.
Pode ter, no máximo, 2.000 caracteres.		CODE100

Botões de resposta rápida

Os botões de resposta rápida são botões personalizados somente de texto que, quando tocados pelo usuário, enviam imediatamente a você uma mensagem com a string especificada. Um caso de uso comum é um botão para o usuário cancelar com facilidade a assinatura de mensagens de marketing.

Os modelos podem ter até 10 botões de resposta rápida. Caso você use botões de resposta rápida com outros tipos de botão, será preciso organizá-los em dois grupos: botões de resposta rápida consecutivos e outros botões. Se eles forem agrupados incorretamente, a API retornará um erro informando uma combinação inválida.

Exemplos de agrupamentos válidos:

  • Resposta rápida, resposta rápida, URL, telefone
  • URL, telefone, resposta rápida, resposta rápida

Exemplos de agrupamentos inválidos:

  • Resposta rápida, URL, resposta rápida
  • URL, resposta rápida, URL

Ao utilizar a API de disparo de mensagem de template para enviar um modelo que tenha mais de um botão de resposta rápida, utilize a propriedade "index" para definir a ordem em que os botões aparecerão no modelo de mensagem.

Sintaxe
{
  "type": "QUICK_REPLY",
  "text": "<TEXT>"
}
Propriedades
Espaço reservadoDescriçãoValor de exemplo
<TEXT>Texto da etiqueta do botão.
Pode ter, no máximo, 25 caracteres.		Remover Inscrição

Botões de copiar código

Os botões de copiar código copiam uma sequência de texto (definida quando o modelo é enviado em uma mensagem) para a área de transferência do dispositivo quando ela é tocada pelo usuário do app. Os modelos podem ter apenas um botão de copiar código.

Sintaxe
{
  "type": "COPY_CODE",
  "example": "<EXAMPLE>"
}
Propriedades
Espaço reservadoDescriçãoValor de exemplo
<EXAMPLE>A string que será copiada para a área de transferência do dispositivo quando for tocada pelo usuário do app.
Pode ter, no máximo, 15 caracteres.		CODE100

Botões de senha descartável

Outros tipos de botões de senha descartável podem ser utilizados na criação de modelos de autenticação.

Botões de flow

Os botões do Flows são destinados ao envio de mensagens do Flows como modelos. Os modelos podem ter apenas um botão do Flows.

Sintaxe
{
  "type": "FLOW",
  "text": "<TEXT>",
  "flow_id": "<FLOW_ID>",
  "flow_action": "<FLOW_ACTION>",
  "navigate_screen": "<NAVIGATE_SCREEN>"
}
Propriedades
Espaço reservadoDescriçãoValor de exemplo
<TEXT>Texto da etiqueta do botão.
Pode ter, no máximo, 25 caracteres.		Sign up
<FLOW_ID>Identificador único do fluxo fornecido pelo WhatsApp. O fluxo precisa estar publicado123456789012345
<FLOW_ACTION>navigate ou data_exchange. Use navigate para predefinir a primeira tela como parte do modelo de mensagem. Use data_exchange para casos de uso avançados, em que a primeira tela é fornecida pelo seu ponto de extremidade.
Padrão: navigate		navigate
<NAVIGATE_SCREEN>Obrigatório somente se flow_action for navigate. O id da primeira tela do fluxo.flow_json_first_screen

Oferta por tempo limitado (Limited-Time Offer, ou LTO)

Os componentes de oferta por tempo limitado são tipos especiais usados para criar modelos de oferta por tempo limitado.

Exemplos de solicitação

Promoção sazonal

Um exemplo de solicitação para criar um modelo de marketing com os seguintes componentes:

  • Um cabeçalho com texto com uma variável e um valor de exemplo
  • Um corpo com texto com variáveis e valores de exemplo
  • Um rodapé com texto
  • Dois botões de resposta rápida
curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
  "name": "promocao_sazonal",
  "language": "pt_BR",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Nossa {{1}} está acontecendo!",
      "example": {
        "header_text": [
          "Promoção de Verão"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Compre agora até {{1}} e use o código {{2}} para obter {{3}} de desconto em todos os produtos.",
      "example": {
        "body_text": [
          [
            "o final de agosto","25OFF","25%"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "Use os botões abaixo para gerenciar suas inscrições de marketing"
    },
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Cancelar inscrição de Promoções"
        },
        {
          "type":"QUICK_REPLY",
          "text": "Cancelar inscrição de Todas"
        }
      ]
    }
  ]
}'

Confirmação de pedido

Um exemplo de solicitação para criar um modelo de utilidade com os seguintes componentes:

  • Um cabeçalho com documento com um valor de exemplo
  • Um corpo com texto com variáveis e valores de exemplo
  • Um botão de número de telefone
  • Um botão URL
curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
    "name": "confirmacao_pedido",
    "language": "pt_BR",
    "category": "UTILITY",
    "components": [
        {
            "type": "HEADER",
            "format": "DOCUMENT",
            "example": {
                "header_handle": [
                    "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf"
                ]
            }
        },
        {
            "type": "BODY",
            "text": "Obrigado pelo seu pedido, {{1}}! Seu número de pedido é {{2}}. Toque no PDF acima para ver seu recibo. Se tiver dúvidas, use os botões abaixo para entrar em contato com o suporte. Obrigado por ser nosso cliente!",
            "example": {
                "body_text": [
                    [
                        "Pablo",
                        "860198-230332"
                    ]
                ]
            }
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "PHONE_NUMBER",
                    "text": "Ligar",
                    "phone_number": "5511999999999"
                },
                {
                    "type": "URL",
                    "text": "Contatar Suporte",
                    "url": "https://wake.tech/"
                }
            ]
        }
    ]
}'

Atualização sobre entrega do pedido

Um exemplo de solicitação para criar um modelo de utilidade com os seguintes componentes:

  • Um cabeçalho com localização
  • Um corpo com texto com variáveis e valores de exemplo
  • Um rodapé
  • Um botão de resposta rápida

Modelos de autenticação

Caso seu app para celular ofereça aos usuários a opção de receber senhas descartáveis ou códigos de verificação via WhatsApp, você precisará usar um modelo de autenticação.

Os modelos de autenticação são compostos pelo seguinte:

  • Texto predefinido fixo: <VERIFICATION_CODE> é seu código de verificação.
  • Um aviso legal opcional: Para sua segurança, não compartilhe este código.
  • Um aviso sobre validade opcional: Este código expirará em <NUM_MINUTES> minutos.
  • Um botão de preencher automaticamente com um toque, um botão de copiar código ou nenhum botão, caso o método usado seja sem toque.

Saiba mais na documentação da Meta.

Preenchimento automático com um toque

Os modelos de autenticação de preenchimento automático com um toque permitem que você envie aos usuários uma senha ou um código descartável e um botão de preencher automaticamente com um toque. Quando um usuário do WhatsApp toca no botão de preenchimento automático, o cliente do WhatsApp dispara uma atividade que abre seu app e entrega a senha ou o código.

Preenchimento automático com um toque

Saiba mais na documentação da Meta.

Sintaxe

{
  "name": "<TEMPLATE_NAME>",
  "language": "<TEMPLATE_LANGUAGE>",
  "category": "authentication",
  "message_send_ttl_seconds": <TIME_T0_LIVE>, // Opcional
  "components": [
    {
      "type": "body",
      "add_security_recommendation": <SECURITY_RECOMMENDATION> // Opcional
    },
    {
      "type": "footer",
      "code_expiration_minutes": <CODE_EXPIRATION> // Opcional
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "otp",
          "otp_type": "one_tap",
          "text": "<COPY_CODE_BUTTON_TEXT>",  // Opcional
          "autofill_text": "<AUTOFILL_BUTTON_TEXT>", // Opcional
          "package_name": "<PACKAGE_NAME>",
          "signature_hash": "<SIGNATURE_HASH>"
        }
      ]
    }
  ]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<TEMPLATE_NAME>Obrigatório.
O nome do modelo.
Máximo de 512 caracteres.		codigo_verificacao
<TEMPLATE_LANGUAGE>Obrigatório.
O código de localidade e idioma do modelo
Consulte linguagens permitidas.		pt_BR
<TIME_TO_LIVE>Opcional.
O código de localidade e idioma do modelo
Valor do tempo de vida da mensagem de autenticação, em segundos. Consulte a seção Tempo de vida.		60
<SECURITY_RECOMMENDATION>Opcional.
Defina como true se quiser que o modelo inclua a string Para sua segurança, não compartilhe este código. Caso contrário, defina como false.		true
<CODE_EXPIRATION>Opcional.
A validade da senha ou do código em minutos.
Se for incluído, o aviso de expiração do código e esse valor serão exibidos na mensagem entregue. O botão será desabilitado na mensagem com base no número de minutos indicado, decorridos após o envio da mensagem.
Caso seja omitido, o aviso de expiração do código não será exibido na mensagem. Além disso, o botão será desabilitado 10 minutos após o envio da mensagem.
Mínimo 1, máximo 90.		5
<COPY_CODE_BUTTON_TEXT>Opcional.
O texto da etiqueta do botão de copiar código.
Se for omitido, o texto será, por padrão, um valor predefinido no idioma do modelo. Por exemplo, Copy Code para inglês (EUA).
Caso seja incluído, a mensagem do modelo de autenticação exibirá um botão de copiar código com esse texto.
Máximo de 25 caracteres.		Copiar Codigo
<AUTOFILL_BUTTON_TEXT>Opcional.
O texto da etiqueta do botão de preencher automaticamente com um toque.
Em caso de omissão, o texto de preenchimento automático será, por padrão, um valor predefinido no idioma do modelo. Por exemplo, Autofill para inglês (EUA).
Máximo de 25 caracteres.		Preencher Automaticamente
<PACKAGE_NAME>Obrigatório.
O nome do pacote do app Android.		com.example.myapplication
<SIGNATURE_HASH>Obrigatório.
O hash da chave de assinatura do app.		K8a%2FAINcGX7

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
  "name": "codigo_verificacao",
  "language": "pt_BR",
  "category": "authentication",
  "message_send_ttl_seconds": 60,
  "components": [
      {
          "type": "body",
          "add_security_recommendation": true
      },
      {
          "type": "footer",
          "code_expiration_minutes": 5
      },
      {
          "type": "buttons",
          "buttons": [
              {
                  "type": "otp",
                  "otp_type": "one_tap",
                  "text": "Copiar Codigo",
                  "autofill_text": "Preencher Automaticamente",
                  "package_name": "com.example.luckyshrub",
                  "signature_hash": "K8a%2FAINcGX7"
              }
          ]
      }
  ]
}'

Zero-Tap

Modelos de autenticação de zero-tap permitem que seus usuários recebam senhas ou códigos de uso único via WhatsApp sem precisar sair do seu aplicativo.

Quando um usuário no seu aplicativo solicita uma senha ou código e você a entrega usando um modelo de autenticação de zero-tap, o cliente do WhatsApp transmite a senha ou código incluído, e seu aplicativo pode capturá-lo imediatamente com um receptor de transmissão.

Aqui estão alguns exemplos que deixam claro para o usuário do aplicativo que seu código aparecerá automaticamente no aplicativo.

Preenchimento automático com um toque

Saiba mais na documentação da Meta.

Limitações

Veja as limitações em Meta.

Sintaxe

{
  "name": "<TEMPLATE_NAME>",
  "language": "<TEMPLATE_LANGUAGE>",
  "category": "authentication",
  "message_send_ttl_seconds": <TIME_T0_LIVE>, // Opcional
  "components": [
    {
      "type": "body",
      "add_security_recommendation": <SECURITY_RECOMMENDATION> // Opcional
    },
    {
      "type": "footer",
      "code_expiration_minutes": <CODE_EXPIRATION> // Opcional
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "otp",
          "otp_type": "zero_tap",
          "text": "<COPY_CODE_BUTTON_TEXT>",  // Opcional
          "autofill_text": "<AUTOFILL_BUTTON_TEXT>", // Opcional
          "package_name": "<PACKAGE_NAME>",
          "signature_hash": "<SIGNATURE_HASH>",
          "zero_tap_terms_accepted": <TERMS_ACCEPTED>
        }
      ]
    }
  ]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<TEMPLATE_NAME>Obrigatório.
O nome do modelo.
Máximo de 512 caracteres.		codigo_zero_tap_verificacao
<TEMPLATE_LANGUAGE>Obrigatório.
O código de localidade e idioma do modelo
Consulte linguagens permitidas.		pt_BR
<TIME_TO_LIVE>Opcional.
O código de localidade e idioma do modelo
Valor do tempo de vida da mensagem de autenticação, em segundos. Consulte a seção Tempo de vida.		60
<SECURITY_RECOMMENDATION>Opcional.
Defina como true se quiser que o modelo inclua a string Para sua segurança, não compartilhe este código. Caso contrário, defina como false.		true
<CODE_EXPIRATION>Opcional.
A validade da senha ou do código em minutos.
Se for incluído, o aviso de expiração do código e esse valor serão exibidos na mensagem entregue. O botão será desabilitado na mensagem com base no número de minutos indicado, decorridos após o envio da mensagem.
Caso seja omitido, o aviso de expiração do código não será exibido na mensagem. Além disso, o botão será desabilitado 10 minutos após o envio da mensagem.
Mínimo 1, máximo 90.		5
<COPY_CODE_BUTTON_TEXT>Opcional.
O texto da etiqueta do botão de copiar código.
Se for omitido, o texto será, por padrão, um valor predefinido no idioma do modelo. Por exemplo, Copy Code para inglês (EUA).
Caso seja incluído, a mensagem do modelo de autenticação exibirá um botão de copiar código com esse texto.
Máximo de 25 caracteres.		Copiar Codigo
<AUTOFILL_BUTTON_TEXT>Opcional.
O texto da etiqueta do botão de preencher automaticamente com um toque.
Em caso de omissão, o texto de preenchimento automático será, por padrão, um valor predefinido no idioma do modelo. Por exemplo, Autofill para inglês (EUA).
Máximo de 25 caracteres.		Preencher Automaticamente
<PACKAGE_NAME>Obrigatório.
O nome do pacote do app Android.		com.example.myapplication
<SIGNATURE_HASH>Obrigatório.
O hash da chave de assinatura do app.		K8a%2FAINcGX7
<TERMS_ACCEPTED>Obrigatório.
Definir como true para indicar que você compreende que o uso da autenticação de zero-tap está sujeito aos Termos de Serviço do WhatsApp Business, e que é de sua responsabilidade garantir que seus clientes estejam cientes de que o código será preenchido automaticamente em seu nome quando optarem por receber o código de zero-tap pelo WhatsApp.
Se definido para false, o template não sera cadastrado pois é necessario aceitar os termos de zero-tap antes de criar o template.		true

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
  "name": "codigo_zero_tap_verificacao",
  "language": "pt_BR",
  "category": "authentication",
  "message_send_ttl_seconds": 60,
  "components": [
      {
          "type": "body",
          "add_security_recommendation": true
      },
      {
          "type": "footer",
          "code_expiration_minutes": 5
      },
      {
          "type": "buttons",
          "buttons": [
              {
                  "type": "otp",
                  "otp_type": "zero_tap",
                  "text": "Copiar Codigo",
                  "autofill_text": "Preencher Automaticamente",
                  "package_name": "com.example.luckyshrub",
                  "signature_hash": "K8a%2FAINcGX7",
                  "zero_tap_terms_accepted": true
              }
          ]
      }
  ]
}'

Copy Code

Os modelos de autenticação de copy code permitem que você envie uma senha ou código de uso único, juntamente com um botão de copy code, para seus usuários. Quando um usuário do WhatsApp toca no botão de copy code, o cliente do WhatsApp copia a senha ou código para a área de transferência do dispositivo. O usuário pode então alternar para o seu aplicativo e colar a senha ou código no seu aplicativo.

Limitações

Veja as limitações em Meta.

Sintaxe

{
  "name": "<TEMPLATE_NAME>",
  "language": "<TEMPLATE_LANGUAGE>",
  "category": "authentication",
  "message_send_ttl_seconds": <TIME_T0_LIVE>, // Opcional
  "components": [
    {
      "type": "body",
      "add_security_recommendation": <SECURITY_RECOMMENDATION> // Opcional
    },
    {
      "type": "footer",
      "code_expiration_minutes": <CODE_EXPIRATION> // Opcional
    },
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "otp",
          "otp_type": "copy_code",
          "text": "<COPY_CODE_BUTTON_TEXT>",  // Opcional
        }
      ]
    }
  ]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<TEMPLATE_NAME>Obrigatório.
O nome do modelo.
Máximo de 512 caracteres.		codigo_copy_code_verificacao
<TEMPLATE_LANGUAGE>Obrigatório.
O código de localidade e idioma do modelo
Consulte linguagens permitidas.		pt_BR
<TIME_TO_LIVE>Opcional.
O código de localidade e idioma do modelo
Valor do tempo de vida da mensagem de autenticação, em segundos. Consulte a seção Tempo de vida.		60
<SECURITY_RECOMMENDATION>Opcional.
Defina como true se quiser que o modelo inclua a string Para sua segurança, não compartilhe este código. Caso contrário, defina como false.		true
<CODE_EXPIRATION>Opcional.
A validade da senha ou do código em minutos.
Se for incluído, o aviso de expiração do código e esse valor serão exibidos na mensagem entregue. O botão será desabilitado na mensagem com base no número de minutos indicado, decorridos após o envio da mensagem.
Caso seja omitido, o aviso de expiração do código não será exibido na mensagem. Além disso, o botão será desabilitado 10 minutos após o envio da mensagem.
Mínimo 1, máximo 90.		5
<COPY_CODE_BUTTON_TEXT>Opcional.
O texto da etiqueta do botão de copiar código.
Se for omitido, o texto será, por padrão, um valor predefinido no idioma do modelo. Por exemplo, Copy Code para inglês (EUA).
Caso seja incluído, a mensagem do modelo de autenticação exibirá um botão de copiar código com esse texto.
Máximo de 25 caracteres.		Copiar Codigo

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
  "name": "codigo_copy_code_verificacao",
  "language": "pt_BR",
  "category": "authentication",
  "message_send_ttl_seconds": 60,
  "components": [
      {
          "type": "body",
          "add_security_recommendation": true
      },
      {
          "type": "footer",
          "code_expiration_minutes": 5
      },
      {
          "type": "buttons",
          "buttons": [
              {
                  "type": "otp",
                  "otp_type": "copy_code",
                  "text": "Copiar Codigo"
              }
          ]
      }
  ]
}'

Modelos de catálogo

Os modelos de catálogo são modelos de marketing que permitem que você apresente seu catálogo de produtos inteiramente dentro do WhatsApp. Os modelos de catálogo exibem uma imagem de cabeçalho em miniatura do produto de sua escolha e texto personalizado no corpo, juntamente com um cabeçalho de texto fixo e um subtítulo de texto fixo.

Saiba mais na documentação da Meta.

Requisitos

Voce deve ter um inventário carregado na Meta em um catálogo de ecommerce conectado à sua conta de Whatsapp Business Account

Sintaxe

{
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "<BODY_TEXT>",
      "example": {
        "body_text": [
          [
            "<EXAMPLE_BODY_TEXT>"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "<FOOTER_TEXT>"
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "CATALOG",
          "text": "View catalog"
        }
      ]
    }
  ]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<NAME>Obrigatório.
O nome do modelo.
Máximo de 512 caracteres.		modelo_catalogo
<LANGUAGE>Obrigatório.
O código de localidade e idioma do modelo
Consulte linguagens permitidas.		pt_BR
<BODY_TEXT>Obrigatório.
Texto do corpo do template. Variaveis são suportadas		Compre agora seus produtos favoritos aqui no Whatsapp! Ganhe {{1}} de desconto nas compras acima de {{2}} reais!
<EXAMPLE_BODY_TEXT>Obrigatório caso BODY_TEXT use variaveis
Matriz de exemplos de strings. O número de strings deve corresponder ao número de variáveis incluídas na string.		"20%", "100"
<FOOTER_TEXT>Opcional
Texto de rodapé. Variáveis são suportadas		Melhores ofertas de compras aqui no Whatsapp!

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
  "name": "modelo_catalogo",
  "language": "pt_BR",
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "Compre agora seus produtos favoritos aqui no Whatsapp! Ganhe {{1}} de desconto nas compras acima de {{2}} reais!",
      "example": {
        "body_text": [
          [
            "20%",
            "100"
          ]
        ]
      }
    },
    {
      "type": "FOOTER",
      "text": "Melhores ofertas de compras aqui no Whatsapp!"
    },
    {
      "type": "BUTTONS",
      "buttons": [
        {
          "type": "CATALOG",
          "text": "View catalog"
        }
      ]
    }
  ]
}'

Modelos carroussel

Este documento descreve os modelos de carrossel e explica como usá-los. Os modelos de carrossel permitem enviar uma única mensagem de texto acompanhada por um conjunto de até 10 cartões de carrossel em uma visualização que pode ser rolada horizontalmente:​

Saiba mais na documentação da Meta.

Sintaxe

{
  "name": "<TEMPLATE_NAME>",
  "language": "<TEMPLATE_LANGUAGE>",
  "category": "<TEMPLATE_CATEGORY>",
  "components": [

    /* Balão de mensagem, obrigatório */
    {
      "type": "BODY",
      "text": "<BUBBLE_TEXT>",
      "example": {
        "body_text": [["<BUBBLE_TEXT_VAR_EXAMPLE>"]]
      }
    },

    /* Cartões de carrossel */
    {
      "type": "CAROUSEL",
      "cards": [

        /* Primeiro cartão de carrossel */
        {
          "components": [
            {
              "type": "HEADER",
              "format": "<CARD_HEADER_FORMAT>",
              "example": {
                "header_handle": ["<CARD_HEADER_HANDLE>"]
              }
            },
            {
              "type": "BODY",
              "text": "<CARD_BODY_TEXT>",
              "example": {
                "body_text": [["<CARD_BODY_TEXT_VAR_EXAMPLE>"]]
              }
            },

            /*Pelo menos um botão obrigatório */
            {
              "type": "BUTTONS",
              "buttons": [
                {
                  "type": "QUICK_REPLY",
                  "text": "<QUICK_REPLY_BUTTON_TEXT>"
                },
                {
                  "type": "URL",
                  "text": "<URL_BUTTON_TEXT>",
                  "url": "<URL_BUTTON_URL>",
                  "example": ["<URL_BUTTON_VAR_EXAMPLE>"]
                }
              ]
            }
          ]
        },
     
        /* Cartões adicionais seguiriam a mesma estrutura do primeiro cartão */
      ]
    }
  ]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<BUBBLE_TEXT>Obrigatório.
String de texto do balão de mensagem . Compatível com variáveis.
Máximo de 1.024 caracteres.		O verão está aqui, e temos os produtos mais frescos ao redor! Use o código {{1}} para obter {{2}} de desconto na sua próxima compra.
<BUBBLE_TEXT_VAR_EXAMPLE>Obrigatório se a string de texto do balão de mensagem tiver variáveis.
Uma matriz de strings de variáveis de exemplo. O número de strings deve corresponder ao número de variáveis incluídas na string.		"15OFF","15%"
<CARD_BODY_TEXT>Obrigatório.
O corpo do texto do cartão. Compatível com variáveis.
Máximo de 160 caracteres.		Limões raros para coquetéis únicos. Use o código {{1}} para obter {{2}} de desconto em todos os produtos.
<CARD_BODY_TEXT_VAR_EXAMPLE>Obrigatório ao usar um texto do corpo do cartão com variáveis.
As variáveis de exemplo do texto do corpo do cartão.		"15OFF","15%"
<CARD_HEADER_FORMAT>Obrigatório.
O formato do cabeçalho de mídia do cartão. Precisa ser IMAGE ou VIDEO.		IMAGE
<CARD_HEADER_HANDLE>Obrigatório.
URL da midia a ser carregada.		https://wake.tech/wp-content/uploads/2023/07/Wake-Experience-Logo-300x135.png
<QUICK_REPLY_BUTTON_TEXT>Obrigatório ao usar um botão de resposta rápida.
O texto da etiqueta do botão de resposta rápida.
Máximo de 25 caracteres.		Enviar mais como este
<TEMPLATE_CATEGORY>Obrigatório.
Precisa ser MARKETING ou UTILITY.		MARKETING
<TEMPLATE_LANGUAGE>Obrigatório.
O código de localidade e idioma do modelo
Consulte linguagens permitidas.		pt_BR
<TEMPLATE_NAME>Obrigatório.
O nome do modelo.
Máximo de 512 caracteres.		modelo_carossel
<URL_BUTTON_TEXT>Obrigatório ao usar um botão URL.
O texto da etiqueta do botão URL. Compatível com 1 variável.
Máximo de 25 caracteres.		Compre agora
<URL_BUTTON_URL>Obrigatório ao usar um botão URL.
A URL do site carregada no navegador-padrão da web para celular quando o usuário do app toca no botão URL. Compatível com 1 variável, adicionada ao final da string da URL.
Máximo de 2.000 caracteres.		https://www.luckyshrub.com/shop?promo={{1}}
<URL_BUTTON_VAR_EXAMPLE>Obrigatório ao usar um botão URL.
A URL do site. Compatível com 1 variável.
Ao usar uma variável, adicione um exemplo de propriedade de variável ao final da string da URL. A URL é carregada no navegador-padrão da web para celular do dispositivo quando o cliente toca no botão URL.
Máximo de 2.000 caracteres.		https://www.luckyshrub.com/shop?promo=verao_limoes_2023

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
  "name": "modelo_carossel",
  "language": "pt_BR",
  "category": "MARKETING",
  "components": [
    {
      "type": "BODY",
      "text": "O verão está aqui, e temos os produtos mais frescos ao redor! Use o código {{1}} para obter {{2}} de desconto na sua próxima compra.",
      "example": {
        "body_text": [
          [
            "15OFF",
            "15%"
          ]
        ]
      }
    },
    {
      "type": "CAROUSEL",
      "cards": [
        {
          "components": [
            {
              "type": "HEADER",
              "format": "IMAGE",
              "example": {
                "header_handle": [
                  "https://wake.tech/wp-content/uploads/2023/07/Wake-Experience-Logo-300x135.png"
                ]
              }
            },
            {
              "type": "BODY",
              "text": "Limões raros para coquetéis únicos. Use o código {{1}} para obter {{2}} de desconto em todos os produtos.",
              "example": {
                "body_text": [
                  [
                    "15OFF",
                    "15%"
                  ]
                ]
              }
            },
            {
              "type": "BUTTONS",
              "buttons": [
                {
                  "type": "QUICK_REPLY",
                  "text": "Enviar mais como este"
                },
                {
                  "type": "URL",
                  "text": "Compre agora",
                  "url": "https://www.luckyshrub.com/shop?promo={{1}}",
                  "example": [
                    "https://www.luckyshrub.com/shop?promo=verao_limoes_2023"
                  ]
                }
              ]
            }
          ]
        },
        {
          "components": [
            {
              "type": "HEADER",
              "format": "IMAGE",
              "example": {
                "header_handle": [
                  "https://wake.tech/wp-content/uploads/2023/07/Wake-Experience-Logo-300x135.png"
                ]
              }
            },
            {
              "type": "BODY",
              "text": "Frutas exóticas para coquetéis únicos! Use o código {{1}} para obter {{2}} de desconto em todos os produtos exóticos.",
              "example": {
                "body_text": [
                  [
                    "20OFFEXOTIC",
                    "20%"
                  ]
                ]
              }
            },
            {
              "type": "BUTTONS",
              "buttons": [
                {
                  "type": "QUICK_REPLY",
                  "text": "Enviar mais como este"
                },
                {
                  "type": "URL",
                  "text": "Compre agora",
                  "url": "https://www.luckyshrub.com/shop?promo={{1}}",
                  "example": [
                    "https://www.luckyshrub.com/shop?promo=exotico_produzir_2023"
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}'

Modelos 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.

Saiba mais na documentação da Meta.

Limitações

Veja as limitações em Meta.

Sintaxe

{
  "name": "<NAME>",
  "language": "<LANGUAGE>",
  "category": "MARKETING",
  "components": [
    ... // Componentes adicionais, caso necessário.
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type":"COPY_CODE",
          "example": "<EXAMPLE>"
        },
        ... // Botões adicionais, caso necessário.
      ]
    }
  ]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<NAME>Obrigatório.
O nome do modelo.
Máximo de 512 caracteres.		prod_promocaoinverno2023_coupon_v1_0
<LANGUAGE>Obrigatório.
O código de localidade e idioma do modelo.		pt_BR
<EXAMPLE>Obrigatório.
O código do cupom que deve ser copiado quando o cliente toca no botão.
Máximo de 15 caracteres.		25OFF

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
    "name": "modelo_promocao_outono_2023",
    "language": "pt_BR",
    "category": "MARKETING",
    "components": [
        {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Nossa Promoção de Outono está no ar!"
        },
        {
            "type": "BODY",
            "text": "Compre agora até novembro e use o código {{1}} para obter {{2}} de desconto em todos os produtos!",
            "example": {
                "body_text": [
                    [
                        "25OFF",
                        "25%"
                    ]
                ]
            }
        },
        {
            "type": "BUTTONS",
            "buttons": [
                {
                    "type": "QUICK_REPLY",
                    "text": "Cancelar inscrição"
                },
                {
                    "type": "COPY_CODE",
                    "example": ["250FF"]
                }
            ]
        }
    ]
}'

Modelos de oferta por tempo limitado (Limited-Time Offer, ou LTO)

Este documento descreve modelos de oferta por tempo limitado (Limited-Time Offer, ou LTO) e como usá-los.

Os modelos de oferta por tempo limitado permitem que você exiba datas de expiração e cronômetros de contagem regressiva em andamento para códigos de oferta em mensagens de modelo, facilitando a comunicação de ofertas com prazo definido e impulsionando o envolvimento do cliente.

Saiba mais na documentação da Meta.

Limitações

Veja as limitações em Meta.

Sintaxe

{
  "name": "<TEMPLATE_NAME>",
  "language": "<TEMPLATE_LANGUAGE>",
  "category": "marketing",
  "components": [

    /* Componente opcional de header. */
    {
      "type": "header",
      "format": "<HEADER_FORMAT>",
      "example": {
        "header_handle": [
          "<HEADER_ASSET_HANDLE>"
        ]
      }
    },

    /* Componente de oferta por tempo limitado obrigatório. */
    {
      "type": "limited_time_offer",
      "limited_time_offer": {
        "text": "<LIMITED_TIME_OFFER_TEXT>",
        "has_expiration": <HAS_EXPIRATION>
      }
    },

    /* Componente do corpo obrigatório. */
    {
      "type": "body",
      "text": "<BODY_TEXT>",
      "example": {
        "body_text": [<BODY_TEXT_VARIABLE_EXAMPLES>]
      }
    },

    /* O componente do botão de cópia de código é necessário se "has_expiration" estiver definido como verdadeiro.
       Se definido como falso, mas quiser usar um botão de cópia de código, ele deverá aparecer primeiro na matriz "botões".
       O componente do botão URL é sempre obrigatório. */
    {
      "type": "buttons",
      "buttons": [
        {
          "type": "copy_code",
          "example": "<OFFER_CODE_EXAMPLE>"
        },
        {
          "type": "url",
          "text": "<URL_BUTTON_TEXT>",
          "url": "<URL_BUTTON_URL>",
          "example": [
            "<URL_EXAMPLE_WITH_VARIABLE_EXAMPLE>"
          ]
        }
      ]
    }
  ]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<BODY_TEXT>Obrigatório. Texto do componente de corpo. Suporta variáveis. Máximo de 600 caracteres.Boas notícias, {{1}}! Use o código {{2}} para obter 25% de desconto em todos os pacotes de Destino no Caribe!
<BODY_TEXT_VARIABLE_EXAMPLES>Obrigatório se o texto do componente de corpo usar variáveis. Array de strings de exemplo de variáveis. Deve fornecer exemplos para todos os espaços reservados na string <BODY_TEXT>. Sem máximo, mas conta para o máximo de <BODY_TEXT>.["Pablo","CARIBE25"]
<HAS_EXPIRATION>Opcional. Defina como true para mostrar os detalhes da oferta por tempo limitado na mensagem entregue. Se definido como true, o componente do botão de cópia do código deve ser incluído no array buttons e deve aparecer primeiro no array. Se definido como false, os detalhes da oferta com prazo de validade não aparecerão na mensagem entregue e o componente do botão de cópia do código é opcional. Se incluir o botão de cópia do código, ele deve aparecer primeiro no array buttons.true
<HEADER_ASSET_HANDLE>Obrigatório se estiver usando um cabeçalho de imagem ou vídeo. URL da midia a ser carregada.https://wake.tech/wp-content/uploads/2023/07/Wake-Experience-Logo-300x135.png
<HEADER_FORMAT>Obrigatório se estiver usando um cabeçalho. Pode ser IMAGE ou VIDEO.IMAGE
<LIMITED_TIME_OFFER_TEXT>Obrigatório. Texto de detalhes da oferta. Máximo de 16 caracteres.Oferta expirando!
<OFFER_CODE_EXAMPLE>Obrigatório. Exemplo de código de oferta. Máximo de 15 caracteres.CARIBE25
<TEMPLATE_LANGUAGE>Obrigatório. Código de idioma e localização do modelo.pt_BR
<TEMPLATE_NAME>Obrigatório. Nome do modelo. Máximo de 512 caracteres.modelo_oferta_tempo_limitado
<URL_BUTTON_TEXT>Obrigatório. Texto do rótulo do botão de URL. Suporta 1 variável. Máximo de 25 caracteres.Reserve agora!
<URL_BUTTON_URL>Obrigatório. URL do site que carrega no navegador da web móvel padrão do dispositivo quando o botão de URL é tocado pelo usuário do WhatsApp. Suporta 1 variável adicionada ao final da string de URL. Máximo de 2000 caracteres.https://destinosincriveis.com/ofertas?code={{1}}
<URL_EXAMPLE_WITH_VARIABLE_EXAMPLE>Obrigatório se a URL usar uma variável. URL de exemplo com uma variável de exemplo adicionada ao final. Sem máximo, mas o valor conta para o máximo de <URL_BUTTON_URL>.https://destinosincriveis.com/ofertas?ref=n3mtql

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
    "name": "modelo_oferta_tempo_limitado",
    "language": "pt_BR",
    "category": "marketing",
    "components": [
        {
            "type": "header",
            "format": "image",
            "example": {
                "header_handle": [
                    "https://wake.tech/wp-content/uploads/2023/07/Wake-Experience-Logo-300x135.png"
                ]
            }
        },
        {
            "type": "limited_time_offer",
            "limited_time_offer": {
                "text": "Oferta expirando",
                "has_expiration": true
            }
        },
        {
            "type": "body",
            "text": "Boas notícias, {{1}}! Use o código {{2}} para obter 25% de desconto em todos os pacotes de Destino no Caribe!",
            "example": {
                "body_text": [
                    [
                        "Pablo",
                        "CARIBE25"
                    ]
                ]
            }
        },
        {
            "type": "buttons",
            "buttons": [
                {
                    "type": "copy_code",
                    "example": [
                        "CARIBE25"
                    ]
                },
                {
                    "type": "url",
                    "text": "Reserve agora!",
                    "url": "https://destinosincriveis.com/ofertas?code={{1}}",
                    "example": [
                        "https://destinosincriveis.com/ofertas?ref=n3mtql"
                    ]
                }
            ]
        }
    ]
}'

Modelos Multi-Product Message (MPM)

Os modelos MPM podem ser usados para iniciar conversas de marketing. Eles permitem que você destaque até 30 produtos do seu catálogo de ecommerce, organizados em até 10 seções, em uma única mensagem.

Os clientes podem navegar por produtos e seções dentro da mensagem, visualizar detalhes de cada produto, adicionar e remover produtos do carrinho e enviar o carrinho para fazer um pedido. Os pedidos são então enviados para você por meio de um webhook.

Saiba mais na documentação da Meta.

Requisitos

Para criar e usar modelos MPM, é necessário ter um catálogo de produtos de ecommerce, com inventário, conectado à sua Whatsapp Business Account.

Limitações

  • Os clientes precisam estar usando o WhatsApp v2.22.24 ou uma versão mais recente.
  • Os modelos MPM não podem ser encaminhados para outros clientes.

Sintaxe

{
  "name": "<NAME>",
  "category": "<CATEGORY>",
  "language": "<LANGUAGE>",
  "components": [
  {
    "type": "HEADER",
    "format": "TEXT",
    "text": "<HEADER_TEXT>",
    
    /* Example obrigatório caso header use variavel */
    "example": {
      "header_text": [
        "<HEADER_EXAMPLE_TEXT>"
      ]
    }
  },
  {
    "type": "BODY",
    "text": "<BODY_TEXT>",

    /* Example obrigatório caso body use variavel  */
​​    "example": {
      "body_text": [
        [
          "<BODY_EXAMPLE_TEXT>"
        ]
      ]
    }
  },
  {
    "type": "FOOTER",
    "text": "<FOOTER_TEXT>"
  },
  {
    "type":"BUTTONS",
    "buttons": [
      {
        "type": "MPM",
        "text": "View items"
      }
    ]
  }
]
}

Propriedades

Espaço reservadoDescriçãoValor de exemplo
<NAME>O nome do modelo.
Máximo de 512 caracteres.		modelo_oferta_multiprodutos
<CATEGORY>A categoria do modelo.
Consulte categorias de modelo.		MARKETING
<LANGUAGE>O código de localidade e idioma do modelo
Consulte linguagens permitidas.		pt_BR
<HEADER_TEXT>Texto do cabeçalho do modelo. Suporta 1 variável.
Se a string contiver uma variável, você deve incluir a propriedade de exemplo e um valor de variável de exemplo.
Máximo de 60 caracteres.		Esqueceu algo, {{1}}?
<HEADER_EXAMPLE_TEXT>Exemplo de variavel do cabeçalho.Pablo
<BODY_TEXT>Texto do corpo do modelo. Suporta 1 variável.
Se a string contiver uma variável, você deve incluir a propriedade de exemplo e um valor de variável de exemplo.
Máximo de 1024 caracteres.		Parece que voce esqueceu alguns itens no carrinho, ainda esta interessado? Use codigo {{1}} para ganhar descontos nos itens restantes!
<BODY_EXAMPLE_TEXT>String ou matriz de string. Valor de exemplo do corpoCODE100
<FOOTER_TEXT>Texto do rodapé do modelo
Máximo de 60 caracteres		Visite agora nosso catalogo!

Exemplo de solicitação

curl --location 'https://api-cerberus-kong.socialminer.tech/api/Templates' \
--header 'Content-Type: application/json' \
--header 'apikey: {{ApiKey}}' \
--header 'version: 6.0' \
--data '{
  "name": "modelo_oferta_multiprodutos",
  "language": "pt_BR",
  "category": "MARKETING",
  "components": [
    {
      "type": "HEADER",
      "format": "TEXT",
      "text": "Esqueceu algo, {{1}}?",
      "example": {
        "header_text": [
          "Pablo"
        ]
      }
    },
    {
      "type": "BODY",
      "text": "Parece que voce esqueceu alguns itens no carrinho, ainda esta interessado? Use codigo {{1}} para ganhar descontos nos itens restantes!",
      "example": {
        "body_text": [
          [
            "CODE100"
          ]
        ]
      }
    },
    {
      "type":"BUTTONS",
      "buttons": [
        {
          "type": "MPM",
          "text": "View items"
        }
      ]
    }
  ]
}'
Language
Click Try It! to start a request and see the response here!