Skip to main content

@wildix/xbees-conversations-client > AssignChannelCommand

AssignChannelCommand class​

Assigns a channel to a user and/or service, optionally managing members according to a variant.

Signature:

export declare class AssignChannelCommand extends AssignChannelCommand_base

Extends: AssignChannelCommand_base

Example​

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

import { ConversationsClient, AssignChannelCommand } from "@wildix/xbees-conversations-client"; // ES Modules import
// const { ConversationsClient, AssignChannelCommand } = require("@wildix/xbees-conversations-client"); // CommonJS import
const client = new ConversationsClient(config);
const input = { // AssignChannelInput
  channelId: "STRING_VALUE", // required
  userId: "STRING_VALUE",
  silent: true || false,
  service: { // AssignChannelServiceRequest Union: only one key present
    uri: "STRING_VALUE",
  },
  assignee: { // AssignChannelAssigneeRequest Union: only one key present
    id: "STRING_VALUE",
    email: "STRING_VALUE",
  },
  variant: "ADAPTIVE" || "SELECTED" || "EVERYBODY" || "SKIP",
};
const command = new AssignChannelCommand(input);
const response = await client.send(command);
// { // AssignChannelOutput
//   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",
//     createdAt: "STRING_VALUE",
//     updatedAt: "STRING_VALUE",
//   },
//   service: { // Service
//     id: Number("int"), // required
//     uri: "STRING_VALUE", // required
//     title: "STRING_VALUE", // required
//     settings: {},
//     extensions: [ // ExtensionsList // required
//       "STRING_VALUE",
//     ],
//     pbx: { // ServicePbx
//       domain: "STRING_VALUE", // required
//       port: Number("int"), // required
//     },
//   },
// };