Docs home

Join Event Admin

Starts a live event as host. Put the event session's `attendance_id` in the URL. Call it as an admin or tutor to open the event; registered students are notified that it has started.

POST/liveclass/join/{attendance_id}
Join Event Admin
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/liveclass/join/{attendance_id}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"force_start":0}'
{
  "code": 200,
  "message": "Success",
  "meeting_password": "413063",
  "join_id": "92660033860",
  "meeting_id": 593,
  "join_url": "https://zoom.us/j/92660033860?pwd=wTV86m3jHLEa6k9CkoHJUMmQ8Brvjb.1",
  "api_key": "BkknCKw1QLqaGXTWRbNNCQ",
  "sdk_key": "rouTHt5TGaObG7ty72yPA",
  "sdk_jwt_key": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhcHBLZXkiOiJyb3VUSHQ1VEdhT2JHN3R5NzJ5UEEiLCJpYXQiOjE3NDM0ODcyOTUsImV4cCI6MTc0MzQ5MDg5NSwidG9rZW5FeHAiOjE3NDM0OTA4OTV9.IDWG0aSsCsxqSICyAKGb-fCsZ-SXI0R4CxIaI8prozs",
  "signature": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZGtLZXkiOiJyb3VUSHQ1VEdhT2JHN3R5NzJ5UEEiLCJtbiI6IjkyNjYwMDMzODYwIiwicm9sZSI6MCwiaWF0IjoxNzQzNDg3Mjk1LCJleHAiOjE3NDM0OTA4OTUsInRva2VuRXhwIjoxNzQzNDkwODk1fQ.xbQbUdEiRzzwN1bbPEFHtNUF2_9KHqlg3h49DwvMq5Q",
  "start_url": "https://zoom.us/s/92660033860?zak=eyJ0eXAiOiJKV1QiLCJzdiI6IjAwMDAwMSIsInptX3NrbSI6InptX28ybSIsImFsZyI6IkhTMjU2In0.eyJpc3MiOiJ3ZWIiLCJjbHQiOjAsIm1udW0iOiI5MjY2MDAzMzg2MCIsImF1ZCI6ImNsaWVudHNtIiwidWlkIjoiWEtJYlJtNTNRVWVTa0hZdEd3Q01rdyIsInppZCI6IjdkZDFmZTNmYzljNTQ4NTA4MjM2NGEwMGIzZjFlNTMwIiwic2siOiIwIiwic3R5Ijo5OSwid2NkIjoiYXcxIiwiZXhwIjoxNzUxMjYyOTY0LCJpYXQiOjE3NDM0ODY5NjQsImFpZCI6IkJfQ3lwMXhyUTVHZ3ZjbkRlU3ZaaFEiLCJjaWQiOiIifQ.IFhGU5pGzpjb4LUDFgV1X8Kcp_ooVDiLIdEUfwDAhAc"
}

Access: Any logged-in user. What happens depends on your role:

  • Admins, tutors and custom roles get the host link (start_url). If the session hasn't started, this call starts it: the meeting is created on the session's platform if needed, the session is signed in and marked as live, and your institute's "session started" webhook is sent. For events, registered users are notified that the event has started. For mentoring sessions, only the assigned mentor can start.
  • Students get the attendee link only once the session has started ("You are not allowed to join at the moment !" before that). Joining marks the student present (unless the session uses Zoom threshold attendance). Students with a pending payment for the batch get an error whose message holds institution_bundle_id, is_free_enrolment and payment_id. Event sessions need the student to be registered ("Please register to join this event !").
Path parameters
attendance_idintegerrequired
The session (or event session) to join.
BodyJSONString
Purpose unclear from code.

A body is optional. If you send one, it is form-data with one field, JSONString, holding the JSON fields above.

Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
Example: 413063
join_idstring
The Zoom meeting number
Example: 92660033860
meeting_idinteger
Example: 593
join_urlstring
And start_url for staff
api_keystring
Example: BkknCKw1QLqaGXTWRbNNCQ
sdk_keystring
Example: rouTHt5TGaObG7ty72yPA
signaturestring
start_urlstring
Staff only

Notes: Errors: "Class is already completed !" for a live session that has ended; "Cannot start cancelled class !"; "This class is live class but no meeting platform attached. Do update platform for this session" when the session has no platform set; "This mentoring session is in-person only and cannot be joined online." Treat start_url and the SDK values as secrets: they let the holder host the meeting. Rate limit: 100 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI