Skip to main content

@wildix/xbees-users-client > QueryUsersCommand

QueryUsersCommand class​

Signature:

export declare class QueryUsersCommand extends QueryUsersCommand_base

Extends: QueryUsersCommand_base

Example​

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

import { UsersClient, QueryUsersCommand } from "@wildix/xbees-users-client"; // ES Modules import
// const { UsersClient, QueryUsersCommand } = require("@wildix/xbees-users-client"); // CommonJS import
const client = new UsersClient(config);
const input = { // QueryUsersInput
  queries: [ // UsersQueryList // required
    { // UserQuery Union: only one key present
      id: "STRING_VALUE",
      email: "STRING_VALUE",
      phone: "STRING_VALUE",
    },
  ],
  predicate: { // UserQueryPredicate
    license: "basic" || "essential" || "business" || "premium" || "wizyconf",
  },
};
const command = new QueryUsersCommand(input);
const response = await client.send(command);
// { // QueryUsersOutput
//   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",
//     },
//   ],
// };