{ "openapi": "3.1.0", "info": { "title": "VmShell Live API", "version": "0.5.0", "description": "多应用授权直播，无录像和回放。密钥只保存在接入方服务端，平台上限200个有效播放会话。" }, "servers": [ { "url": "https://live.vmshell.com/api/v1" } ], "paths": { "/public-config": { "get": { "summary": "GET /public-config", "operationId": "get__public_config", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "platformName": { "type": "string" }, "supportEmail": { "type": "string" }, "notice": { "type": "string" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/application": { "get": { "summary": "GET /partner/application", "operationId": "get__partner_application", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "应用名称" }, "slug": { "type": "string", "description": "应用标识" }, "status": { "type": "string" }, "policy": { "type": "object" }, "expiresAt": { "type": [ "string", "null" ], "format": "date-time" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/quotas": { "get": { "summary": "GET /partner/quotas", "operationId": "get__partner_quotas", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "limits": { "type": "object" }, "activeStreams": { "type": "integer" }, "activeViewers": { "type": "integer" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/usage": { "get": { "summary": "GET /partner/usage", "operationId": "get__partner_usage", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "application_id": { "type": "string", "format": "uuid" }, "bucket": { "type": "string", "format": "date-time" }, "requests": { "type": "integer" }, "errors": { "type": "integer" } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/rooms": { "get": { "summary": "GET /partner/rooms", "operationId": "get__partner_rooms", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "直播间名称" }, "status": { "type": "string", "enum": [ "ready", "archived" ] }, "description": { "type": "string", "description": "介绍" }, "cover_url": { "type": "string" }, "category": { "type": "string", "enum": [ "community", "travel", "event", "other" ] }, "visibility": { "type": "string", "enum": [ "public", "authenticated", "members" ] }, "broadcaster_subject": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } } } }, "page": { "type": "integer" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ] }, "post": { "summary": "POST /partner/rooms", "operationId": "post__partner_rooms", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "201": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "status": { "type": "string" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "coverUrl": { "type": "string", "format": "uri" }, "category": { "type": "string" }, "visibility": { "type": "string" }, "allowedSubjects": { "type": "array", "items": { "type": "string" } }, "broadcasterSubject": { "type": "string" } }, "required": [ "name" ] }, "example": { "name": "城市旅行直播", "description": "分享旅途见闻", "category": "travel", "visibility": "authenticated", "allowedSubjects": [] } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/rooms/{id}": { "get": { "summary": "GET /partner/rooms/{id}", "operationId": "get__partner_rooms__id_", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "description": "直播间名称" }, "status": { "type": "string", "enum": [ "ready", "archived" ] }, "description": { "type": "string", "description": "介绍" }, "cover_url": { "type": "string" }, "category": { "type": "string", "enum": [ "community", "travel", "event", "other" ] }, "visibility": { "type": "string", "enum": [ "public", "authenticated", "members" ] }, "broadcaster_subject": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" }, "allowed_subjects": { "type": "array", "items": { "type": "string" } }, "stream_key": { "type": "string", "description": "流标识；不能代替推流或播放凭证" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] }, "patch": { "summary": "PATCH /partner/rooms/{id}", "operationId": "patch__partner_rooms__id_", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "coverUrl": { "type": "string", "format": "uri" }, "category": { "type": "string" }, "visibility": { "type": "string" }, "allowedSubjects": { "type": "array", "items": { "type": "string" } }, "broadcasterSubject": { "type": "string" } }, "required": [ "name" ] }, "example": { "name": "城市旅行直播", "description": "更新介绍", "coverUrl": "", "category": "travel", "visibility": "members", "allowedSubjects": [ "viewer-123" ], "broadcasterSubject": "host-123" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/partner/rooms/{id}/publish-credentials": { "post": { "summary": "POST /partner/rooms/{id}/publish-credentials", "operationId": "post__partner_rooms__id__publish_credentials", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "rtmpsUrl": { "type": "string", "description": "编码器服务器地址" }, "streamKey": { "type": "string", "description": "完整串流密钥，包含短时一次性 token，不得记录或公开" }, "expiresInSeconds": { "type": "integer" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string" } }, "required": [ "subject" ] }, "example": { "subject": "host-123" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/rooms/{id}/revoke-credentials": { "post": { "summary": "POST /partner/rooms/{id}/revoke-credentials", "operationId": "post__partner_rooms__id__revoke_credentials", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "revoked": { "type": "integer" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/rooms/{id}/end": { "post": { "summary": "POST /partner/rooms/{id}/end", "operationId": "post__partner_rooms__id__end", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/rooms/{id}/archive": { "post": { "summary": "POST /partner/rooms/{id}/archive", "operationId": "post__partner_rooms__id__archive", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/sessions": { "get": { "summary": "GET /partner/sessions", "operationId": "get__partner_sessions", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "room_id": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "started_at": { "type": "string", "format": "date-time" }, "ended_at": { "type": [ "string", "null" ], "format": "date-time" }, "end_reason": { "type": [ "string", "null" ] } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 } } ] } }, "/partner/playback-grants": { "post": { "summary": "POST /partner/playback-grants", "operationId": "post__partner_playback_grants", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "201": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "grant": { "type": "string", "description": "5分钟、一次性播放授权" }, "expiresInSeconds": { "type": "integer" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "roomId": { "type": "string", "format": "uuid" }, "subject": { "type": "string" } }, "required": [ "roomId", "subject" ] }, "example": { "roomId": "00000000-0000-4000-8000-000000000001", "subject": "viewer-123" } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/broadcaster-requests": { "post": { "summary": "POST /partner/broadcaster-requests", "operationId": "post__partner_broadcaster_requests", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "201": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string" }, "name": { "type": "string" }, "useCase": { "type": "string" } }, "required": [ "subject", "name", "useCase" ] }, "example": { "subject": "host-123", "name": "旅行主播", "useCase": "分享城市旅行与社区活动的实时直播" } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] }, "get": { "summary": "GET /partner/broadcaster-requests", "operationId": "get__partner_broadcaster_requests", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subject": { "type": "string" }, "name": { "type": "string" }, "use_case": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "rejected" ] }, "review_note": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/broadcasters": { "get": { "summary": "GET /partner/broadcasters", "operationId": "get__partner_broadcasters", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "subject": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "approved", "banned", "revoked" ] }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/broadcaster-requests/{id}/review": { "post": { "summary": "POST /partner/broadcaster-requests/{id}/review", "operationId": "post__partner_broadcaster_requests__id__review", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "note": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "status", "note" ] }, "example": { "status": "approved", "note": "直播用途符合要求" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/broadcasters/{id}": { "patch": { "summary": "PATCH /partner/broadcasters/{id}", "operationId": "patch__partner_broadcasters__id_", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" } }, "required": [ "status" ] }, "example": { "status": "banned" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/partner/webhooks": { "get": { "summary": "GET /partner/webhooks", "operationId": "get__partner_webhooks", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } }, "post": { "summary": "POST /partner/webhooks", "operationId": "post__partner_webhooks", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "201": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "signingSecret": { "type": "string", "description": "仅在创建时返回一次的 HMAC 验签密钥" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string" } } }, "required": [ "url", "events" ] }, "example": { "url": "https://your-app.example/live/events", "events": [ "live.started", "live.ended", "viewer.restricted" ] } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/webhook-deliveries": { "get": { "summary": "GET /partner/webhook-deliveries", "operationId": "get__partner_webhook_deliveries", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "event_id": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "processing", "delivered", "failed" ] }, "attempts": { "type": "integer" }, "response_code": { "type": [ "integer", "null" ] }, "last_error": { "type": [ "string", "null" ] }, "created_at": { "type": "string", "format": "date-time" } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/webhooks/{id}": { "patch": { "summary": "PATCH /partner/webhooks/{id}", "operationId": "patch__partner_webhooks__id_", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" } }, "required": [ "url", "events", "enabled" ] }, "example": { "url": "https://your-app.example/live/events", "events": [ "live.started", "live.ended" ], "enabled": true } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/partner/webhook-deliveries/{id}/retry": { "post": { "summary": "POST /partner/webhook-deliveries/{id}/retry", "operationId": "post__partner_webhook_deliveries__id__retry", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/rooms/{id}/restrictions/{subject}": { "delete": { "summary": "DELETE /partner/rooms/{id}/restrictions/{subject}", "operationId": "delete__partner_rooms__id__restrictions__subject_", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "subject", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/partner/events": { "get": { "summary": "GET /partner/events", "operationId": "get__partner_events", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "type": { "type": "string" }, "payload": { "type": "object" }, "created_at": { "type": "string", "format": "date-time" } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/events/stream": { "get": { "summary": "GET /partner/events/stream", "operationId": "get__partner_events_stream", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "SSE事件流；60秒后重连，按事件ID去重。", "content": { "text/event-stream": { "schema": { "type": "string" } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/partner/reports": { "post": { "summary": "POST /partner/reports", "operationId": "post__partner_reports", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "201": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "status": { "type": "string" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "roomId": { "type": "string", "format": "uuid" }, "subject": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "roomId", "subject", "reason" ] }, "example": { "roomId": "00000000-0000-4000-8000-000000000001", "subject": "viewer-123", "reason": "直播内容存在不当行为，请审核" } } } }, "parameters": [ { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/partner/rooms/{id}/restrictions": { "post": { "summary": "POST /partner/rooms/{id}/restrictions", "operationId": "post__partner_rooms__id__restrictions", "tags": [ "合作方 API" ], "description": "仅合作方服务端调用。服务端必须先核验业务用户身份；每次检查应用、权限、配额和有效期。", "security": [ { "ApplicationKey": [] } ], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string" }, "kind": { "type": "string" }, "reason": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } }, "required": [ "subject", "kind" ] }, "example": { "subject": "viewer-123", "kind": "ban", "reason": "违反社区规范" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "Idempotency-Key", "in": "header", "description": "8–128位字母数字、短横线或下划线；保留24小时。", "schema": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{8,128}$" } } ] } }, "/viewer-sessions": { "post": { "summary": "POST /viewer-sessions", "operationId": "post__viewer_sessions", "tags": [ "播放授权" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "201": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "uuid" }, "playbackToken": { "type": "string", "description": "短时播放与续租凭证" }, "hlsUrl": { "type": "string", "format": "uri" }, "renewAfterSeconds": { "type": "integer" }, "expiresInSeconds": { "type": "integer" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "grant": { "type": "string" } }, "required": [ "grant" ] }, "example": { "grant": "" } } } } } }, "/viewer-sessions/{id}/renew": { "post": { "summary": "POST /viewer-sessions/{id}/renew", "operationId": "post__viewer_sessions__id__renew", "tags": [ "播放授权" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "renewAfterSeconds": { "type": "integer" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "playbackToken": { "type": "string" } }, "required": [ "playbackToken" ] }, "example": { "playbackToken": "" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/viewer-sessions/{id}": { "delete": { "summary": "DELETE /viewer-sessions/{id}", "operationId": "delete__viewer_sessions__id_", "tags": [ "播放授权" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "playbackToken": { "type": "string" } }, "required": [ "playbackToken" ] }, "example": { "playbackToken": "" } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/docs": { "get": { "summary": "GET /docs", "operationId": "get__docs", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "title": { "type": "string" }, "visibility": { "type": "string" }, "category": { "type": [ "string", "null" ] }, "published_version": { "type": "integer" }, "updated_at": { "type": "string", "format": "date-time" } } } } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string", "maxLength": 100 } } ] } }, "/docs/{slug}": { "get": { "summary": "GET /docs/{slug}", "operationId": "get__docs__slug_", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "title": { "type": "string" }, "body": { "type": "string" }, "html": { "type": "string" }, "published_version": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/files/{id}": { "get": { "summary": "GET /files/{id}", "operationId": "get__files__id_", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "附件二进制；伙伴/内部附件要求对应会话。", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ] } }, "/recovery/forgot-password": { "post": { "summary": "POST /recovery/forgot-password", "operationId": "post__recovery_forgot_password", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" } }, "required": [ "email" ] } } } } } }, "/recovery/confirm-email": { "post": { "summary": "POST /recovery/confirm-email", "operationId": "post__recovery_confirm_email", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ] } } } } } }, "/recovery/reset-password": { "post": { "summary": "POST /recovery/reset-password", "operationId": "post__recovery_reset_password", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" }, "password": { "type": "string" } }, "required": [ "token", "password" ] } } } } } }, "/identity/status": { "get": { "summary": "GET /identity/status", "operationId": "get__identity_status", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "200": { "description": "成功", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "provider": { "type": "string" }, "emailRecoveryEnabled": { "type": "boolean" } } } } } }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } } } }, "/identity/start": { "get": { "summary": "GET /identity/start", "operationId": "get__identity_start", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "302": { "description": "浏览器重定向" }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "acceptTerms", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/identity/link": { "get": { "summary": "GET /identity/link", "operationId": "get__identity_link", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "302": { "description": "浏览器重定向" }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "acceptTerms", "in": "query", "required": false, "schema": { "type": "string" } } ] } }, "/identity/callback": { "get": { "summary": "GET /identity/callback", "operationId": "get__identity_callback", "tags": [ "账户与文档" ], "description": "观看使用短时 Grant / playbackToken；公开文档无需登录。", "security": [], "responses": { "302": { "description": "浏览器重定向" }, "400": { "description": "参数错误", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "401": { "description": "身份无效或需要双因素认证", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "403": { "description": "权限不足、封禁或播放失效", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "404": { "description": "资源不存在或跨应用访问", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "409": { "description": "状态或幂等冲突", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "428": { "description": "需要重新验证管理员密码", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "429": { "description": "频率或容量限额", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } }, "503": { "description": "维护中或依赖服务不可用", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "稳定的机器可读错误代码" }, "requestId": { "type": "string", "description": "请求追踪编号；不要用错误文案判断状态" } } } } } } }, "parameters": [ { "name": "state", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "query", "required": true, "schema": { "type": "string" } } ] } } }, "components": { "securitySchemes": { "ApplicationKey": { "type": "http", "scheme": "bearer" }, "AdminSession": { "type": "apiKey", "in": "cookie", "name": "vmlive_session" }, "PartnerSession": { "type": "apiKey", "in": "cookie", "name": "vmlive_portal" } } } }