Edita, remarca, publica ou cancela
curl --request PATCH \
--url https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"cover_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_url": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"duration_minutes": 367,
"chat_enabled": true,
"record": true,
"published_at": "2023-11-07T05:31:56Z",
"replay_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelled": true,
"cancel_reason": "<string>"
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}"
payload = {
"title": "<string>",
"description": "<string>",
"cover_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_url": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"duration_minutes": 367,
"chat_enabled": True,
"record": True,
"published_at": "2023-11-07T05:31:56Z",
"replay_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelled": True,
"cancel_reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
cover_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_url: '<string>',
starts_at: '2023-11-07T05:31:56Z',
duration_minutes: 367,
chat_enabled: true,
record: true,
published_at: '2023-11-07T05:31:56Z',
replay_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
cancelled: true,
cancel_reason: '<string>'
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}', 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://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'description' => '<string>',
'cover_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_url' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'duration_minutes' => 367,
'chat_enabled' => true,
'record' => true,
'published_at' => '2023-11-07T05:31:56Z',
'replay_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'cancelled' => true,
'cancel_reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cover_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_url\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"duration_minutes\": 367,\n \"chat_enabled\": true,\n \"record\": true,\n \"published_at\": \"2023-11-07T05:31:56Z\",\n \"replay_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cancelled\": true,\n \"cancel_reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cover_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_url\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"duration_minutes\": 367,\n \"chat_enabled\": true,\n \"record\": true,\n \"published_at\": \"2023-11-07T05:31:56Z\",\n \"replay_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cancelled\": true,\n \"cancel_reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cover_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_url\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"duration_minutes\": 367,\n \"chat_enabled\": true,\n \"record\": true,\n \"published_at\": \"2023-11-07T05:31:56Z\",\n \"replay_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cancelled\": true,\n \"cancel_reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"live": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"public_id": "<string>",
"channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel_name": "<string>",
"title": "<string>",
"provider": "livekit",
"status": "scheduled",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"chat_enabled": true,
"record": true,
"recording": true,
"hosts": [
{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"viewers": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"cover": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"source_url": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancel_reason": "<string>",
"replay": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"speakers": [
{
"student_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"since": "2023-11-07T05:31:56Z"
}
],
"recordings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "requested",
"started_at": "2023-11-07T05:31:56Z",
"media": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"size_bytes": 123,
"duration_seconds": 123,
"error": "<string>",
"ended_at": "2023-11-07T05:31:56Z"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Lives
Editar live
Edita, remarca, publica ou cancela.
PATCH
/
v1
/
clubs
/
{clubId}
/
lives
/
{liveId}
Edita, remarca, publica ou cancela
curl --request PATCH \
--url https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"cover_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_url": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"duration_minutes": 367,
"chat_enabled": true,
"record": true,
"published_at": "2023-11-07T05:31:56Z",
"replay_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelled": true,
"cancel_reason": "<string>"
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}"
payload = {
"title": "<string>",
"description": "<string>",
"cover_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"source_url": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"duration_minutes": 367,
"chat_enabled": True,
"record": True,
"published_at": "2023-11-07T05:31:56Z",
"replay_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cancelled": True,
"cancel_reason": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
cover_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
source_url: '<string>',
starts_at: '2023-11-07T05:31:56Z',
duration_minutes: 367,
chat_enabled: true,
record: true,
published_at: '2023-11-07T05:31:56Z',
replay_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
cancelled: true,
cancel_reason: '<string>'
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}', 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://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'title' => '<string>',
'description' => '<string>',
'cover_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'source_url' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'duration_minutes' => 367,
'chat_enabled' => true,
'record' => true,
'published_at' => '2023-11-07T05:31:56Z',
'replay_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'cancelled' => true,
'cancel_reason' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cover_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_url\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"duration_minutes\": 367,\n \"chat_enabled\": true,\n \"record\": true,\n \"published_at\": \"2023-11-07T05:31:56Z\",\n \"replay_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cancelled\": true,\n \"cancel_reason\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cover_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_url\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"duration_minutes\": 367,\n \"chat_enabled\": true,\n \"record\": true,\n \"published_at\": \"2023-11-07T05:31:56Z\",\n \"replay_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cancelled\": true,\n \"cancel_reason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/lives/{liveId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"cover_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"source_url\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"duration_minutes\": 367,\n \"chat_enabled\": true,\n \"record\": true,\n \"published_at\": \"2023-11-07T05:31:56Z\",\n \"replay_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"cancelled\": true,\n \"cancel_reason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"live": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"public_id": "<string>",
"channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"channel_name": "<string>",
"title": "<string>",
"provider": "livekit",
"status": "scheduled",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"chat_enabled": true,
"record": true,
"recording": true,
"hosts": [
{
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"viewers": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"cover": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"source_url": "<string>",
"published_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"cancelled_at": "2023-11-07T05:31:56Z",
"cancel_reason": "<string>",
"replay": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"speakers": [
{
"student_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"since": "2023-11-07T05:31:56Z"
}
],
"recordings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "requested",
"started_at": "2023-11-07T05:31:56Z",
"media": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"size_bytes": 123,
"duration_seconds": 123,
"error": "<string>",
"ended_at": "2023-11-07T05:31:56Z"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Token OPACO de sessão de quem administra, emitido por
/v1/auth/admin/sign-in e verificado contra a nossa tabela — o mesmo
desenho do studentSession, para a outra identidade.
É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
studentSession; uma rota consumida pelos dois declara os dois
esquemas, e o middleware aceita qualquer um deles. As duas credenciais
são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
que cada uma existe.
O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
Authorization a cada chamada.
Path Parameters
Id público da organização — o mesmo que GET /v1/me devolve em
organization_id.
Na URL o recurso se chama club; no contrato e no domínio, organization.
A divergência é deliberada: clubs é a palavra do produto, e a URL é o que
as pessoas leem.
É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer.
O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso.
Body
application/json
Required string length:
1 - 160Maximum string length:
4000Onde a transmissão acontece. livekit é a sala nossa — com palco, chat e
gravação —; youtube e vimeo são tocados por embed no classroom; link
é qualquer outra sala (Zoom, Meet), aberta fora.
Available options:
livekit, youtube, vimeo, link Maximum string length:
500Required range:
15 <= x <= 720Um vídeo da biblioteca; nulo tira o replay.
Só true; live cancelada não volta.
Maximum string length:
500Response
A live
Show child attributes
Show child attributes