Set Playback All Viewable

This is an LMS classroom activity API used to set all users as viewable for client-side playback of classroom activities.

Notes

1. The following general logic applies to playback viewing permission settings:
   • Only classroom activities are supported, and settings can only be configured after the class ends (via both API and backend).
   • Default users = lesson instructor + lesson co-instructor + lesson students (including transfer students) + other teachers in the class + class head teacher
   • Selectable users = lesson instructor + lesson co-instructor + lesson students + other teachers in the class + head teacher - transferred out students
   • Based on the above rules, if a student was configured not to view historical recordings when joining the class, they will be treated as a transferred-out student for historical lessons. As a result, they cannot be added to the playback viewer list for those lessons.
   • For compatibility, the API supports either activityId or classId, but it is strongly recommended to use activityId.
2. About this API -- Set Playback All Viewable
   • Multiple classrooms can be configured in batch, with each classroom having a separate return code in the data field.
   • To add certain optional users as viewable, use the Add Playback Viewable Users API.
   • To remove certain optional users from viewable, use the Delete Playback Viewable Users API.

URL

https://root_url/playback/setPlaybackAllViewable

HTTP Request Methods

• POST

Encoding Format

• UTF-8

Request Parameters

Header Parameters

Body Parameters

Response Parameters

Examples

• HTTP Request

POST /playback/setPlaybackAllViewable HTTP/1.1
Host: root_url
X-EEO-SIGN: ceb7a2c0534999960c02c191d409c41e
X-EEO-UID: 409864
X-EEO-TS: 1722938382
Content-Type: application/json
Content-Length: 117

{
    "courseId": 414193,
    "activityIds": [25096097,25096099]
}

• Shell cURL Command

curl -X POST \
     -H 'Host: root_url' \
     -H 'X-EEO-SIGN: ceb7a2c0534999960c02c191d409c41e' \
     -H 'X-EEO-UID: 409864' \
     -H 'X-EEO-TS: 1722938382' \
     -H 'Content-Type: application/json' \
     -d '{"courseId": 414193, "activityIds": [25096097,25096099]}' \
     'https://root_url/playback/setPlaybackAllViewable'

Response Example (Normal JSON Response)

{
    "code": 1,
    "msg": "Success",
    "data": {
        "successList": [25096097,25096099],
        "failedList": []
    }
}

Error Codes