Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(channel): say channel messages carry no media URL today

Yudhi Armyndharisdb620e8e15ec
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index b88f7e230..fe74b5a2a 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -3821,7 +3821,7 @@ Get recent messages from a channel/newsletter.
]
```
-Bare array. `timestamp` is an epoch number (seconds). `mediaUrl` is present only when the message carries media with a readable URL.
+Bare array. `timestamp` is an epoch number (seconds). Neither engine populates `mediaUrl` on channel messages today; use `hasMedia` to tell a media post apart.
**Errors:** `400` `Session is not started` · `401` missing/invalid API key · `404` `Channel <channelId> not found` (on whatsapp-web.js, the id is not among the channels the account follows) · `409` conflict or engine not ready (retryable) · `501` not supported on the active engine
diff --git a/openapi.json b/openapi.json
index 7aace652c..2df4c300c 100644
--- a/openapi.json
+++ b/openapi.json
@@ -23314,7 +23314,7 @@
},
"mediaUrl": {
"type": "string",
- "description": "Media URL, when the engine resolved one."
+ "description": "Media URL. Neither engine populates it today; use hasMedia."
}
},
"required": [
diff --git a/src/modules/channel/dto/channel-response.dto.ts b/src/modules/channel/dto/channel-response.dto.ts
index 2aac1255f..edd894069 100644
--- a/src/modules/channel/dto/channel-response.dto.ts
+++ b/src/modules/channel/dto/channel-response.dto.ts
@@ -51,7 +51,7 @@ export class ChannelMessageDto {
@ApiProperty({ description: 'Whether the post carries media.', example: false })
hasMedia!: boolean;
- @ApiPropertyOptional({ description: 'Media URL, when the engine resolved one.' })
+ @ApiPropertyOptional({ description: 'Media URL. Neither engine populates it today; use hasMedia.' })
mediaUrl?: string;
}