ChatIds Client API
Generated client method reference for the chatIds namespace.
ChatIds Client API
This page documents 1 schema-registry client methods in the chatIds namespace.
getAllChatIds
Get all chat IDs
Signature client.getAllChatIds(): Promise<ChatId[]>
Usage
import { SocketClient } from '@open-wa/socket-client';
const client = await SocketClient.connect('http://localhost:8080', 'YOUR_API_KEY');
const result = await client.getAllChatIds();Parameters
This method does not define input parameters.
Returns
| Prop | Value |
|---|---|
| Return type | Promise<ChatId[]> |
| ChatId | View fields |
Resolves to ChatId[]. A rejected Promise indicates input validation or dispatch failure.
This method is not declared on the in-process Client facade. Use the remote Node.js client or HTTP API. Opaque conversation identifier. Use the exact value returned by a message event or chat lookup.
Advanced method metadata
Overview
| Prop | Value |
|---|---|
| Namespace | chatIds |
| Action | read |
| Functionality | both |
| Positional parameter order | - |
| Aliases | chatIds.all, chatIds.getAll, chatIds.list, chats.ids, listChatIds |
| Deprecated aliases | - |
| License | none |
| WAPI override | - |
| Deprecated | No |
Routes
| Type | Method | Path | Name | Status |
|---|---|---|---|---|
| Primary | GET | /api/chatIds/getAll | getAllChatIds | Active |
| Alias | GET | /api/chatIds/all | chatIds.all | Active |
| Alias | GET | /api/chatIds/list | chatIds.list | Active |
| Alias | GET | /api/chats/ids | chats.ids | Active |
| Alias | GET | /api/getAllChatIds | getAllChatIds | Active |
| Alias | GET | /api/listChatIds | listChatIds | Active |
Was this helpful?
Your answer includes the page path and docs version.