Verwaltung von Tagungsräumen
Dieser Leitfaden zeigt Ihnen, wie Sie:
- Rufen Sie die Details für einen einzelnen Raum ab.
- Erhalten Sie eine Liste aller Räume, die mit Ihrer Anwendung verbunden sind.
- Ändern Sie das Ablaufdatum für einen einzelnen Langzeitraum.
Einzelraumabfrage
https://api-eu.vonage.com/v1/meetings/rooms/:room_id
Wenn Sie einen Raum erstellen, erhalten Sie einen Raum id in der Antwort. Diese id kann für den Abruf von Räumen mit einer
Beispiel-Anfrage
const credentials = new Auth({
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
applicationId: VONAGE_APPLICATION_ID,
});
const options = {};
const meetingsClient = new Meetings(credentials, options);
const room = await meetingsClient.getRoom("9f6fe8ae-3458-4a72-b532-8276d5533e97");
var client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();
var room = client.getMeetingsClient().getRoom(
UUID.fromString("9f6fe8ae-3458-4a72-b532-8276d5533e97")
);
var credentials = Credentials.FromAppIdAndPrivateKeyPath(applicationId, privateKeyPath);
var client = new VonageClient(credentials);
var request = GetRoomRequest.Parse(new Guid("9f6fe8ae-3458-4a72-b532-8276d5533e97"));
var response = await client.MeetingsClient.GetRoomAsync(request);
client = vonage.Client(
application_id=VONAGE_APPLICATION_ID,
private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
)
response = client.meetings.get_room('9f6fe8ae-3458-4a72-b532-8276d5533e97')
Dies gibt eine generische Vonage::Response Objekt.
Die Vonage::Response Objekt de-serialisiert die zurückgegebenen JSON-Daten in Vonage::Entity Objekten und bietet Getter-Methoden für die Top-Level-Eigenschaften dieser JSON-Daten, zum Beispiel:
Für Eigenschaften in den JSON-Daten, bei denen der Wert ein JSON-Objekt ist, wird dieses selbst in ein JSON-Objekt de-serialisiert. Vonage::Entity Objekt, mit seinen eigenen Getter-Methoden. Zum Beispiel kann das recording_options Getter gibt eine Vonage::Entity Objekt mit auto_record und record_only_owner Getter. Sie können diese Getter-Methodenaufrufe verketten, um an die benötigten Daten zu gelangen:
Die Reaktion ist identisch, unabhängig davon, ob es sich um ein Langzeit- oder ein Sofortzimmer handelt.
Beispiel Antwort
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"meeting_code": "280674154",
"is_available": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"created_at": "2023-06-06T06:45:07.135Z",
"expires_at": "2023-06-06T06:55:07.134Z",
"expire_after_use": true,
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
},
"_links": {
"guest_url": {
"href": "https://meetings.vonage.com/280674154"
},
"host_url": {
"href": "https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC"
}
}
}
Alle Räume abrufen
https://api-eu.vonage.com/v1/meetings/rooms/
Um alle Räume abzurufen, senden Sie eine
id: Beispiel-Anfrage
const credentials = new Auth({
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
applicationId: VONAGE_APPLICATION_ID,
});
const options = {};
const meetingsClient = new Meetings(credentials, options);
const rooms = meetingsClient.getRooms();
var client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();
var rooms = client.getMeetingsClient().listRooms();
var credentials = Credentials.FromAppIdAndPrivateKeyPath(applicationId, privateKeyPath);
var client = new VonageClient(credentials);
var request = GetRoomsRequest.Build().Create();
var response = await client.MeetingsClient.GetRoomsAsync(request);
client = vonage.Client(
application_id=VONAGE_APPLICATION_ID,
private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
)
response = client.meetings.list_rooms()
Dies gibt ein Objekt der Klasse Vonage::Meetings::Rooms::ListResponse Klasse.
Diese Klasse definiert eine each Methode, die es Ihnen ermöglicht, durch die folgenden Elemente zu iterieren _embedded Array, das in der Antwort zurückgegeben wird. Zum Beispiel:
Die Klasse umfasst außerdem Enumerable, so dass Sie jede Instanzmethode dieses Moduls für das Objekt aufrufen können. Zum Beispiel:
Beispiel Antwort
{
"page_size": 25,
"total_items": 30,
"_embedded": [
{
"id": "9f6fe8ae-3458-4a72-b532-8276d5533e97",
"display_name": "My custom room",
"metadata": "Welcome to my custom room",
"type": "instant",
"recording_options": {
"auto_record": false,
"record_only_owner": false
},
"meeting_code": "280674154",
"is_available": true,
"theme_id": "ef2b46f3-8ebb-437e-a671-272e4990fbc8",
"created_at": "2023-06-06T06:45:07.135Z",
"expires_at": "2023-06-06T06:55:07.134Z",
"expire_after_use": true,
"join_approval_level": "none",
"initial_join_options": {
"microphone_state": "on"
},
"callback_urls": {
"rooms_callback_url": "https://example.com/rooms",
"sessions_callback_url": "https://example.com/sessions",
"recordings_callback_url": "https://example.com/recordings"
},
"available_features": {
"is_recording_available": true,
"is_chat_available": true,
"is_whiteboard_available": true,
"is_locale_switcher_available": true,
"is_captions_available": false
},
"ui_settings": {
"language": "es"
},
"_links": {
"guest_url": {
"href": "https://meetings.vonage.com/280674154"
},
"host_url": {
"href": "https://meetings.vonage.com/?room_token=280674154&participant_token=eyJhbGciOiJIUzI1NiIsInR5cC"
}
}
}
],
"_links": {
"first": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50"
},
"self": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293905"
},
"next": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293906"
},
"prev": {
"href": "https://api-eu.vonage.com/v1/meetings/rooms?page_size=50&start_id=2293904"
}
}
}
Update zum Verfallsdatum
PATCH: https://api-eu.vonage.com/v1/meetings/rooms/
Das Ablaufdatum eines Langzeitraums kann mit Hilfe eines PATCH Aktion und der Raum id. Das neue Datum sollte in ein Objekt namens update_details:
Beispiel-Anfrage
const credentials = new Auth({
privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH,
applicationId: VONAGE_APPLICATION_ID,
});
const options = {};
const meetingsClient = new Meetings(credentials, options);
const room = await meetingsClient.getRoom("9f6fe8ae-3458-4a72-b532-8276d5533e97");
room.expiresAt = '2022-11-11T16:00:00.000Z';
await meetingsClient.updateRoom("9f6fe8ae-3458-4a72-b532-8276d5533e97", room);
var client = VonageClient.builder()
.applicationId(VONAGE_APPLICATION_ID)
.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
.build();
var room = client.getMeetingsClient().updateRoom(
UUID.fromString("9f6fe8ae-3458-4a72-b532-8276d5533e97"),
UpdateRoomRequest.builder()
.expiresAt(Instant.parse("2022-11-11T16:00:00.000Z"))
.build()
);
var credentials = Credentials.FromAppIdAndPrivateKeyPath(applicationId, privateKeyPath);
var client = new VonageClient(credentials);
var request = UpdateRoomRequest.Build()
.WithRoomId(new Guid("9f6fe8ae-3458-4a72-b532-8276d5533e97"))
.WithExpiresAt(DateTime.Parse("2022-11-11T16:00:00.000Z"))
.Create();
var response = await client.MeetingsClient.UpdateRoomAsync(request);
client = vonage.Client(
application_id=VONAGE_APPLICATION_ID,
private_key=VONAGE_APPLICATION_PRIVATE_KEY_PATH,
)
response = client.meetings.update_room(
'9f6fe8ae-3458-4a72-b532-8276d5533e97',
{'update_details': {'expires_at': '2023-11-11T16:00:00.000Z'}},
)
Bitte beachten Sie, dass nur Langzeitzimmer aktualisiert werden können.