wehub-resource-sync
86 lines
2.9 KiB
Markdown
86 lines
2.9 KiB
Markdown
# Zoom Clips API
|
|
|
|
Authoritative endpoint inventory for Clips. This file mirrors the official Zoom API Hub OpenAPI document for this product area.
|
|
|
|
## Canonical Source
|
|
|
|
- OpenAPI JSON: https://developers.zoom.us/api-hub/clips/methods/endpoints.json
|
|
- Base URL: `https://api.zoom.us/`
|
|
- Authentication details: [authentication.md](authentication.md)
|
|
|
|
## Notes
|
|
|
|
- Endpoint methods and paths below are generated from the official Zoom API Hub `paths` object.
|
|
- Scope names are defined per operation and frequently use granular scope names. Check the API Hub operation page for the exact scopes before implementation.
|
|
- Use this file for endpoint discovery and inventory. Use `../examples/` for orchestration patterns, not as the canonical source of path names.
|
|
|
|
## Coverage
|
|
|
|
| Metric | Value |
|
|
|--------|-------|
|
|
| Endpoint operations | 13 |
|
|
| Path templates | 11 |
|
|
| Tags | 7 |
|
|
|
|
## Tag Index
|
|
|
|
| Tag | Operations |
|
|
|-----|------------|
|
|
| Clips | 3 |
|
|
| Collaborator | 1 |
|
|
| Comment | 2 |
|
|
| Download | 1 |
|
|
| Single | 1 |
|
|
| Transfer | 2 |
|
|
| Upload | 3 |
|
|
|
|
## Endpoints by Tag
|
|
|
|
### Clips
|
|
|
|
| Method | Endpoint | Summary | Operation ID |
|
|
|--------|----------|---------|-------------|
|
|
| GET | `/clips` | List all clips | `GetUserClips` |
|
|
| GET | `/clips/{clipId}` | Get a clip | `GetClipById` |
|
|
| GET | `/clips/{clipId}/collaborators` | Get collaborators of a clip | `GetClipCollaborators` |
|
|
|
|
### Collaborator
|
|
|
|
| Method | Endpoint | Summary | Operation ID |
|
|
|--------|----------|---------|-------------|
|
|
| DELETE | `/clips/{clipId}/collaborators` | Remove the collaborator from a clip | `DeleteCollaborator` |
|
|
|
|
### Comment
|
|
|
|
| Method | Endpoint | Summary | Operation ID |
|
|
|--------|----------|---------|-------------|
|
|
| GET | `/clips/{clipId}/comments` | List clip comments | `Listclipcomments` |
|
|
| DELETE | `/clips/{clipId}/comments/{commentId}` | Delete a comment | `Deleteacomment` |
|
|
|
|
### Download
|
|
|
|
| Method | Endpoint | Summary | Operation ID |
|
|
|--------|----------|---------|-------------|
|
|
| GET | `/clips/{clipId}/download` | Download a clip | `downloadClip` |
|
|
|
|
### Single
|
|
|
|
| Method | Endpoint | Summary | Operation ID |
|
|
|--------|----------|---------|-------------|
|
|
| DELETE | `/clips/{clipId}` | Delete a clip(soft delete) | `DeleteClip` |
|
|
|
|
### Transfer
|
|
|
|
| Method | Endpoint | Summary | Operation ID |
|
|
|--------|----------|---------|-------------|
|
|
| POST | `/clips/transfers` | Transfer clips owner | `Transferclipsowner` |
|
|
| GET | `/clips/transfers/{taskId}` | Transfer task status check | `Transfertaskstatuscheck` |
|
|
|
|
### Upload
|
|
|
|
| Method | Endpoint | Summary | Operation ID |
|
|
|--------|----------|---------|-------------|
|
|
| POST | `/clips/files` | Upload clip file | `UploadClipFile` |
|
|
| POST | `/clips/files/multipart` | Upload clip multipart files | `UploadIqMultipartClipFile` |
|
|
| POST | `/clips/files/multipart/upload_events` | Initiate and complete the multipart file upload for a clip | `InitiateAndCompleteAClipMultipartUpload.` |
|