Rate this page:

CallListsInterface

Props

appendToCallList: (request: AppendToCallListRequest) => Promise<AppendToCallListResponse>

Appends a new task to the existing call list.
This method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the delimiter parameter.

cancelCallListTask: (request: CancelCallListTaskRequest) => Promise<CancelCallListTaskResponse>

Cancels the specified tasks in the call list by their IDs or UUIDs.

createCallList: (request: CreateCallListRequest) => Promise<CreateCallListResponse>

Adds a new CSV file for call list processing and starts the specified rule immediately. To send a file, use the request body. To set the call time constraints, use the following options in a CSV file:

__start_execution_time – when the call list processing starts every day, UTC+0 24-h format: HH:mm:ss
__end_execution_time – when the call list processing stops every day, UTC+0 24-h format: HH:mm:ss
__start_at – when the call list processing starts, UNIX timestamp. If not specified, the processing starts immediately after a method call
__task_uuid – call list UUID. A string up to 40 characters, can contain latin letters, digits, hyphens (-) and colons (:). Unique within the call list

This method accepts CSV files with custom delimiters, such a commas (,), semicolons (;) and other. To specify a delimiter, pass it to the delimiter parameter.
IMPORTANT: the account's balance should be equal or greater than 1 USD. If the balance is lower than 1 USD, the call list processing does not start, or it stops immediately if it is active.

deleteCallList: (request: DeleteCallListRequest) => Promise<DeleteCallListResponse>

Deletes an existing call list by its ID.

getCallLists: (request: GetCallListsRequest) => Promise<GetCallListsResponse>

Get all call lists for the specified user.