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

    Interface DialCommand

    Initiates a new outbound call leg within the current session. This is a non-blocking command — the next command in the sequence executes immediately while the call is being established in parallel. Call lifecycle events (answer, busy, reject, timeout, hangup, failure) are handled via the events property. The from and to endpoint types should ideally match. If they differ, the platform attempts to convert the from value to be compatible with the to type. For example, PSTN supports only E.164 phone numbers, so a SIP address such as sip:46701234567@acme.se can be converted to an E.164 number. If the from value cannot be converted, it defaults to null (anonymous).

    interface DialCommand {
        callName?: string;
        command: "dial";
        dialTimeoutDurationSeconds?: number;
        events?: CallEvents;
        from?: CallOrigin;
        maxCallDurationSeconds?: number;
        to: CallDestination;
    }
    Index

    Properties

    callName?: string

    Identifier for this call leg within the session. Must be unique across all active call legs in the session. Other commands (e.g., hangup) can reference this name to target this specific leg.

    command: "dial"

    Command to initiate a new call

    dialTimeoutDurationSeconds?: number

    Maximum time in seconds to wait for the call to be answered. If the timeout expires without an answer, the onTimeout event is triggered.

    events?: CallEvents

    CallEvents

    from?: CallOrigin

    CallOrigin

    maxCallDurationSeconds?: number

    Maximum duration of the call in seconds. The call is terminated automatically when this limit is reached.

    CallDestination