Skip to main content

Constructor

Parameters

SDKDependencies

Returns

IMessageSDK

Properties

PluginManager
required
Get plugin manager

Methods

close()

Close SDK and release resources

Returns

Promise<void>

getMessages()

Query messages

Parameters

Returns

MessageQueryResult

getUnreadMessages()

Get unread messages (grouped by sender)

Returns

UnreadMessagesResult Unread messages with statistics

listChats()

List chats with filtering and sorting options

Parameters

number | ListChatsOptions
Type: ListChatsOptionsFilter and sort options (or a number for backward compatibility)

Returns

ChatSummary Array of chat summaries with unread counts

message()

Create message processing chain

Parameters

required

Returns

MessageChain

send()

Send message to recipient (phone/email) or chat (chatId) Automatically detects whether the target is:
  • A recipient (phone number or email): e.g., ‘+1234567890’, ‘[email protected]’
  • A chatId (group or DM): e.g., ‘chat123…’, ‘iMessage;+1234567890’

Parameters

string
required
string | { files: string[]; images: string[]; text: string }
required

Returns

SendResult

sendBatch()

Send batch messages (concurrency controlled by sender’s maxConcurrent config)

Parameters

{ content: string | { files: string[]; images: string[]; text: string }; to: st…
required
Batch message list

Returns

SendResult List of send results (including success and failure)

sendFile()

Send file (convenience method) Supports both recipient (phone/email) and chatId

Parameters

string
required
string
required
string

Returns

SendResult

sendFiles()

Send multiple files (convenience method) Supports both recipient (phone/email) and chatId

Parameters

string
required
string[]
required
string

Returns

SendResult

startWatching()

Start watching for new messages

Parameters

Returns

Promise<void>

stopWatching()

Stop watching for new messages

use()

Register plugin

Parameters

required

Returns

this