Class BatchCallRecordsResource

A batch's per-number records — vsdk.batchcall.records.

Index

Constructors

Methods

delete export list update

Constructors

constructor

new BatchCallRecordsResource(http: HttpClient): BatchCallRecordsResource
Parameters
- http: HttpClient
Returns BatchCallRecordsResource

Methods

delete

delete(batchId: string, recordIds: string[]): Promise<DeleteRecordsResult>
Bulk delete records.
Parameters
- batchId: string
- recordIds: string[]
Returns Promise<DeleteRecordsResult>

export

export(batchId: string, params?: ExportBatchCallRecordsParams): Promise<string>
Export records as CSV (returns the CSV text).
Parameters
- batchId: string
- params: ExportBatchCallRecordsParams = {}
Returns Promise<string>

list

list(
batchId: string,
params?: ListBatchCallRecordsParams,
): Promise<Page<BatchCallRecord>>
List a batch's per-number records (paginated, async-iterable).
Parameters
- batchId: string
- params: ListBatchCallRecordsParams = {}
Returns Promise<Page<BatchCallRecord>>

update

update(
    batchId: string,
    recordId: string,
    options: UpdateBatchCallRecordOptions,
): Promise<BatchCallRecord>
Edit a single pending record before it runs.
Parameters
- batchId: string
- recordId: string
- options: UpdateBatchCallRecordOptions
Returns Promise<BatchCallRecord>