POST
/
rooms
curl --request POST \
  --url https://api.pagecall.com/v1/rooms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "max_meeting_seconds": 123,
  "members": [
    {
      "name": "user-1",
      "type": "guest",
      "user_id": "000585f36eed9e8fb6b655b4"
    }
  ],
  "name": "Meeting Room - 1",
  "record": true,
  "type": "public",
  "webhook": {
    "headers": {},
    "url": "<string>"
  }
}'
{
  "paging": {
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "room": {
    "application_id": "000585f36eed9e8fb6b655b4",
    "created_at": "2023-01-01T01:00:00.000Z",
    "created_user_id": "#DEPRECATED#",
    "id": "000585f36eed9e8fb6b655b4",
    "is_ephemeral": "#DEPRECATED#",
    "is_recurring": "#DEPRECATED#",
    "is_terminated": "#DEPRECATED#",
    "last_thumbnail_updated_at": "#DEPRECATED#",
    "layout": "SixAll",
    "meeting_time": 200000,
    "name": "Weekly Meet",
    "record": true,
    "room_template_id": "#DEPRECATED#",
    "started_at": "2023-01-01T01:00:00.000Z",
    "terminated_at": "2023-01-01T01:00:00.000Z",
    "thumbnail_url": "https://example.url/thumbnail.png",
    "type": "public",
    "updated_at": "2023-01-01T01:00:00.000Z"
  }
}

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
headerrequired

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

Body

application/json
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

name
string
required

Human-readable name of the room

record
boolean
default: true

All meeting will be recorded

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
webhook
object

Response

200 - application/json
paging
object

Details of pagination used for current responses.

room
object

Information about room