Create Room

Create Room

curl --request POST \
  --url https://api.pagecall.com/v1/rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Meeting Room - 1",
  "type": "public",
  "record": true,
  "max_meeting_seconds": 123,
  "members": [
    {
      "user_id": "000585f36eed9e8fb6b655b4",
      "type": "guest",
      "name": "user-1"
    }
  ],
  "webhook": {
    "url": "<string>",
    "headers": {}
  }
}
'

{
  "room": {
    "id": "000585f36eed9e8fb6b655b4",
    "type": "public",
    "name": "Weekly Meet",
    "application_id": "000585f36eed9e8fb6b655b4",
    "created_user_id": "#DEPRECATED#",
    "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"
  },
  "paging": {
    "limit": 30,
    "offset": 0,
    "total": 0
  }
}

POST

rooms

Create Room

curl --request POST \
  --url https://api.pagecall.com/v1/rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Meeting Room - 1",
  "type": "public",
  "record": true,
  "max_meeting_seconds": 123,
  "members": [
    {
      "user_id": "000585f36eed9e8fb6b655b4",
      "type": "guest",
      "name": "user-1"
    }
  ],
  "webhook": {
    "url": "<string>",
    "headers": {}
  }
}
'

{
  "room": {
    "id": "000585f36eed9e8fb6b655b4",
    "type": "public",
    "name": "Weekly Meet",
    "application_id": "000585f36eed9e8fb6b655b4",
    "created_user_id": "#DEPRECATED#",
    "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"
  },
  "paging": {
    "limit": 30,
    "offset": 0,
    "total": 0
  }
}

Webhook

When you create a room with webhook parameters, a webhook will be sent via a POST method for each participant’s entry and exit. The request body for this is as follows.

{
  action: "sessionLeft" | "sessionJoined",
  payload: {
    roomId: string,
    userId?: string,
    memberId: string,
    sessionId: string,
    sessionsCount: number,
    membersCount: number,
    timestamp: string // e.g. '2022-05-31T12:38:15.059Z'
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request format to create a new room

name

string

required

Human-readable name of the room

Example:

"Meeting Room - 1"

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"

record

boolean

default:true

All meeting will be recorded

max_meeting_seconds

integer

Determines the maximum meeting time in seconds. Once this time has elapsed, the meeting room will be automatically terminated. The 'meeting time' refers to the duration during which two or more participants are connected. If a max_meeting_seconds is set, the timer UI will display the remaining meeting time, rather than the elapsed time.

members

object[]

Specify inviting user_id and type

Show child attributes

members.user_id

string

required

user_id of the user in application (workspace) scope

Example:

"000585f36eed9e8fb6b655b4"

members.type

enum<string>

default:guest

required

Type of user in this room

guest: The user is guest.
host: The user is host. This user has administrator privileges.
monitor: The user is observer. Can watch the meeting, but can not join.

Available options:

guest,

host,

monitor

Example:

"guest"

members.name

string

Display name of the user in the meeting room

Example:

"user-1"

webhook

object

Show child attributes

webhook.url

string

required

an URL to which the Pagecall server will send the webhook

webhook.headers

object

Headers to include when sending the webhook, which can be useful when authentication is required.

Response

Successful operation

room

object

Information about room

Show child attributes

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<date-time>

[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<date-time>

The meeting is started at specified time format

Example:

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

room.terminated_at

string<date-time>

The room is terminated at specified time format

Example:

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

room.updated_at

string<date-time>

The room settings are changed at specified time format

Example:

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

room.created_at

string<date-time>

The room is created at specified time format

Example:

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

paging

object

Details of pagination used for current responses.

Show child attributes

paging.limit

number

default:30

required

paging.offset

number

default:0

required

paging.total

number

required

Example:

0

List Rooms Get Room

⌘I

Room Endpoints

User Endpoints

Member Endpoints

Webhook

Authorizations

Body

Response

Room Endpoints

User Endpoints

Member Endpoints

​Webhook

Authorizations

Body

Response

Webhook