Enviar botões com video
#
Método#
/send-button-listPOST
https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-button-list
#
HeaderKey | Value |
---|---|
Client-Token | TOKEN 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çãoNeste 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.
#
Atributos#
ObrigatóriosAtributos | Tipo | Descrição |
---|---|---|
phone | string | Telefone (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 |
message | string | Texto a ser enviado |
buttonList | buttonList | Objeto do tipo botão |
important
O atributo "message" não pode ser enviado vazio!
#
OpcionaisAtributos | 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 |
#
Button ListAtributos | Tipo | Descrição |
---|---|---|
video | string | URL ou Base64 do video que será enviada |
buttons | button | lista de botões a ser enviado |
#
ButtonAtributos | Tipo | Descrição |
---|---|---|
label | string | Texto para o botão |
#
Opcionais ButtonAtributos | Tipo | Descrição |
---|---|---|
id | string | Identificador do botão |
#
Request Body#
Response#
200Atributos | Tipo | Descrição |
---|---|---|
zaapId | string | id no z-api |
messageId | string | id no whatsapp |
id | string | Adicionado para compatibilidade com zapier, ele tem o mesmo valor do messageId |
Exemplo
#
405Neste 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.
#
415Caso 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 ResponseLink para a response do webhook (ao receber)