Class ConduitMessagesAPI

High-level messaging API for Conduit.

Provides message sending, editing, reactions, attachments, and thread interaction utilities.

Remarks

All methods wrap the underlying FCA callback API and expose Promise-based interfaces.

If a ConduitQueue is provided, outgoing operations are rate-limited and executed sequentially with simulated typing delays.

Accessible via client.messages.

Index

Constructors

constructor

Methods

changeThreadColor changeThreadEmoji delete edit forwardAttachment getMessage getThreadColors markAsRead react reply send sendTypingIndicator shareContact unsend uploadAttachment

Constructors

constructor

new ConduitMessagesAPI(
    bot: MessengerBot,
    eventBus: EventEmitter,
    queue?: ConduitQueue,
): ConduitMessagesAPI
Parameters
- bot: MessengerBot
- eventBus: EventEmitter
- Optionalqueue: ConduitQueue
Returns ConduitMessagesAPI
- Defined in src/api/ConduitMessagesAPI.ts:32

Methods

changeThreadColor

changeThreadColor(color: string, threadID: string): Promise<any>
Changes the theme color of a thread.
Parameters
- color: string
  Hex color string
- threadID: string
  Target conversation
Returns Promise<any>
- Defined in src/api/ConduitMessagesAPI.ts:318

changeThreadEmoji

changeThreadEmoji(emoji: string, threadID: string): Promise<any>
Changes the quick reaction emoji for a thread.
Parameters
- emoji: string
  Emoji string
- threadID: string
  Target conversation
Returns Promise<any>
- Defined in src/api/ConduitMessagesAPI.ts:333

delete

delete(messageID: string): Promise<void>
Deletes a message.
Parameters
- messageID: string
  Message to delete
Returns Promise<void>
- Defined in src/api/ConduitMessagesAPI.ts:208

edit

edit(messageID: string, body: string): Promise<SentMessage>
Edits an existing message sent by the bot.
Parameters
- messageID: string
  ID of the message to edit.
- body: string
  New text content to replace the message with.
Returns Promise<SentMessage>
Remarks
Only works on messages sent by the authenticated account. Attachments cannot be edited — text only.
- Defined in src/api/ConduitMessagesAPI.ts:155

forwardAttachment

forwardAttachment(attachmentID: string, threadID: string): Promise<any>
Forwards an existing attachment to another thread.
Parameters
- attachmentID: string
  Attachment identifier
- threadID: string
  Destination thread
Returns Promise<any>
- Defined in src/api/ConduitMessagesAPI.ts:301

getMessage

getMessage(messageID: string): Promise<any>
Retrieves a message by ID.
Parameters
- messageID: string
  Target message
Returns Promise<any>
- Defined in src/api/ConduitMessagesAPI.ts:349

getThreadColors

getThreadColors(): Promise<any>
Retrieves available thread color themes.

Returns Promise<any>
List of supported thread colors
- Defined in src/api/ConduitMessagesAPI.ts:363

markAsRead

markAsRead(messageID: string): Promise<any>
Marks a message as read.
Parameters
- messageID: string
  Message to mark
Returns Promise<any>
- Defined in src/api/ConduitMessagesAPI.ts:267

react

react(emoji: string, messageID: string, threadID: string): Promise<void>
Adds or removes a reaction to a message.
Parameters
- emoji: string
  Reaction emoji
- messageID: string
  Target message
- threadID: string
  Conversation ID
Returns Promise<void>
Remarks
Includes a small randomized delay to mimic natural interaction timing.
- Defined in src/api/ConduitMessagesAPI.ts:229

reply

reply(
    body: string | ConduitMessageBody | ConduitMessageBuilder,
    threadID: string,
    messageID: string,
): Promise<SentMessage>
Sends a reply to a specific message.
Parameters
- body: string | ConduitMessageBody | ConduitMessageBuilder
  Reply content
- threadID: string
  Conversation ID
- messageID: string
  Message being replied to
Returns Promise<SentMessage>
A SentMessage with collect(), waitResponse(), edit(), and unsend() scoped to this message.

Remarks
Behaves like send but attaches a reply reference to the message. The typing indicator is automatically stopped once the message is sent.
- Defined in src/api/ConduitMessagesAPI.ts:111

send

send(
body: string | ConduitMessageBody | ConduitMessageBuilder,
threadID: string,
): Promise<SentMessage>
Sends a message to a thread.
Parameters
- body: string | ConduitMessageBody | ConduitMessageBuilder
  Message content (text, structured body, or builder)
- threadID: string
  Target conversation ID
Returns Promise<SentMessage>
A SentMessage with collect(), waitResponse(), edit(), and unsend() scoped to this message.

Remarks
If a queue is enabled, the message is delayed and sent after a simulated typing indicator for a more natural behavior. The typing indicator is automatically stopped once the message is sent.
- Defined in src/api/ConduitMessagesAPI.ts:68

sendTypingIndicator

sendTypingIndicator(threadID: string): () => void
Sends a typing indicator to a thread and returns a function to stop it.
Parameters
- threadID: string
  Target conversation
Returns () => void
A stop function that cancels the typing indicator when called.
Example
```
const stopTyping = client.messages.sendTypingIndicator(threadID);
await doSomethingSlow();
stopTyping();
```
- Defined in src/api/ConduitMessagesAPI.ts:258

shareContact

shareContact(
    message: string | ConduitMessageBody | ConduitMessageBuilder,
    userID: string,
    threadID: string,
): Promise<unknown>
Shares a contact card (user profile) into a thread.
Parameters
- message: string | ConduitMessageBody | ConduitMessageBuilder
  Caption text accompanying the contact card.
- userID: string
  Facebook user ID of the contact to share.
- threadID: string
  Thread to send the contact card to.
Returns Promise<unknown>
- Defined in src/api/ConduitMessagesAPI.ts:188

unsend

unsend(messageID: string): Promise<void>
Retracts a message sent by the bot, removing it from the thread for all participants.
Parameters
- messageID: string
  ID of the message to unsend.
Returns Promise<void>
Remarks
Only works on messages sent by the authenticated account.
- Defined in src/api/ConduitMessagesAPI.ts:172

uploadAttachment

uploadAttachment(file: any): Promise<any>
Uploads an attachment and returns the uploaded reference.
Parameters
- file: any
  Stream, buffer, or attachment builder
Returns Promise<any>
- Defined in src/api/ConduitMessagesAPI.ts:283

Class ConduitMessagesAPI

Remarks

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ConduitMessagesAPI

Methods

changeThreadColor

Parameters

Returns Promise<any>

changeThreadEmoji

Parameters

Returns Promise<any>

delete

Parameters

Returns Promise<void>

edit

Parameters

Returns Promise<SentMessage>

Remarks

forwardAttachment

Parameters

Returns Promise<any>

getMessage

Parameters

Returns Promise<any>

getThreadColors

Returns Promise<any>

markAsRead

Parameters

Returns Promise<any>

react

Parameters

Returns Promise<void>

Remarks

reply

Parameters

Returns Promise<SentMessage>

Remarks

send

Parameters

Returns Promise<SentMessage>

Remarks

sendTypingIndicator

Parameters

Returns () => void

Example

shareContact

Parameters

Returns Promise<unknown>

unsend

Parameters

Returns Promise<void>

Remarks

uploadAttachment

Parameters

Returns Promise<any>

Settings

On This Page