Package com.sinch.sdk.domains.voice.models.v2.batches.request

Interface StartBatchRequest

public interface StartBatchRequest
Request to start a batch of outbound calls.

Each entry in getParameters() queues one call, using that entry's values for the placeholders in the commands.

  • Method Details

    • getCommands

      List<SvamlCommand> getCommands()
      An ordered list of SVAML v2 (Sinch Voice Application Markup Language) commands that describe a call flow. Commands are executed sequentially in the order they are defined.

      Blocking vs. non-blocking: Some commands block execution until they complete (pause , webhook, menu, gotoMenu), while others return immediately and run in parallel (dial, messages, amd, answer, hangup, startRecording, stopRecording , bridgeCall, stopMessages). Each command's description specifies its behavior.

      Nesting scope: Commands that appear inside event handlers (e.g., dial.events.onAnswer , messages.events.onFinish) form independent sequences and execute in their own context — they are not continuations of the parent sequence.

      Field is required

      Returns:
      commands

    • getParameters

      List<Map<String,String>> getParameters()
      An array of parameter objects that define values for dynamic placeholders in commands. Each object represents a set of parameters for a single queued call.

      Use these parameters to inject customer-defined values into your SVAML commands, enabling personalized call flows without modifying the base command structure.

      Field is required

      Returns:
      parameters

    • getBatchOptions

      BatchOptions getBatchOptions()
      Options for batch dialing
      Returns:
      batchOptions

    • getIdempotencyKey

      String getIdempotencyKey()
      Client-generated idempotency key to safely retry requests. The server uses this key to recognize retries of the same request. If a request with the same key is received within 10 minutes, the server returns the cached response from the original request. Using a random UUID (v4) is strongly recommended.

      Sent as the Idempotency-Key header. If not set, the SDK generates one for the call and sends it again on the retries of that call. Set your own key if you need to retry the call yourself, since the generated one is not returned.

      Returns:
      idempotencyKey

    • builder

      static StartBatchRequest.Builder builder()
      Getting builder
      Returns:
      New Builder instance