Skip to main content

@wildix/xbees-users-client > QueryColleaguesCommand

QueryColleaguesCommand class​

Signature:

export declare class QueryColleaguesCommand extends QueryColleaguesCommand_base

Extends: QueryColleaguesCommand_base

Example​

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

import { UsersClient, QueryColleaguesCommand } from "@wildix/xbees-users-client"; // ES Modules import
// const { UsersClient, QueryColleaguesCommand } = require("@wildix/xbees-users-client"); // CommonJS import
const client = new UsersClient(config);
const input = { // QueryColleaguesInput
  company: "STRING_VALUE",
  query: { // QueryColleaguesParameters
    id: [ // ColleaguesFilterList
      "STRING_VALUE",
    ],
    extension: [
      "STRING_VALUE",
    ],
    officePhone: [
      "STRING_VALUE",
    ],
    mobilePhone: [
      "STRING_VALUE",
    ],
    name: [
      "STRING_VALUE",
    ],
    email: "<ColleaguesFilterList>",
    department: "<ColleaguesFilterList>",
    search: "STRING_VALUE",
    searchFields: [ // PbxColleaguesQueryFieldList
      "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
    ],
    searchStrategy: "contain" || "startsWith",
    sort: [
      "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
    ],
    start: Number("int"),
    count: Number("int"),
    dir: "asc" || "desc",
  },
};
const command = new QueryColleaguesCommand(input);
const response = await client.send(command);
// { // QueryColleaguesOutput
//   colleagues: [ // QueryColleaguesOutputItemList // required
//     { // QueryColleaguesOutputItem
//       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",
//       },
//       colleague: { // PbxColleague
//         id: "STRING_VALUE", // required
//         name: "STRING_VALUE",
//         login: "STRING_VALUE",
//         extension: "STRING_VALUE", // required
//         officePhone: "STRING_VALUE",
//         mobilePhone: "STRING_VALUE",
//         faxNumber: "STRING_VALUE",
//         email: "STRING_VALUE",
//         pbxDn: "STRING_VALUE", // required
//         pbx: "STRING_VALUE", // required
//         role: "admin" || "user" || "fax" || "park_orbit" || "room", // required
//         groupName: "STRING_VALUE", // required
//         groupDn: "STRING_VALUE", // required
//         language: "STRING_VALUE", // required
//         dialplan: "STRING_VALUE", // required
//         faxDialplan: "STRING_VALUE", // required
//         department: "STRING_VALUE",
//         picture: "STRING_VALUE", // required
//         sourceId: "STRING_VALUE",
//         licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
//         jid: "STRING_VALUE", // required
//       },
//     },
//   ],
// };