Generate Online Conference Attendee Join Token

Required permissions: online_conferences.join_token.*

POST /online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join

Generate Online Conference Attendee Join Token

cURL

curl --request POST \
  --url https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join \
  --header 'X-Access-Key-Id: <api-key>' \
  --header 'X-Access-Key-Secret: <api-key>'

import requests

url = "https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join"

headers = {
    "X-Access-Key-Id": "<api-key>",
    "X-Access-Key-Secret": "<api-key>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Access-Key-Id': '<api-key>', 'X-Access-Key-Secret': '<api-key>'}
};

fetch('https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-Access-Key-Id: <api-key>",
    "X-Access-Key-Secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-Access-Key-Id", "<api-key>")
	req.Header.Add("X-Access-Key-Secret", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join")
  .header("X-Access-Key-Id", "<api-key>")
  .header("X-Access-Key-Secret", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{primary_domain}/api/public/v2.0/online_conferences/{online_conference_id}/attendees/{online_conference_attendee_id}/join")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Access-Key-Id"] = '<api-key>'
request["X-Access-Key-Secret"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "data": {
    "join_token": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
  }
}

"Invalid or missing access key."

"Resource object does not exist."

"Online Conference has ended."

"Too many requests."

"An unexpected error occurred."

Authorizations

X-Access-Key-Id · string · header · required

X-Access-Key-Secret · string · header · required

Path Parameters

online_conference_id · integer · required

online_conference_attendee_id · integer · required

Response

200

application/json

on

message · string · required

data · object · required

Show child attributes