Getting started
Authentication
Resources
- Access Passes
- Attachments
- Authentication
- Chats
- Companies
- Direct Messages
- Experiences
- Forums
- Notifications
- Payments
- Users
Direct Messages
List Direct Message Conversations
Fetch direct message or group chats for the current user. Experimental, don’t use in production yet.
This operation is only available on the server.
Copy
import { whopApi } from "@/lib/whop-api";
const result = await whopApi.listDirectMessageConversations({
// The `last_post_sent_at` timestamp to fetch channels before
beforeTimestamp: "9999999",
// Maximum number of channels to return
limit: 10,
// Filter by user or group name, e.g. 'Jack' or 'Fight Club'
query: "some string",
// Filter by status (accepted, requested, etc.)
status: "accepted" /* Valid values: accepted | hidden | requested */,
// Filter by unread status (true or false)
unread: true,
});
Example output:
Copy
const response = {
// Fetch direct message or group chats for the current user. Experimental, don't use in production yet.
myDmsChannelsV2: [
{
// The timestamp when the channel was created
createdAt: 1716931200,
// The unique identifier of the channel, e.g. 'feed_12345'
id: "xxxxxxxxxxx",
// Whether or not the channel is pinned to the top of the list
isPinned: true,
// The custom name of the DM channel, if any
customName: "some string",
// Whether or not the channel is a group chat
isGroupChat: true,
// List of members for the channel
feedMembers: [
{
// The username of the user e.g. 'jacksmith01'
username: "some string",
// The unique identifier of the member resource, e.g. 'feed_member_12345'
id: "xxxxxxxxxxx",
},
],
// Whether or not the channel has unread posts
isUnread: true,
// Last post in the channel
lastMessage: {
// The text content of the post
content: "some string",
// The ID of the user who sent this message, e.g. 'user_12345'
userId: "xxxxxxxxxxx",
},
},
],
};
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.