Skip to main content

@wildix/wms-api-client > NotificationsCommand

NotificationsCommand class​

Notifications

Signature:

export declare class NotificationsCommand extends NotificationsCommand_base

Extends: NotificationsCommand_base

Example​

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

import { WmsApiClient, NotificationsCommand } from "@wildix/wms-api-client"; // ES Modules import
// const { WmsApiClient, NotificationsCommand } = require("@wildix/wms-api-client"); // CommonJS import
const client = new WmsApiClient(config);
const input = { // NotificationsInput
  from: "STRING_VALUE", // required
  notificationType: "STRING_VALUE", // required
  event: "STRING_VALUE", // required
  broadcastMessage: "STRING_VALUE", // required
  conferenceId: "STRING_VALUE", // required
  playFrequency: Number("int"),
  confirmationTimeout: Number("int"),
  queueTimeout: Number("int"),
  origin: "STRING_VALUE",
  priority: Number("int"),
  customRid: "STRING_VALUE",
};
const command = new NotificationsCommand(input);
const response = await client.send(command);
// { // NotificationsOutput
//   type: "result" || "error", // required
//   result: { // NotificationsOutputResult
//     requestId: "STRING_VALUE", // required
//   },
// };