Get Session
GetSession retrieves details of a specific session.
Use this method to fetch the current state of a session identified by its resource name.
Request: GetSessionRequest Response: Session
HTTP: GET /v1/conversation/sessions/{name}
Path parameters
session
The session id.
Response
OK
profile
The profile associated with the session.
displayName
display_name is the title of the session.
sessionType
session_type defines the type of the session, such as Public, Private, or Temporary.
owners
owners contains the list of owners of the session.
defaultChannels
default_channels specifies the default channels for the session.
name
name is the resource identifier for the Session. It follows the format “sessions/{session}” and uniquely identifies a Session resource.
description
description provides a brief overview of the session.
sessionId
The unique identifier for the session, often sourced from a NATS subject
or a dedicated ID.
allowedUsers
allowed_users contains the list of users allowed in the session.
options
options contains various options for the session.
secretKey
secret_key is the secret key for the session.
createTime
Output only. The time at which the session was created.
updateTime
Output only. The time at which the session was last updated.
Errors
400
Bad Request Error