Show / Hide Table of Contents

Class RealtimeSessionToken

The response from the realtime session token endpoint that creates the auth token to be used with the realtime speech service.

Inheritance
object
RealtimeSessionToken
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.AispeechService.Models
Assembly: OCI.DotNetSDK.Aispeech.dll
Syntax
public class RealtimeSessionToken

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

Compartment ID that was used to create the token.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace-1": {"bar-key-1": "value-1", "bar-key-2": "value-2"}, "foo-namespace-2": {"bar-key-1": "value-1", "bar-key-2": "value-2"}}.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}.

SessionId

Declaration
[Required(ErrorMessage = "SessionId is required.")]
[JsonProperty(PropertyName = "sessionId")]
public string SessionId { get; set; }
Property Value
Type Description
string

The session ID this token corresponds to. Provided for convenience, the session ID is already present in the JWT token.

Remarks

Required

Token

Declaration
[Required(ErrorMessage = "Token is required.")]
[JsonProperty(PropertyName = "token")]
public string Token { get; set; }
Property Value
Type Description
string

The session token (JWT) to be consumed by the websocket server. The token contains the session/tenant ID, as well as the expiry time.

Remarks

Required

In this article
Back to top