sessions

Manages streaming client sessions

Session manager list sessions

GEThttp://admin.m2worlds.io/api/sessions/

Authorization

Response

Default Response

Body

itemsstring

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  "text"
]

Session manager create session

POSThttp://admin.m2worlds.io/api/sessions/

Authorization

Body

slotIdstring

The ID of a slot

userIdstring

The ID of a user

startTimestring (date-time)

The time a session started

expiryTimestring (date-time)

The time a session expires

providerConfigany of

Config data for the chosen provider

metadataobject

The metadata of a session

streamContextIdstring

The ID of a stream context

deviceTypestring

streamIdstring

deletionReasonstring

Response

Default Response

Body

sessionId*string

The ID of a session

signedSessionIdstring

The signed ID of a session for use with unauthenticated keep alive requests.

providerConfigany of

Config data for the chosen provider

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "sessionId": "text",
  "signedSessionId": "text",
  "providerConfig": {
    "name": "gdn",
    "cmsId": "text",
    "nonce": "text",
    "redirect": "text",
    "partnerId": "text",
    "zone": "text",
    "state": "text",
    "windowed": false
  }
}

Session manager list sessions

GEThttp://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}

Authorization

Path parameters

organizationId*string

The ID of an organization

projectId*string

The ID of a project

launchContextId*string

The ID of a Launch Context

Response

Default Response

Body

itemsstring

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

[
  "text"
]

Session manager create session

POSThttp://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}

Authorization

Path parameters

organizationId*string

The ID of an organization

projectId*string

The ID of a project

launchContextId*string

The ID of a Launch Context

Body

slotIdstring

The ID of a slot

userIdstring

The ID of a user

startTimestring (date-time)

The time a session started

expiryTimestring (date-time)

The time a session expires

providerConfigany of

Config data for the chosen provider

metadataobject

The metadata of a session

streamContextIdstring

The ID of a stream context

deviceTypestring

streamIdstring

deletionReasonstring

Response

Default Response

Body

sessionId*string

The ID of a session

signedSessionIdstring

The signed ID of a session for use with unauthenticated keep alive requests.

providerConfigany of

Config data for the chosen provider

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "sessionId": "text",
  "signedSessionId": "text",
  "providerConfig": {
    "name": "gdn",
    "cmsId": "text",
    "nonce": "text",
    "redirect": "text",
    "partnerId": "text",
    "zone": "text",
    "state": "text",
    "windowed": false
  }
}

Session manager get session

GEThttp://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{sessionId}

Authorization

Path parameters

organizationId*string

The ID of an organization

projectId*string

The ID of a project

launchContextId*string

The ID of a Launch Context

sessionId*string

The ID of a session

Response

Default Response

Body

sessionId*string

The ID of a session

slotIdstring

The ID of a slot

userIdstring

The ID of a user

startTimestring (date-time)

The time a session started

expiryTimestring (date-time)

The time a session expires

providerConfigany of

Config data for the chosen provider

streamStatus*any of

The status of a session's stream

metadataobject

The metadata of a session

streamContextIdstring

The ID of a stream context

deviceTypestring

streamIdstring

deletionReasonstring

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{sessionId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "sessionId": "text",
  "slotId": "text",
  "userId": "text",
  "startTime": "2024-05-20T04:55:23.158Z",
  "expiryTime": "2024-05-20T04:55:23.158Z",
  "providerConfig": {
    "name": "gdn",
    "cmsId": "text",
    "nonce": "text",
    "redirect": "text",
    "partnerId": "text",
    "zone": "text",
    "state": "text",
    "windowed": false
  },
  "streamStatus": "PENDING",
  "metadata": {
    "browserName": "text",
    "browserVersion": 0,
    "osName": "text",
    "deviceModel": "text",
    "deviceType": "text",
    "ubitusSupported": false,
    "geforceSupported": false,
    "forceProvider": "text",
    "forceCapacity": "text"
  },
  "streamContextId": "text",
  "deviceType": "text",
  "streamId": "text",
  "deletionReason": "text"
}

Session manager delete session

DELETEhttp://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{sessionId}

Authorization

Path parameters

organizationId*string

The ID of an organization

projectId*string

The ID of a project

launchContextId*string

The ID of a Launch Context

sessionId*string

The ID of a session

Response

Default Response

Body

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{sessionId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Session manager keep alive session

POSThttp://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{signedSessionId}/keepalive

Authorization

Path parameters

organizationId*string

The ID of an organization

projectId*string

The ID of a project

launchContextId*string

The ID of a Launch Context

signedSessionId*string

The signed ID of a session for use with unauthenticated keep alive requests.

Response

Default Response

Body

expiry*string (date-time)

The time a session expires

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{signedSessionId}/keepalive', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "expiry": "2024-05-20T04:55:23.158Z"
}

Session manager keep alive session

DELETEhttp://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{signedSessionId}/keepalive

Authorization

Path parameters

organizationId*string

The ID of an organization

projectId*string

The ID of a project

launchContextId*string

The ID of a Launch Context

signedSessionId*string

The signed ID of a session for use with unauthenticated keep alive requests.

Response

Default Response

Body

expiry*string (date-time)

The time a session expires

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/organizations/{organizationId}/projects/{projectId}/launchContexts/{launchContextId}/sessions/{signedSessionId}/keepalive', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "expiry": "2024-05-20T04:55:23.158Z"
}

Service health check

GEThttp://admin.m2worlds.io/api/sessions/healthz

Response

Default Response

Body

statusMessage (string)

Provides information about the service status.

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Session manager get session

GEThttp://admin.m2worlds.io/api/sessions/{sessionId}/

Authorization

Path parameters

sessionId*string

The ID of a session

Response

Default Response

Body

sessionId*string

The ID of a session

slotIdstring

The ID of a slot

userIdstring

The ID of a user

startTimestring (date-time)

The time a session started

expiryTimestring (date-time)

The time a session expires

providerConfigany of

Config data for the chosen provider

streamStatus*any of

The status of a session's stream

metadataobject

The metadata of a session

streamContextIdstring

The ID of a stream context

deviceTypestring

streamIdstring

deletionReasonstring

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/{sessionId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "sessionId": "text",
  "slotId": "text",
  "userId": "text",
  "startTime": "2024-05-20T04:55:23.158Z",
  "expiryTime": "2024-05-20T04:55:23.158Z",
  "providerConfig": {
    "name": "gdn",
    "cmsId": "text",
    "nonce": "text",
    "redirect": "text",
    "partnerId": "text",
    "zone": "text",
    "state": "text",
    "windowed": false
  },
  "streamStatus": "PENDING",
  "metadata": {
    "browserName": "text",
    "browserVersion": 0,
    "osName": "text",
    "deviceModel": "text",
    "deviceType": "text",
    "ubitusSupported": false,
    "geforceSupported": false,
    "forceProvider": "text",
    "forceCapacity": "text"
  },
  "streamContextId": "text",
  "deviceType": "text",
  "streamId": "text",
  "deletionReason": "text"
}

Session manager delete session

DELETEhttp://admin.m2worlds.io/api/sessions/{sessionId}/

Authorization

Path parameters

sessionId*string

The ID of a session

Response

Default Response

Body

error*string

HTTP error message

codestring

Fastify error code

message*string

User error message

statusCode*number

HTTP status code

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/{sessionId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Session manager keep alive session

POSThttp://admin.m2worlds.io/api/sessions/{signedSessionId}/keepalive/

Authorization

Path parameters

signedSessionId*string

The signed ID of a session for use with unauthenticated keep alive requests.

Response

Default Response

Body

expiry*string (date-time)

The time a session expires

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/{signedSessionId}/keepalive/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "expiry": "2024-05-20T04:55:23.158Z"
}

Session manager keep alive session

DELETEhttp://admin.m2worlds.io/api/sessions/{signedSessionId}/keepalive/

Authorization

Path parameters

signedSessionId*string

The signed ID of a session for use with unauthenticated keep alive requests.

Response

Default Response

Body

expiry*string (date-time)

The time a session expires

Request

const response = await fetch('http://admin.m2worlds.io/api/sessions/{signedSessionId}/keepalive/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "expiry": "2024-05-20T04:55:23.158Z"
}

Previousrealtime Nextslots oracle

Last updated 2 months ago