Skip to main content

@wildix/xbees-users-client > GetAccountCommand

GetAccountCommand class​

Retrieves the current account with identities and workspaces.

Signature:

export declare class GetAccountCommand extends GetAccountCommand_base

Extends: GetAccountCommand_base

Example​

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

import { UsersClient, GetAccountCommand } from "@wildix/xbees-users-client"; // ES Modules import
// const { UsersClient, GetAccountCommand } = require("@wildix/xbees-users-client"); // CommonJS import
const client = new UsersClient(config);
const input = { // GetAccountInput
  accountId: "STRING_VALUE", // required
};
const command = new GetAccountCommand(input);
const response = await client.send(command);
// { // GetAccountOutput
//   account: { // Account
//     id: "STRING_VALUE", // required
//     defaultWorkspace: "STRING_VALUE",
//     primaryIdentity: "STRING_VALUE",
//   },
//   workspaces: [ // WorkspaceList // required
//     { // Workspace
//       companyId: "STRING_VALUE",
//       pbxUser: { // 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",
//       },
//       streamUser: { // 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",
//         pbxGroupId: "STRING_VALUE",
//         createdAt: "STRING_VALUE",
//         updatedAt: "STRING_VALUE",
//       },
//       type: "personal" || "work" || "support",
//       id: "STRING_VALUE", // required
//       accountId: "STRING_VALUE", // required
//       active: true || false, // required
//     },
//   ],
//   identities: [ // IdentityList // required
//     { // Identity
//       identity: "STRING_VALUE", // required
//       account: "STRING_VALUE", // required
//       verified: true || false,
//     },
//   ],
// };