Skip to main content

@wildix/wda-stream-client > QueryPresencesCommand

QueryPresencesCommand class​

Retrieves users presences

Signature:

export declare class QueryPresencesCommand extends QueryPresencesCommand_base

Extends: QueryPresencesCommand_base

Example​

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

import { WdaStreamClient, QueryPresencesCommand } from "@wildix/wda-stream-client"; // ES Modules import
// const { WdaStreamClient, QueryPresencesCommand } = require("@wildix/wda-stream-client"); // CommonJS import
const client = new WdaStreamClient(config);
const input = { // QueryPresencesInput
  filter: [ // PresenceQueryFilterList // required
    { // PresenceQueryFilter
      id: "STRING_VALUE",
      company: "STRING_VALUE",
      extension: "STRING_VALUE",
    },
  ],
};
const command = new QueryPresencesCommand(input);
const response = await client.send(command);
// { // QueryPresencesOutput
//   presences: [ // PresenceList // required
//     { // Presence
//       company: "STRING_VALUE",
//       address: "STRING_VALUE",
//       extension: "STRING_VALUE",
//       id: "STRING_VALUE",
//       lng: "STRING_VALUE",
//       lat: "STRING_VALUE",
//       until: "STRING_VALUE",
//       status: "ONLINE" || "OFFLINE" || "DND" || "AWAY" || "ONLY_SIP",
//       message: "STRING_VALUE",
//       telephony: "REGISTERED" || "UNREGISTERED" || "RINGING" || "TALKING" || "RT",
//       seen: "STRING_VALUE",
//     },
//   ],
// };