Skip to main content

@wildix/xbees-conversations-client > ListChannelMembersReadStatusCommand

ListChannelMembersReadStatusCommand class​

Retrieves a list of members read status for a specific channel. Read status does not work for conversations with more than 100 members.

Signature:

export declare class ListChannelMembersReadStatusCommand extends ListChannelMembersReadStatusCommand_base

Extends: ListChannelMembersReadStatusCommand_base

Example​

Use a bare-bones client and the command you need to make an API call.

import { ConversationsClient, ListChannelMembersReadStatusCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, ListChannelMembersReadStatusCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // ListChannelMembersReadStatusInput
  channelId: "STRING_VALUE", // required
};
const command = new ListChannelMembersReadStatusCommand(input);
const response = await client.send(command);
// { // ListChannelMembersReadStatusOutput
//   members: [ // ChannelMembersReadStatusList // required
//     { // ChannelMemberReadStatus
//       user: { // User
//         id: "STRING_VALUE", // required
//         name: "STRING_VALUE",
//         email: "STRING_VALUE",
//         phone: "STRING_VALUE",
//         picture: "STRING_VALUE",
//         locale: "STRING_VALUE",
//         timeZone: "STRING_VALUE",
//         company: "STRING_VALUE",
//         bot: true || false,
//         pbxDomain: "STRING_VALUE",
//         pbxPort: "STRING_VALUE",
//         pbxExtension: "STRING_VALUE",
//         pbxSerial: "STRING_VALUE",
//         pbxUserId: "STRING_VALUE",
//         createdAt: "STRING_VALUE",
//         updatedAt: "STRING_VALUE",
//       },
//       lastRead: "STRING_VALUE",
//       lastReadMessageId: "STRING_VALUE",
//     },
//   ],
// };