Skip to main content

@wildix/xbees-users-client > GetUserPbxLinkDataCommand

GetUserPbxLinkDataCommand class​

Signature:

export declare class GetUserPbxLinkDataCommand extends GetUserPbxLinkDataCommand_base

Extends: GetUserPbxLinkDataCommand_base

Example​

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

import { UsersClient, GetUserPbxLinkDataCommand } from "@wildix/xbees-users-client"; // ES Modules import
// const { UsersClient, GetUserPbxLinkDataCommand } = require("@wildix/xbees-users-client"); // CommonJS import
const client = new UsersClient(config);
const input = { // GetUserPbxLinkDataInput
  userId: "STRING_VALUE", // required
};
const command = new GetUserPbxLinkDataCommand(input);
const response = await client.send(command);
// { // GetUserPbxLinkDataOutput
//   user: { // UserPbxLinkData
//     id: "STRING_VALUE", // required
//     company: "STRING_VALUE", // required
//     companyName: "STRING_VALUE",
//     domain: "STRING_VALUE", // required
//     email: "STRING_VALUE",
//     info: { // UserPersonalInfo
//       dn: "STRING_VALUE", // required
//       id: "STRING_VALUE", // required
//       name: "STRING_VALUE", // required
//       extension: "STRING_VALUE", // required
//       officePhone: "STRING_VALUE",
//       mobilePhone: "STRING_VALUE",
//       faxNumber: "STRING_VALUE",
//       email: "STRING_VALUE",
//       role: "STRING_VALUE", // required
//       language: "STRING_VALUE", // required
//       dialplan: "STRING_VALUE", // required
//       faxDialplan: "STRING_VALUE", // required
//       departament: "STRING_VALUE",
//       picture: "STRING_VALUE", // required
//       groupDn: "STRING_VALUE", // required
//       groupName: "STRING_VALUE", // required
//       jid: "STRING_VALUE", // required
//       licenseType: "basic" || "essential" || "business" || "premium" || "wizyconf", // required
//       login: "STRING_VALUE",
//       pbx: "STRING_VALUE",
//       pbxDn: "STRING_VALUE", // required
//       sourceId: "STRING_VALUE",
//       sipPassword: "STRING_VALUE",
//     },
//     pbx: { // UserPbxInfo
//       networkAddresses: [ // UserPbxInfoNetworkAddresses // required
//         "STRING_VALUE",
//       ],
//       ports: [ // UserPbxInfoPorts // required
//         "STRING_VALUE",
//       ],
//       externalLinePrefix: "STRING_VALUE",
//       version: "STRING_VALUE", // required
//       serial: "STRING_VALUE", // required
//     },
//     picture: "STRING_VALUE", // required
//     pictureDeleted: true || false,
//     port: "STRING_VALUE", // required
//     serial: "STRING_VALUE", // required
//     services: { // UserPbxServices
//       xcaracal: true || false,
//       wizyWebinar: true || false,
//     },
//     personalSettings: {},
//     dialplanSettings: {},
//     awsRegion: "STRING_VALUE",
//     updatedAt: "STRING_VALUE",
//   },
// };