Type alias BuddyAgents

BuddyAgents: {
    action?: "Consult" | "Transfer";
    mediaType?: "telephony" | "chat" | "social" | "email";
    state?: "Available" | "Idle";
}

Represents the options to fetch buddy agents for the logged in agent. Buddy agents are other agents who can be consulted or transferred to.

Optional action?: "Consult" | "Transfer"
Applies the default state policy for the operation. An explicit state takes precedence.
Optional mediaType?: "telephony" | "chat" | "social" | "email"
The media type channel to filter buddy agents. Defaults to telephony when omitted.
Optional state?: "Available" | "Idle"
Optional filter for agent state. If specified, returns only agents in that state. If omitted, returns both available and idle agents.

const opts: BuddyAgents = { mediaType: 'telephony', state: 'Available' };