Get Room

GET

rooms

{id}

curl --request GET \
  --url https://api.pagecall.com/v1/rooms/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

room id

Response

200

application/json

Successful operation

room

object

Information about room

room.id

string

required

ID of the room

Example:

"000585f36eed9e8fb6b655b4"

room.type

enum<string>

required

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.

Available options:

open,

public,

private

Example:

"public"

room.name

string

required

Human readable name of the room

Example:

"Weekly Meet"

room.application_id

string

ID of the workspace

Example:

"000585f36eed9e8fb6b655b4"

room.created_user_id

string

[Deprecated] ID of the user who create this room

Example:

"#DEPRECATED#"

room.thumbnail_url

string

Generated thumbnail for this room

Example:

"https://example.url/thumbnail.png"

room.last_thumbnail_updated_at

string

[Deprecated] Last update time of generated thumbnail

Example:

"#DEPRECATED#"

room.room_template_id

string

[Deprecated] Use layout instead. ID of the room template used by this room

Example:

"#DEPRECATED#"

room.layout

string

How the room looks

Example:

"SixAll"

room.record

boolean

Whether this room is recorded or not.

room.meeting_time

integer

Total meeting time in seconds

Example:

200000

room.is_terminated

boolean

[Deprecated] Use terminated_at instead. Whether this room is terminated or not. If true, not available to join the room

Example:

"#DEPRECATED#"

room.is_ephemeral

boolean

[Deprecated] Whether this room is for temporary or not. If true and all the members of this room leave, the room will be closed

Example:

"#DEPRECATED#"

room.is_recurring

boolean

[Deprecated] Whether this meeting occurs regularly or not. If true, it will be reopened according to a predefined schedule.

Example:

"#DEPRECATED#"

room.started_at

string

The meeting is started at specified time format

Example:

"2023-01-01T01:00:00.000Z"

room.terminated_at

string

The room is terminated at specified time format

Example:

"2023-01-01T01:00:00.000Z"

room.updated_at

string

The room settings are changed at specified time format

Example:

"2023-01-01T01:00:00.000Z"

room.created_at

string

The room is created at specified time format

Example:

"2023-01-01T01:00:00.000Z"

Create Room Update Room

curl --request GET \
  --url https://api.pagecall.com/v1/rooms/{id} \
  --header 'Authorization: Bearer <token>'

{
  "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"
  }
}

Room Endpoints

User Endpoints

Member Endpoints

Authorizations

Path Parameters

Response