Pular para o conteúdo principal

Enviar botões com imagem

Método#

/send-button-list#

POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-button-list

Header#

KeyValue
Client-TokenTOKEN DE SEGURANÇA DA CONTA

Atenção

Envios de botões atualmente se encontram disponíveis, para mais detalhes acesse o tópico Funcionamento dos Botões

Conceituação#

Neste método você poderá enviar imagens com opções de botões de ação, o conteudo do botão ex: SIM / Não, poderão ser escolhidos pelo usuário e será utilizado como resposta da mensagem enviada junto com os botões.

image


Atributos#

Obrigatórios#

AtributosTipoDescrição
phonestringTelefone (ou ID do grupo para casos de envio para grupos) do destinatário no formato DDI DDD NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara
messagestringTexto a ser enviado
buttonListbuttonListObjeto do tipo botão
important

O atributo "message" não pode ser enviado vazio!

Opcionais#

AtributosTipoDescrição
delayMessagenumberNesse 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

Button List#

AtributosTipoDescrição
imagestringURL ou Base64 da imagem que será enviada
buttonsbuttonlista de botões a ser enviado

Button#

AtributosTipoDescrição
labelstringTexto para o botão

Opcionais Button#

AtributosTipoDescrição
idstringIdentificador do botão

Request Body#

{
"phone": "5511999999999",
"message": "Z-API é Bom ?",
"buttonList": {
"image": "https://avatars.githubusercontent.com/u/60630101?s=280&v=4",
"buttons": [
{
"id": "1",
"label": "Ótimo"
},
{
"id": "2",
"label": "Excelente"
}
]
}
}

Response#

200#

AtributosTipoDescrição
zaapIdstringid no z-api
messageIdstringid no whatsapp
idstringAdicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId

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


Code#