Package com.sinch.sdk.domains.voice.models.v2.svaml.playback

Interface MessagesCommand

All Superinterfaces:
SvamlCommand
public interface MessagesCommand extends SvamlCommand
Plays one or more messages on the call. Multiple messages in the array are played sequentially in order.

This is a non-blocking command — the next command in the sequence executes immediately while messages play in parallel. Playback outcomes are handled via the events property. The onFinish event can be used to run a command after all messages complete.

  • Method Details

    • getMessagesName

      String getMessagesName()
      Name of the message for identification and reference within the call session.

      This name is used to uniquely identify the message and must be unique within the current call session. This name can be referenced in other commands (e.g., stopMessages) to control this specific message.

      Returns:
      messagesName

    • getMessages

      List<Message> getMessages()
      Ordered list of messages to play.

      Field is required

      Returns:
      messages

    • getEvents

      MessageEvents getEvents()
      SVAML commands to execute based on message playback outcomes.
      Returns:
      events

    • builder

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