Skip to main content

@wildix/wms-api-client > GetPbxesCommand

GetPbxesCommand class​

Get list of PBXes.

Signature:

export declare class GetPbxesCommand extends GetPbxesCommand_base

Extends: GetPbxesCommand_base

Example​

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

import { WmsApiClient, GetPbxesCommand } from "@wildix/wms-api-client"; // ES Modules import
// const { WmsApiClient, GetPbxesCommand } = require("@wildix/wms-api-client"); // CommonJS import
const client = new WmsApiClient(config);
const input = {};
const command = new GetPbxesCommand(input);
const response = await client.send(command);
// { // GetPbxesOutput
//   type: "result" || "error", // required
//   result: { // GetPbxesResult
//     records: [ // PbxesList // required
//       { // Pbx
//         ip: "STRING_VALUE", // required
//         serial: "STRING_VALUE", // required
//         host: "STRING_VALUE", // required
//         isServer: true || false, // required
//         port: Number("int"), // required
//         failOver: "STRING_VALUE", // required
//         version: "STRING_VALUE", // required
//         isUpdateNeeded: true || false, // required
//         dn: "STRING_VALUE", // required
//       },
//     ],
//   },
// };