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

    Class CommandsSequenceCreator

    Commands sequence creator.

    Command helpers that return one command live beside this class: Amd, Calls, Menu, Messages, Recording, and Webhook.

    Helper names on the sequence follow the SVAML sequence creator: amd, answer, bridgeCall, webhook, dial, hangup, menu, gotoMenu, messages, stopMessages, play, pause, prompt, recording, stopRecording, text, and command.

    Each command helper appends to the sequence and returns it. prompt returns a MenuPrompt and does not append a command. text is a plain-text shortcut. Use messages with ssml for SSML.

    Index

    Constructors

    Methods

    • Parameters

      Returns this

    • Appends an answer command.

      Returns this

    • Appends a bridgeCall command. name is written to bridgeName.

      Parameters

      • name: string

      Returns this

    • Parameters

      Returns this

    • Appends a gotoMenu command. name is written to menuName. The target must be an item of the menu that contains this command.

      Parameters

      • name: string

      Returns this

    • Parameters

      Returns this

    • Appends a pause command. durationMilliseconds is required by the command.

      Parameters

      • durationMilliseconds: number

      Returns this

    • Returns a menu prompt. This does not append a command. Pass the result to a menu item, or build the prompt on the item directly. text on the prompt is plain text.

      Parameters

      Returns MenuPrompt

    • Appends a stopMessages command. name is written to messagesName.

      Parameters

      • name: string

      Returns this

    • Appends a stopRecording command. name is written to recordingName.

      Parameters

      • name: string

      Returns this

    • Shortcut: appends a messages command with one plain-text Say message. SSML belongs on messages via ssml, not on this shortcut.

      Parameters

      Returns this

    • Appends a webhook command.

      Parameters

      Returns this