🆕Oturum Oluşturma

Bu alan, bir oturumu PerculusAPI ile nasıl oluşturabileceğiniz gösterir.

Aşağıdaki listede bir oturum oluştururken ekleyebileceğiniz tüm parametrelerin listesini görebilirsiniz:

Parametre	Tip	Zorunlu	Açıklama
name	string	Evet	Oturum adı
description	string	Hayır	Açıklama
tags	string	Hayır
start_date	datetime(ISO 8601 )	Evet	Başlangıç tarihi
duration	integer(min: 5)	Evet	Oturum süresi
lang	string(IETF language tag)	Hayır
status	integer	Hayır
replay_status	integer	Hayır
options	Options	hayır	Oturum ayarlarını içerir

Options Objesi

Parametre	Tip	Zorunlu	Açıklama
allow_rating	boolean	Hayır
preparation_time	integer	Hayır
session_duration	integer	Hayır
allow_users_stream_self_cam_mic	boolean	Hayır
hide_user_streams	boolean	Hayır
enable_attendance_check	boolean	Hayır
enable_simultaneous_interpretation	boolean	Hayır
enable_simultaneous_interpretation_for_users	boolean	Hayır
start_active	boolean	Hayır
return_url	string	Hayır
chat	Chat	Hayır	Chat ayarlarını içerir
duration	Duration	Hayır

Chat Objesi

Parametre	Tip	Zorunlu	Açıklama
offMessageModule	boolean	Hayır
offGeneralMsging	boolean	Hayır
offGeneralMsgLimitForUser	boolean	Hayır
offSpecialMsging	boolean	Hayır
offSpecialMsgToAdmin	boolean	Hayır
offSpecialMsgToUser	boolean	Hayır
offNewMsgSound	boolean	Hayır
offClearForReplay	boolean	Hayır
onNewMsgSoundInAll	boolean	Hayır
onNewMsgNotifyInAll	boolean	Hayır

Duration Objesi

Parametre	Tip	Zorunlu	Açıklama
allowExtendTime	boolean	Hayır
useRemainingTime	boolean	Hayır

Tüm parametrelerden sonra aşağıdaki şekilde örnek bir oturum oluşturabilirsiniz:

CURL

curl --location '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

İlk olarak Python SDK'sı yüklenmelidir:

pip install perculus-sdk

SDK'nın yüklendiğinden emin olunduktan sonra aşağıdaki şekilde yeni oturum oluşturabilirsiniz:

from perculus_sdk.client import APIClient

# API client
client = APIClient()

# Set your domain (if you haven't set it before)
client.set_domain("<DOMAIN>")

# Set your credentials(if you haven't set it before)
client.set_credentials(
    access_key="<EMAIL>",
    secret_key="<PASSWORD>",
    account_id="<ACCOUNT_ID>"
)

#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

// ASAP :)

Go

// ASAP :)

İstek sonrasında aşağıdaki örnek response modelini görebilirsiniz:

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