Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onlyfanskit.dev/llms.txt

Use this file to discover all available pages before exploring further.

ResourceWhat it covers
of.messagesDirect + mass messaging: list, send, delete, markRead, search, per-message reactions (like, unlike, pin, unpin, hide), templates, mass-message queue lifecycle (queueCreate, queueUpdate, queueCancel, queueSize, queueBuyers, queueChart), reply-on-subscribe template.
of.chatsChat list, retrieve, mark-read / mark-unread (single + batch), priority counts, mediaGallery, searchMessages, retrieveMessage, delete chat, unpin all.
of.notificationsList, count, mark-all-read, transports, per-category settings.

​
Recipes

const chats = await of.chats.list({ limit: 20, order: "recent" });
const first = chats.list[0];

const msgs = await of.messages.list(first.withUser.id, { limit: 30 });

await of.messages.send(first.withUser.id, {
  text: "Hi!",
  // mediaFiles: [...], price: 0, lockedText: false   // for paid messages
});
See the Messaging guide for end-to-end flows and Mass messaging for campaigns.