Entry codes
Console client configuration · Response and shared models
Entry codes are issued per classroom for teacher or student roles. maxClaims is required. Teacher codes allow one claim; batched individual student codes also allow one claim per code. Lists include status, claim counts, and claimants. Update can change remarks or limits and rotate the code; revoke invalidates the code.
Application backends use application business APIs with app credentials. This page describes the separate tenant management calls.
entryCodes.list
List entry codes and claims.
GET /v1/classrooms/entry-codes
Authentication: tenant Bearer token and x-app-id.
| Language | Call |
|---|---|
| Node.js | c.entryCodes.list(appId, input) |
| Python | c.entry_codes.list(app_id, **input) |
| Java | c.entryCodes.list(appId, input) |
| Go | c.EntryCodes.List(ctx, appID, input, &result) |
| PHP | $c->entryCodes->list($appId, $input) |
Input: ClassroomIdInput. Fields are sent as URL query parameters.
| Field | Required | Type | Description |
|---|---|---|---|
classroomId | Yes | string | Classroom ID |
Returns: EntryCodeList. See shared models for nested fields.
entryCodes.issue
Issue entry codes.
POST /v1/classrooms/entry-codes
Authentication: tenant Bearer token and x-app-id.
| Language | Call |
|---|---|
| Node.js | c.entryCodes.issue(appId, input) |
| Python | c.entry_codes.issue(app_id, **input) |
| Java | c.entryCodes.issue(appId, input) |
| Go | c.EntryCodes.Issue(ctx, appID, input, &result) |
| PHP | $c->entryCodes->issue($appId, $input) |
Input: IssueEntryCodesInput. Fields are sent in the JSON body.
| Field | Required | Type | Description |
|---|---|---|---|
role | Yes | "teacher" | "student" | Member or entry code role |
maxClaims | Yes | number | Maximum claims, 1–500; teacher code uses 1 |
count | No | number | undefined | Issue count, 1–20; teacher code uses 1 |
remark | No | string | undefined | Remark, up to 64 characters |
classroomId | Yes | string | Classroom ID |
Returns: EntryCodeList. See shared models for nested fields.
entryCodes.update
Update or rotate entry code.
POST /v1/classrooms/entry-codes/update
Authentication: tenant Bearer token and x-app-id.
| Language | Call |
|---|---|
| Node.js | c.entryCodes.update(appId, input) |
| Python | c.entry_codes.update(app_id, **input) |
| Java | c.entryCodes.update(appId, input) |
| Go | c.EntryCodes.Update(ctx, appID, input, &result) |
| PHP | $c->entryCodes->update($appId, $input) |
Input: UpdateEntryCodeInput. Fields are sent in the JSON body.
| Field | Required | Type | Description |
|---|---|---|---|
entryCodeId | Yes | string | Entry-code record ID |
maxClaims | No | number | undefined | Maximum claims, 1–500; teacher code uses 1 |
remark | No | string | undefined | Remark, up to 64 characters |
rotate | No | boolean | undefined | Rotate entry-code value |
classroomId | Yes | string | Classroom ID |
Returns: EntryCodeRecord. See shared models for nested fields.
entryCodes.revoke
Revoke entry code.
POST /v1/classrooms/entry-codes/revoke
Authentication: tenant Bearer token and x-app-id.
| Language | Call |
|---|---|
| Node.js | c.entryCodes.revoke(appId, input) |
| Python | c.entry_codes.revoke(app_id, **input) |
| Java | c.entryCodes.revoke(appId, input) |
| Go | c.EntryCodes.Revoke(ctx, appID, input, &result) |
| PHP | $c->entryCodes->revoke($appId, $input) |
Input: RevokeEntryCodeInput. Fields are sent in the JSON body.
| Field | Required | Type | Description |
|---|---|---|---|
entryCodeId | Yes | string | Entry-code record ID |
classroomId | Yes | string | Classroom ID |
Returns: EntryCodeRecord. See shared models for nested fields.