Sinch Node.js SDK - v1.6.0
    Preparing search index...

    Interface BatchSummary

    Summary of a batch call operation, including counts of call sessions by state and overall progress.

    interface BatchSummary {
        batchId: string;
        completed: number;
        endTime?: Date;
        expired: number;
        inProgress: number;
        queued: number;
        requestedCps: number;
        sessionCount: number;
        ttlSeconds?: number;
    }
    Index

    Properties

    batchId completed endTime? expired inProgress queued requestedCps sessionCount ttlSeconds?

    Properties

    batchId: string

    Unique identifier of the batch call operation (ULID).

    completed: number

    Number of call sessions that have completed successfully.

    endTime?: Date

    Timestamp (RFC 3339) when the batch finished processing (all call sessions reached a final state). Omitted if the batch is still in progress or has not completed yet.

    expired: number

    Number of queued call sessions that were not initiated before the batch TTL (ttlSeconds) elapsed and therefore expired.

    inProgress: number

    Number of call sessions that are in progress.

    queued: number

    Number of call sessions that are queued and waiting to be initiated (not yet in progress).

    requestedCps: number

    Requested maximum call initiation rate, in calls per second (CPS), for this batch. Actual CPS may be lower depending on routing, carrier, and platform capacity, as well as account limitations.

    sessionCount: number

    Total number of call sessions requested in this batch.

    ttlSeconds?: number

    Batch time-to-live (TTL) in seconds. The maximum amount of time the platform will keep attempting to start queued call sessions in this batch. When the TTL expires, any call sessions that have not yet been initiated will stop being processed (calls already in progress are not affected).

    Settings

    Member Visibility

    On This Page

    Properties