Kapitel 7 GET POST

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.

Dette er det eneste BigBlueButton-API-endepunkt, der returnerer JSON i stedet for XML.

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-* ↗ undocumented 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>",
        "sessionToken": "replace-with-session-token"
  }
}
Meddelelse Betydning
Invalid Session sessionToken er ugyldigt eller er udløbet.
Access denied Brugeren blev ikke fundet eller har ikke tilladelse.
Meeting not found Mødet findes ikke eller kører ikke længere.

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 enforceLayout er 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.

Bemærkninger til bbbserver.de-brugere

Endepunktet getJoinUrl er tilgængeligt på alle bbbserver.de-instanser, der kører BigBlueButton 3.0 eller senere. Hvis din integration skal understøtte scenarier med flere skærme eller enhedsskift, giver dette endepunkt en ren måde at generere yderligere join-URL'er på uden at kræve et andet join-kald med moderatoroplysninger.

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.

Ofte stillede spørgsmål

Nej. I modsætning til de fleste BigBlueButton-API-endepunkter bruger getJoinUrl session-token-godkendelse. Du sender parameteren sessionToken i stedet for at beregne en tjeksum med den delte hemmelighed.

Nej. Brugeren skal allerede have deltaget via standard-endepunktet join og have et gyldigt, aktivt sessionToken. Endepunktet kan ikke bruges til at oprette indledende join-URL'er.

Begge sessioner — den oprindelige og den nye — vil eksistere parallelt. Brugeren vises kun en gang i deltagerlisten, men begge browservinduer eller enheder forbliver aktive.

Dette er et designvalg truffet af BigBlueButton-udviklerne, da dette endepunkt blev introduceret i version 3.0. Det er det eneste API-endepunkt, der returnerer JSON. Alle andre endepunkter fortsætter med at returnere XML.

Endepunktet getJoinUrl blev introduceret i BigBlueButton 3.0. Det er ikke tilgængeligt i tidligere versioner.

Ikke nødvendigvis. En konfigurerbar blokliste kan begrænse bestemte userdata-nøgler for brugere, der ikke er moderatorer. Hvis bloklisten er sat til "all", videresendes ingen userdata-parametre for seere. Moderatorer omgår bloklisten undtagen i breakout rooms.