Skip to main content

@wildix/wda-stream-client > GetOngoingCallTranscriptionCommand

GetOngoingCallTranscriptionCommand class​

Retrieves information and transcription for ongoing call.

Signature:

export declare class GetOngoingCallTranscriptionCommand extends GetOngoingCallTranscriptionCommand_base

Extends: GetOngoingCallTranscriptionCommand_base

Example​

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

import { WdaStreamClient, GetOngoingCallTranscriptionCommand } from "@wildix/wda-stream-client"; // ES Modules import
// const { WdaStreamClient, GetOngoingCallTranscriptionCommand } = require("@wildix/wda-stream-client"); // CommonJS import
const client = new WdaStreamClient(config);
const input = { // GetOngoingCallTranscriptionInput
  company: "STRING_VALUE",
  callId: "STRING_VALUE", // required
};
const command = new GetOngoingCallTranscriptionCommand(input);
const response = await client.send(command);
// { // GetOngoingCallTranscriptionOutput
//   company: "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"),
//       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",
//         publicAddress: "STRING_VALUE",
//         privateAddress: "STRING_VALUE",
//         location: "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",
//         publicAddress: "STRING_VALUE",
//         privateAddress: "STRING_VALUE",
//         location: "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" || "POST_TRANSCRIPTION" || "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",
//           },
//         },
//       ],
//       notifications: { // CallFlowNotifications
//         destinations: "<CallFlowAttachmentDestinationList>",
//         type: [ // NotificationsType
//           "STRING_VALUE",
//         ],
//       },
//       status: "CONNECTING" || "TALKING" || "HOLD", // required
//       statusChangeDate: "STRING_VALUE", // required
//     },
//   ],
//   transcriptions: [ // CallAnalyticsLiveTranscriptionEventList
//     { // CallAnalyticsLiveTranscriptionEvent
//       id: "STRING_VALUE", // required
//       pbx: "STRING_VALUE", // required
//       time: Number("long"), // required
//       company: "STRING_VALUE", // required
//       licenses: [ // LicensesList // required
//         "x-bees" || "uc",
//       ],
//       event: "chat" || "chat_transcription" || "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" || "service" || "service_complete" || "service_agent" || "service_call" || "service_call_complete", // required
//       flowIndex: Number("int"), // required
//       flowStartTime: Number("long"), // required
//       callStartTime: Number("long"), // required
//       chunk: { // CallTranscriptionChunk
//         id: "STRING_VALUE", // required
//         time: Number("long"), // required
//         speaker: "callee" || "caller", // required
//         text: "STRING_VALUE", // required
//         language: "STRING_VALUE",
//         isFinal: true || false, // required
//         start: Number("long"), // required
//         end: Number("long"), // required
//         confidence: Number("double"),
//         sentiment: "STRING_VALUE",
//       },
//       participant: {
//         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",
//         publicAddress: "STRING_VALUE",
//         privateAddress: "STRING_VALUE",
//         location: "STRING_VALUE",
//       },
//     },
//   ],
// };