Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(channel): stop documenting a Baileys channel picture

Yudhi Armyndharis4c51acdd2b32
diff --git a/docs/06-api-specification.md b/docs/06-api-specification.md
index 3ee339588..1cc46e1c5 100644
--- a/docs/06-api-specification.md
+++ b/docs/06-api-specification.md
@@ -3710,17 +3710,16 @@ Get a single channel/newsletter by its id.
"description": "Release notes and tips",
"inviteCode": "ABC123xyz",
"subscriberCount": 1042,
- "picture": "https://example.com/ch.jpg",
"verified": true,
"createdAt": 1717200000
}
```
-> **`picture` and `createdAt` are Baileys-only, and the lookup reaches further there.** The
-> whatsapp-web.js engine exposes no per-id channel lookup, so the adapter scans the subscribed-channel
-> list: a channel the account does not follow answers `404` even though it exists, and those two
-> fields are always absent from the payload. The Baileys engine resolves any channel by id and fills
-> both.
+> **`createdAt` is Baileys-only, and the lookup reaches further there.** The whatsapp-web.js engine
+> exposes no per-id channel lookup, so the adapter scans the subscribed-channel list: a channel the
+> account does not follow answers `404` even though it exists, and `createdAt` is always absent from
+> the payload. The Baileys engine resolves any channel by id and fills `createdAt`. Neither engine
+> fills `picture`: WhatsApp reports the channel picture as a media path, not a URL.
**Errors:** `400` `Session is not started` · `401` missing/invalid API key · `404` `Channel <channelId> not found` (engine returned null; on whatsapp-web.js this includes a channel the account does not follow) · `409` conflict or engine not ready (retryable) · `503` session not ready or dependency unavailable (retryable)
@@ -3903,7 +3902,6 @@ Subscribe to a channel using its invite code.
"description": "Release notes and tips",
"inviteCode": "ABC123xyz",
"subscriberCount": 1042,
- "picture": "https://example.com/ch.jpg",
"verified": true,
"createdAt": 1717200000
}
diff --git a/openapi.json b/openapi.json
index 999ff5c3f..21a36578e 100644
--- a/openapi.json
+++ b/openapi.json
@@ -7134,7 +7134,7 @@
],
"responses": {
"200": {
- "description": "Channel details. The whatsapp-web.js engine never fills `picture` or `createdAt`; the Baileys engine reads both off the newsletter metadata.",
+ "description": "Channel details. The Baileys engine reads `createdAt` off the newsletter metadata and the whatsapp-web.js engine never fills it. Neither engine fills `picture`: WhatsApp reports only a media path.",
"content": {
"application/json": {
"schema": {
diff --git a/sdk/go/types_channel.go b/sdk/go/types_channel.go
index 548011fa3..4f1b9e6e9 100644
--- a/sdk/go/types_channel.go
+++ b/sdk/go/types_channel.go
@@ -11,7 +11,7 @@ type ChannelRecord struct {
// InviteCode is the invite code from the channel link.
InviteCode *string `json:"inviteCode,omitempty"`
SubscriberCount int `json:"subscriberCount,omitempty"`
- // Picture is the channel picture URL. Populated by Baileys; whatsapp-web.js omits it.
+ // Picture is the channel picture URL. Not currently filled by either engine.
Picture *string `json:"picture,omitempty"`
Verified *bool `json:"verified,omitempty"`
// CreatedAt is the channel creation time as reported by the engine. Populated by Baileys;
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/model/ChannelRecord.java b/sdk/java/src/main/java/com/rmyndharis/openwa/model/ChannelRecord.java
index 7558c49fc..8cc2950b6 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/model/ChannelRecord.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/model/ChannelRecord.java
@@ -11,7 +11,7 @@ public record ChannelRecord(
/** Invite code from the channel link. */
String inviteCode,
Integer subscriberCount,
- /** Channel picture URL. Populated by Baileys; whatsapp-web.js omits it. */
+ /** Channel picture URL. Not currently filled by either engine. */
String picture,
Boolean verified,
/** Channel creation time as reported by the engine. Populated by Baileys; whatsapp-web.js omits it. */
diff --git a/sdk/javascript/src/types.ts b/sdk/javascript/src/types.ts
index 75be2545b..bfd8107b1 100644
--- a/sdk/javascript/src/types.ts
+++ b/sdk/javascript/src/types.ts
@@ -1239,7 +1239,7 @@ export interface ChannelRecord {
/** Invite code from the channel link. */
inviteCode?: string;
subscriberCount?: number;
- /** Channel picture URL. Populated by Baileys; whatsapp-web.js omits it. */
+ /** Channel picture URL. Not currently filled by either engine. */
picture?: string;
verified?: boolean;
/** Channel creation time as reported by the engine. Populated by Baileys; whatsapp-web.js omits it. */
diff --git a/sdk/javascript/test/wire-contract.test-d.ts b/sdk/javascript/test/wire-contract.test-d.ts
index 9b9f070b8..0be9447d8 100644
--- a/sdk/javascript/test/wire-contract.test-d.ts
+++ b/sdk/javascript/test/wire-contract.test-d.ts
@@ -50,7 +50,7 @@ interface WireStatus {
expiresAt: string;
}
-/** `Channel` — `picture`/`createdAt` come from the Baileys `toChannel()` path; wwjs omits both. */
+/** `Channel` — `createdAt` comes from the Baileys `toChannel()` path; wwjs omits it. No engine fills `picture`. */
interface WireChannel {
id: string;
name: string;
diff --git a/sdk/python/openwa/types.py b/sdk/python/openwa/types.py
index f06d01e3a..7a546f24e 100644
--- a/sdk/python/openwa/types.py
+++ b/sdk/python/openwa/types.py
@@ -1255,7 +1255,8 @@ class AddLabelRequest(TypedDict):
# Mirrors the backend ``Channel`` — returned by the engine as-is, with no DTO in between.
-# ``picture``/``createdAt`` are populated by Baileys; whatsapp-web.js omits both.
+# ``createdAt`` is populated by Baileys; whatsapp-web.js omits it. ``picture`` is not currently
+# filled by either engine.
class ChannelRecord(TypedDict, total=False):
id: Jid
name: str
diff --git a/src/modules/channel/channel.controller.ts b/src/modules/channel/channel.controller.ts
index 20fb5e0ff..1ac88e5d0 100644
--- a/src/modules/channel/channel.controller.ts
+++ b/src/modules/channel/channel.controller.ts
@@ -42,8 +42,8 @@ export class ChannelController {
@ApiResponse({
status: 200,
description:
- 'Channel details. The whatsapp-web.js engine never fills `picture` or `createdAt`; the Baileys ' +
- 'engine reads both off the newsletter metadata.',
+ 'Channel details. The Baileys engine reads `createdAt` off the newsletter metadata and the ' +
+ 'whatsapp-web.js engine never fills it. Neither engine fills `picture`: WhatsApp reports only a media path.',
type: ChannelDto,
})
@ApiResponse({