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

    Class VoiceV2BatchesApi

    Index

    Methods

    • Get batch details Retrieve per-session details for a batch call operation, including the current state of each call session in the batch. Use this endpoint when individual session-level visibility is needed (for example, to inspect which sessions are QUEUED, IN_PROGRESS or COMPLETED). EXPIRED sessions are never returned because they were never initiated.

      Parameters

      Returns Promise<BatchDetails>

    • Create and initiate a batch of outbound call sessions Create a batch of outbound call sessions associated to the project's default service or to the service specified in the serviceId query parameter. Uses the same HTTP operation as voice.v2.calls.start (POST /v2/projects/{projectId}/calls). Logged as createBatch to distinguish it from single-call createCall.

      Parameters

      Returns Promise<BatchResponse>

    • Stop processing a batch of call sessions Stop processing a batch of call sessions. This will prevent any queued calls in the batch from being initiated. Calls that are already in progress will not be affected and will continue until completion. Returns HTTP 202 with { result: 'STOP_REQUESTED' } when the cancellation request is accepted; it does not delete the batch or hang up in-progress calls.

      Parameters

      Returns Promise<BatchStopResponse>