Du ser API-dokumentationen til BigBlueButton 3.x. Den aktuelle version er BigBlueButton 4.x. Planlægger du en opgradering? Migreringsvejledningen viser alle de ændringer, dine API-kald kræver.
getJoinUrl – Generer deltagelses-URL
Endepunktet getJoinUrl genererer en ny join-URL til en bruger, der allerede har deltaget i et møde. Dette gør det muligt for den samme bruger at åbne yderligere sessioner — for eksempel på en anden skærm eller efter skift af enhed — uden at skulle godkendes igen gennem det almindelige join-flow. BBB 3.0+
Endepunkt
GET/POST https://api-guide.bbbserver.com/bigbluebutton/api/getJoinUrl?<parameters> Dette endepunkt bruger session-token-godkendelse i stedet for den standardmæssige shared-secret-tjeksum-mekanisme. Brugeren skal allerede have deltaget via endepunktet join og have et gyldigt sessionToken.
I modsætning til de kontrolsumsbeskyttede BigBlueButton-API-endepunkter, som returnerer XML, returnerer dette endepunkt JSON.
Obligatoriske parametre
| Parameter | Type | Påkrævet | Standard | Beskrivelse |
|---|---|---|---|---|
sessionToken | String | Ja | — | Brugerens sessionToken, som der skal genereres en ny join-URL for. |
Valgfrie parametre
| Parameter | Type | Påkrævet | Standard | Beskrivelse |
|---|---|---|---|---|
replaceSession | Boolean | Nej | false | Når den er sat til true, ugyldiggøres den oprindelige session og erstattes af den nye (sessionsoverførsel). |
sessionName | String | Nej | — | Et beskrivende navn til den nye session. |
enforceLayout | String | Nej | — | Tilsidesæt layoutet for den nye session. |
userdata-* | String | Nej | — | Brugerdefinerede brugerdata til den nye session. Nøgler skal have præfikset userdata-. |
Anvendelsesområder
- Hybride scenarier — en moderator bruger én skærm til præsentationen og en anden skærm til deltageroversigten.
- Enhedsskift — en bruger skifter fra sin computer til en tablet under et møde.
- Opsætninger med flere skærme — et konferencelokale med flere skærme, der viser forskellige layouts.
Adfærd
Den nye session deler brugeridentiteten med den oprindelige session. Brugeren vises kun én gang på deltagerlisten.
Uden replaceSession findes begge sessioner parallelt.
Med replaceSession=true ugyldiggøres den oprindelige session, og brugeren overføres problemfrit til den nye session.
Eksempel på anmodning
GET https://api-guide.bbbserver.com/bigbluebutton/api/getJoinUrl?sessionToken=replace-with-session-token&sessionName=SecondScreen&enforceLayout=PRESENTATION_FOCUS Eksempelsvar (succes)
{
"response": {
"returncode": "SUCCESS",
"message": "Join URL provided successfully.",
"url": "https://api-guide.bbbserver.com/bigbluebutton/api/join?...&checksum=replace-with-checksum"
}
} Fejlsvar
Når en anmodning mislykkes, returnerer endepunktet et JSON-objekt med en beskrivende fejlmeddelelse:
{
"response": {
"returncode": "FAILED",
"message": "<error message>"
}
} | Meddelelse | Betydning |
|---|---|
You must provide a session token | Parameteren sessionToken mangler. |
Invalid session token | sessionToken er ugyldigt eller er udløbet. |
Invalid Session | Anmodningen indeholder ikke den HTTP-sessionscookie, som join har oprettet, og mødet tillader ikke anmodninger uden en session (allowRequestsWithoutSession, standardværdi false). |
Access denied | Brugeren blev ikke fundet eller har ikke tilladelse. |
Meeting not found | Mødet findes ikke eller kører ikke længere. |
I BigBlueButton 3.0 returneres kun Meeting not found som en JSON-fejl. For de øvrige fejl, der er angivet ovenfor, sender endepunktet intet JSON-svar.
Userdata-blokliste
Når du bruger userdata-*-parametre med getJoinUrl, begrænser en konfigurerbar blokliste (getJoinUrlUserdataBlocklist) bestemte userdata-nøgler for brugere, der ikke er moderatorer:
- Hvis bloklisten indeholder værdien
"all", blokeres alle userdata-parametre for seere. - Moderatorer omgår bloklisten, undtagen i breakout rooms.
- Parameteren
enforceLayouter altid tilladt, uanset bloklisten.
Endepunktet er kun tilgængeligt, når brugeren allerede har et gyldigt sessionToken — det vil sige, at vedkommende først skal have deltaget i mødet via standard-endepunktet join. Udløbne tokens afvises.
Ved brugstilfaelde med enhedsskift skal du indstille replaceSession=true for problemfrit at overfore sessionen til den nye enhed. Dette undgar at have en foraeldet session pa den gamle enhed, som kan skabe forvirring i deltagerlisten.