Skip to main content

@wildix/wms-api-client > GetPbxColleaguesCommand

GetPbxColleaguesCommand class​

Signature:

export declare class GetPbxColleaguesCommand extends GetPbxColleaguesCommand_base

Extends: GetPbxColleaguesCommand_base

Example​

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

import { WmsApiClient, GetPbxColleaguesCommand } from "@wildix/wms-api-client"; // ES Modules import
// const { WmsApiClient, GetPbxColleaguesCommand } = require("@wildix/wms-api-client"); // CommonJS import
const client = new WmsApiClient(config);
const input = { // GetPbxColleaguesInput
  extension: [ // ColleaguesFilterList
    "STRING_VALUE",
  ],
  id: [
    "STRING_VALUE",
  ],
  officePhone: [
    "STRING_VALUE",
  ],
  mobilePhone: [
    "STRING_VALUE",
  ],
  name: [
    "STRING_VALUE",
  ],
  email: "<ColleaguesFilterList>",
  role: "<ColleaguesFilterList>",
  dialplan: "<ColleaguesFilterList>",
  faxDialplan: "<ColleaguesFilterList>",
  department: "<ColleaguesFilterList>",
  login: "<ColleaguesFilterList>",
  groupDn: "<ColleaguesFilterList>",
  pbxDn: "<ColleaguesFilterList>",
  licenseType: [ // ColleaguesFilterLicenseTypeList
    "basic" || "essential" || "business" || "premium" || "wizyconf",
  ],
  fields: [ // PbxColleaguesQueryFieldList
    "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
  ],
  searchFields: [
    "extension" || "officePhone" || "mobilePhone" || "name" || "email" || "role" || "groupDn" || "language" || "dialplan" || "faxDialplan" || "department" || "login" || "id" || "pbxDn" || "picture" || "sourceId" || "licenseType",
  ],
  search: "STRING_VALUE",
  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",
  searchStrategy: "contain" || "startsWith",
};
const command = new GetPbxColleaguesCommand(input);
const response = await client.send(command);
// { // GetPbxColleaguesOutput
//   type: "result" || "error", // required
//   result: { // GetPbxColleaguesResult
//     records: [ // PbxColleaguesList // required
//       { // 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
//       },
//     ],
//     total: Number("int"), // required
//   },
// };