# Meetings API

This group covers meetings and their occurrences, shared notes and attendance, the scheduled calls of a chat, and groups and their members. Every call acts as a person: send a personal access token, or an OAuth access token from a person's sign-in (scope `Volobox`). An integration app's own client secret is refused with `403` (`Volobox:Integrations:MemberConnectionRequired`). Paths, tokens and conventions are in [API overview](/docs/api-overview).

## Groups

| Method | Path | Operation | Summary |
| --- | --- | --- | --- |
| GET | `/api/v1/group` | `meetings.group.getList` | Lists the groups the caller can see, filtered and paged. |
| POST | `/api/v1/group` | `meetings.group.create` | Creates a group with the caller as its admin. |
| GET | `/api/v1/group/{id}` | `meetings.group.get` | Gets a group the caller can see. |
| PUT | `/api/v1/group/{id}` | `meetings.group.update` | Updates the details of a group the caller administers. |
| DELETE | `/api/v1/group/{id}` | `meetings.group.delete` | Deletes a group the caller administers. |
| POST | `/api/v1/group/{id}/leave` | `meetings.group.leave` | Takes the caller out of a group. |
| DELETE | `/api/v1/group/{id}/member-entries/{memberId}` | `meetings.group.removeMemberEntry` | Removes one member entry, a person or an agent, from a group the caller administers. |
| GET | `/api/v1/group/{id}/members` | `meetings.group.getMembers` | Lists the members of a group the caller can see. |
| POST | `/api/v1/group/{id}/members` | `meetings.group.addMember` | Adds a workspace member to a group the caller administers. |
| PUT | `/api/v1/group/{id}/members/{memberId}` | `meetings.group.updateMember` | Changes the role of a member of a group the caller administers. |
| DELETE | `/api/v1/group/{id}/members/{userId}` | `meetings.group.removeMember` | Removes a person from a group the caller administers. |
| GET | `/api/v1/group/for-user/{userId}` | `meetings.group.getForUser` | Lists the groups a workspace member belongs to that the caller can see. |
| GET | `/api/v1/group/my-groups` | `meetings.group.getMyGroups` | Lists the groups the caller is a member of. Acts on the signed-in person's own account. |

Request bodies:

- `CreateGroupDto` (`create`): requires `name` (string).
- `UpdateGroupDto` (`update`): requires `name` (string).
- `UpdateGroupMemberDto` (`updateMember`): requires `role` (GroupMemberRole: None, Viewer, Member, Manager, Admin).

## Meetings

| Method | Path | Operation | Summary |
| --- | --- | --- | --- |
| GET | `/api/v1/meeting` | `meetings.meeting.getList` | Lists the meetings of one category the caller can see (for example the ones they take part in), optionally within a date range. |
| POST | `/api/v1/meeting` | `meetings.meeting.create` | Creates a meeting with its time, participants, audience and conference link. |
| GET | `/api/v1/meeting/{id}` | `meetings.meeting.get` | Gets a meeting the caller can see. |
| PUT | `/api/v1/meeting/{id}` | `meetings.meeting.update` | Updates a meeting the caller may manage. |
| DELETE | `/api/v1/meeting/{id}` | `meetings.meeting.delete` | Deletes a meeting the caller may manage. |
| GET | `/api/v1/meeting/{id}/attendance` | `meetings.meeting.getAttendance` | Lists who attended a meeting, or one occurrence of a recurring meeting, as its conference provider reported it. |
| PUT | `/api/v1/meeting/{id}/audience` | `meetings.meeting.setAudience` | Changes who can see a meeting the caller may manage. |
| POST | `/api/v1/meeting/{id}/invite` | `meetings.meeting.invite` | Invites workspace members to a meeting: the organizer always may, a participant on an open meeting, or on a private one whose organizer lets guests invite others. |
| POST | `/api/v1/meeting/{id}/leave` | `meetings.meeting.leave` | Takes the caller off a meeting's participants. |
| POST | `/api/v1/meeting/{id}/mark-joined` | `meetings.meeting.markJoined` | Records that the caller joined a meeting, or one occurrence of it. |
| GET | `/api/v1/meeting/{id}/notes` | `meetings.meeting.getNotes` | Gets the shared notes of a meeting the caller can see. |
| PUT | `/api/v1/meeting/{id}/notes` | `meetings.meeting.updateNotes` | Updates the shared notes of a meeting. |
| GET | `/api/v1/meeting/{id}/occurrence` | `meetings.meeting.getOccurrence` | Gets one occurrence of a recurring meeting, with its own changes applied. |
| PUT | `/api/v1/meeting/{id}/occurrence` | `meetings.meeting.updateOccurrence` | Changes one occurrence of a recurring meeting without changing the series. |
| POST | `/api/v1/meeting/{id}/occurrence/cancel` | `meetings.meeting.cancelOccurrence` | Cancels one occurrence of a recurring meeting. |
| POST | `/api/v1/meeting/{id}/occurrence/restore` | `meetings.meeting.restoreOccurrence` | Restores a cancelled occurrence of a recurring meeting. |
| POST | `/api/v1/meeting/{id}/response` | `meetings.meeting.respond` | Records the caller's answer (yes, no or maybe) to a meeting, or to one occurrence of it. |
| GET | `/api/v1/meeting/attendance/active-users` | `meetings.meeting.getActiveAttendance` | Lists the people in a meeting right now: those a conference provider reports, and those invited to an in-person meeting while it runs. |
| POST | `/api/v1/meeting/check-availability` | `meetings.meeting.checkAvailability` | Checks whether the proposed participants are free at a proposed meeting time. |
| GET | `/api/v1/meeting/conference-options` | `meetings.meeting.getConferenceOptions` | Lists the conference providers the caller can use for a meeting, and which one is the default. |
| GET | `/api/v1/meeting/live` | `meetings.meeting.getLive` | Lists the scheduled meetings the caller can see that are running now or about to start, with a join link. |
| POST | `/api/v1/meeting/quick-conference-link` | `meetings.meeting.generateQuickConferenceLink` | Creates a conference link on a chosen provider for a meeting held right away. |

Request bodies:

- `CreateMeetingDto` (`create`): requires `startTime` (date-time), `title` (string).
- `UpdateMeetingDto` (`update`): requires `startTime` (date-time), `title` (string).
- `UpdateMeetingNotesDto` (`updateNotes`): no field is required.
- `UpdateOccurrenceDto` (`updateOccurrence`): requires `occurrenceStartUtc` (date-time), `startTime` (date-time), `title` (string).

## Scheduled calls

| Method | Path | Operation | Summary |
| --- | --- | --- | --- |
| GET | `/api/v1/scheduled-talk/{id}` | `meetings.scheduledTalk.get` | Gets a scheduled call the caller can see. |
| POST | `/api/v1/scheduled-talk/{id}/cancel` | `meetings.scheduledTalk.cancel` | Cancels a scheduled call that the caller may change. |
| POST | `/api/v1/scheduled-talk/{id}/subscribe` | `meetings.scheduledTalk.subscribe` | Asks to be notified when a scheduled call starts. |
| DELETE | `/api/v1/scheduled-talk/{id}/subscribe` | `meetings.scheduledTalk.unsubscribe` | Stops the caller's notification for a scheduled call. |
| PUT | `/api/v1/scheduled-talk/{id}/time` | `meetings.scheduledTalk.reschedule` | Moves a scheduled call to a new time, or to now. |
| GET | `/api/v1/scheduled-talk/conversations/{conversationId}` | `meetings.scheduledTalk.getLiveForConversation` | Lists the scheduled calls of a chat that have not ended yet. |
| POST | `/api/v1/scheduled-talk/conversations/{conversationId}` | `meetings.scheduledTalk.create` | Schedules a call in a chat at a given time, or starts one now when no time is given. |
| GET | `/api/v1/scheduled-talk/conversations/{conversationId}/history` | `meetings.scheduledTalk.getConversationHistory` | Lists the past calls of a chat, paged. |
| GET | `/api/v1/scheduled-talk/upcoming` | `meetings.scheduledTalk.getUpcomingForMe` | Lists the scheduled calls the caller is invited to or can join that have not started yet. |

Request bodies:

- `CreateScheduledTalkDto` (`create`): no field is required.

## Example

`meetings.meeting.getLive`: lists the scheduled meetings the caller can see that are running now or about to start, with a join link.

```bash title="curl"
curl -s "https://volobox.example.com/api/v1/meeting/live" \
  -H "Authorization: Bearer $VOLOBOX_TOKEN"
```
