Set Classroom Webcast Parameters

This interface is used to modify the web live streaming and playback-related parameters of an LMS classroom.

Notes

• Either classId or activityId must be provided; if both are present, activityId takes priority.
• At least one optional parameter (other than the identifier fields) must be included to trigger an actual update.
• useCoMainRecord can only be set for dual-teacher sub-classrooms.
• Certain parameters cannot be edited within 20 minutes before class starts, during an ongoing class, or after the class has ended. See ClassIn Help Center for details.

URL

https://root_url/lms/activity/setWebcast

HTTP Request Method

• POST

Encoding

• UTF-8

Request Parameters

Header Parameters

Body Parameters (JSON)

* Either classId or activityId must be provided. In addition, at least one other optional parameter must be included.

Response Parameters

Example Request

curl --location --request POST 'https://{root_url}/lms/activity/setWebcast' \
--header 'X-EEO-SIGN: {{sign}}' \
--header 'X-EEO-UID: {{UID}}' \
--header 'X-EEO-TS: {{timeStamp}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "courseId": 414193,
    "activityId": 25096094,
    "recordState": 1,
    "recordType": 0,
    "liveState": 1,
    "openState": 1,
    "watchByLogin": 0,
    "webcastIntroduce": "Course introduction for this live session"
}'

Example Response

Success

{
    "code": 1,
    "msg": "Execution successful",
    "data": null
}

Failure

{
    "code": 121601009,
    "msg": "Institution does not have live streaming permission",
    "data": null
}

Error Codes

General Error Codes

Business Error Codes