Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): name the engine that answers 501 in the SDK docs

Yudhi Armyndharisc5bdcabc49de
diff --git a/sdk/go/catalog.go b/sdk/go/catalog.go
index 34209ee89..8728f01fa 100644
--- a/sdk/go/catalog.go
+++ b/sdk/go/catalog.go
@@ -13,13 +13,14 @@ func (s *CatalogService) sessionBase(sessionID string) string {
}
// Info returns catalog metadata, or nil when the account has no catalog.
+// Baileys only; whatsapp-web.js answers 501.
func (s *CatalogService) Info(ctx context.Context, sessionID string) (*CatalogInfo, error) {
var out *CatalogInfo
err := s.client.do(ctx, "GET", s.sessionBase(sessionID)+"/catalog", nil, nil, &out)
return out, err
}
-// Products returns paginated catalog products.
+// Products returns paginated catalog products. Baileys only; whatsapp-web.js answers 501.
func (s *CatalogService) Products(ctx context.Context, sessionID string, query *CatalogProductsQuery) (*PaginatedProducts, error) {
var out PaginatedProducts
err := s.client.do(ctx, "GET", s.sessionBase(sessionID)+"/catalog/products", valuesOf(query), nil, &out)
@@ -30,6 +31,7 @@ func (s *CatalogService) Products(ctx context.Context, sessionID string, query *
}
// Product returns a single catalog product, or nil when no product has that id.
+// Baileys only; whatsapp-web.js answers 501.
func (s *CatalogService) Product(ctx context.Context, sessionID, productID string) (*CatalogProduct, error) {
var out *CatalogProduct
err := s.client.do(ctx, "GET", s.sessionBase(sessionID)+"/catalog/products/"+pathEscape(productID), nil, nil, &out)
@@ -37,6 +39,7 @@ func (s *CatalogService) Product(ctx context.Context, sessionID, productID strin
}
// SendProduct sends a product message. Requires an OPERATOR-level key.
+// Baileys only; whatsapp-web.js answers 501.
func (s *CatalogService) SendProduct(ctx context.Context, sessionID string, body SendProductRequest) (*ProductMessageResponse, error) {
var out ProductMessageResponse
err := s.client.do(ctx, "POST", s.sessionBase(sessionID)+"/messages/send-product", nil, body, &out)
diff --git a/sdk/go/channels.go b/sdk/go/channels.go
index 0ece20366..47d52ce3a 100644
--- a/sdk/go/channels.go
+++ b/sdk/go/channels.go
@@ -10,7 +10,7 @@ func (s *ChannelsService) base(sessionID string) string {
return "/api/sessions/" + pathEscape(sessionID) + "/channels"
}
-// List returns channels for a session.
+// List returns channels for a session. whatsapp-web.js only; Baileys answers 501.
func (s *ChannelsService) List(ctx context.Context, sessionID string) ([]ChannelRecord, error) {
var out []ChannelRecord
err := s.client.do(ctx, "GET", s.base(sessionID), nil, nil, &out)
@@ -27,7 +27,7 @@ func (s *ChannelsService) Get(ctx context.Context, sessionID, channelID string)
return &out, nil
}
-// Messages returns recent messages from a channel.
+// Messages returns recent messages from a channel. whatsapp-web.js only; Baileys answers 501.
func (s *ChannelsService) Messages(ctx context.Context, sessionID, channelID string, query *ChannelMessageQuery) ([]ChannelMessageRecord, error) {
var out []ChannelMessageRecord
err := s.client.do(ctx, "GET", s.base(sessionID)+"/"+pathEscape(channelID)+"/messages", valuesOf(query), nil, &out)
@@ -68,6 +68,7 @@ func (s *ChannelsService) Mute(ctx context.Context, sessionID, channelID string,
}
// Subscribe subscribes to a channel by invite code. Requires an OPERATOR-level key.
+// Baileys only; whatsapp-web.js answers 501.
func (s *ChannelsService) Subscribe(ctx context.Context, sessionID string, body SubscribeChannelRequest) (*ChannelRecord, error) {
var out ChannelRecord
err := s.client.do(ctx, "POST", s.base(sessionID)+"/subscribe", nil, body, &out)
diff --git a/sdk/go/groups.go b/sdk/go/groups.go
index 218758e2e..233110190 100644
--- a/sdk/go/groups.go
+++ b/sdk/go/groups.go
@@ -44,7 +44,7 @@ func (s *GroupsService) JoinInfo(ctx context.Context, sessionID, code string) (*
return &out, nil
}
-// Create makes a new group. It answers the group SUMMARY, not the detail shape Get returns — there is
+// Create makes a new group. Baileys only; whatsapp-web.js answers 501. It answers the group SUMMARY, not the detail shape Get returns — there is
// no participant list, description, owner or creation time on a create response.
func (s *GroupsService) Create(ctx context.Context, sessionID string, body CreateGroupRequest) (*GroupSummary, error) {
var out GroupSummary
diff --git a/sdk/go/labels.go b/sdk/go/labels.go
index 46b75892e..6dfba23eb 100644
--- a/sdk/go/labels.go
+++ b/sdk/go/labels.go
@@ -10,14 +10,14 @@ func (s *LabelsService) base(sessionID string) string {
return "/api/sessions/" + pathEscape(sessionID) + "/labels"
}
-// List returns all labels.
+// List returns all labels. whatsapp-web.js only; Baileys answers 501.
func (s *LabelsService) List(ctx context.Context, sessionID string) ([]LabelRecord, error) {
var out []LabelRecord
err := s.client.do(ctx, "GET", s.base(sessionID), nil, nil, &out)
return out, err
}
-// Get returns a single label.
+// Get returns a single label. whatsapp-web.js only; Baileys answers 501.
func (s *LabelsService) Get(ctx context.Context, sessionID, labelID string) (*LabelRecord, error) {
var out LabelRecord
err := s.client.do(ctx, "GET", s.base(sessionID)+"/"+pathEscape(labelID), nil, nil, &out)
@@ -62,7 +62,7 @@ func (s *LabelsService) Delete(ctx context.Context, sessionID, labelID string) (
return &out, nil
}
-// ForChat returns the labels applied to a chat.
+// ForChat returns the labels applied to a chat. whatsapp-web.js only; Baileys answers 501.
func (s *LabelsService) ForChat(ctx context.Context, sessionID, chatID string) ([]LabelRecord, error) {
var out []LabelRecord
err := s.client.do(ctx, "GET", s.base(sessionID)+"/chat/"+pathEscape(chatID), nil, nil, &out)
diff --git a/sdk/go/messages.go b/sdk/go/messages.go
index 606f357fb..31479f0d1 100644
--- a/sdk/go/messages.go
+++ b/sdk/go/messages.go
@@ -126,7 +126,7 @@ func (s *MessagesService) EditMessage(ctx context.Context, sessionID string, bod
return &out, nil
}
-// History reads live chat history from WhatsApp.
+// History reads live chat history from WhatsApp. whatsapp-web.js only; Baileys answers 501.
func (s *MessagesService) History(ctx context.Context, sessionID, chatID string, query *MessageHistoryQuery) ([]ChatHistoryMessage, error) {
var out []ChatHistoryMessage
path := s.base(sessionID) + "/" + pathEscape(chatID) + "/history"
@@ -134,7 +134,7 @@ func (s *MessagesService) History(ctx context.Context, sessionID, chatID string,
return out, err
}
-// Reactions returns the reactions on a message.
+// Reactions returns the reactions on a message. whatsapp-web.js only; Baileys answers 501.
func (s *MessagesService) Reactions(ctx context.Context, sessionID, chatID, messageID string) ([]ReactionRecord, error) {
var out []ReactionRecord
path := s.base(sessionID) + "/" + pathEscape(chatID) + "/" + pathEscape(messageID) + "/reactions"
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/CatalogResource.java b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/CatalogResource.java
index 041278b60..fa3d0cb4a 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/CatalogResource.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/CatalogResource.java
@@ -26,13 +26,19 @@ public final class CatalogResource {
this.client = client;
}
- /** Get the business catalog info, or {@code null} when the account has no catalog. */
+ /**
+ * Get the business catalog info, or {@code null} when the account has no catalog. Baileys only;
+ * whatsapp-web.js answers {@code 501}.
+ */
public CatalogInfo info(String sessionId) {
return client.request(
HttpMethod.GET, "/api/sessions/" + encodeSegment(sessionId) + "/catalog", null, null, CatalogInfo.class);
}
- /** List catalog products. Returns a {@code { products, pagination }} page. */
+ /**
+ * List catalog products. Returns a {@code { products, pagination }} page. Baileys only;
+ * whatsapp-web.js answers {@code 501}.
+ */
public PaginatedProducts products(String sessionId, CatalogProductsQuery query) {
return client.request(
HttpMethod.GET,
@@ -42,7 +48,10 @@ public final class CatalogResource {
PaginatedProducts.class);
}
- /** Get a single product by id, or {@code null} when no product in the catalog carries that id. */
+ /**
+ * Get a single product by id, or {@code null} when no product in the catalog carries that id.
+ * Baileys only; whatsapp-web.js answers {@code 501}.
+ */
public CatalogProduct product(String sessionId, String productId) {
return client.request(
HttpMethod.GET,
@@ -52,7 +61,10 @@ public final class CatalogResource {
CatalogProduct.class);
}
- /** Send a product message. Requires an OPERATOR-level key. Shares the messages path. */
+ /**
+ * Send a product message. Requires an OPERATOR-level key. Shares the messages path. Baileys only;
+ * whatsapp-web.js answers {@code 501}.
+ */
public ProductMessageResponse sendProduct(String sessionId, SendProductRequest body) {
return client.request(
HttpMethod.POST,
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/ChannelsResource.java b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/ChannelsResource.java
index 3a9a10343..9455b142f 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/ChannelsResource.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/ChannelsResource.java
@@ -27,7 +27,10 @@ public final class ChannelsResource {
this.client = client;
}
- /** List all channels/newsletters the session is subscribed to. */
+ /**
+ * List all channels/newsletters the session is subscribed to. whatsapp-web.js only; Baileys
+ * answers {@code 501}.
+ */
public List<ChannelRecord> list(String sessionId) {
return client.requestList(
HttpMethod.GET, "/api/sessions/" + encodeSegment(sessionId) + "/channels", null, null, ChannelRecord.class);
@@ -43,7 +46,7 @@ public final class ChannelsResource {
ChannelRecord.class);
}
- /** Get recent messages from a channel. */
+ /** Get recent messages from a channel. whatsapp-web.js only; Baileys answers {@code 501}. */
public List<ChannelMessageRecord> messages(String sessionId, String channelId, ChannelMessageQuery query) {
return client.requestList(
HttpMethod.GET,
@@ -84,7 +87,10 @@ public final class ChannelsResource {
SuccessResult.class);
}
- /** Subscribe to a channel using its invite code. Requires an OPERATOR-level key. */
+ /**
+ * Subscribe to a channel using its invite code. Requires an OPERATOR-level key. Baileys only;
+ * whatsapp-web.js answers {@code 501}.
+ */
public ChannelRecord subscribe(String sessionId, SubscribeChannelRequest body) {
return client.request(
HttpMethod.POST,
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/GroupsResource.java b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/GroupsResource.java
index dc75da224..56d7f733a 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/GroupsResource.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/GroupsResource.java
@@ -54,7 +54,8 @@ public final class GroupsResource {
}
/**
- * Create a group. Answers the group SUMMARY, not the detail shape {@code get} returns — there is
+ * Create a group. Baileys only; whatsapp-web.js answers {@code 501}. Answers the group SUMMARY,
+ * not the detail shape {@code get} returns — there is
* no participant list, description, owner or creation time on a create response.
*/
public GroupSummary create(String sessionId, CreateGroupRequest body) {
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/LabelsResource.java b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/LabelsResource.java
index 970f63b9d..821ad2e9d 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/LabelsResource.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/LabelsResource.java
@@ -23,13 +23,16 @@ public final class LabelsResource {
this.client = client;
}
- /** List all labels available in the business account. */
+ /**
+ * List all labels available in the business account. whatsapp-web.js only; Baileys answers
+ * {@code 501}.
+ */
public List<LabelRecord> list(String sessionId) {
return client.requestList(
HttpMethod.GET, "/api/sessions/" + encodeSegment(sessionId) + "/labels", null, null, LabelRecord.class);
}
- /** Get a single label by id. */
+ /** Get a single label by id. whatsapp-web.js only; Baileys answers {@code 501}. */
public LabelRecord get(String sessionId, String labelId) {
return client.request(
HttpMethod.GET,
@@ -80,7 +83,10 @@ public final class LabelsResource {
SuccessResult.class);
}
- /** Get the labels currently applied to a chat. */
+ /**
+ * Get the labels currently applied to a chat. whatsapp-web.js only; Baileys answers
+ * {@code 501}.
+ */
public List<LabelRecord> forChat(String sessionId, String chatId) {
return client.requestList(
HttpMethod.GET,
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/MessagesResource.java b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/MessagesResource.java
index ca0e3133e..d7b42e21c 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/resources/MessagesResource.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/resources/MessagesResource.java
@@ -300,7 +300,10 @@ public final class MessagesResource {
SuccessResult.class);
}
- /** Get the message history for a chat (read live from WhatsApp). */
+ /**
+ * Get the message history for a chat (read live from WhatsApp). whatsapp-web.js only; Baileys
+ * answers {@code 501}.
+ */
public List<ChatHistoryMessage> history(String sessionId, String chatId, MessageHistoryQuery query) {
return client.requestList(
HttpMethod.GET,
@@ -328,7 +331,7 @@ public final class MessagesResource {
null);
}
- /** Get reactions for a specific message. */
+ /** Get reactions for a specific message. whatsapp-web.js only; Baileys answers {@code 501}. */
public List<ReactionRecord> reactions(String sessionId, String chatId, String messageId) {
return client.requestList(
HttpMethod.GET,
diff --git a/sdk/javascript/src/resources/catalog.ts b/sdk/javascript/src/resources/catalog.ts
index b056653c1..2b5305d48 100644
--- a/sdk/javascript/src/resources/catalog.ts
+++ b/sdk/javascript/src/resources/catalog.ts
@@ -23,7 +23,10 @@ import type {
export class CatalogResource {
constructor(private readonly client: OpenWAClient) {}
- /** Get the business catalog info, or `null` when the account has no catalog. */
+ /**
+ * Get the business catalog info, or `null` when the account has no catalog.
+ * **Baileys only**: whatsapp-web.js answers 501.
+ */
info(sessionId: string): Promise<CatalogInfo | null> {
return this.client.request<CatalogInfo | null>({
method: 'GET',
@@ -31,7 +34,10 @@ export class CatalogResource {
});
}
- /** List catalog products. Returns a `{ products, pagination }` page. */
+ /**
+ * List catalog products. Returns a `{ products, pagination }` page.
+ * **Baileys only**: whatsapp-web.js answers 501.
+ */
products(sessionId: string, query?: CatalogProductsQuery): Promise<PaginatedProducts> {
return this.client.request<PaginatedProducts>({
method: 'GET',
@@ -40,7 +46,10 @@ export class CatalogResource {
});
}
- /** Get a single product by id, or `null` when no product in the catalog carries that id. */
+ /**
+ * Get a single product by id, or `null` when no product in the catalog carries that id.
+ * **Baileys only**: whatsapp-web.js answers 501.
+ */
product(sessionId: string, productId: string): Promise<CatalogProduct | null> {
return this.client.request<CatalogProduct | null>({
method: 'GET',
@@ -48,7 +57,10 @@ export class CatalogResource {
});
}
- /** Send a product message. Requires an OPERATOR-level key. Shares the messages path. */
+ /**
+ * Send a product message. Requires an OPERATOR-level key. Shares the messages path.
+ * **Baileys only**: whatsapp-web.js answers 501.
+ */
sendProduct(sessionId: string, body: SendProductRequest): Promise<ProductMessageResponse> {
return this.client.request<ProductMessageResponse>({
method: 'POST',
diff --git a/sdk/javascript/src/resources/channels.ts b/sdk/javascript/src/resources/channels.ts
index 4747aaeb2..59a2d039e 100644
--- a/sdk/javascript/src/resources/channels.ts
+++ b/sdk/javascript/src/resources/channels.ts
@@ -22,7 +22,7 @@ import type {
export class ChannelsResource {
constructor(private readonly client: OpenWAClient) {}
- /** List all channels/newsletters the session is subscribed to. */
+ /** List all channels/newsletters the session is subscribed to. **whatsapp-web.js only**: Baileys answers 501. */
list(sessionId: string): Promise<ChannelRecord[]> {
return this.client.request<ChannelRecord[]>({
method: 'GET',
@@ -38,7 +38,7 @@ export class ChannelsResource {
});
}
- /** Get recent messages from a channel. */
+ /** Get recent messages from a channel. **whatsapp-web.js only**: Baileys answers 501. */
messages(sessionId: string, channelId: string, query?: ChannelMessageQuery): Promise<ChannelMessageRecord[]> {
return this.client.request<ChannelMessageRecord[]>({
method: 'GET',
@@ -78,7 +78,10 @@ export class ChannelsResource {
});
}
- /** Subscribe to a channel using its invite code. Requires an OPERATOR-level key. */
+ /**
+ * Subscribe to a channel using its invite code. Requires an OPERATOR-level key.
+ * **Baileys only**: whatsapp-web.js answers 501.
+ */
subscribe(sessionId: string, body: SubscribeChannelRequest): Promise<ChannelRecord> {
return this.client.request<ChannelRecord>({
method: 'POST',
diff --git a/sdk/javascript/src/resources/groups.ts b/sdk/javascript/src/resources/groups.ts
index 9308a74d0..a994385e0 100644
--- a/sdk/javascript/src/resources/groups.ts
+++ b/sdk/javascript/src/resources/groups.ts
@@ -49,7 +49,7 @@ export class GroupsResource {
}
/**
- * Create a new group.
+ * Create a new group. **Baileys only**: whatsapp-web.js answers 501.
*
* Answers the group SUMMARY, not the detail shape `get()` returns — there is no participant list,
* description, owner or creation time on a create response.
diff --git a/sdk/javascript/src/resources/labels.ts b/sdk/javascript/src/resources/labels.ts
index 0d4cd8fb1..14a93e3f7 100644
--- a/sdk/javascript/src/resources/labels.ts
+++ b/sdk/javascript/src/resources/labels.ts
@@ -13,7 +13,7 @@ import type { AddLabelRequest, ChatSummary, LabelRecord, SuccessResult, UpsertLa
export class LabelsResource {
constructor(private readonly client: OpenWAClient) {}
- /** List all labels available in the business account. */
+ /** List all labels available in the business account. **whatsapp-web.js only**: Baileys answers 501. */
list(sessionId: string): Promise<LabelRecord[]> {
return this.client.request<LabelRecord[]>({
method: 'GET',
@@ -21,7 +21,7 @@ export class LabelsResource {
});
}
- /** Get a single label by id. */
+ /** Get a single label by id. **whatsapp-web.js only**: Baileys answers 501. */
get(sessionId: string, labelId: string): Promise<LabelRecord> {
return this.client.request<LabelRecord>({
method: 'GET',
@@ -65,7 +65,7 @@ export class LabelsResource {
});
}
- /** Get the labels currently applied to a chat. */
+ /** Get the labels currently applied to a chat. **whatsapp-web.js only**: Baileys answers 501. */
forChat(sessionId: string, chatId: string): Promise<LabelRecord[]> {
return this.client.request<LabelRecord[]>({
method: 'GET',
diff --git a/sdk/javascript/src/resources/messages.ts b/sdk/javascript/src/resources/messages.ts
index 64cc91153..210a89d0e 100644
--- a/sdk/javascript/src/resources/messages.ts
+++ b/sdk/javascript/src/resources/messages.ts
@@ -182,7 +182,7 @@ export class MessagesResource {
});
}
- /** Get the message history for a chat (read live from WhatsApp). */
+ /** Get the message history for a chat (read live from WhatsApp). **whatsapp-web.js only**: Baileys answers 501. */
history(sessionId: string, chatId: string, query?: MessageHistoryQuery): Promise<ChatHistoryMessage[]> {
return this.client.request<ChatHistoryMessage[]>({
method: 'GET',
@@ -191,7 +191,7 @@ export class MessagesResource {
});
}
- /** Get reactions for a specific message. */
+ /** Get reactions for a specific message. **whatsapp-web.js only**: Baileys answers 501. */
reactions(sessionId: string, chatId: string, messageId: string): Promise<ReactionRecord[]> {
return this.client.request<ReactionRecord[]>({
method: 'GET',
diff --git a/sdk/php/src/Resources/CatalogResource.php b/sdk/php/src/Resources/CatalogResource.php
index f3f98f6d9..89deaa38b 100644
--- a/sdk/php/src/Resources/CatalogResource.php
+++ b/sdk/php/src/Resources/CatalogResource.php
@@ -25,6 +25,7 @@ class CatalogResource
/**
* The catalog summary, or null when the account has no catalog collection to describe.
+ * Baileys only; whatsapp-web.js answers 501.
*
* @return array<string,mixed>|null
*/
@@ -37,6 +38,7 @@ class CatalogResource
* List catalog products (paginated). Returns a page shaped
* {products: list, pagination: {page, limit, total, totalPages}} — iterate over the `products`
* field, not the result itself. Consistent with the JavaScript, Python, and Java SDKs.
+ * Baileys only; whatsapp-web.js answers 501.
*
* @param array<string,mixed> $query e.g. ['page' => 1, 'limit' => 20].
* @return array{products: array<int,array<string,mixed>>, pagination: array<string,mixed>}
@@ -49,6 +51,7 @@ class CatalogResource
/**
* One catalog product, or null when no product in the catalog carries that id.
+ * Baileys only; whatsapp-web.js answers 501.
*
* @return array<string,mixed>|null
*/
@@ -59,6 +62,7 @@ class CatalogResource
/**
* Send a product message. Requires an OPERATOR-level key. Shares the messages path.
+ * Baileys only; whatsapp-web.js answers 501.
*
* @param array<string,mixed> $body chatId + productId required; body optional.
* @return array<string,mixed>
diff --git a/sdk/php/src/Resources/ChannelsResource.php b/sdk/php/src/Resources/ChannelsResource.php
index ef9f85d4e..fec6dbc4d 100644
--- a/sdk/php/src/Resources/ChannelsResource.php
+++ b/sdk/php/src/Resources/ChannelsResource.php
@@ -20,7 +20,11 @@ class ChannelsResource
$this->http = $http;
}
- /** @return array<int,array<string,mixed>> */
+ /**
+ * List the channels the session is subscribed to. whatsapp-web.js only; Baileys answers 501.
+ *
+ * @return array<int,array<string,mixed>>
+ */
public function list(string $sessionId): array
{
return $this->http->request('GET', "/api/sessions/{$this->http->encodeSegment($sessionId)}/channels") ?? [];
@@ -33,7 +37,7 @@ class ChannelsResource
}
/**
- * Get recent messages from a channel.
+ * Get recent messages from a channel. whatsapp-web.js only; Baileys answers 501.
*
* @param array<string,mixed> $query e.g. ['limit' => 50].
* @return array<int,array<string,mixed>>
@@ -79,6 +83,7 @@ class ChannelsResource
}
/**
* Subscribe to a channel using its invite code. Requires an OPERATOR-level key.
+ * Baileys only; whatsapp-web.js answers 501.
*
* @param array<string,mixed> $body Must contain 'inviteCode'.
* @return array<string,mixed>
diff --git a/sdk/php/src/Resources/GroupsResource.php b/sdk/php/src/Resources/GroupsResource.php
index bd14ffc36..935b5a5a4 100644
--- a/sdk/php/src/Resources/GroupsResource.php
+++ b/sdk/php/src/Resources/GroupsResource.php
@@ -36,6 +36,8 @@ class GroupsResource
}
/**
+ * Create a group. Baileys only; whatsapp-web.js answers 501.
+ *
* @param array<string,mixed> $body
* @return array<string,mixed>
*/
diff --git a/sdk/php/src/Resources/LabelsResource.php b/sdk/php/src/Resources/LabelsResource.php
index 3c0f907ba..13384047f 100644
--- a/sdk/php/src/Resources/LabelsResource.php
+++ b/sdk/php/src/Resources/LabelsResource.php
@@ -21,13 +21,21 @@ class LabelsResource
$this->http = $http;
}
- /** @return array<int,array<string,mixed>> */
+ /**
+ * List all labels available in the business account. whatsapp-web.js only; Baileys answers 501.
+ *
+ * @return array<int,array<string,mixed>>
+ */
public function list(string $sessionId): array
{
return $this->http->request('GET', "/api/sessions/{$this->http->encodeSegment($sessionId)}/labels") ?? [];
}
- /** @return array<string,mixed> */
+ /**
+ * Get a single label by id. whatsapp-web.js only; Baileys answers 501.
+ *
+ * @return array<string,mixed>
+ */
public function get(string $sessionId, string $labelId): array
{
return $this->http->request('GET', "/api/sessions/{$this->http->encodeSegment($sessionId)}/labels/{$this->http->encodeSegment($labelId)}");
@@ -70,7 +78,11 @@ class LabelsResource
return $this->http->request('DELETE', "/api/sessions/{$this->http->encodeSegment($sessionId)}/labels/{$this->http->encodeSegment($labelId)}");
}
- /** @return array<int,array<string,mixed>> */
+ /**
+ * Get the labels currently applied to a chat. whatsapp-web.js only; Baileys answers 501.
+ *
+ * @return array<int,array<string,mixed>>
+ */
public function forChat(string $sessionId, string $chatId): array
{
return $this->http->request('GET', "/api/sessions/{$this->http->encodeSegment($sessionId)}/labels/chat/{$this->http->encodeSegment($chatId)}") ?? [];
diff --git a/sdk/php/src/Resources/MessagesResource.php b/sdk/php/src/Resources/MessagesResource.php
index 283baaaab..37bac33ab 100644
--- a/sdk/php/src/Resources/MessagesResource.php
+++ b/sdk/php/src/Resources/MessagesResource.php
@@ -165,6 +165,7 @@ class MessagesResource
}
/**
+ * Read a chat's message history live from WhatsApp. whatsapp-web.js only; Baileys answers 501.
* Poll messages include poll.name, poll.options, and poll.allowMultipleAnswers when available.
* @param array<string,mixed> $query
* @return array<int,array<string,mixed>>
@@ -174,7 +175,11 @@ class MessagesResource
return $this->http->request('GET', "/api/sessions/{$this->http->encodeSegment($sessionId)}/messages/{$this->http->encodeSegment($chatId)}/history", $query) ?? [];
}
- /** @return array<int,array<string,mixed>> */
+ /**
+ * Get the reactions on a message. whatsapp-web.js only; Baileys answers 501.
+ *
+ * @return array<int,array<string,mixed>>
+ */
public function reactions(string $sessionId, string $chatId, string $messageId): array
{
return $this->http->request('GET', "/api/sessions/{$this->http->encodeSegment($sessionId)}/messages/{$this->http->encodeSegment($chatId)}/{$this->http->encodeSegment($messageId)}/reactions") ?? [];
diff --git a/sdk/python/openwa/resources/catalog.py b/sdk/python/openwa/resources/catalog.py
index 6905431e9..d0c19c036 100644
--- a/sdk/python/openwa/resources/catalog.py
+++ b/sdk/python/openwa/resources/catalog.py
@@ -30,24 +30,28 @@ class CatalogResource:
self._http = http
def info(self, session_id: str) -> CatalogInfo | None:
- """Get catalog info, or None when the account has no catalog."""
+ """Get catalog info, or None when the account has no catalog. Baileys only; whatsapp-web.js answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/catalog")
def products(
self, session_id: str, query: CatalogProductsQuery | None = None
) -> PaginatedProducts:
+ """List catalog products, one page. Baileys only; whatsapp-web.js answers 501."""
return self._http.request(
"GET", f"/api/sessions/{quote_segment(session_id)}/catalog/products", query=query
)
def product(self, session_id: str, product_id: str) -> CatalogProduct | None:
- """Get one product, or None when no product has that id."""
+ """Get one product, or None when no product has that id. Baileys only; whatsapp-web.js answers 501."""
return self._http.request(
"GET", f"/api/sessions/{quote_segment(session_id)}/catalog/products/{quote_segment(product_id)}"
)
def send_product(self, session_id: str, body: SendProductRequest) -> ProductMessageResponse:
- """Send a product message. Requires an OPERATOR-level key. Shares the messages path."""
+ """Send a product message. Requires an OPERATOR-level key. Shares the messages path.
+
+ Baileys only; whatsapp-web.js answers 501.
+ """
return self._http.request(
"POST", f"/api/sessions/{quote_segment(session_id)}/messages/send-product", body=body
)
diff --git a/sdk/python/openwa/resources/channels.py b/sdk/python/openwa/resources/channels.py
index ece249723..a7dd64a49 100644
--- a/sdk/python/openwa/resources/channels.py
+++ b/sdk/python/openwa/resources/channels.py
@@ -30,6 +30,7 @@ class ChannelsResource:
self._http = http
def list(self, session_id: str) -> list[ChannelRecord]:
+ """List the channels the session is subscribed to. whatsapp-web.js only; Baileys answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/channels")
def get(self, session_id: str, channel_id: str) -> ChannelRecord:
@@ -38,6 +39,7 @@ class ChannelsResource:
def messages(
self, session_id: str, channel_id: str, query: ChannelMessageQuery | None = None
) -> List[ChannelMessageRecord]:
+ """Get recent messages from a channel. whatsapp-web.js only; Baileys answers 501."""
return self._http.request(
"GET", f"/api/sessions/{quote_segment(session_id)}/channels/{quote_segment(channel_id)}/messages", query=query
)
@@ -63,7 +65,10 @@ class ChannelsResource:
)
def subscribe(self, session_id: str, body: SubscribeChannelRequest) -> ChannelRecord:
- """Subscribe to a channel using its invite code. Requires an OPERATOR-level key."""
+ """Subscribe to a channel using its invite code. Requires an OPERATOR-level key.
+
+ Baileys only; whatsapp-web.js answers 501.
+ """
return self._http.request("POST", f"/api/sessions/{quote_segment(session_id)}/channels/subscribe", body=body)
def unsubscribe(self, session_id: str, channel_id: str) -> SuccessResult:
diff --git a/sdk/python/openwa/resources/groups.py b/sdk/python/openwa/resources/groups.py
index b656b877f..6c8be2873 100644
--- a/sdk/python/openwa/resources/groups.py
+++ b/sdk/python/openwa/resources/groups.py
@@ -43,7 +43,7 @@ class GroupsResource:
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/groups/{quote_segment(group_id)}")
def create(self, session_id: str, body: CreateGroupRequest) -> GroupSummary:
- """Create a group.
+ """Create a group. Baileys only; whatsapp-web.js answers 501.
Answers the group SUMMARY, not the detail shape ``get()`` returns -- no participant list,
description, owner or creation time.
diff --git a/sdk/python/openwa/resources/labels.py b/sdk/python/openwa/resources/labels.py
index 09762a1b6..a120a2f1b 100644
--- a/sdk/python/openwa/resources/labels.py
+++ b/sdk/python/openwa/resources/labels.py
@@ -21,9 +21,11 @@ class LabelsResource:
self._http = http
def list(self, session_id: str) -> List[LabelRecord]:
+ """List all labels available in the business account. whatsapp-web.js only; Baileys answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/labels")
def get(self, session_id: str, label_id: str) -> LabelRecord:
+ """Get a single label by id. whatsapp-web.js only; Baileys answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/labels/{quote_segment(label_id)}")
def chats(self, session_id: str, label_id: str) -> List[ChatSummary]:
@@ -55,6 +57,7 @@ class LabelsResource:
)
def for_chat(self, session_id: str, chat_id: str) -> List[LabelRecord]:
+ """Get the labels currently applied to a chat. whatsapp-web.js only; Baileys answers 501."""
return self._http.request("GET", f"/api/sessions/{quote_segment(session_id)}/labels/chat/{quote_segment(chat_id)}")
def add_to_chat(self, session_id: str, chat_id: str, body: AddLabelRequest) -> SuccessResult:
diff --git a/sdk/python/openwa/resources/messages.py b/sdk/python/openwa/resources/messages.py
index 65e03bb61..1e4812626 100644
--- a/sdk/python/openwa/resources/messages.py
+++ b/sdk/python/openwa/resources/messages.py
@@ -111,11 +111,13 @@ class MessagesResource:
def history(
self, session_id: str, chat_id: str, query: MessageHistoryQuery | None = None
) -> List[ChatHistoryMessage]:
+ """Read a chat's message history live from WhatsApp. whatsapp-web.js only; Baileys answers 501."""
return self._http.request(
"GET", f"/api/sessions/{quote_segment(session_id)}/messages/{quote_segment(chat_id)}/history", query=query
)
def reactions(self, session_id: str, chat_id: str, message_id: str) -> List[ReactionRecord]:
+ """Get the reactions on a message. whatsapp-web.js only; Baileys answers 501."""
return self._http.request(
"GET", f"/api/sessions/{quote_segment(session_id)}/messages/{quote_segment(chat_id)}/{quote_segment(message_id)}/reactions"
)