Skip to main content

@wildix/xbees-kite-client > ListAgentsCommand

ListAgentsCommand class​

Signature:

export declare class ListAgentsCommand extends ListAgentsCommand_base

Extends: ListAgentsCommand_base

Example​

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

import { KiteClient, ListAgentsCommand } from "@wildix/xbees-kite-client"; // ES Modules import
// const { KiteClient, ListAgentsCommand } = require("@wildix/xbees-kite-client"); // CommonJS import
const client = new KiteClient(config);
const input = { // ListAgentsInput
  companyId: "STRING_VALUE",
  filter: { // ListAgentsFilter Union: only one key present
    service: "STRING_VALUE",
    extensions: [ // ExtensionsList
      "STRING_VALUE",
    ],
    emails: [ // EmailsList
      "STRING_VALUE",
    ],
  },
};
const command = new ListAgentsCommand(input);
const response = await client.send(command);
// { // ListAgentsOutput
//   users: [ // UsersList // required
//     { // 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",
//     },
//   ],
// };