Skip to main content

@wildix/wda-history-client > GetConferenceCommand

GetConferenceCommand class​

Signature:

export declare class GetConferenceCommand extends GetConferenceCommand_base

Extends: GetConferenceCommand_base

Example​

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

import { WdaHistoryClient, GetConferenceCommand } from "@wildix/wda-history-client"; // ES Modules import
// const { WdaHistoryClient, GetConferenceCommand } = require("@wildix/wda-history-client"); // CommonJS import
const client = new WdaHistoryClient(config);
const input = { // GetConferenceInput
  company: "STRING_VALUE",
  conferenceId: "STRING_VALUE", // required
};
const command = new GetConferenceCommand(input);
const response = await client.send(command);
// { // GetConferenceOutput
//   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",
//     type: "call" || "call_transcription" || "conference" || "conference_transcription", // required
//   },
// };