List Rooms

GET

rooms

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

{
  "rooms": [
    {
      "id": "000585f36eed9e8fb6b655b4",
      "type": "private",
      "name": "Monthly Meeting Room with Design Class"
    },
    {
      "id": "000235f36efd9e8db6bc55b4",
      "type": "public",
      "name": "Daily Meet"
    },
    {
      "id": "000935fc6efd9f8db61c35b4",
      "type": "open",
      "name": "Free Disgn Class"
    }
  ],
  "paging": {
    "limit": 30,
    "offset": 0,
    "total": 0
  }
}

Authorizations

Authorization

string

header

required

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

Query Parameters

offset

integer

The number of items to skip before starting to collect the result set

limit

integer

The numbers of items to return

name

string

Exact name of the room to search.

layout

string

Layout name to search.

is_terminated

boolean

Filter rooms by their termination status

Response

200

application/json

Successful operation

rooms

object[]

Information about room

rooms.id

string

required

ID of the room

Example:

"000585f36eed9e8fb6b655b4"

rooms.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"

rooms.name

string

required

Human readable name of the room

Example:

"Weekly Meet"

rooms.application_id

string

ID of the workspace

Example:

"000585f36eed9e8fb6b655b4"

rooms.created_user_id

string

[Deprecated] ID of the user who create this room

Example:

"#DEPRECATED#"

rooms.thumbnail_url

string

Generated thumbnail for this room

Example:

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

rooms.last_thumbnail_updated_at

string

[Deprecated] Last update time of generated thumbnail

Example:

"#DEPRECATED#"

rooms.room_template_id

string

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

Example:

"#DEPRECATED#"

rooms.layout

string

How the room looks

Example:

"SixAll"

rooms.record

boolean

Whether this room is recorded or not.

rooms.meeting_time

integer

Total meeting time in seconds

Example:

200000

rooms.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#"

rooms.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#"

rooms.is_recurring

boolean

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

Example:

"#DEPRECATED#"

rooms.started_at

string

The meeting is started at specified time format

Example:

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

rooms.terminated_at

string

The room is terminated at specified time format

Example:

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

rooms.updated_at

string

The room settings are changed at specified time format

Example:

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

rooms.created_at

string

The room is created at specified time format

Example:

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

Example:

[
  {
    "id": "000585f36eed9e8fb6b655b4",
    "type": "private",
    "name": "Monthly Meeting Room with Design Class"
  },
  {
    "id": "000235f36efd9e8db6bc55b4",
    "type": "public",
    "name": "Daily Meet"
  },
  {
    "id": "000935fc6efd9f8db61c35b4",
    "type": "open",
    "name": "Free Disgn Class"
  }
]

paging

object

Details of pagination used for current responses.

Create Room

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

{
  "rooms": [
    {
      "id": "000585f36eed9e8fb6b655b4",
      "type": "private",
      "name": "Monthly Meeting Room with Design Class"
    },
    {
      "id": "000235f36efd9e8db6bc55b4",
      "type": "public",
      "name": "Daily Meet"
    },
    {
      "id": "000935fc6efd9f8db61c35b4",
      "type": "open",
      "name": "Free Disgn Class"
    }
  ],
  "paging": {
    "limit": 30,
    "offset": 0,
    "total": 0
  }
}

Room Endpoints

User Endpoints

Member Endpoints

Authorizations

Query Parameters

Response