For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Platform docsVideosCommunitySign up
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
CapabilitiesGetting startedVoice AI OrchestrationVoxEngine PlatformAPI ReferenceFAQ
      • Overview
        • ACDEvents
        • ACDRequest
        • SmartQueueEvents
        • SmartQueueOperatorSettingsMode
        • SmartQueueTask
        • TaskWaitingCode
  • Management API
    • Reference
    • Authorization
    • Errors
  • Web SDK
    • Overview
  • Android SDK
    • Overview
  • Android SDK v3
    • Overview
  • iOS SDK
    • Overview
  • React Native SDK
    • Overview
  • Flutter SDK
    • Overview
LogoLogo
Platform docsVideosCommunitySign up
On this page
  • Methods
  • addEventListener
  • end
  • removeEventListener
  • Properties
VoxEngineQueues and routing

SmartQueueTask

A SmartQueue task is for a certain agent, which can be a call or a chat.
||View as Markdown|
Was this page helpful?
Edit this page
Previous

SmartQueueOperatorSettingsMode

Next

TaskWaitingCode

Built with

A SmartQueue task is for a certain agent, which can be a call or a chat. Add the following line to your scenario code to use the class:

require(Modules.SmartQueue);

Methods

addEventListener

Adds a handler for the specified SmartQueueEvents event. Use only functions as handlers; anything except a function leads to the error and scenario termination when a handler is called.

1addEventListener(event: SmartQueueEvents | T, callback: (event: _SmartQueueEvents[T]) => any): void

Parameters

event
SmartQueueEvents | TRequired
callback
(event: _SmartQueueEvents[T]) => anyRequired

end

Ends the current task.

1end(description: string, terminationStatus?: TerminationStatus): void

Parameters

description
stringRequired
terminationStatus
TerminationStatus

removeEventListener

Removes a handler for the specified SmartQueueEvents event.

1removeEventListener(event: SmartQueueEvents | T, callback?: (event: _SmartQueueEvents[T]) => any): void

Parameters

event
SmartQueueEvents | TRequired
callback
(event: _SmartQueueEvents[T]) => any

Properties

agentCall
Call | null

The agent’s Call object.

clientCall
Call | null

The client’s Call object.

id
string

A SmartQueue task’s ID.

parameters
SmartQueueTaskParameters

SmartQueue task’s parameters, such as required skills, priority, queue, etc.