Enviar texto com botões de ação

Método#

/send-button-actions#

POST https://api.plugzapi.com.br/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-button-actions

Conceituação#

Neste método você poderá enviar mensagens de texto com botões de ação, você conseguirá redirecionar para links, fazer chamadas, e também dar respostas padrões.

Atributos#

Obrigatórios#

Atributos	Tipo	Descrição
phone	string	Telefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NUMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara
message	string	Texto a ser enviado
buttonActions	buttonActions	Objeto do tipo botão

button Actions#

Atributos	Tipo	Descrição
type	string	Tipos de botão a ser enviados (CALL, URL, REPLY)
phone	string	Número atribuído ao botão caso seja do tipo CALL
URL	string	Link atribuído ao botão caso seja do tipo URL
label	string	Texto para o botão

Opcionais Button#

Atributos	Tipo	Descrição
id	string	Identificador do botão
title	string	Caso queira enviar um título
footer	string	Caso queira enviar um rodapé

Opcionais#

Atributos	Tipo	Descrição
delayMessage	number	Nesse atributo um delay é adicionado na mensagem. Você pode decidir entre um range de 1~15 sec, significa quantos segundos ele vai esperar para enviar a próxima mensagem. (Ex "delayMessage": 5, ). O delay default caso não seja informado é de 1~3 sec

Request Body#

{
    "phone": "551199999999",
    "message": "uma mensagem",
    "title": "se quiser vincular um titulo",
    "footer": "se quiser vincular um rodape top",
    "buttonActions": [
        {
            "id": "1",
            "type": "CALL",
            "phone": "554499999999",
            "label": "Fale conosco"
        },
        {
            "id": "2",
            "type": "URL",
            "url": "https://.plugzapi.com",
            "label": "Visite nosso site"
        },
        {
            "id": "3",
            "type": "REPLY",
            "label": "Falar com atendente"
        }
    ]
}

Response#

200#

Atributos	Tipo	Descrição
zaapId	string	id no plugzapi
messageId	string	id no whatsapp

Exemplo

{
  "zaapId": "3999984263738042930CD6ECDE9VDWSA",
  "messageId": "D241XXXX732339502B68",
  "id": "D241XXXX732339502B68"
}

405#

Neste caso certifique que esteja enviando o corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no inicio deste tópico.

415#

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json"

Webhook Response#

Link para a response do webhook (ao receber)

Webhook