| 1 | # channels API |
| 2 | |
| 3 | ## 模块边界 |
| 4 | |
| 5 | 渠道平台元数据、渠道授权、发布流程与发布记录。开源版只保留登录用户的渠道授权、发布 Flow、发布记录、发布任务操作和作品数据接口。 |
| 6 | |
| 7 | ## 文件清单 |
| 8 | |
| 9 | - `channel.api.ts` |
| 10 | - `channel.constants.ts` |
| 11 | - `channel.types.ts` |
| 12 | |
| 13 | ## 接口清单 |
| 14 | |
| 15 | | 方法 | 请求 | 说明 | |
| 16 | | ---------------------------------- | ------------------------------------------------------ | ------------------------ | |
| 17 | | `cancelChannelPublishTaskApi` | `DELETE v2/channels/publish/tasks/{param}` | 取消发布任务 | |
| 18 | | `createChannelPublishFlowApi` | `POST v2/channels/publish/flows` | 创建发布 Flow | |
| 19 | | `deleteChannelPublishRecordApi` | `DELETE v2/channels/publish/records/{param}` | 删除发布记录 | |
| 20 | | `getChannelAccountAuthStatusApi` | `GET v2/channels/accounts/auth/{param}/status/{param}` | 查询授权状态 | |
| 21 | | `getChannelPlatformsApi` | `GET v2/channels/platforms` | 获取所有平台元数据 | |
| 22 | | `getChannelPublicPublishRecordApi` | `GET v2/channels/publish/records/public/{param}` | 公开查询发布记录 | |
| 23 | | `getChannelPublishFlowApi` | `GET v2/channels/publish/flows/{param}` | 获取 Flow 详情 | |
| 24 | | `getChannelPublishRecordApi` | `GET v2/channels/publish/records/{param}` | 获取发布记录详情 | |
| 25 | | `getChannelPublishRecordsApi` | `GET v2/channels/publish/records` | 获取发布历史 | |
| 26 | | `getChannelPublishUserActionApi` | `GET v2/channels/publish/records/{param}/user-action` | 获取发布记录用户操作信息 | |
| 27 | | `getChannelWorkAnalyticsApi` | `GET v2/channels/works/{param}/{param}/analytics` | 获取作品数据 | |
| 28 | | `publishChannelTaskNowApi` | `POST v2/channels/publish/tasks/{param}/publish-now` | 立即发布 | |
| 29 | | `retryChannelPublishTaskApi` | `POST v2/channels/publish/tasks/{param}/retry` | 重试发布任务 | |
| 30 | | `startChannelAccountAuthApi` | `GET v2/channels/accounts/auth/{param}` | 开始平台授权 | |
| 31 | | `startChannelOAuthLoginApi` | `GET v2/channels/oauth/{param}` | 开始平台 OAuth 登录 | |
| 32 | | `updateChannelPublishAtApi` | `PATCH v2/channels/publish/tasks/{param}/publish-at` | 修改发布时间 | |
| 33 | |
| 34 | ## 类型清单 |
| 35 | |
| 36 | | 名称 | 类型 | 说明 | |
| 37 | | --------------------------------- | ----------- | ------------------------------------------ | |
| 38 | | `ChannelAccountAuthStart` | `interface` | ChannelAccountAuthStart 类型。 | |
| 39 | | `ChannelAccountAuthStatus` | `interface` | ChannelAccountAuthStatus 类型。 | |
| 40 | | `ChannelAuthConnectedAccount` | `interface` | ChannelAuthConnectedAccount 类型。 | |
| 41 | | `ChannelAuthSelectableAccount` | `interface` | ChannelAuthSelectableAccount 类型。 | |
| 42 | | `ChannelAuthSessionStatus` | `type` | ChannelAuthSessionStatus 类型。 | |
| 43 | | `ChannelCreatePublishFlowItem` | `interface` | ChannelCreatePublishFlowItem 数据结构。 | |
| 44 | | `ChannelCreatePublishFlowParams` | `interface` | ChannelCreatePublishFlowParams 请求参数。 | |
| 45 | | `ChannelOAuthLoginStart` | `interface` | ChannelOAuthLoginStart 类型。 | |
| 46 | | `ChannelPlatformListOptions` | `interface` | Channel platform metadata list options. | |
| 47 | | `ChannelPublicPublishRecordItem` | `type` | ChannelPublicPublishRecordItem 数据结构。 | |
| 48 | | `ChannelPublishContentInput` | `interface` | ChannelPublishContentInput 数据结构。 | |
| 49 | | `ChannelPublishContentOverride` | `interface` | ChannelPublishContentOverride 类型。 | |
| 50 | | `ChannelPublishCoverInput` | `interface` | ChannelPublishCoverInput 数据结构。 | |
| 51 | | `ChannelPublishFlowContext` | `interface` | ChannelPublishFlowContext 类型。 | |
| 52 | | `ChannelPublishFlowTaskVo` | `interface` | ChannelPublishFlowTaskVo 响应数据。 | |
| 53 | | `ChannelPublishFlowVo` | `interface` | ChannelPublishFlowVo 响应数据。 | |
| 54 | | `ChannelPublishMediaInput` | `interface` | ChannelPublishMediaInput 数据结构。 | |
| 55 | | `ChannelPublishRecordEngagement` | `interface` | ChannelPublishRecordEngagement 类型。 | |
| 56 | | `ChannelPublishRecordItem` | `interface` | ChannelPublishRecordItem 数据结构。 | |
| 57 | | `ChannelPublishRecordListVo` | `type` | ChannelPublishRecordListVo 响应数据。 | |
| 58 | | `ChannelPublishRecordOption` | `interface` | ChannelPublishRecordOption 数据结构。 | |
| 59 | | `ChannelPublishRecordQueryParams` | `interface` | ChannelPublishRecordQueryParams 请求参数。 | |
| 60 | | `ChannelPublishSource` | `type` | ChannelPublishSource 类型。 | |
| 61 | | `ChannelPublishTaskActionVo` | `interface` | ChannelPublishTaskActionVo 响应数据。 | |
| 62 | | `ChannelPublishUserActionVo` | `interface` | ChannelPublishUserActionVo 响应数据。 | |
| 63 | | `ChannelWorkAnalyticsVo` | `interface` | ChannelWorkAnalyticsVo 响应数据。 | |
| 64 | | `ChannelWorkQueryParams` | `interface` | ChannelWorkQueryParams 请求参数。 | |
| 65 | | `PlatformMetadataVo` | `interface` | PlatformMetadataVo 数据结构。 | |
| 66 | | `StartChannelAccountAuthParams` | `interface` | StartChannelAccountAuthParams 请求参数。 | |
| 67 | | `StartChannelOAuthLoginParams` | `interface` | StartChannelOAuthLoginParams 请求参数。 | |
| 68 |