Skip to main content

@wildix/xbees-conversations-client > GetChannelMemberCommand

GetChannelMemberCommand class​

Retrieves details of a specific member in a channel. This includes the member's role and user information.

Signature:

export declare class GetChannelMemberCommand extends GetChannelMemberCommand_base

Extends: GetChannelMemberCommand_base

Example​

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

import { ConversationsClient, GetChannelMemberCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, GetChannelMemberCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // GetChannelMemberInput
  channelId: "STRING_VALUE", // required
  memberId: "STRING_VALUE", // required
};
const command = new GetChannelMemberCommand(input);
const response = await client.send(command);
// { // GetChannelMemberOutput
//   member: { // ChannelMember
//     id: "STRING_VALUE", // required
//     createdAt: "STRING_VALUE", // required
//     role: "member" || "supervisor", // required
//   },
//   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",
//   },
// };