Download Disponivel
Webhook
POSTDownload Disonivel
Descricao
Quando e disparado?
Estrutura do Payload
Campos raiz
| Campo | Tipo | Descricao |
|---|---|---|
packageId | string | Identificador unico do pacote (UUIDv7) |
channelId | string | Identificador do canal que recebeu a mensagem |
organizationID | string | Identificador da organizacao |
accountId | string | Identificador da conta |
content | object | Dados do evento de download — veja tabela abaixo |
timestamp | string (ISO 8601) | Data/hora do processamento no MessageFy |
Campos do objeto content
| Campo | Tipo | Obrigatorio | Descricao |
|---|---|---|---|
type | string | Sim | Sempre "DOWNLOAD_AVAILABLE" |
success | boolean | Sim | true se o download foi concluido com sucesso, false em caso de falha |
messageId | string | Sim | Identificador da mensagem no WhatsApp (ex: 3EB082D1B9E2909C104074) |
externalDownloadUrl | string | Sim* | URL publica para download do arquivo. Presente apenas quando success: true |
errorMessage | string | Nao | Mensagem de erro. Presente apenas quando success: false |
isStatusMessage | boolean | Sim | NOVO — true quando a midia pertence a uma mensagem de status (story) do WhatsApp (status@broadcast). Default: false |
to | object | Sim | Dados do chat/destinatario original |
filename | string | Sim | Nome do arquivo (ex: foto.jpg, video.mp4) |
mimetype | string | Sim | Tipo MIME do arquivo (ex: image/jpeg, video/mp4) |
caption | string | Nao | Legenda da midia, se houver |
timestamp | string (ISO 8601) | Sim | Data/hora do evento |
Campos do objeto to
| Campo | Tipo | Descricao |
|---|---|---|
type | string | Tipo do canal (ex: "WHATSAPP") |
id | string | Identificador do chat |
jid | string | JID do WhatsApp |
lid | string | LID do WhatsApp |
number | string | Numero de telefone |
name | string | Nome do contato/grupo |
Requisição
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://your-api-server.com' \
--header 'api-key: <api-key>'Response Response Example
Sucesso
{
"packageId": "019d5a12-e396-7a40-985b-d60d6f71214a",
"channelId": "019bfc54-773b-754f-a2bb-8ace7206c6b7",
"organizationID": "019bfc53-7df6-7a36-8387-5fafd009e93d",
"accountId": "019bfc53-7ec6-7a54-b9ef-4ebb73b33246",
"content": {
"type": "DOWNLOAD_AVAILABLE",
"success": true,
"messageId": "3EB082D1B9E2909C104074",
"externalDownloadUrl": "https://storage.messagefy.io/media/019d5a12-e396-7a40-985b-d60d6f71214a/video.mp4",
"isStatusMessage": false,
"to": {
"type": "WHATSAPP",
"id": "120363402110764959@g.us",
"jid": "",
"lid": "",
"number": "120363402110764959",
"name": "Grupo Exemplo"
},
"filename": "video.mp4",
"mimetype": "video/mp4",
"caption": "",
"timestamp": "2026-04-03T14:30:00.0000000+00:00"
},
"timestamp": "2026-04-03T14:30:01.1234567+00:00"
}Modificado em 2026-04-03 22:31:38