Mensagem com Mídia

Quando acontece?

Sempre que você receber uma mensagem de alguém este evento será disparado. O exemplo abaixo está considerando que você está recebendo um áudio.

Payload

📘

O exemplo é referente a recebimento de áudio, para outras mídias como imagens, vídeos, documentos, stickers pode haver pequenas diferenças no payload, mas no geral sempre haverá indicação em data.type o tipo de mensagem.

JSON

{
  "created_at": "2024-03-14T23:33:13.623Z",
  "data": {
    "content": {
      "view_once": false,
      "expires_at": "2024-03-15T23:33:13.000Z",
      "media": {
        "url": "https://media.url.download/",
        "metadata": {
          "duration": 5,
          "ptt": true
        }
      }
    },
    "id": "3EB0F65D626B2131A6B6A0",
    "recipient": {
      "name": "Recipient Name",
      "id": "5511999999999",
      "profile_picture": "http://placeimg.com/640/480",
      "type": "chat"
    },
    "sender": {
      "name": "Sender Name",
      "id": "5511999999999",
      "profile_picture": "http://placeimg.com/640/480"
    },
    "sent_at": "2024-03-14T23:33:13.000Z",
    "type": "audio"
  },
  "id": "so9lv3u3pu81he8gumfa4",
  "type": "message.received"
}

Propriedades

Propriedade	Descrição
created_at	Data da criação do evento.
data	Objeto contendo os dados do evento. Vazio se não houver dados.
data.content	Conteúdo da mensagem.
data.content.view_once	Define se a mensagem é de visualização única.
data.content.expires_at	Data de expiração da mensagem, para conversas com mensagens temporárias.
data.content.media	Mensagens com mídias terão esta propriedade.
data.content.media.url	URL para mídia que poderá ser usada para fazer download, é válida por 1 hora.
data.content.media.metadata.duration	Em casos de áudio e vídeo, será a duração em segundos.
data.content.media.metadata.playback	Em casos de vídeo, representa se foi enviado com a função GIF ativada.
data.content.media.metadata.ptt	Em casos de áudios, repeseta se o áudio foi enviado com a função Push to Talk (áudio gravado).
data.id	ID da mensagem.
data.recipient	Destinatário da mensagem, sob a perspectiva da instância conectada.
data.recipient.name	Nome do destinatário.
data.recipient.id	ID do destinatário, representando o chat, conversa ou grupo.
data.recipient.profile_picture	Foto de perfil do destinatário.
data.recipient.type	Tipo do destinatário, como chat ou grupo.
data.sender	Quem está enviando a mensagem.
data.sender.name	Nome do remetente.
data.sender.id	ID do remetente (número de quem está enviando a mensagem).
data.sender.profile_picture	Foto de perfil do remetente.
data.sent_at	Data em que a mensagem foi enviada.
data.type	Tipo de mensagem recebida: text, video, audio, image, sticker ou document.
id	Identificador do evento criado.
type	Tipo do evento disparado, como message.received.