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
          • 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
  • Functions
  • reportError
  • reportErrorAsync
  • reportProgress
  • reportProgressAsync
  • reportResult
  • reportResultAsync
  • requestNextAttempt
  • requestNextAttemptAsync
VoxEngineQueues and routingCallList

CallList

Represents a call list to interact with Voximplant's call list processing functionality.
||View as Markdown|
Was this page helpful?
Edit this page
Previous

WebSocketReadyState

Next

ACDEvents

Built with

Functions

reportError

Reports error to the CallList module and continues the call list.

Call this method if the call attempt is not successful. If you do not call this method or reportError(/docs/references/voxengine/calllist/reporterror), the call list considers this task successful and does not make any more attempts to call this task.

1reportError(error: string | Object, callback?: (result: Net.HttpRequestResult) => void): void

Parameters

error
string | ObjectRequired
callback
(result: Net.HttpRequestResult) => void

reportErrorAsync

Reports error to the CallList module asynchronously and continues the call list.

Call this method if the call attempt is not successful. If you do not call this method or reportErrorAsync(/docs/references/voxengine/calllist/reporterrorasync), the call list considers this task successful and does not make any more attempts to call this task.

1reportErrorAsync(error: string | Object): Promise<Net.HttpRequestResult>

Parameters

error
string | ObjectRequired

reportProgress

Report progress to the CallList module

1reportProgress(progress: string | Object, callback?: (result: Net.HttpRequestResult) => void): void

Parameters

progress
string | ObjectRequired
callback
(result: Net.HttpRequestResult) => void

reportProgressAsync

Report progress to the CallList module

1reportProgressAsync(progress: string | Object): Promise<Net.HttpRequestResult>

Parameters

progress
string | ObjectRequired

reportResult

Reports successful result to the CallList module, saves the report to result_data field in the sheet, stops the calling attempts for this task and proceeds to the next task.

1reportResult(result: string | Object, callback?: (result: Net.HttpRequestResult) => void): void

Parameters

result
string | ObjectRequired
callback
(result: Net.HttpRequestResult) => void

reportResultAsync

Reports successful result to the CallList module asynchronously, saves the report to result_data field in the sheet, stops the calling attempts for this task and proceeds to the next task.

1reportResultAsync(result: string | Object): Promise<Net.HttpRequestResult>

Parameters

result
string | ObjectRequired

requestNextAttempt

Changes parameters for the current task and request another calling attempt with updated data. This method can change the following fields for the current task: start_at, attempts_left, custom_data, start_execution_time, end_execution_time and next_attempt_time. The new values work for all remaining attempts. This method does not change the global call list settings. NOTE: if you do not change the attempts_left manually, the call list decreases its value by 1 automatically. After an unsuccessful calling attempt, this method executes the reportError(/docs/references/voxengine/calllist/reporterror) method automatically. Refer to the Editable call lists guide to learn more.

1requestNextAttempt(data: Object, callback?: (result: Net.HttpRequestResult) => void): void

Parameters

data
ObjectRequired
callback
(result: Net.HttpRequestResult) => void

requestNextAttemptAsync

Changes parameters for the current task and request another calling attempt with updated data asynchronously. This method can change the following fields for the current task: start_at, attempts_left, custom_data, start_execution_time, end_execution_time and next_attempt_time. The new values work for all remaining attempts. This method does not change the global call list settings. NOTE: if you do not change the attempts_left manually, the call list decreases its value by 1 automatically. After an unsuccessful calling attempt, this method executes the reportError(/docs/references/voxengine/calllist/reporterror) method automatically. Refer to the Editable call lists guide to learn more.

1requestNextAttemptAsync(data: Object): Promise<Net.HttpRequestResult>

Parameters

data
ObjectRequired