Skip to main content

@wildix/wda-insights-client > ListConversationsInsightsCommand

ListConversationsInsightsCommand class​

Lists multiple independent insights in parallel.

Signature:

export declare class ListConversationsInsightsCommand extends ListConversationsInsightsCommand_base

Extends: ListConversationsInsightsCommand_base

Example​

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

import { WdaInsightsClient, ListConversationsInsightsCommand } from "@wildix/wda-insights-client"; // ES Modules import
// const { WdaInsightsClient, ListConversationsInsightsCommand } = require("@wildix/wda-insights-client"); // CommonJS import
const client = new WdaInsightsClient(config);
const input = { // ListConversationsInsightsInput
  company: "STRING_VALUE",
  insights: [ // InsightsDefinitionsList
    { // InsightsDefinition Union: only one key present
      projection: { // ProjectionDefinition
        id: "STRING_VALUE", // required
        fields: [ // ProjectionFieldsIdList
          "STRING_VALUE",
        ],
      },
      direction: {},
      duration: { // AggregationDurationDefinition
        buckets: [ // DurationGroupBucketsList
          { // DurationGroupBucket
            title: "STRING_VALUE", // required
            from: Number("int"),
            to: Number("int"),
          },
        ],
      },
      service: {},
      type: {},
      recorded: {},
    },
  ],
  filter: { // ListConversationsFilter
    participants: [ // ListConversationsFilterParticipantList
      { // ListConversationsFilterParticipant Union: only one key present
        email: "STRING_VALUE",
        phone: "STRING_VALUE",
        extension: "STRING_VALUE",
      },
    ],
    participantsToInclude: [
      {//  Union: only one key present
        email: "STRING_VALUE",
        phone: "STRING_VALUE",
        extension: "STRING_VALUE",
      },
    ],
    participantsToExclude: [
      {//  Union: only one key present
        email: "STRING_VALUE",
        phone: "STRING_VALUE",
        extension: "STRING_VALUE",
      },
    ],
    service: [ // ListConversationsFilterService
      "STRING_VALUE",
    ],
    phases: [ // ListConversationsFilterPhases
      "STRING_VALUE",
    ],
    language: [ // ListConversationsFilterLanguage
      "STRING_VALUE",
    ],
    duration: { // ListConversationsFilterDuration
      from: Number("int"),
      to: Number("int"),
    },
    recorded: true || false,
    transcribed: true || false,
    direction: { // ListConversationsFilterDirection
      inbound: true || false,
      outbound: true || false,
      internal: true || false,
    },
    insights: [ // ListConversationsFilterInsightsList
      { // ListConversationsFilterInsight
        projectionId: "STRING_VALUE", // required
        fieldId: "STRING_VALUE", // required
        match: "STRING_VALUE",
        matchAny: [ // StringList
          "STRING_VALUE",
        ],
      },
    ],
    date: { // ListConversationsFilterDate Union: only one key present
      absolute: { // ListConversationsFilterAbsoluteDate
        from: "STRING_VALUE",
        to: "STRING_VALUE",
        timeZone: "STRING_VALUE",
      },
      predefined: { // ListConversationsFilterPredefinedDate
        type: "THIS_QUARTER" || "THIS_MONTH" || "THIS_WEEK" || "TODAY" || "YESTERDAY" || "PREVIOUS_WEEK" || "PREVIOUS_MONTH" || "LAST_30_DAYS", // required
        timeZone: "STRING_VALUE",
      },
    },
  },
};
const command = new ListConversationsInsightsCommand(input);
const response = await client.send(command);
// { // ListConversationsInsightsOutput
//   count: Number("int"), // required
//   result: [ // InsightResultsList
//     { // InsightResult
//       insight: { // InsightsResultDefinition Union: only one key present
//         projection: { // ProjectionFieldDefinition
//           id: "STRING_VALUE", // required
//           fieldId: "STRING_VALUE", // required
//         },
//         direction: {},
//         duration: { // AggregationDurationDefinition
//           buckets: [ // DurationGroupBucketsList
//             { // DurationGroupBucket
//               title: "STRING_VALUE", // required
//               from: Number("int"),
//               to: Number("int"),
//             },
//           ],
//         },
//         service: {},
//         type: {},
//         recorded: {},
//       },
//       buckets: [ // InsightsBucketsList // required
//         { // InsightsBucket
//           key: "STRING_VALUE", // required
//           count: Number("long"), // required
//         },
//       ],
//     },
//   ],
// };