Skip to main content

Get User Session by ID

Retrieves a specific session for the authenticated user.

Path Parameters
session_id string REQUIRED

The ID of the session.

Responses
200

Session details.

Schema OPTIONAL
ok boolean
data object
id string OPTIONAL

Session identifier.

created_at date-time OPTIONAL

Session creation timestamp.

updated_at date-time OPTIONAL

Session last update timestamp.

expires_at date-time OPTIONAL

Session expiration timestamp.

intent string OPTIONAL

Possible values: [api, broadcaster, desktop, event, agora, captions, bot_conversational, bot_presentation]

Intent of the session. Used for analytics and debugging purposes.

aggregation_id string OPTIONAL

Aggregation ID for grouping sessions in billing display.

organization string OPTIONAL

Casdoor organization that owns the session.

default

Default Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

errors object[]

List of errors

type uri

Possible values: 1 ≤ length ≤ 2083

A string containing a URI reference that identifies the problem type.

status Status

Possible values: 399 < value < 600

A number indicating the HTTP status code.

title Title

Possible values: 5 ≤ length

A string containing a short, human-readable summary of the problem type.

detail Detail

Possible values: 5 ≤ length

A string containing a human-readable explanation specific to this occurrence of the problem.

instance Instance

Possible values: 1 ≤ length

A string containing a URI reference that identifies the specific occurrence of the problem.

error_code Error Code

A Number that indicates the error type that occurred.