whatsapp-rpc 0.0.10 → 0.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +74 -0
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -144,6 +144,23 @@ Connect via WebSocket to `ws://localhost:9400/ws/rpc` and send JSON-RPC 2.0 requ
144
144
  | `group_invite_link` | `group_id` | Get invite link |
145
145
  | `group_revoke_invite` | `group_id` | Revoke and regenerate invite link |
146
146
 
147
+ ### Channels (Newsletters)
148
+
149
+ | Method | Parameters | Description |
150
+ |--------|------------|-------------|
151
+ | `newsletters` | `refresh` | List subscribed channels (cached 24h) |
152
+ | `newsletter_info` | `jid` or `invite`, `refresh` | Get channel details |
153
+ | `newsletter_create` | `name`, `description`, `picture` | Create a new channel |
154
+ | `newsletter_follow` | `jid` | Subscribe to a channel |
155
+ | `newsletter_unfollow` | `jid` | Unsubscribe from a channel |
156
+ | `newsletter_mute` | `jid`, `mute` | Mute/unmute a channel |
157
+ | `newsletter_messages` | `jid`, `count`, `before` | Get channel messages |
158
+ | `newsletter_send` | `group_id`, `type`, `message`/`media_data` | Send to channel (admin only) |
159
+ | `newsletter_mark_viewed` | `jid`, `server_ids[]` | Mark messages as viewed |
160
+ | `newsletter_react` | `jid`, `server_id`, `reaction` | React to a channel message |
161
+ | `newsletter_live_updates` | `jid` | Subscribe to live view/reaction updates |
162
+ | `newsletter_stats` | `jid` or `invite`, `count` | Get channel statistics (views, reactions) |
163
+
147
164
  ### Chat History
148
165
 
149
166
  | Method | Parameters | Description |
@@ -179,6 +196,10 @@ The server pushes events as JSON-RPC notifications (no `id` field):
179
196
  | `event.message_sent` | Message sent successfully |
180
197
  | `event.message_received` | New message received (includes forwarding info) |
181
198
  | `event.history_sync_complete` | History sync completed after first login |
199
+ | `event.newsletter_join` | Joined a channel |
200
+ | `event.newsletter_leave` | Left a channel |
201
+ | `event.newsletter_mute_change` | Channel mute state changed |
202
+ | `event.newsletter_live_update` | Live view/reaction count updates |
182
203
 
183
204
  ### Message Received Event Fields
184
205
 
@@ -321,6 +342,59 @@ The server pushes events as JSON-RPC notifications (no `id` field):
321
342
  }
322
343
  ```
323
344
 
345
+ ### List Channels
346
+
347
+ ```json
348
+ {
349
+ "jsonrpc": "2.0",
350
+ "id": 8,
351
+ "method": "newsletters",
352
+ "params": {}
353
+ }
354
+ ```
355
+
356
+ ### Get Channel Info by Invite Link
357
+
358
+ ```json
359
+ {
360
+ "jsonrpc": "2.0",
361
+ "id": 9,
362
+ "method": "newsletter_info",
363
+ "params": {
364
+ "invite": "https://whatsapp.com/channel/0029Va..."
365
+ }
366
+ }
367
+ ```
368
+
369
+ ### Send Message to Channel
370
+
371
+ ```json
372
+ {
373
+ "jsonrpc": "2.0",
374
+ "id": 10,
375
+ "method": "newsletter_send",
376
+ "params": {
377
+ "group_id": "123456789@newsletter",
378
+ "type": "text",
379
+ "message": "Hello subscribers!"
380
+ }
381
+ }
382
+ ```
383
+
384
+ ### Get Channel Statistics
385
+
386
+ ```json
387
+ {
388
+ "jsonrpc": "2.0",
389
+ "id": 11,
390
+ "method": "newsletter_stats",
391
+ "params": {
392
+ "jid": "123456789@newsletter",
393
+ "count": 20
394
+ }
395
+ }
396
+ ```
397
+
324
398
  ## Error Codes
325
399
 
326
400
  | Code | Description |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "whatsapp-rpc",
3
- "version": "0.0.10",
3
+ "version": "0.0.12",
4
4
  "type": "module",
5
5
  "description": "WhatsApp WebSocket RPC Server with JSON-RPC 2.0 protocol",
6
6
  "author": "Rohit G <trohitg@gmail.com>",