com.opentok.Sip Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentok-server-sdk Show documentation

The OpenTok Java SDK lets you generate sessions and tokens for OpenTok applications. This version of the SDK also includes support for working with OpenTok 2.0 archives.

There is a newer version: 4.15.0

Show newest version

/**
 * OpenTok Java SDK
 * Copyright (C) 2025 Vonage.
 * http://www.tokbox.com
 * 
 * Licensed under The MIT License (MIT). See LICENSE file for more information.
 */
package com.opentok;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * An object representing an OpenTok SIP call.
 * 
 * Do not call the new() constructor. To start a SIP call, call the
 * {@link OpenTok#dial OpenTok.dial()} method.
 */
@JsonIgnoreProperties(ignoreUnknown=true)

public class Sip {
    @JsonProperty private String id;
    @JsonProperty private String connectionId;
    @JsonProperty private String streamId;

    protected Sip() {
    }

    /**
     * Used internally. Use the {@link OpenTok#dial OpenTok.dial()} method to
     * start a SIP call.
     */
    @JsonCreator
    public static Sip makeSip() {
        return new Sip();
    }

    /**
     * The unique ID of the SIP conference.
     */
    public String getId() {
        return id;
    }

    /**
     * The connection ID of the audio-only stream that is put into an OpenTok Session.
     */
    public String getConnectionId() {
        return connectionId;
    }

    /**
     * The stream ID of the audio-only stream that is put into an OpenTok Session.
     */
    public String getStreamId() {
        return streamId;
    }
}