Skip to main content

@wildix/wda-insights-client > QueryConversationsCountCommand

QueryConversationsCountCommand class​

Insights API are currently in active development. All interfaces are subject to change.

Signature:

export declare class QueryConversationsCountCommand extends QueryConversationsCountCommand_base

Extends: QueryConversationsCountCommand_base

Example​

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

import { WdaInsightsClient, QueryConversationsCountCommand } from "@wildix/wda-insights-client"; // ES Modules import
// const { WdaInsightsClient, QueryConversationsCountCommand } = require("@wildix/wda-insights-client"); // CommonJS import
const client = new WdaInsightsClient(config);
const input = { // QueryConversationsCountInput
  company: "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",
      },
    ],
    chatbots: [ // ListConversationsFilterKeyword
      "STRING_VALUE",
    ],
    voicebots: [
      "STRING_VALUE",
    ],
    service: [
      "STRING_VALUE",
    ],
    group: [
      "STRING_VALUE",
    ],
    department: [
      "STRING_VALUE",
    ],
    tag: "<ListConversationsFilterKeyword>",
    pbx: "<ListConversationsFilterKeyword>",
    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",
      },
    },
    dayOfWeek: { // ListConversationsFilterDateIndex
      index: Number("int"),
      timeZone: "STRING_VALUE",
    },
    hourOfDay: {
      index: Number("int"),
      timeZone: "STRING_VALUE",
    },
    present: [ // ListConversationsFilterFieldsList
      { // ListConversationsFilterField Union: only one key present
        direction: true || false,
        service: true || false,
        group: true || false,
        department: true || false,
        chatbot: true || false,
        voicebot: 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,
        chatbot: true || false,
        voicebot: 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 QueryConversationsCountCommand(input);
const response = await client.send(command);
// { // QueryConversationsCountOutput
//   count: Number("int"), // required
// };