⏫Updating Sessions

This step shows how to update sessions through PerculusAPI

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

Parameter	Type	Required	Description
name	string	Yes	Session name
description	string	Yes	Session description
tags	string	No
start_date	datetime(ISO 8601 )	Yes	Start time
duration	integer(min: 5)	Yes	Session duration
lang	string(IETF language tag)	No	ar-SA, en-US, tr-TR are supported.
status	integer	No
replay_status	integer	No
options	Options	No	Includes session settings

Options Object

Parameter	Type	Required	Description
allow_rating	boolean	No
preparation_time	integer	No
session_duration	integer	No
allow_users_stream_self_cam_mic	boolean	No
hide_user_streams	boolean	No
enable_attendance_check	boolean	No
enable_simultaneous_interpretation	boolean	No
enable_simultaneous_interpretation_for_users	boolean	No
start_active	boolean	No
return_url	string	No
chat	Chat	No	Includes chat settings.
duration	Duration	No

Chat Object

Parameter	Type	Required	Description
offMessageModule	boolean	No
offGeneralMsging	boolean	No
offGeneralMsgLimitForUser	boolean	No
offSpecialMsging	boolean	No
offSpecialMsgToAdmin	boolean	No
offSpecialMsgToUser	boolean	No
offNewMsgSound	boolean	No
offClearForReplay	boolean	No
onNewMsgSoundInAll	boolean	No
onNewMsgNotifyInAll	boolean	No

Duration Object

Parameter	Type	Required	Description
allowExtendTime	boolean	No
useRemainingTime	boolean	No

You can update the session by passing SESSION_ID as a parameter after all parameters. Example:

CURL

curl --location --request PUT '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()
...

# Update session 
session = client.sessions.update_session("<SESSION_ID>",{
    "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()
...

// Update session 
const session = client.sessions.updateSession("<SESSION_ID>", {
    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 :)

Example Response:

{
    "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
}