Skip to main content

@wildix/wda-insights-client > ListConversationsAggregationsCommand

ListConversationsAggregationsCommand class​

Lists multiple independent insights in parallel.

Signature:

export declare class ListConversationsAggregationsCommand extends ListConversationsAggregationsCommand_base

Extends: ListConversationsAggregationsCommand_base

Example​

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

import { WdaInsightsClient, ListConversationsAggregationsCommand } from "@wildix/wda-insights-client"; // ES Modules import
// const { WdaInsightsClient, ListConversationsAggregationsCommand } = require("@wildix/wda-insights-client"); // CommonJS import
const client = new WdaInsightsClient(config);
const input = { // ListConversationsAggregationsInput
  company: "STRING_VALUE",
  insights: [ // AggregationDefinitionsList
    { // AggregationDefinition Union: only one key present
      projection: { // AggregationProjectionDefinition
        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: {},
      extension: {},
      group: {},
      department: {},
      tag: "<AggregationNoConfigurationDefinition>",
      pbx: "<AggregationNoConfigurationDefinition>",
      trunk: "<AggregationNoConfigurationDefinition>",
      queue: "<AggregationNoConfigurationDefinition>",
      country: "<AggregationNoConfigurationDefinition>",
      location: "<AggregationNoConfigurationDefinition>",
      language: "<AggregationNoConfigurationDefinition>",
      entity: "<AggregationNoConfigurationDefinition>",
      channel: "<AggregationNoConfigurationDefinition>",
      recorded: "<AggregationNoConfigurationDefinition>",
      date: { // AggregationDateDefinition
        timeZone: "STRING_VALUE",
      },
      dayOfWeek: { // AggregationDayOfWeekDefinition
        timeZone: "STRING_VALUE",
      },
      hourOfDay: { // AggregationHourOfDayDefinition
        timeZone: "STRING_VALUE",
      },
    },
  ],
  filter: { // ListConversationsFilter
    id: [ // ListConversationsFilterIdList
      { // ConversationTarget Union: only one key present
        call: { // CallConversationTarget
          callId: "STRING_VALUE", // required
          flowIndex: Number("int"), // required
        },
        conference: { // ConferenceConversationTarget
          conferenceId: "STRING_VALUE", // required
        },
        chat: { // ChatConversationTarget
          chatId: "STRING_VALUE", // required
        },
      },
    ],
    entity: { // ListConversationsFilterEntity
      call: true || false,
      conference: true || false,
      chat: true || false,
    },
    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: [ // ListConversationsFilterKeyword
      "STRING_VALUE",
    ],
    group: [
      "STRING_VALUE",
    ],
    department: [
      "STRING_VALUE",
    ],
    tag: [
      "STRING_VALUE",
    ],
    pbx: [
      "STRING_VALUE",
    ],
    trunk: "<ListConversationsFilterKeyword>",
    queue: "<ListConversationsFilterKeyword>",
    country: "<ListConversationsFilterKeyword>",
    location: "<ListConversationsFilterKeyword>",
    phases: [ // ListConversationsFilterPhases
      "STRING_VALUE",
    ],
    language: "<ListConversationsFilterKeyword>",
    duration: { // ListConversationsFilterNumber
      from: Number("int"),
      to: Number("int"),
    },
    interaction: { // ListConversationsFilterInteraction
      talkRatio: {
        from: Number("int"),
        to: Number("int"),
      },
      wordsPerMinute: {
        from: Number("int"),
        to: Number("int"),
      },
      interruptions: {
        from: Number("int"),
        to: Number("int"),
      },
      patience: { // ListConversationsFilterFloat
        from: Number("float"),
        to: Number("float"),
      },
      longestMonologue: {
        from: Number("int"),
        to: Number("int"),
      },
      longestCustomerStory: "<ListConversationsFilterNumber>",
    },
    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",
        ],
      },
    ],
    channel: { // ListConversationsFilterChannel
      sms: true || false,
      whatsapp: true || false,
      kite: true || false,
    },
    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",
      },
    },
    present: [ // ListConversationsFilterFieldsList
      { // ListConversationsFilterField Union: only one key present
        direction: true || false,
        service: true || false,
        group: true || false,
        department: true || false,
        tag: true || false,
        pbx: true || false,
        trunk: true || false,
        queue: true || false,
        country: true || false,
        location: true || false,
        language: true || false,
        projection: { // ListConversationsFilterProjectionField
          projectionId: "STRING_VALUE", // required
          fieldId: "STRING_VALUE", // required
        },
      },
    ],
    absent: [
      {//  Union: only one key present
        direction: true || false,
        service: true || false,
        group: true || false,
        department: true || false,
        tag: true || false,
        pbx: true || false,
        trunk: true || false,
        queue: true || false,
        country: true || false,
        location: true || false,
        language: true || false,
        projection: {
          projectionId: "STRING_VALUE", // required
          fieldId: "STRING_VALUE", // required
        },
      },
    ],
  },
};
const command = new ListConversationsAggregationsCommand(input);
const response = await client.send(command);
// { // ListConversationsAggregationsOutput
//   count: Number("int"), // required
//   result: [ // FlatAggregationResultList
//     { // FlatAggregationResult
//       aggregation: { // AggregationDefinition Union: only one key present
//         projection: { // AggregationProjectionDefinition
//           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: {},
//         extension: {},
//         group: {},
//         department: {},
//         tag: "<AggregationNoConfigurationDefinition>",
//         pbx: "<AggregationNoConfigurationDefinition>",
//         trunk: "<AggregationNoConfigurationDefinition>",
//         queue: "<AggregationNoConfigurationDefinition>",
//         country: "<AggregationNoConfigurationDefinition>",
//         location: "<AggregationNoConfigurationDefinition>",
//         language: "<AggregationNoConfigurationDefinition>",
//         entity: "<AggregationNoConfigurationDefinition>",
//         channel: "<AggregationNoConfigurationDefinition>",
//         recorded: "<AggregationNoConfigurationDefinition>",
//         date: { // AggregationDateDefinition
//           timeZone: "STRING_VALUE",
//         },
//         dayOfWeek: { // AggregationDayOfWeekDefinition
//           timeZone: "STRING_VALUE",
//         },
//         hourOfDay: { // AggregationHourOfDayDefinition
//           timeZone: "STRING_VALUE",
//         },
//       },
//       buckets: [ // FlatAggregationBucketList // required
//         { // FlatAggregationBucket
//           key: "STRING_VALUE", // required
//           count: Number("long"), // required
//           interval: "month" || "week" || "day" || "hour" || "minute",
//           filter: { // ListConversationsFilter
//             id: [ // ListConversationsFilterIdList
//               { // ConversationTarget Union: only one key present
//                 call: { // CallConversationTarget
//                   callId: "STRING_VALUE", // required
//                   flowIndex: Number("int"), // required
//                 },
//                 conference: { // ConferenceConversationTarget
//                   conferenceId: "STRING_VALUE", // required
//                 },
//                 chat: { // ChatConversationTarget
//                   chatId: "STRING_VALUE", // required
//                 },
//               },
//             ],
//             entity: { // ListConversationsFilterEntity
//               call: true || false,
//               conference: true || false,
//               chat: true || false,
//             },
//             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: [ // ListConversationsFilterKeyword
//               "STRING_VALUE",
//             ],
//             group: [
//               "STRING_VALUE",
//             ],
//             department: [
//               "STRING_VALUE",
//             ],
//             tag: [
//               "STRING_VALUE",
//             ],
//             pbx: [
//               "STRING_VALUE",
//             ],
//             trunk: "<ListConversationsFilterKeyword>",
//             queue: "<ListConversationsFilterKeyword>",
//             country: "<ListConversationsFilterKeyword>",
//             location: "<ListConversationsFilterKeyword>",
//             phases: [ // ListConversationsFilterPhases
//               "STRING_VALUE",
//             ],
//             language: "<ListConversationsFilterKeyword>",
//             duration: { // ListConversationsFilterNumber
//               from: Number("int"),
//               to: Number("int"),
//             },
//             interaction: { // ListConversationsFilterInteraction
//               talkRatio: {
//                 from: Number("int"),
//                 to: Number("int"),
//               },
//               wordsPerMinute: {
//                 from: Number("int"),
//                 to: Number("int"),
//               },
//               interruptions: {
//                 from: Number("int"),
//                 to: Number("int"),
//               },
//               patience: { // ListConversationsFilterFloat
//                 from: Number("float"),
//                 to: Number("float"),
//               },
//               longestMonologue: {
//                 from: Number("int"),
//                 to: Number("int"),
//               },
//               longestCustomerStory: "<ListConversationsFilterNumber>",
//             },
//             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",
//                 ],
//               },
//             ],
//             channel: { // ListConversationsFilterChannel
//               sms: true || false,
//               whatsapp: true || false,
//               kite: true || false,
//             },
//             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",
//               },
//             },
//             present: [ // ListConversationsFilterFieldsList
//               { // ListConversationsFilterField Union: only one key present
//                 direction: true || false,
//                 service: true || false,
//                 group: true || false,
//                 department: true || false,
//                 tag: true || false,
//                 pbx: true || false,
//                 trunk: true || false,
//                 queue: true || false,
//                 country: true || false,
//                 location: true || false,
//                 language: true || false,
//                 projection: { // ListConversationsFilterProjectionField
//                   projectionId: "STRING_VALUE", // required
//                   fieldId: "STRING_VALUE", // required
//                 },
//               },
//             ],
//             absent: [
//               {//  Union: only one key present
//                 direction: true || false,
//                 service: true || false,
//                 group: true || false,
//                 department: true || false,
//                 tag: true || false,
//                 pbx: true || false,
//                 trunk: true || false,
//                 queue: true || false,
//                 country: true || false,
//                 location: true || false,
//                 language: true || false,
//                 projection: {
//                   projectionId: "STRING_VALUE", // required
//                   fieldId: "STRING_VALUE", // required
//                 },
//               },
//             ],
//           },
//         },
//       ],
//     },
//   ],
// };