O componente de output Arquivo permite o envio de imagens ou documentos. Utilize quando tiver uma URL pública ou o id de mídia do arquivo hospedado no WhatsApp.
Embora alguns parâmetros não sejam obrigatórios, procure preencher o máximo de informações possíveis sobre o arquivo que estiver enviando. As informações extras serão utilizadas para exibir detalhes sobre o arquivo no histórico de mensagens em Atendimento.
Disponível nos canais Liveperson, WhatsApp e Widget
Estrutura
[
{
"<channel>": {
"type": "file",
"file": {
"url": "<url http ou https do arquivo>",
"whatsapp_media_id": "<id do arquivo WhatsApp>",
"type": "<tipo do arquivo>",
"name": "<nome do arquivo>",
"caption": "<descrição do arquivo - não é possível adicionar formatação>",
"size": "<tamanho do arquivo em bytes>",
"payload": {
"delay": 2000
}
}
}
}
]
Atributos:
Nome
Obrigatório
Descrição
channel
Sim
Opções: default, Apple, Facebook, Whatsapp ou Widget. Especifica o canal que deverá receber o arquivo. Quando channel for default, todos os canais com suporte poderão receber o arquivo. Quando definir um canal específico, apenas este canal receberá o arquivo.
url
Sim, quando enviado para um canal diferente de whatsapp do Facebook
A URL pública e válida do arquivo. Quando channel for whatsapp, certifique-se que a URL seja HTTP ou HTTPS.
whatsapp_media_id
Sim, quando enviar ao canal whatsapp do Facebook e url não for definido
type
Sim
Extensão do arquivo. Por exemplo "JPEG", "PNG", "PDF", "DOCX", e etc.(Caso queira enviar vários tipos de arquivo, utilize "application/*").
name
Sim, quando channel for default ou liveperson
O nome do arquivo.
caption
Não
Descrição do arquivo.
size
Sim, quando channel for liveperson
Tamanho do arquivo em kilobytes.
delay
Não
Tempo (milissegundos) de atraso antes da próxima opção aparecer. Sendo de 0 á 5000, se for inserido um valor acima de 5000 o delay é descartado.
Exemplos
O output de arquivo a seguir é utilizado para enviar um arquivo acessível através de uma URL pública. A imagem será entregue ao usuário através do canal Whatsapp de origem Facebook ou Liveperson.
O output de arquivo a seguir é utilizado para enviar um arquivo a todos canais com suporte ao envio de arquivos. O arquivo é acessível através do id de mídia no canal Whatsapp de origem Facebook e acessível através de uma URL pública nos demais canais.
Para usar dessa maneira, é necessário que o array criado tenha o mesmo formato que o output de arquivo para um arquivo só, ou seja, o array deve conter vários objetos do tipo file.
O id da imagem ou documento enviado para o cliente da API do WhatsApp Business. Poderá utilizar qualquer id válido. Este parâmetro tem precedência ao parâmetro url em canal Whatsapp de origem Facebook. Consulte mais informações sobre na documentação do Facebook.
