Skip to main content

@wildix/classound-client > SendSmsCommand

SendSmsCommand class​

Signature:

export declare class SendSmsCommand extends SendSmsCommand_base

Extends: SendSmsCommand_base

Example​

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

import { ClassoundClient, SendSmsCommand } from "@wildix/classound-client"; // ES Modules import
// const { ClassoundClient, SendSmsCommand } = require("@wildix/classound-client"); // CommonJS import
const client = new ClassoundClient(config);
const input = { // SendSmsInput
  from: "STRING_VALUE", // required
  to: "STRING_VALUE", // required
  pbx: "STRING_VALUE", // required
  company: "STRING_VALUE", // required
  message: "STRING_VALUE", // required
  extension: "STRING_VALUE", // required
  media: [ // StringList
    "STRING_VALUE",
  ],
  userId: "STRING_VALUE",
  channelId: "STRING_VALUE",
  messageId: "STRING_VALUE",
};
const command = new SendSmsCommand(input);
const response = await client.send(command);
// { // SendSmsOutput
//   type: "STRING_VALUE",
//   success: true || false,
//   status: "STRING_VALUE",
//   id: [ // StringList
//     "STRING_VALUE",
//   ],
//   company: "STRING_VALUE",
//   data: { // SendSmsOutputData
//     from: "STRING_VALUE",
//     to: "STRING_VALUE",
//     message: "STRING_VALUE",
//     pbx: "STRING_VALUE",
//     extension: "STRING_VALUE",
//   },
// };