CallList

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.

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

Parameters

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.

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

Parameters

reportProgress

Report progress to the CallList module

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

Parameters

reportProgressAsync

Report progress to the CallList module

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

Parameters

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.

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

Parameters

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.

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

Parameters

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.

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

Parameters

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.

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

Parameters