đCreating a Session
This step shows how to create a session with PerculusAPI.
The below list explains all the available parameters when creating 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 | 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 | No | Includes chat settings. | |
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 |
Example below shows how to create a new session with a specified set of parameters.
Below is an example response from the service:
Last updated