Enviar áudio
Método#
/send-audio#
POST https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-audio
Header#
| Key | Value |
|---|---|
| Client-Token | TOKEN DE SEGURANÇA DA CONTA |
Conceituação#
Método responsavel por enviar audios para os seus chats, você pode trabalhar com as audios de 2 formas que são:
Por Link, onde você tem um audio hospedado em algum lugar da internet e envia apenas o link do mesmo.
Por Base64, se você optar por esta opção precisará ter em sua aplicação um método para converter o audio em Base64.
Tamanho e formatos#
O WhatsApp limita o tamanho de arquivos e sua politica muda constantemente, por isso sempre recomendamos a verificação direto no site do próprio WhatsApp.
Neste link você encontra tudo que precisa saber sobre formatos e tamanhos de arquivos.
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 NÚMERO Ex: 551199999999. IMPORTANTE Envie somente números, sem formatação ou máscara |
| audio | string | Link do audio ou seu Base64 |
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 |
| delayTyping | number | Nesse atributo um delay é adicionado na mensagem. Você pode decidir entre um range de 1~15 sec, significa quantos segundos ele vai ficar com o status "Gravando áudio...". (Ex "delayTyping": 5, ). O delay default caso não seja informado é de 0 |
| viewOnce | boolean | Define se será uma mensagem de visualização única ou não |
| async | boolean | Se ativo, a request responderá imediatamente com sucesso e o processamento do arquivo será realizado em segundo plano. O envio pode ser verificado através do webhook de envio. |
| waveform | boolean | Define se o áudio será enviado com ondas sonoras ou não |
Request Body#
Envio por URL
Envio por Base64
Response#
200#
| Atributos | 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
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)