Skip to main content

@wildix/wda-stream-client > GetConversationsCommand

GetConversationsCommand class​

Retrieves ongoing conversations.

Once the conversation ends the item would be dissapeared from the list.

Signature:

export declare class GetConversationsCommand extends GetConversationsCommand_base

Extends: GetConversationsCommand_base

Example​

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

import { WdaStreamClient, GetConversationsCommand } from "@wildix/wda-stream-client"; // ES Modules import
// const { WdaStreamClient, GetConversationsCommand } = require("@wildix/wda-stream-client"); // CommonJS import
const client = new WdaStreamClient(config);
const input = { // GetConversationsInput
  company: "STRING_VALUE",
};
const command = new GetConversationsCommand(input);
const response = await client.send(command);
// { // GetConversationsOutput
//   calls: [ // GetConversationsCallsList // required
//     { // CallAnalyticsLiveProgressEvent
//       id: "STRING_VALUE", // required
//       pbx: "STRING_VALUE", // required
//       time: Number("long"), // required
//       company: "STRING_VALUE", // required
//       licenses: [ // LicensesList // required
//         "x-bees",
//       ],
//       event: "chat" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave", // required
//       eventTrigger: "call.start" || "call.update" || "call.split" || "call.agents_start" || "call.agents_cancel" || "call.record_start" || "call.record_stop" || "call.transcription" || "call.attachment", // required
//       start: "STRING_VALUE", // required
//       flows: [ // CallAnalyticsLiveProgressEventFlowList // required
//         { // CallAnalyticsLiveProgressEventFlow
//           flowIndex: Number("int"), // required
//           startTime: Number("long"), // required
//           endTime: Number("long"), // required
//           connectTime: Number("long"),
//           talkTime: Number("long"),
//           waitTime: 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" || "UNKNOWN",
//             role: "CLIENT" || "AGENT", // required
//             license: "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" || "UNKNOWN",
//             role: "CLIENT" || "AGENT", // required
//             license: "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
//             { // RecordingsData
//               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",
//           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",
//             },
//           ],
//           status: "CONNECTING" || "TALKING" || "HOLD", // required
//           statusChangeDate: "STRING_VALUE", // required
//         },
//       ],
//     },
//   ],
//   conferences: [ // GetConversationsConferencesList // required
//     { // ConferenceAnalyticsLiveProgressEvent
//       id: "STRING_VALUE", // required
//       time: Number("long"), // required
//       company: "STRING_VALUE", // required
//       event: "chat" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave", // required
//       start: "STRING_VALUE", // required
//       subject: "STRING_VALUE", // required
//       participants: [ // ConferenceParticipantsList // required
//         { // 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",
//         },
//       ],
//       transcriptionStatus: "AVAILABLE" || "UNAVAILABLE", // required
//       transcriptionLanguage: "STRING_VALUE",
//     },
//   ],
//   chats: [ // GetConversationsChatsList // required
//     { // ChatAnalyticsLiveProgressEvent
//       id: "STRING_VALUE", // required
//       time: Number("long"), // required
//       company: "STRING_VALUE", // required
//       event: "chat" || "chat_complete" || "chat_interrupted" || "chat_missed" || "call_cost" || "call" || "call_complete" || "call_interrupted" || "call_transcription" || "conference" || "conference_complete" || "conference_interrupted" || "conference_transcription" || "conference_join" || "conference_leave", // required
//       start: "STRING_VALUE", // required
//       channelId: "STRING_VALUE", // required
//       channelType: "direct" || "group", // required
//       subject: "STRING_VALUE", // required
//       service: "STRING_VALUE",
//       serviceTitle: "STRING_VALUE",
//       participants: [ // ChatParticipantList // required
//         { // ChatParticipant
//           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",
//           createdAt: "STRING_VALUE",
//           updatedAt: "STRING_VALUE",
//           type: "REMOTE" || "LOCAL", // required
//           role: "CLIENT" || "AGENT", // required
//         },
//       ],
//       agents: [ // ChatUserList // required
//         { // 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",
//           createdAt: "STRING_VALUE",
//           updatedAt: "STRING_VALUE",
//         },
//       ],
//       agentsCount: Number("int"), // required
//       customers: [ // required
//         {
//           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",
//           createdAt: "STRING_VALUE",
//           updatedAt: "STRING_VALUE",
//         },
//       ],
//       customersCount: Number("int"), // required
//       tags: [ // ChatTags
//         "sms" || "telephony" || "whatsapp",
//       ],
//       direction: "INTERNAL" || "INBOUND" || "OUTBOUND", // required
//       status: "WAITFIRSTREPLY" || "WAITREPLYFROMGUEST" || "WAITREPLYFROMAGENT" || "COMPLETED" || "MISSED", // required
//     },
//   ],
// };