API Oficial Mensagem de Lista

🧩 Envia uma mensagem com uma Lista de opções, estando com a Janela de Atendimento ao Cliente aberta, para o usuário escolher uma resposta. O título da opção é a resposta devolvida quando o lead escolhe.

API: Oficial

Endpoint

https://{BACKEND_URL}/api/messages/sendInteractive

Método

POST

Autenticação

Bearer {seutokenaqui}

Payload

{
    "number": "5511999999999",
    "type": "list",
    "header": {
        "type": "text",
        "text": "Texto do Header"
    },
    "body": {
        "text": "Texto do Body"
    },
    "footer": {
        "text": "Rodapé"
    },
    "action": {
        "sections": [
            {
                "title": "Titulo da lista A",
                "rows": [
                    {
                        "id": 1,
                        "title": "Linha 01 - lista A",
                        "description": "descricao 01 - lista A"
                    },
                    {
                        "id": 2,
                        "title": "Linha 02 - lista A",
                        "description": "descricao 02 - lista A"
                    }
                ]
            },
            {
                "title": "Titulo da lista B",
                "rows": [
                    {
                        "id": 3,
                        "title": "Linha 03 - lista B",
                        "description": "descricao 03 - lista B"
                    },
                    {
                        "id": 4,
                        "title": "Linha 04 - lista B",
                        "description": "descricao 04 - lista B"
                    }
                ]
            }
        ],
        "button": "Lista de opções"
    }
}

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

➡️ “type”: list.

➡️ “header”: cabeçalho opcional, no campo text.

➡️ “body”: sua mensagem, no campo text (máximo de 1024 caracteres).

➡️ “footer”: rodapé opcional, no campo text.

➡️ “action”: o conteúdo da lista, sendo que:

◽ sections: cada seção da lista, com title (título da seção) e rows (as opções dela).

◽ cada opção dentro de rows tem id, title e description.

◽ button: texto do botão que, ao ser clicado, exibe as opções da lista.

Adicione mais seções e opções se desejar.

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://{BACKEND_URL}/api/messages/sendInteractive',
  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": "5511999999999",
    "type": "list",
    "header": {
        "type": "text",
        "text": "Texto do Header"
    },
    "body": {
        "text": "Texto do Body"
    },
    "footer": {
        "text": "Rodapé"
    },
    "action": {
        "sections": [
            {
                "title": "Titulo da lista A",
                "rows": [
                    {
                        "id": 1,
                        "title": "Linha 01 - lista A",
                        "description": "descricao 01 - lista A"
                    },
                    {
                        "id": 2,
                        "title": "Linha 02 - lista A",
                        "description": "descricao 02 - lista A"
                    }
                ]
            },
            {
                "title": "Titulo da lista B",
                "rows": [
                    {
                        "id": 3,
                        "title": "Linha 03 - lista B",
                        "description": "descricao 03 - lista B"
                    },
                    {
                        "id": 4,
                        "title": "Linha 04 - lista B",
                        "description": "descricao 04 - lista B"
                    }
                ]
            }
        ],
        "button": "Lista de opções"
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;