Add Playback Viewable Users

This is an LMS classroom activity API used to add users who can view the client-side playback for a classroom activity.

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 -- Add Playback Viewable Users

   • This is an incremental API. Adding new users will not affect existing members.
   • When adding viewable users, each user has a separate return code in the data field.
   • If a user being added already exists in the list, no error will be returned; the user will be returned in the success list and processed normally.
   • To set all selectable users as viewable, use the Set Playback All Viewable API.
   • To set all selectable users as non-viewable, use the Set Playback All Forbidden API.

URL

https://root_url/playback/addPlaybackUser

HTTP Request Methods

• POST

Encoding Format

• UTF-8

Request Parameters

Header Parameters

Body Parameters

Response Parameters

Examples

• HTTP Request

POST /playback/addPlaybackUser 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,
    "activityId": 25096097,
    "uidList": [
        504026,
        504028
    ]
}

• 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, "activityId": 25096097, "uidList": [504026, 504028]}' \
     'https://root_url/playback/addPlaybackUser'

Response Example (Normal JSON Response)

{
    "code": 1,
    "msg": "Success",
    "data": {
        "successList": [504026],

        "failedList": [
            {
                "uid":504028,
                "code": 121609003,
                "msg": "The user is not in the class and cannot be added"
            }
        ]
    }
}

Error Codes