@wildix/xbees-kite-client > ListSmsConfigurationsCommand
ListSmsConfigurationsCommand class
Signature:
export declare class ListSmsConfigurationsCommand extends ListSmsConfigurationsCommand_base
Extends: ListSmsConfigurationsCommand_base
Example
Use a bare-bones client and the command you need to make an API call.
import { KiteClient, ListSmsConfigurationsCommand } from "@wildix/xbees-kite-client"; // ES Modules import
// const { KiteClient, ListSmsConfigurationsCommand } = require("@wildix/xbees-kite-client"); // CommonJS import
const client = new KiteClient(config);
const input = { // ListSmsConfigurationsInput
companyId: "STRING_VALUE",
};
const command = new ListSmsConfigurationsCommand(input);
const response = await client.send(command);
// { // ListSmsConfigurationsOutput
// configurations: [ // SmsConfigsList // required
// { // SmsConfig
// serviceUri: "STRING_VALUE", // required
// routes: [ // SmsConfigRoutesList
// { // SmsConfigRoute
// id: "STRING_VALUE", // required
// rules: [ // RouteRulesList // required
// { // RouteRule Union: only one key present
// timeFrame: { // RouteTimeFrameRule
// timeZone: "STRING_VALUE", // required
// day: "EVERY_DAY" || "WEEKDAYS" || "WEEKENDS" || "MONDAY" || "TUESDAY" || "WEDNESDAY" || "THURSDAY" || "FRIDAY" || "SATURDAY" || "SUNDAY", // required
// startMinute: Number("int"), // required
// endMinute: Number("int"), // required
// },
// },
// ],
// target: { // RouteTarget Union: only one key present
// service: { // RouteServiceTarget
// id: Number("int"), // required
// uri: "STRING_VALUE", // required
// },
// agent: { // RouteAgentTarget
// email: "STRING_VALUE", // required
// },
// bot: { // RouteBotTarget
// id: "STRING_VALUE", // required
// },
// },
// actions: [ // RouteActions
// { // RouteAction
// id: "STRING_VALUE", // required
// conditions: [ // RouteActionConditions
// { // RouteActionCondition Union: only one key present
// replyTimeout: { // RouteReplyTimeoutCondition
// timeout: Number("int"), // required
// },
// readTimeout: { // RouteReadTimeoutCondition
// timeout: Number("int"), // required
// },
// inactivityTimeout: { // InactivityTimeoutCondition
// timeout: Number("int"), // required
// },
// evaluation: { // RouteEvaluationCondition
// prompt: "STRING_VALUE", // required
// },
// },
// ],
// task: { // RouteActionTask Union: only one key present
// sendMessage: { // RouteSendMessageTask
// botId: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// },
// sendGenerativeMessage: { // RouteSendGenerativeMessageTask
// botId: "STRING_VALUE", // required
// },
// addMembers: { // RouteAddMembersTask
// emails: [ // RouteAddMembersUsersList // required
// "STRING_VALUE",
// ],
// },
// notifyMessage: { // RouteNotifyMessage
// botId: "STRING_VALUE", // required
// userId: "STRING_VALUE",
// channelId: "STRING_VALUE",
// text: "STRING_VALUE", // required
// variables: [ // RouteGenerativeVariablesList
// { // RouteGenerativeVariable
// term: "STRING_VALUE", // required
// description: "STRING_VALUE", // required
// },
// ],
// },
// notifyEmail: { // RouteNotifyEmail
// recipient: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// variables: [
// {
// term: "STRING_VALUE", // required
// description: "STRING_VALUE", // required
// },
// ],
// },
// },
// once: true || false,
// },
// ],
// },
// ],
// target: {// Union: only one key present
// service: {
// id: Number("int"), // required
// uri: "STRING_VALUE", // required
// },
// agent: {
// email: "STRING_VALUE", // required
// },
// bot: {
// id: "STRING_VALUE", // required
// },
// },
// actions: [
// {
// id: "STRING_VALUE", // required
// conditions: [
// {// Union: only one key present
// replyTimeout: {
// timeout: Number("int"), // required
// },
// readTimeout: {
// timeout: Number("int"), // required
// },
// inactivityTimeout: {
// timeout: Number("int"), // required
// },
// evaluation: {
// prompt: "STRING_VALUE", // required
// },
// },
// ],
// task: {// Union: only one key present
// sendMessage: {
// botId: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// },
// sendGenerativeMessage: {
// botId: "STRING_VALUE", // required
// },
// addMembers: {
// emails: [ // required
// "STRING_VALUE",
// ],
// },
// notifyMessage: {
// botId: "STRING_VALUE", // required
// userId: "STRING_VALUE",
// channelId: "STRING_VALUE",
// text: "STRING_VALUE", // required
// variables: [
// {
// term: "STRING_VALUE", // required
// description: "STRING_VALUE", // required
// },
// ],
// },
// notifyEmail: {
// recipient: "STRING_VALUE", // required
// text: "STRING_VALUE", // required
// variables: [
// {
// term: "STRING_VALUE", // required
// description: "STRING_VALUE", // required
// },
// ],
// },
// },
// once: true || false,
// },
// ],
// companyId: "STRING_VALUE", // required
// serviceNumber: "STRING_VALUE", // required
// createdAt: "STRING_VALUE", // required
// updatedAt: "STRING_VALUE",
// },
// ],
// };