API Oficial Botão URL

Envia uma mensagem com um botão que abre um link, estando com a Janela de Atendimento ao Cliente aberta.

API: Oficial

Endpoint

https://apichat.agpt.com.br/api/messages/sendCTAURL

Método

POST

Autenticação

Bearer {seutokenaqui}

Payload

{
    "number": "554130776744",
    "type": "button",
    "header": {
        "type": "text",
        "text": "Catálogo 2026"
    },
    "body": {
      "text": "Confira nosso catálogo completo e escolha o que mais combina com você."
    },
    "footer": {
        "text": "Rodapé opcional"
    },
    "displayText": "Visitar site",
    "url": "https://www.meusite.com.br/produtos",
    "openTicket": 1,
    "queueId": 1
}

“number”: telefone do destinatário no formato ddi ddd numero (somente números).

“type”: button.

“header”: cabeçalho opcional. Pode ser texto, imagem, vídeo ou documento, no formato da Meta.

Texto: {"type": "text", "text": "Meu cabeçalho"}

Imagem: {"type": "image", "image": {"link": "https://meusite.com.br/foto.jpg"}}

Vídeo: {"type": "video", "video": {"link": "https://meusite.com.br/video.mp4"}}

Documento: {"type": "document", "document": {"link": "https://meusite.com.br/catalogo.pdf", "filename": "catalogo.pdf"}}

Áudio não existe no cabeçalho: a Meta não aceita.

“body”: o texto da mensagem, dentro de text. Até 1024 caracteres. Obrigatório.

“footer”: rodapé opcional, dentro de text.

“displayText”: o rótulo do botão, até 20 caracteres (limite da Meta). Obrigatório.

“url”: o endereço que o botão abre. Precisa começar com http:// ou https://. Obrigatório.

“queueId”: ID do Setor para onde a conversa vai quando "openTicket": 1.

Aqui o openTicket não funciona como nas outras chamadas: 1 deixa a conversa em Aguardando no Setor de queueId; qualquer outro valor — inclusive não enviar o campo — ENCERRA o atendimento depois do envio.

Só passa dentro da janela de 24 horas. Fora dela a Meta recusa, e o caminho é um template aprovado.

A mensagem fica gravada no atendimento com o texto e o rótulo do botão com o link.

Recusa da Meta vira mensagem de erro dentro do próprio atendimento.

Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://apichat.agpt.com.br/api/messages/sendCTAURL',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "number": "554130776744",
    "type": "button",
    "header": {
        "type": "text",
        "text": "Catálogo 2026"
    },
    "body": {
      "text": "Confira nosso catálogo completo e escolha o que mais combina com você."
    },
    "footer": {
        "text": "Rodapé opcional"
    },
    "displayText": "Visitar site",
    "url": "https://www.meusite.com.br/produtos",
    "openTicket": 1,
    "queueId": 1
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
Copiar como cURL