Spaces:
Runtime error
Runtime error
File size: 6,755 Bytes
46252cd | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | /**
* Messages resource — sending and querying messages.
*
* Backed by `src/modules/message/message.controller.ts`.
* NOTE: the real paths use the `/send-` prefix, e.g. `/messages/send-text`.
* @packageDocumentation
*/
import { encodeSegment } from '../http.js';
import type { OpenWAClient } from '../client.js';
import type {
BatchStatusResponse,
BulkMessageResponse,
ChatHistoryMessage,
DeleteMessageRequest,
EditMessageRequest,
ForwardMessageRequest,
ListMessagesQuery,
MessageHistoryQuery,
MessageListResponse,
MessageResponse,
ReactionRecord,
ReactMessageRequest,
ReplyMessageRequest,
SendBulkRequest,
SendContactRequest,
SendLocationRequest,
SendAudioRequest,
SendMediaRequest,
SendTemplateRequest,
SendTextRequest,
SuccessResult,
} from '../types.js';
export class MessagesResource {
constructor(private readonly client: OpenWAClient) {}
/** List messages, optionally filtered by chat or sender. Returns a `{ messages, total }` page. */
list(sessionId: string, query?: ListMessagesQuery): Promise<MessageListResponse> {
return this.client.request<MessageListResponse>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/messages`,
query,
});
}
/** Send a text message. */
sendText(sessionId: string, body: SendTextRequest): Promise<MessageResponse> {
return this.client.request<MessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/send-text`,
body,
});
}
/** Send an image (url or base64). */
sendImage(sessionId: string, body: SendMediaRequest): Promise<MessageResponse> {
return this.client.sendMedia(sessionId, 'send-image', body);
}
/** Send a video (url or base64). */
sendVideo(sessionId: string, body: SendMediaRequest): Promise<MessageResponse> {
return this.client.sendMedia(sessionId, 'send-video', body);
}
/** Send an audio file (url or base64). */
sendAudio(sessionId: string, body: SendAudioRequest): Promise<MessageResponse> {
return this.client.sendMedia(sessionId, 'send-audio', body);
}
/** Send a document (url or base64; `filename` required). */
sendDocument(sessionId: string, body: SendMediaRequest): Promise<MessageResponse> {
return this.client.sendMedia(sessionId, 'send-document', body);
}
/** Send a sticker (url or base64). */
sendSticker(sessionId: string, body: SendMediaRequest): Promise<MessageResponse> {
return this.client.sendMedia(sessionId, 'send-sticker', body);
}
/** Send a location. */
sendLocation(sessionId: string, body: SendLocationRequest): Promise<MessageResponse> {
return this.client.request<MessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/send-location`,
body,
});
}
/** Send a contact card. */
sendContact(sessionId: string, body: SendContactRequest): Promise<MessageResponse> {
return this.client.request<MessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/send-contact`,
body,
});
}
/** Render and send a stored message template. */
sendTemplate(sessionId: string, body: SendTemplateRequest): Promise<MessageResponse> {
return this.client.request<MessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/send-template`,
body,
});
}
/** Reply to a specific message. */
reply(sessionId: string, body: ReplyMessageRequest): Promise<MessageResponse> {
return this.client.request<MessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/reply`,
body,
});
}
/** Forward a message to another chat. */
forward(sessionId: string, body: ForwardMessageRequest): Promise<MessageResponse> {
return this.client.request<MessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/forward`,
body,
});
}
/** React to a message (empty `emoji` removes the reaction). */
react(sessionId: string, body: ReactMessageRequest): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/react`,
body,
});
}
/** Delete a message. */
delete(sessionId: string, body: DeleteMessageRequest): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/delete`,
body,
});
}
/** Edit the text of an own message (404 if the message is not found). */
editMessage(sessionId: string, body: EditMessageRequest): Promise<MessageResponse> {
return this.client.request<MessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/edit`,
body,
});
}
/** Get the message history for a chat (read live from WhatsApp). */
history(sessionId: string, chatId: string, query?: MessageHistoryQuery): Promise<ChatHistoryMessage[]> {
return this.client.request<ChatHistoryMessage[]>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/${encodeSegment(chatId)}/history`,
query,
});
}
/** Get reactions for a specific message. */
reactions(sessionId: string, chatId: string, messageId: string): Promise<ReactionRecord[]> {
return this.client.request<ReactionRecord[]>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/${encodeSegment(chatId)}/${encodeSegment(messageId)}/reactions`,
});
}
/**
* Send a batch of messages asynchronously. Returns HTTP 202 with a batch id;
* poll the status via {@link batchStatus}.
*/
sendBulk(sessionId: string, body: SendBulkRequest): Promise<BulkMessageResponse> {
return this.client.request<BulkMessageResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/send-bulk`,
body,
});
}
/** Poll the status/progress of a bulk send batch. */
batchStatus(sessionId: string, batchId: string): Promise<BatchStatusResponse> {
return this.client.request<BatchStatusResponse>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/batch/${encodeSegment(batchId)}`,
});
}
/** Cancel a running batch. Requires an OPERATOR-level key. */
cancelBatch(sessionId: string, batchId: string): Promise<BatchStatusResponse> {
return this.client.request<BatchStatusResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/messages/batch/${encodeSegment(batchId)}/cancel`,
});
}
}
|