Skip to content

Report a meeting start (metering)

POST
/v1/meetings/start
curl --request POST \
--url https://api.meetor.co/v1/meetings/start \
--header 'Content-Type: application/json' \
--cookie meetor_session=<meetor_session> \
--data '{ "workspaceId": "example", "clientMeetingId": "example", "startedAt": 1 }'

Counts a meeting start toward the monthly limit, once per clientMeetingId. The meeting itself stays on the device. A running meeting is never blocked: allowed: false means the next start should be.

Media typeapplication/json
object
workspaceId
required
string
>= 1 characters <= 64 characters
clientMeetingId
required
string
>= 1 characters <= 64 characters
startedAt
required
integer
Examplegenerated
{
"workspaceId": "example",
"clientMeetingId": "example",
"startedAt": 1
}

Counted (or already counted).

Media typeapplication/json
object
allowed
required
boolean
used
required
integer
limit
required
number | null
month
required
string
Examplegenerated
{
"allowed": true,
"used": 1,
"limit": 1,
"month": "example"
}

Not signed in.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

No such workspace.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}