Skip to main content

@wildix/wda-insights-client > ListConversationsCommand

ListConversationsCommand class​

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

Signature:

export declare class ListConversationsCommand extends ListConversationsCommand_base

Extends: ListConversationsCommand_base

Example​

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

import { WdaInsightsClient, ListConversationsCommand } from "@wildix/wda-insights-client"; // ES Modules import
// const { WdaInsightsClient, ListConversationsCommand } = require("@wildix/wda-insights-client"); // CommonJS import
const client = new WdaInsightsClient(config);
const input = { // ListConversationsInput
  company: "STRING_VALUE",
  filter: { // ListConversationsFilter
    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: [ // ListConversationsFilterService
      "STRING_VALUE",
    ],
    group: [ // ListConversationsFilterGroup
      "STRING_VALUE",
    ],
    phases: [ // ListConversationsFilterPhases
      "STRING_VALUE",
    ],
    language: [ // ListConversationsFilterLanguage
      "STRING_VALUE",
    ],
    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",
      },
    },
  },
  exclusiveStartKey: "STRING_VALUE",
};
const command = new ListConversationsCommand(input);
const response = await client.send(command);
// { // ListConversationsOutput
//   items: [ // ListConversationsItemsList // required
//     { // ListConversationsItem
//       event: { // ListConversationsItemEvent Union: only one key present
//         call: { // CallRecord
//           flowIndex: Number("int"), // required
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           connectTime: Number("long"),
//           talkTime: Number("long"),
//           waitTime: Number("long"),
//           queueTime: Number("long"),
//           holdTime: Number("long"),
//           duration: Number("long"), // required
//           caller: { // CallParticipant
//             type: "REMOTE" || "LOCAL", // required
//             phone: "STRING_VALUE",
//             name: "STRING_VALUE",
//             company: "STRING_VALUE",
//             email: "STRING_VALUE",
//             userId: "STRING_VALUE",
//             userExtension: "STRING_VALUE",
//             userDepartment: "STRING_VALUE",
//             groupId: "STRING_VALUE",
//             groupName: "STRING_VALUE",
//             userAgent: "STRING_VALUE",
//             userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
//             role: "CLIENT" || "AGENT", // required
//             license: "STRING_VALUE",
//             sipCallId: "STRING_VALUE",
//           },
//           callee: {
//             type: "REMOTE" || "LOCAL", // required
//             phone: "STRING_VALUE",
//             name: "STRING_VALUE",
//             company: "STRING_VALUE",
//             email: "STRING_VALUE",
//             userId: "STRING_VALUE",
//             userExtension: "STRING_VALUE",
//             userDepartment: "STRING_VALUE",
//             groupId: "STRING_VALUE",
//             groupName: "STRING_VALUE",
//             userAgent: "STRING_VALUE",
//             userDevice: "COLLABORATION_WEB" || "COLLABORATION_IOS" || "COLLABORATION_ANDROID" || "XBEES_WEB" || "XBEES_IOS" || "XBEES_ANDROID" || "WILDIX_PHONE" || "WILDIX_DEVICE" || "VOICEBOT" || "UNKNOWN",
//             role: "CLIENT" || "AGENT", // required
//             license: "STRING_VALUE",
//             sipCallId: "STRING_VALUE",
//           },
//           service: "STRING_VALUE",
//           serviceNumber: "STRING_VALUE",
//           destination: "STRING_VALUE",
//           direction: "INTERNAL" || "INBOUND" || "OUTBOUND" || "UNDEFINED",
//           trunkName: "STRING_VALUE",
//           trunkDirection: "STRING_VALUE",
//           queueName: "STRING_VALUE",
//           queueId: "STRING_VALUE",
//           tags: [ // CallFlowTags
//             "STRING_VALUE",
//           ],
//           flags: [ // CallFlowFlags
//             "STRING_VALUE",
//           ],
//           callerMos: "STRING_VALUE",
//           calleeMos: "STRING_VALUE",
//           xhoppersConfId: "STRING_VALUE",
//           recordings: [ // CallFlowRecordings
//             "STRING_VALUE",
//           ],
//           recordingsData: [ // CallFlowRecordingsData
//             { // CallFlowRecording
//               fileName: "STRING_VALUE", // required
//               start: Number("long"), // required
//               end: Number("long"), // required
//               owner: "callee" || "caller" || "system", // required
//               url: "STRING_VALUE", // required
//               pauses: [ // CallRecordPausesList // required
//                 { // CallRecordPause
//                   start: Number("long"),
//                   end: Number("long"),
//                   reason: "pause" || "hold",
//                 },
//               ],
//             },
//           ],
//           mergeWith: "STRING_VALUE",
//           splitReason: "STRING_VALUE",
//           splitTransferType: "STRING_VALUE",
//           remotePhone: "STRING_VALUE",
//           remotePhoneCountryCode: Number("int"),
//           remotePhoneCountryCodeStr: "STRING_VALUE",
//           remotePhoneLocation: "STRING_VALUE",
//           callStatus: "COMPLETED" || "MISSED",
//           transcriptionStatus: "AVAILABLE" || "UNAVAILABLE",
//           transcriptionLanguage: "STRING_VALUE",
//           transcriptionSeconds: Number("int"),
//           attachment: "STRING_VALUE",
//           attachmentType: "VOICEMAIL" || "FAX",
//           attachmentDestinations: [ // CallFlowAttachmentDestinationList
//             { // CallFlowAttachmentDestination
//               phone: "STRING_VALUE",
//               name: "STRING_VALUE",
//               email: "STRING_VALUE",
//               userId: "STRING_VALUE",
//               userExtension: "STRING_VALUE",
//               userDepartment: "STRING_VALUE",
//               groupId: "STRING_VALUE",
//               groupName: "STRING_VALUE",
//             },
//           ],
//           attachments: [ // CallFlowAttachments
//             { // CallFlowAttachment Union: only one key present
//               recording: {
//                 fileName: "STRING_VALUE", // required
//                 start: Number("long"), // required
//                 end: Number("long"), // required
//                 owner: "callee" || "caller" || "system", // required
//                 url: "STRING_VALUE", // required
//                 pauses: [ // required
//                   {
//                     start: Number("long"),
//                     end: Number("long"),
//                     reason: "pause" || "hold",
//                   },
//                 ],
//               },
//               fax: { // CallFlowFax
//                 url: "STRING_VALUE", // required
//                 status: "ok" || "error",
//                 destinations: [
//                   {
//                     phone: "STRING_VALUE",
//                     name: "STRING_VALUE",
//                     email: "STRING_VALUE",
//                     userId: "STRING_VALUE",
//                     userExtension: "STRING_VALUE",
//                     userDepartment: "STRING_VALUE",
//                     groupId: "STRING_VALUE",
//                     groupName: "STRING_VALUE",
//                   },
//                 ],
//                 owner: "callee" || "caller" || "system",
//                 error: "STRING_VALUE",
//               },
//               voicemail: { // CallFlowVoicemail
//                 url: "STRING_VALUE", // required
//                 destinations: [
//                   {
//                     phone: "STRING_VALUE",
//                     name: "STRING_VALUE",
//                     email: "STRING_VALUE",
//                     userId: "STRING_VALUE",
//                     userExtension: "STRING_VALUE",
//                     userDepartment: "STRING_VALUE",
//                     groupId: "STRING_VALUE",
//                     groupName: "STRING_VALUE",
//                   },
//                 ],
//                 owner: "callee" || "caller" || "system",
//               },
//             },
//           ],
//           id: "STRING_VALUE", // required
//           pbx: "STRING_VALUE", // required
//           time: Number("long"), // required
//           company: "STRING_VALUE", // required
//           licenses: [ // LicensesList // required
//             "x-bees" || "uc",
//           ],
//           type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
//         },
//         conference: { // ConferenceRecord
//           id: "STRING_VALUE", // required
//           time: Number("long"), // required
//           company: "STRING_VALUE", // required
//           pbx: "STRING_VALUE",
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           duration: Number("long"), // required
//           waitTime: Number("int"),
//           subject: "STRING_VALUE",
//           direction: "INTERNAL" || "INBOUND" || "OUTBOUND", // required
//           service: "STRING_VALUE",
//           status: "COMPLETED" || "MISSED",
//           participants: [ // ConferenceAnalyticsRecordParticipantList // required
//             { // ConferenceAnalyticsRecordParticipant
//               jid: "STRING_VALUE", // required
//               info: { // ConferenceParticipant
//                 type: "EXTERNAL" || "EXTERNAL_DIAL_IN" || "PBX" || "PBX_SIP" || "XBS", // required
//                 role: "CLIENT" || "AGENT",
//                 jid: "STRING_VALUE",
//                 name: "STRING_VALUE",
//                 email: "STRING_VALUE",
//                 phone: "STRING_VALUE",
//                 department: "STRING_VALUE",
//                 company: "STRING_VALUE",
//                 pbxSerial: "STRING_VALUE",
//                 pbxExtension: "STRING_VALUE",
//                 pbxGroupId: "STRING_VALUE",
//                 xbsId: "STRING_VALUE",
//                 license: "basic" || "essential" || "business" || "premium" || "wizyconf",
//               },
//               totalDuration: Number("int"), // required
//               totalSpeakDuration: Number("int"), // required
//               joinTime: Number("long"), // required
//             },
//           ],
//           recordings: [ // ConferenceRecordingList
//             { // ConferenceRecording
//               url: "STRING_VALUE", // required
//               start: Number("long"), // required
//               end: Number("long"), // required
//             },
//           ],
//           transcriptionStatus: "AVAILABLE" || "UNAVAILABLE", // required
//           transcriptionLanguage: "STRING_VALUE",
//           transcriptionSeconds: Number("int"),
//           type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
//         },
//         chat: { // ChatRecord
//           id: "STRING_VALUE",
//           chatId: "STRING_VALUE",
//           time: Number("long"), // required
//           company: "STRING_VALUE", // required
//           pbx: "STRING_VALUE",
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           waitTime: Number("int"),
//           duration: Number("long"), // required
//           direction: "INTERNAL" || "INBOUND" || "OUTBOUND", // required
//           subject: "STRING_VALUE",
//           service: "STRING_VALUE",
//           serviceTitle: "STRING_VALUE",
//           tags: [ // ChatTags
//             "sms" || "telephony" || "whatsapp",
//           ],
//           channel: { // Channel
//             subject: "STRING_VALUE",
//             description: "STRING_VALUE",
//             picture: "STRING_VALUE",
//             pictureColor: "STRING_VALUE",
//             access: "private" || "public",
//             company: "STRING_VALUE",
//             context: { // ChannelContext
//               source: "kite",
//               target: "STRING_VALUE",
//               events: [ // ChannelContextEventList
//                 { // ChannelContextEvent
//                   id: "STRING_VALUE",
//                   owner: "STRING_VALUE",
//                   start: "STRING_VALUE",
//                   end: "STRING_VALUE",
//                   summary: "STRING_VALUE",
//                   attendees: [ // ChannelContextEventAttendeeList
//                     { // ChannelContextEventAttendee
//                       email: "STRING_VALUE", // required
//                       name: "STRING_VALUE",
//                       status: "accepted" || "tentative" || "declined" || "none", // required
//                     },
//                   ],
//                 },
//               ],
//               ptt: { // ChannelContextPushToTalk
//                 broadcastId: "STRING_VALUE",
//               },
//             },
//             kite: true || false,
//             kiteTarget: "STRING_VALUE",
//             kiteVariant: "STRING_VALUE",
//             kiteAssign: "STRING_VALUE",
//             kiteServiceName: "STRING_VALUE",
//             kiteDefaultSubject: "STRING_VALUE",
//             service: "STRING_VALUE",
//             serviceTitle: "STRING_VALUE",
//             serviceRecipient: "STRING_VALUE",
//             assignee: { // User
//               id: "STRING_VALUE", // required
//               name: "STRING_VALUE",
//               email: "STRING_VALUE",
//               phone: "STRING_VALUE",
//               picture: "STRING_VALUE",
//               locale: "STRING_VALUE",
//               timeZone: "STRING_VALUE",
//               company: "STRING_VALUE",
//               bot: true || false,
//               pbxDomain: "STRING_VALUE",
//               pbxPort: "STRING_VALUE",
//               pbxExtension: "STRING_VALUE",
//               pbxSerial: "STRING_VALUE",
//               pbxUserId: "STRING_VALUE",
//               pbxGroupId: "STRING_VALUE",
//               createdAt: "STRING_VALUE",
//               updatedAt: "STRING_VALUE",
//             },
//             telephony: true || false,
//             sms: true || false,
//             mms: true || false,
//             whatsapp: true || false,
//             whatsappStatus: "24h_channel_closed",
//             broadcast: true || false,
//             external: true || false,
//             autoRecord: true || false,
//             transcriptionLanguage: "STRING_VALUE",
//             wizyGuestViewOnly: true || false,
//             channelId: "STRING_VALUE", // required
//             channelType: "direct" || "group", // required
//             memberCount: Number("int"), // required
//             createdAt: "STRING_VALUE", // required
//             createdBy: "STRING_VALUE", // required
//             updatedAt: "STRING_VALUE",
//           },
//           status: "WAITFIRSTREPLY" || "WAITREPLYFROMGUEST" || "WAITREPLYFROMAGENT" || "COMPLETED" || "MISSED",
//           participants: [ // ChatParticipantsList // required
//             { // ChatParticipant
//               id: "STRING_VALUE", // required
//               info: { // ChatParticipantInfo
//                 id: "STRING_VALUE", // required
//                 name: "STRING_VALUE",
//                 email: "STRING_VALUE",
//                 phone: "STRING_VALUE",
//                 picture: "STRING_VALUE",
//                 locale: "STRING_VALUE",
//                 timeZone: "STRING_VALUE",
//                 company: "STRING_VALUE",
//                 bot: true || false,
//                 pbxDomain: "STRING_VALUE",
//                 pbxPort: "STRING_VALUE",
//                 pbxExtension: "STRING_VALUE",
//                 pbxSerial: "STRING_VALUE",
//                 pbxUserId: "STRING_VALUE",
//                 pbxGroupId: "STRING_VALUE",
//                 createdAt: "STRING_VALUE",
//                 updatedAt: "STRING_VALUE",
//                 type: "REMOTE" || "LOCAL", // required
//                 role: "CLIENT" || "AGENT", // required
//               },
//             },
//           ],
//           type: "call" || "call_transcription" || "conference" || "conference_transcription" || "chat" || "chat_transcription", // required
//         },
//       },
//       interaction: { // ListConversationsItemInteraction
//         talkRatio: Number("int"),
//         wordsPerMinute: Number("int"),
//         interruptions: Number("int"),
//         patience: Number("float"),
//         longestMonologue: Number("int"),
//         longestCustomerStory: Number("int"),
//       },
//       summary: { // ListConversationsItemSummary
//         status: "NONE" || "UNAVAILABLE" || "SCHEDULED" || "STARTED" || "SUCCEEDED" || "FAILED", // required
//         title: "STRING_VALUE",
//         brief: "STRING_VALUE",
//         insights: [ // ListConversationsItemInsightsList
//           { // ListConversationsItemInsight
//             field: "STRING_VALUE", // required
//             value: "STRING_VALUE", // required
//           },
//         ],
//         language: "STRING_VALUE",
//       },
//       highlight: { // ListConversationsItemHighlight
//         transcription: [ // ListConversationsItemHighlightTranscriptionList
//           { // ListConversationsItemHighlightTranscriptionItem
//             id: "STRING_VALUE", // required
//             user: "STRING_VALUE", // required
//             start: Number("long"), // required
//             text: "STRING_VALUE", // required
//           },
//         ],
//         summary: { // ListConversationsItemHighlightSummary
//           title: "STRING_VALUE",
//           brief: "STRING_VALUE",
//         },
//         subject: "STRING_VALUE",
//       },
//     },
//   ],
//   lastEvaluatedKey: "STRING_VALUE",
// };