🆕Creating a Session

This step shows how to create a session with GroupsAPI.

Important Note! Constructor Groups’ V1 API has been retired and is no longer available to new customers. Please use the Groups V2 API going forward. Link to V2 API documentation: https://developer.perculus.com/v2-en

The list below explains all the parameters available when creating a session.

Parameter	Type	Required	Default	Description
name	string	Yes	n/a	Session's name
description	string	Yes	n/a	Session's description
tags	string	No	null	A comma separated list of tags
start_date	string	Yes	n/a	Date which the session will start(see)
duration	integer	Yes	n/a	Session duration in minutes. It can be between 5 and 360 minutes.
lang	string	No	tr-TR	Language code(see)
timezone	string	No	Europe/Istanbul	TZ identifier (see)
options	Session Options Object	No	See object	Contains various session options(see)
allow_recording	bool	No	true	Flag to determine if the session will be recorded
inaccessible_replay	bool	No	false	Flag to determine if the session's replay should be inaccessible

Example below shows how to create a new session with a specified set of parameters.

CURL

curl --location --request POST 'https://<DOMAIN>/xapi/session' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "test session ",
    "start_date": "2024-09-27T14:00:25.699Z",
    "duration": "6",
    "options": {
        "allow_rating": false,
        "chat": {
            "offMessageModule": true,
            "offGeneralMsging": false
        },
        "duration": {
            "allowExtendTime": false,
            "useRemainingTime": true
        },
        "allow_users_stream_self_cam_mic": false,
    }
}'

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Create session 
session = client.sessions.create_session({
    "name": "test session",
    "start_date": "2024-09-27T14:00:25.699Z",
    "duration": "6",
    "options": {
        "allow_rating": false,
        "chat": {
            "offMessageModule": true,
            "offGeneralMsging": false
        },
        "duration": {
            "allowExtendTime": false,
            "useRemainingTime": true
        },
        "allow_users_stream_self_cam_mic": false,
    }
})
print(session)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Create session 
const session = client.sessions.createSession({
    name: "test session",
    start_date: "2024-09-27T14:00:25.699Z",
    duration: "6",
    options: {
        allow_rating: false,
        chat: {
            offMessageModule: true,
            offGeneralMsging: false
        },
        duration: {
            allowExtendTime: false,
            useRemainingTime: true
        },
        allow_users_stream_self_cam_mic: false,
    }
})
console.log(session)

Go

// ASAP :)

Below is an example response from the service:

{
    "session_id": "<SESSION_ID>",
    "name": "test session",
    "description": "",
    "tags": "",
    "start_date": "2024-09-27T14:00:25.699+03:00",
    "timezone": "Europe/Istanbul",
    "duration": 6,
    "lang": "tr-TR",
    "status": 1, 
    "replay_status": 0,
    "options": {
        "allow_rating": false,
        "preparation_time": 15,
        "session_duration": 60,
        "chat": {
            "offMessageModule": true,
            "offGeneralMsging": false,
            "offGeneralMsgLimitForUser": false,
            "offSpecialMsging": false,
            "offSpecialMsgToAdmin": false,
            "offSpecialMsgToUser": false,
            "offNewMsgSound": false,
            "offClearForReplay": false,
            "onNewMsgSoundInAll": false,
            "onNewMsgNotifyInAll": false
        },
        "duration": {
            "allowExtendTime": false,
            "useRemainingTime": true
        },
        "allow_users_stream_self_cam_mic": false,
        "hide_user_streams": false,
        "enable_attendance_check": false,
        "enable_simultaneous_interpretation": false,
        "enable_simultaneous_interpretation_for_users": false,
        "start_active": false,
        "return_url": ""
    },
    "creation_date": "2024-08-01T22:53:46.5570837+00:00",
    "updating_date": null
}