Update Room
Update some of room settings
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
room id
Request format to update setting of exisiting room
Set this to chagne current room name
Set true to close this room
curl --request PUT \
--url https://api.pagecall.com/v1/rooms/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Monthly Meetting - 2",
"is_terminated": true
}'
{
"room": {
"id": "000585f36eed9e8fb6b655b4",
"application_id": "000585f36eed9e8fb6b655b4",
"type": "public",
"created_user_id": "#DEPRECATED#",
"name": "Weekly Meet",
"thumbnail_url": "https://example.url/thumbnail.png",
"last_thumbnail_updated_at": "#DEPRECATED#",
"room_template_id": "#DEPRECATED#",
"layout": "SixAll",
"record": true,
"meeting_time": 200000,
"is_terminated": "#DEPRECATED#",
"is_ephemeral": "#DEPRECATED#",
"is_recurring": "#DEPRECATED#",
"started_at": "2023-01-01T01:00:00.000Z",
"terminated_at": "2023-01-01T01:00:00.000Z",
"updated_at": "2023-01-01T01:00:00.000Z",
"created_at": "2023-01-01T01:00:00.000Z"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
room id
Body
Set this to chagne current room name
Set true to close this room
Response
Information about room
ID of the room
ID of the workspace
Room can have three different type
open
- anyone who obtain this room url can join and replay the meet.public
- any member who haved joined in same worksapce can join and replay the meet.private
- only invited workspace user can join and replay the meet.
open
, public
, private
[Deprecated] ID of the user who create this room
Human readable name of the room
Generated thumbnail for this room
[Deprecated] Last update time of generated thumbnail
[Deprecated] Use layout
instead. ID of the room template used by this room
How the room looks
Whether this room is recorded or not.
Total meeting time in seconds
[Deprecated] Use terminated_at
instead. Whether this room is terminated or not. If true, not available to join the room
[Deprecated] Whether this room is for temporary or not. If true and all the members of this room leave, the room will be closed
[Deprecated] Whether this meeting occurs regularly or not. If true, it will be reopened according to a predefined schedule.
The meeting is started at specified time format
The room is terminated at specified time format
The room settings are changed at specified time format
The room is created at specified time format
curl --request PUT \
--url https://api.pagecall.com/v1/rooms/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Monthly Meetting - 2",
"is_terminated": true
}'
{
"room": {
"id": "000585f36eed9e8fb6b655b4",
"application_id": "000585f36eed9e8fb6b655b4",
"type": "public",
"created_user_id": "#DEPRECATED#",
"name": "Weekly Meet",
"thumbnail_url": "https://example.url/thumbnail.png",
"last_thumbnail_updated_at": "#DEPRECATED#",
"room_template_id": "#DEPRECATED#",
"layout": "SixAll",
"record": true,
"meeting_time": 200000,
"is_terminated": "#DEPRECATED#",
"is_ephemeral": "#DEPRECATED#",
"is_recurring": "#DEPRECATED#",
"started_at": "2023-01-01T01:00:00.000Z",
"terminated_at": "2023-01-01T01:00:00.000Z",
"updated_at": "2023-01-01T01:00:00.000Z",
"created_at": "2023-01-01T01:00:00.000Z"
}
}