Plan a conference
v1
kmeetworkspace:calendar
post
/1/kmeet/rooms
This endpoint allows you to plan a conference with predefined settings. It will add an event on your Infomaniak Calendar with the meeting url. If you just want to create a room you don't need any API calls, you can build a conference URL by adding an unique identifier to your kMeet instance url (eg: kmeet.infomaniak.com/${MY_VERY_SECRET_CONFERENCE_ID})
Body Parameters
application/jsoncalendar_idrequiredinteger
The unique identifier (ID) of the Infomaniak Calendar where you want to plan the meeting. Make a GET request on https://calendar.infomaniak.com/api/pim/calendar
Examples:72618
starting_atrequiredstring
Examples:2020-06-01 20:00:00
ending_atrequiredstring
Room settings can be deleted if this date expires. This field will be updated if event dates change in Infomaniak Calendar.
Examples:2020-06-01 20:00:00
timezonerequiredstring
Examples:Europe/Zurich
hostnamerequiredstring
Needed for rebuilding room url
Examples:kmeet.infomaniak.com
titlerequiredstring
Examples:example
descriptionstring
Examples:Illo voluptatem modi rerum praesentium provident voluptatum quaerat.
attendeesarrayofobject
optionsrequiredarrayofobject
Response Body
application/json
resultrequiredstring
Possible values:successerrorasynchronous
Result of the HTTP request
Examples:success
dataPlanned room return
Example request
<?php
use GuzzleHttp\Client;
$client = new Client();
$headers = [
'Authorization' => 'Bearer YOUR-TOKEN-HERE',
'Content-Type' => 'application/json'
];
$body = '{
"calendar_id": 72618,
"starting_at": "2020-06-01 20:00:00",
"ending_at": "2020-06-01 20:00:00",
"timezone": "Europe\/Zurich",
"hostname": "kmeet.infomaniak.com",
"title": "example",
"options": [
{
"subject": "example",
"start_audio_muted": false,
"enable_recording": false,
"enable_moderator_video": true,
"start_audio_only": true,
"lobby_enabled": false,
"password_enabled": false,
"e2ee_enabled": true
}
]
}';
$request = new Request('POST', 'https://api.infomaniak.com/1/kmeet/rooms', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();
Example response
application/json
{"result":"success","data":{"ending_at":"2020-06-01 20:00:00","hostname":"kmeet.infomaniak.com","options":[{"subject":"example","start_audio_muted":false,"enable_recording":false,"enable_moderator_video":false,"start_audio_only":false,"lobby_enabled":true,"password_enabled":true,"e2ee_enabled":true}]}}