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ível 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.

⚠️Atenção: 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

Exemplo 1

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.

[
   {
      "whatsapp": {
         "type": "file",
         "file": {
            "url": "https://s3-sa-east-1.amazonaws.com/altu-assets/dev/profiles/1/avatar",
            "type": "PNG",
            "name": "avatar.png",
            "caption": "Esta imagem é usada como avatar",
            "size": "3127"
          }
       }
    }
 ]

Exemplo 2

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.

[
   {
     "default": {
       "type": "file",
       "file": {
          "url": "https://prime.altubots.com/chats/dev/cesar/07db4c9e4559050116d38e660548749a/uploads/3660b5fe-4c62-8979-2619-761f234892bf/20200909165426883_gato.jpg",
          "whatsapp_media_id": "bc5e2bc0-845c-49bd-80a8-8675ac973c5f",
          "type": "JPEG",
          "name": "gato.jpg",
          "caption": "Veja este gatinho",
          "size": "145126"
         }
       }
    }
 ]

Compatibilidades

• Facebook via Altu
  

• Compatíveis

• imagens: JPEG /JPG / PNG
• vídeos: MP4
• musica: MP3
• documentos: DOCX / PDF /XLSX e TXT

⚠️Atenção: não compatível com GIF, PPTX (Power Point) e compactadores RAR/ZIP

• WA via Liveperson
  
  

• Compatíveis

• imagens: JPEG /JPG / PNG
• vídeos: MP3
• documentos: DOCX / PDF /XLSX

⚠️Atenção: não compatível com GIF, PPTX (Power Point) , compactadores RAR/ZIP, vídeo MP4 e TXT

• Zenvia
  

• Compatíveis

• imagens: JPEG /JPG / PNG
• vídeos: MP4
• musica: MP3
• documentos: DOCX / PDF /XLSX e PPXT

⚠️Atenção: não compatível com GIF e TXT

Stickers

Envie sticker por meio de um template para o usuário. Modelo:

{
   "default": {
      "file": {
        "url": "<url_da_imagem>.webp",
        "name": "<nome_da_imagem>.webp",
        "type": "WEBP",
        "caption": "Descrição do sticker",
        "size": <tamanho em byte>
      },
      "type": "file"
    }
 }

Multiplos arquivos

O output de arquivo é usado da seguinte maneira:

[
   {
      "default": {
        "file": {
            "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo1.jpg",
            "name": "jogo1.jpg",
            "size": "20900",
            "type": "JPG",
            "caption": "primeiro jogo"
        },
        "type": "file"
      }
    }
 ]

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.

Exemplo:

"file_array": [

 {
   "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo1.jpg",
   "name": "jogo1.jpg",
   "size": "20900",
   "type": "JPG",
   "caption": "primeiro jogo"
 },
 {
  "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo2.jpg",
  "name": "jogo2.jpg",
  "size": "17600",
  "type": "JPG",
  "caption": "segundo jogo"
 },
 {
  "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo3.jpg",
  "name": "jogo3.jpg",
  "size": "35600",
  "type": "JPG",
  "caption": "3 jogo"
 },
 {
  "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo4.jpeg",
  "name": "jogo4.jpeg",
  "size": "15600",
  "type": "JPEG",
  "caption": "4 jogo"
 },
 {
  "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo5.jpeg",
  "name": "jogo5.jpeg",
  "size": "11700",
  "type": "JPEG",
  "caption": "5 jogo"
 }
 ]

O array file_array foi criado onde cada objeto possui os seguintes campos:

• url
• name
• size
• type
• caption.

Para usar no output, basta usar o nome da variável criada:

{
 "default": {
    "file": "<?$file_array?>",
    "type": "file"
 }
 }

Dessa forma, todas as imagens serão mostradas para o usuario. Também é possível passar o array diretamente no output (sem o uso de uma variável).

{
    "default": {
        "file": [
       {
         "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo1.jpg",
         "name": "jogo1.jpg",
         "size": "20900",
         "type": "JPG",
         "caption": "primeiro jogo"
     },
    {
       "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo2.jpg",
       "name": "jogo2.jpg",
       "size": "17600",
       "type": "JPG",
       "caption": "segundo jogo"
    },
   {
     "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo3.jpg",
     "name": "jogo3.jpg",
     "size": "35600",
     "type": "JPG",
     "caption": "3 jogo"
   },
  {
    "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo4.jpeg",
    "name": "jogo4.jpeg",
    "size": "15600",
    "type": "JPEG",
    "caption": "4 jogo"
  },
 {
   "url": "https://altuclients.s3.sa-east-1.amazonaws.com/Demo/imagens/jogo5.jpeg",
   "name": "jogo5.jpeg",
   "size": "11700",
   "type": "JPEG",
   "caption": "5 jogo"
 }
 ],
 "type": "file"
 }
 }