Enviar PTV
#
Método#
/send-ptvPOST
https://api.z-api.io/instances/SUA_INSTANCIA/token/SEU_TOKEN/send-ptv
#
HeaderKey | Value |
---|---|
Client-Token | TOKEN DE SEGURANÇA DA CONTA |
#
ConceituaçãoA sigla PTV vem de "Pre-Recorded Transfer Video".
Método responsavel por enviar PTV para os seus chats, você pode trabalhar com as PTV de 2 formas que são:
Por Link, onde você tem um video 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 video em Base64.
#
Tamanho e formatosO 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ó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 |
ptv | string | Link do video ou seu Base64 |
#
OpcionaisAtributos | Tipo | Descrição |
---|---|---|
messageId | String | Atributo utilizado para responder uma mensagem do chat, basta adicionar o messageId da mensagem que queira responder neste atributo |
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#
Envio por URL#
Envio por Base64#
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)