Enviar GIF

Método#

/send-gif#

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

Header#

Key	Value
Client-Token	TOKEN DE SEGURANÇA DA CONTA

Conceituação#

Método responsavel por enviar GIFs para os seus chats através da api (O arquivo a ser enviado precisa ser um MP4)

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
gif	string	Link do arquivo do seu GIF (O arquivo precisa ser um mp4)

Opcionais#

Atributos	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
caption	String	Mensagem em que desejar enviar, junto com o gif

Request Body#

{
  "phone": "",
  "gif": "https://file-examples.com/storage/fe88505b6162b2538a045ce/2017/04/file_example_MP4_480_1_5MG.mp4",
  "caption": ""
}

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

{
  "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