Skip to main content

@wildix/wda-history-client > GetChatCommand

GetChatCommand class​

Gets a chat by chatId.

Signature:

export declare class GetChatCommand extends GetChatCommand_base

Extends: GetChatCommand_base

Example​

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

import { WdaHistoryClient, GetChatCommand } from "@wildix/wda-history-client"; // ES Modules import
// const { WdaHistoryClient, GetChatCommand } = require("@wildix/wda-history-client"); // CommonJS import
const client = new WdaHistoryClient(config);
const input = { // GetChatInput
  company: "STRING_VALUE",
  chatId: "STRING_VALUE", // required
};
const command = new GetChatCommand(input);
const response = await client.send(command);
// { // GetChatOutput
//   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
//   },
// };