Ir para o conteúdo

Como enviar mídia para Cloud Api da Meta

Para as mensagens de notificação ou retorno, caso o tipo de cabeçalho escolhido seja Mídia, deve-se fazer primeiro o upload da mídia para a Cloud Api da Meta.

Para solicitar o upload de mídia para a Meta deve-se fazer uma requisição HTTP POST para o endpoint https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/media, passando no formulário o tipo mídia e o conteúdo do arquivo.

URI

URI: https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/media
Método: POST

FROM_PHONE_NUMBER_ID

Este campo deve ser o mesmo informado no client_id na geração do token.

Exemplo de upload de mídia usando curl

curl -X 'POST' 'https://api.whatsapp.serpro.gov.br/client/{fromPhoneNumberId}/v2/media' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer VALOR_TOKEN' \
  -H 'Content-Type: multipart/form-data' \
  -F 'mediaType=image/png' \
  -F 'file=@/home/user/imagem-folder/image.png'

Interpretando resultado do upload de mídia

Em caso de sucesso, o código retornado é igual a 200 e o resultado da chamada ao serviço de upload de mídia é um objeto com quatro campos, conforme abaixo.

Segue um exemplo de payload:

{
    "id": "1117935403029375",
    "acoes": [
        {
            "rel": "download",
            "uri": "#/client/{fromPhoneNumberId}/v2/media/1117935403029375",
            "method": "GET"
        }
    ]
}
Se o upload não for realizado com sucesso, o resultado da chamada indicará que ocorreu um erro e exibirá a mensagem de erro, o código, o tipo e o fbtrace_id, que é um identificador interno utilizado para ajudar a encontrar os dados de registro para depuração.

{
    "error": {
        "message": "(#100) The parameter file is required.",
        "type": "OAuthException",
        "code": 100,
        "fbtrace_id": "AJa_F6oKs7wv-hTWxgaFI2W"
    }
}

Tipos de mídia suportados

Os tipos de mídia atualmente suportados são imagem, vídeo e documento.

Formatos de imagem

  • image/png
  • image/jpeg

Formatos de vídeo

  • video/mp4
  • video/3gpp

Formatos de documento

  • application/msword
  • text/plain
  • application/vnd.ms-powerpoint
  • application/pdf
  • application/vnd.ms-excel
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.openxmlformats-officedocument.presentationml.presentation
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Formatos de áudio

  • audio/aac
  • audio/amr
  • audio/mpeg
  • audio/mp4
  • audio/ogg

Há ainda a validação do tamanho máximo destas mídias, que é diferente pelo tipo:

  • documento: 95MB
  • imagem: 5MB
  • vídeo: 16MB
  • áudio: 16MB

Importante

No geral, as mídias de saída podem ser removidas depois de 30 dias, mas use a estratégia que melhor se adapta à sua empresa.