Envio de templates interativos

POST/rest/sendMessage/{{instance_key}}/templateMessage

Enviar Templates com Botões de Ação

O templateMessage é um tipo especial de mensagem que permite o envio de uma mensagem com botões interativos, como copyButton, urlButton, callButton, entre outros. Esses botões oferecem funcionalidades especiais que tornam a interação mais dinâmica e conveniente para os usuários.

:::danger[]
Aviso Importante
📅 Esta documentação foi atualizada em 29/10/2024. Cada atualização do WhatsApp pode alterar o comportamento dos botões, por isso é essencial estar sempre atento às mudanças e ajustes. 🔄
:::

Exemplo do envio com imagem

{
    "messageData": {
        "to": "556195562618@s.whatsapp.net",
        "title": "Message Title",
        "text": "Message Text",
        "footer": "Message Footer",
        "type": "image", 
        "mediaUrl": "https://mega-api-painel.app.br/arquivos_doc/megaapi.png",
        "buttons": [
            {
                "type": "copy",
                "title": "This is a copyButton",
                "payload": "Your text for copy"
            },
            {
                "type": "url",
                "title": "This is a urlButton",
                "payload": "https://google.com"
            },
            {
                "type": "call",
                "title": "This is a callButton",
                "payload": "918788889688"
            }
        ]
    }
}

Exemplo do envio com video

{
    "messageData": {
        "to": "556195562618@s.whatsapp.net",
        "title": "Message Title",
        "text": "Message Text",
        "footer": "Message Footer",
        "type": "video", 
        "mediaUrl": "https://mega-api-painel.app.br/arquivos_doc/video.mp4",
        "buttons": [
            {
                "type": "copy",
                "title": "This is a copyButton",
                "payload": "Your text for copy"
            },
            {
                "type": "url",
                "title": "This is a urlButton",
                "payload": "https://google.com"
            },
            {
                "type": "call",
                "title": "This is a callButton",
                "payload": "918788889688"
            }
        ]
    }
}

Exemplo do envio com document

{
    "messageData": {
        "to": "556195562618@s.whatsapp.net",
        "title": "Message Title",
        "text": "Message Text",
        "footer": "Message Footer",
        "type": "document", 
        "mediaUrl": "https://araucariageneticabovina.com.br/arquivos/servico/pdfServico_57952bf8ca7af_24-07-2016_17-58-32.pdf",
        "buttons": [
            {
                "type": "copy",
                "title": "This is a copyButton",
                "payload": "Your text for copy"
            },
            {
                "type": "url",
                "title": "This is a urlButton",
                "payload": "https://google.com"
            },
            {
                "type": "call",
                "title": "This is a callButton",
                "payload": "918788889688"
            }
        ]
    }
}

Request

Authorization: Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Exemplo

Authorization: Bearer 2f68dbbf-519d-4f01-9636-e2421b68f379

Parâmetros Header

Authorization

string

requerido

Exemplo:

Bearer {{token}}

Content-Type

string

opcional

Exemplo:

application/json

object {0}

{
  "messageData": {
    "to": "556195562618@s.whatsapp.net",
    "title": "megaAPI",
    "text": "megaAPI - A melhor api whatsapp do Brasil",
    "footer": "Acesse uma das opções abaixo",
    "type": "text",
    "mediaUrl": "",
    "buttons": [
      {
        "type": "copy",
        "title": "Copiar link do site",
        "payload": "https://mega-api.app.br"
      },
      {
        "type": "url",
        "title": "Acesse o site da megaAPI",
        "payload": "https://mega-api.app.br"
      },
      {
        "type": "call",
        "title": "Chamar a megaAPI",
        "payload": "556195562618"
      }
    ]
  }
}

Request samples

Respostas

Success(200)

Não autorizado(200)

Whatsapp inválido(200)

HTTP Code: 200

Content Type : JSONapplication/json

error

boolean

requerido

message

string

requerido

messageData

object

requerido

key

object

requerido

message

object

requerido

messageTimestamp

string

requerido

status

string

requerido

{
  "error": false,
  "message": "Message sent",
  "messageData": {
    "key": {
      "remoteJid": "5511999999999@s.whatsapp.net",
      "fromMe": true,
      "id": "BAE5403BBB515C2F"
    },
    "message": {
      "listMessage": {
        "title": "TEste",
        "description": "Testanto",
        "buttonText": "Escolha",
        "listType": "SINGLE_SELECT",
        "sections": [
          {
            "title": "PIX",
            "rows": [
              {
                "title": "PIX",
                "description": "pagamento via pix",
                "rowId": "01"
              }
            ]
          }
        ],
        "footerText": "Selecione uma forma de pagamento"
      }
    },
    "messageTimestamp": "1658283308",
    "status": "PENDING"
  }
}