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
  • cancel
  • getStatus
  • id
  • removeEventListener
VoxEngineQueues and routing

ACDRequest

Represents a request that is put to the ACD queue. Add the following line to your scenario code to use the class: require(Modules.ACD);

||View as Markdown|
Was this page helpful?
Edit this page
Previous

ACDEvents

Next

SmartQueueEvents

Built with

Methods

addEventListener

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

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

Parameters

event
ACDEvents | TRequired
callback
(event: _ACDEvents[T]) => anyRequired

cancel

Cancel pending request and remove it from the queue

1cancel(): void

getStatus

Gets status of the current request. Not to be called before the request is successfully queued (the ACDEvents.Queued event). This method’s call triggers the ACDEvents.Waiting event; it is possible to retrieve an estimated waiting time in minutes via the ewt property of the event.

1getStatus(): void

id

Returns the request’s id. It can be used as the acd_request_id parameter in the GetACDHistory(/docs/references/httpapi/managing_history#getacdhistory) method to search in ACD history.

1id(): string

removeEventListener

Removes a handler for the specified ACDEvents event.

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

Parameters

event
ACDEvents | TRequired
callback
(event: _ACDEvents[T]) => any