{ "openapi": "3.1.0", "info": { "title": "NI PaaS IM Open API", "version": "1.0.0", "summary": "由平台契约自动生成的 Open API 3.1 描述", "description": "所有接口均为 POST，基础路径 /im/v2。\n鉴权头：App-Key / Nonce / Timestamp / Signature。\nSignature = hex(sha1(AppSecret + Nonce + Timestamp))（小写）；Timestamp 允许 ±300000ms；Nonce 8-64 字符且 5 分钟内不可重放。\n统一响应：{code,msg?,data?,requestId?}；code=0 表示成功。\n本文件由平台自动生成，请勿手工修改；变更请通过契约发布流程重新生成", "license": { "name": "Proprietary" } }, "servers": [ { "url": "http://127.0.0.1:8080/im/v2", "description": "本地默认地址（环境变量 IM_ADDR，默认 127.0.0.1:8080）" }, { "url": "https://{host}/im/v2", "description": "生产/私有化部署地址", "variables": { "host": { "default": "im.example.com" } } } ], "tags": [ { "name": "user", "description": "用户" }, { "name": "friend", "description": "好友关系链" }, { "name": "blacklist", "description": "黑名单" }, { "name": "message", "description": "消息" }, { "name": "group", "description": "群组" }, { "name": "supergroup", "description": "超级群" }, { "name": "chatroom", "description": "聊天室" }, { "name": "conversation", "description": "会话" }, { "name": "presence", "description": "在线状态" }, { "name": "sensitive-word", "description": "敏感词" }, { "name": "callback", "description": "回调配置与投递" }, { "name": "service", "description": "服务开通" }, { "name": "stats", "description": "运营统计" }, { "name": "agent", "description": "AI 助理代理" }, { "name": "bot", "description": "机器人" }, { "name": "push", "description": "推送通道" }, { "name": "sensitiveword", "description": "sensitiveword" }, { "name": "statusmessage", "description": "statusmessage" }, { "name": "entrust", "description": "entrust" }, { "name": "ultragroup", "description": "ultragroup" } ], "security": [ { "AppKeySignature": [] } ], "paths": { "/user/register": { "post": { "operationId": "user.register", "summary": "注册用户；userId 幂等（已存在则更新 name/avatarUrl 并返回现有用户）。", "description": "注册用户；userId 幂等（已存在则更新 name/avatarUrl 并返回现有用户）。\n\noperationId: user.register", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1016 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string", "description": "1-64 字符，应用内唯一" }, "name": { "type": "string", "description": "显示名 1-64 字符" }, "avatarUrl": { "type": "string" } }, "required": [ "userId", "name" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/User" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/update": { "post": { "operationId": "user.update", "summary": "更新用户资料。", "description": "更新用户资料。\n\noperationId: user.update", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1016 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/User" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/get": { "post": { "operationId": "user.get", "summary": "查询用户。", "description": "查询用户。\n\noperationId: user.get", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/User" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/token/issue": { "post": { "operationId": "user.token.issue", "summary": "签发用户 JWT（供客户端 SDK connect 使用），有效期 7 天。", "description": "签发用户 JWT（供客户端 SDK connect 使用），有效期 7 天。\n\noperationId: user.token.issue", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1016 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/TokenInfo" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/online/check": { "post": { "operationId": "user.online.check", "summary": "查询用户在线状态。", "description": "查询用户在线状态。\n\noperationId: user.online.check", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/OnlineStatus" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/ban": { "post": { "operationId": "user.ban", "summary": "封禁/解封用户；封禁后在线连接被 kick，新连接返回 1016。", "description": "封禁/解封用户；封禁后在线连接被 kick，新连接返回 1016。\n\noperationId: user.ban", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-callback-events": [ "user.banned" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "banned": { "type": "boolean" }, "reason": { "type": "string" } }, "required": [ "userId", "banned" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/User" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/add": { "post": { "operationId": "friend.add", "summary": "直接建立双向好友关系（应用服务器代操作，不经过申请流程）。", "description": "直接建立双向好友关系（应用服务器代操作，不经过申请流程）。\n\noperationId: friend.add", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1011 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "friendId": { "type": "string" } }, "required": [ "userId", "friendId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Friend" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/remove": { "post": { "operationId": "friend.remove", "summary": "删除双向好友关系。", "description": "删除双向好友关系。\n\noperationId: friend.remove", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "friendId": { "type": "string" } }, "required": [ "userId", "friendId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/list": { "post": { "operationId": "friend.list", "summary": "好友列表。", "description": "好友列表。\n\noperationId: friend.list", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/FriendList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/blacklist/add": { "post": { "operationId": "blacklist.add", "summary": "加入黑名单（幂等）。", "description": "加入黑名单（幂等）。\n\noperationId: blacklist.add", "tags": [ "blacklist" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "targetId": { "type": "string" } }, "required": [ "userId", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/blacklist/remove": { "post": { "operationId": "blacklist.remove", "summary": "移出黑名单（幂等）。", "description": "移出黑名单（幂等）。\n\noperationId: blacklist.remove", "tags": [ "blacklist" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "targetId": { "type": "string" } }, "required": [ "userId", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/blacklist/list": { "post": { "operationId": "blacklist.list", "summary": "黑名单列表。", "description": "黑名单列表。\n\noperationId: blacklist.list", "tags": [ "blacklist" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BlacklistList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/private/publish": { "post": { "operationId": "message.private.publish", "summary": "以指定用户身份发送单聊消息；返回服务端消息（含 seq）。幂等键 clientMsgId。", "description": "以指定用户身份发送单聊消息；返回服务端消息（含 seq）。幂等键 clientMsgId。\n\noperationId: message.private.publish", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1007, 1008, 1010, 1011, 1016, 1021 ], "x-idl-callback-events": [ "message.routed", "message.offline" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "toUserId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content" }, "clientMsgId": { "type": "string" }, "push": { "type": "object", "additionalProperties": true, "description": "{title?,content?,forceShowPushContent?} 离线推送文案" } }, "required": [ "fromUserId", "toUserId", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Message" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/group/publish": { "post": { "operationId": "message.group.publish", "summary": "发送群/超级群消息。", "description": "发送群/超级群消息。\n\noperationId: message.group.publish", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1021 ], "x-idl-callback-events": [ "message.routed", "message.offline" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "groupId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content" }, "clientMsgId": { "type": "string" }, "isMentionAll": { "type": "boolean" }, "mentionedUserIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "fromUserId", "groupId", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Message" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/chatroom/publish": { "post": { "operationId": "message.chatroom.publish", "summary": "发送聊天室消息（仅广播在线成员，不落离线）。", "description": "发送聊天室消息（仅广播在线成员，不落离线）。\n\noperationId: message.chatroom.publish", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1007, 1008, 1010, 1012, 1013, 1014, 1021 ], "x-idl-callback-events": [ "message.routed" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "chatroomId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content" }, "clientMsgId": { "type": "string" } }, "required": [ "fromUserId", "chatroomId", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Message" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/system/publish": { "post": { "operationId": "message.system.publish", "summary": "发送系统通知给一批用户；落库、离线补发、多端同步，客户端展示为“系统通知”会话。", "description": "发送系统通知给一批用户；落库、离线补发、多端同步，客户端展示为“系统通知”会话。\n\noperationId: message.system.publish", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1007, 1008, 1021 ], "x-idl-callback-events": [ "message.routed" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "toUserIds": { "type": "array", "items": { "type": "string" }, "description": "1-1000 个用户" }, "content": { "$ref": "#/components/schemas/Content", "description": "type=system，systemType=system_notification|broadcast 等" }, "clientMsgId": { "type": "string" } }, "required": [ "toUserIds", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SystemPublishResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/recall": { "post": { "operationId": "message.recall", "summary": "撤回消息（发送者或应用服务器；时限 recallWindowMs，超时 1022）。", "description": "撤回消息（发送者或应用服务器；时限 recallWindowMs，超时 1022）。\n\noperationId: message.recall", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1022, 1023 ], "x-idl-callback-events": [ "message.recalled" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string", "description": "操作者（须为发送者，服务端代操作需应用级权限）" }, "messageId": { "type": "string" }, "isAdmin": { "type": "boolean", "description": "true=应用侧强制撤回（忽略时限）" } }, "required": [ "fromUserId", "messageId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Message" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/history/get": { "post": { "operationId": "message.history.get", "summary": "查询历史消息（倒序分页，beforeSeq 向前翻页）。", "description": "查询历史消息（倒序分页，beforeSeq 向前翻页）。\n\noperationId: message.history.get", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1005 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "conversationType": { "type": "object", "x-idl-type": "ConversationType" }, "targetId": { "type": "string" }, "userId": { "type": "string", "description": "可选：校验用户在该会话的可见性" }, "limit": { "type": "integer", "format": "uint32", "minimum": 0, "description": "默认 20，上限 100" }, "beforeSeq": { "type": "integer", "format": "uint64", "minimum": 0 } }, "required": [ "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessagePage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/read/count": { "post": { "operationId": "message.read.count", "summary": "查询消息已读人数。", "description": "查询消息已读人数。\n\noperationId: message.read.count", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ReadCount" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/search": { "post": { "operationId": "message.search", "summary": "按用户搜索文本消息。", "description": "按用户搜索文本消息。\n\noperationId: message.search", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "keyword": { "type": "string" }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "userId", "keyword" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessagePage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/trace/get": { "post": { "operationId": "message.trace.get", "summary": "消息投递轨迹（存储/ACK/离线补偿/回调路由），控制台消息流转查询使用。", "description": "消息投递轨迹（存储/ACK/离线补偿/回调路由），控制台消息流转查询使用。\n\noperationId: message.trace.get", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageTrace" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/create": { "post": { "operationId": "group.create", "summary": "创建群/超级群；groupId 可指定（幂等）或服务端生成。", "description": "创建群/超级群；groupId 可指定（幂等）或服务端生成。\n\noperationId: group.create", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1015, 1021 ], "x-idl-callback-events": [ "group.created" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "members": { "type": "array", "items": { "type": "string" } }, "groupType": { "type": "object", "x-idl-type": "GroupType", "description": "normal(默认)/super" } }, "required": [ "name", "owner" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/update": { "post": { "operationId": "group.update", "summary": "更新群信息（name/notice/avatarUrl）。", "description": "更新群信息（name/notice/avatarUrl）。\n\noperationId: group.update", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1005 ], "x-idl-callback-events": [ "group.updated" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" }, "notice": { "type": "string" }, "avatarUrl": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/get": { "post": { "operationId": "group.get", "summary": "查询群信息。", "description": "查询群信息。\n\noperationId: group.get", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/members/list": { "post": { "operationId": "group.members.list", "summary": "群成员列表。", "description": "群成员列表。\n\noperationId: group.members.list", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0, "description": "默认 100，上限 500" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupMemberList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/members/add": { "post": { "operationId": "group.members.add", "summary": "批量拉人入群。", "description": "批量拉人入群。\n\noperationId: group.members.add", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1005, 1015 ], "x-idl-callback-events": [ "group.updated" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupMemberChange" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/members/remove": { "post": { "operationId": "group.members.remove", "summary": "批量移除群成员。", "description": "批量移除群成员。\n\noperationId: group.members.remove", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1005 ], "x-idl-callback-events": [ "group.updated" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupMemberChange" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/quit": { "post": { "operationId": "group.quit", "summary": "用户退群（群主需先转让）。", "description": "用户退群（群主需先转让）。\n\noperationId: group.quit", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1005, 1006 ], "x-idl-callback-events": [ "group.updated" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/dismiss": { "post": { "operationId": "group.dismiss", "summary": "解散群（群主或应用强制）。", "description": "解散群（群主或应用强制）。\n\noperationId: group.dismiss", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1005 ], "x-idl-callback-events": [ "group.destroyed" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "operatorId": { "type": "string" }, "force": { "type": "boolean" } }, "required": [ "groupId", "operatorId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/admin/add": { "post": { "operationId": "group.admin.add", "summary": "设置群管理员（幂等）。", "description": "设置群管理员（幂等）。\n\noperationId: group.admin.add", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1005 ], "x-idl-idempotent": true, "x-idl-callback-events": [ "group.updated" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/admin/remove": { "post": { "operationId": "group.admin.remove", "summary": "取消群管理员。", "description": "取消群管理员。\n\noperationId: group.admin.remove", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1005 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/mute": { "post": { "operationId": "group.mute", "summary": "禁言/解禁群成员（mutedUntil=0 解禁）。", "description": "禁言/解禁群成员（mutedUntil=0 解禁）。\n\noperationId: group.mute", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1005, 1006 ], "x-idl-callback-events": [ "group.updated" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "mutedUntil": { "type": "integer", "format": "uint64", "minimum": 0 } }, "required": [ "groupId", "userId", "mutedUntil" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/join-policy/set": { "post": { "operationId": "supergroup.join.policy.set", "summary": "设置超级群加入策略：invite（默认）/ open。", "description": "设置超级群加入策略：invite（默认）/ open。\n\noperationId: supergroup.join.policy.set", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1005, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "joinPolicy": { "type": "string", "description": "invite|open" } }, "required": [ "groupId", "joinPolicy" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/create": { "post": { "operationId": "chatroom.create", "summary": "创建聊天室（幂等：同 chatroomId 已存在则返回现有）。", "description": "创建聊天室（幂等：同 chatroomId 已存在则返回现有）。\n\noperationId: chatroom.create", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1015, 1021 ], "x-idl-idempotent": true, "x-idl-callback-events": [ "chatroom.created" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" } }, "required": [ "name" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Chatroom" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/destroy": { "post": { "operationId": "chatroom.destroy", "summary": "销毁聊天室：踢出所有在线成员、广播 destroyed。", "description": "销毁聊天室：踢出所有在线成员、广播 destroyed。\n\noperationId: chatroom.destroy", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012 ], "x-idl-callback-events": [ "chatroom.destroyed" ], "externalDocs": { "url": "/docs/platform-chat-api/callback", "description": "该接口触发的回调事件" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/get": { "post": { "operationId": "chatroom.get", "summary": "聊天室信息（含在线数）。", "description": "聊天室信息（含在线数）。\n\noperationId: chatroom.get", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Chatroom" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/members/list": { "post": { "operationId": "chatroom.members.list", "summary": "聊天室在线成员列表。", "description": "聊天室在线成员列表。\n\noperationId: chatroom.members.list", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMemberList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/keepalive": { "post": { "operationId": "chatroom.keepalive", "summary": "刷新聊天室空闲销毁时间（默认 30 分钟无活动销毁）。", "description": "刷新聊天室空闲销毁时间（默认 30 分钟无活动销毁）。\n\noperationId: chatroom.keepalive", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Chatroom" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/list": { "post": { "operationId": "conversation.list", "summary": "用户会话列表（置顶优先/updatedAt 倒序）。", "description": "用户会话列表（置顶优先/updatedAt 倒序）。\n\noperationId: conversation.list", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationTypes": { "type": "array", "items": { "type": "object", "x-idl-type": "ConversationType" } } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/settings": { "post": { "operationId": "conversation.settings", "summary": "设置会话置顶/草稿/提醒级别（服务端代操作）。", "description": "设置会话置顶/草稿/提醒级别（服务端代操作）。\n\noperationId: conversation.settings", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "object", "x-idl-type": "ConversationType" }, "targetId": { "type": "string" }, "isPinned": { "type": "boolean" }, "draft": { "type": "string" }, "notificationLevel": { "type": "object", "x-idl-type": "NotificationLevel" } }, "required": [ "userId", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Conversation" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/unread/clear": { "post": { "operationId": "conversation.unread.clear", "summary": "清空会话未读。", "description": "清空会话未读。\n\noperationId: conversation.unread.clear", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "object", "x-idl-type": "ConversationType" }, "targetId": { "type": "string" } }, "required": [ "userId", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/presence/batch": { "post": { "operationId": "presence.batch", "summary": "批量在线状态（<=100）。", "description": "批量在线状态（<=100）。\n\noperationId: presence.batch", "tags": [ "presence" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/OnlineStatusBatch" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/sensitive-word/list": { "post": { "operationId": "sensitive-word.list", "summary": "查询敏感词配置。", "description": "查询敏感词配置。\n\noperationId: sensitive-word.list", "tags": [ "sensitive-word" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SensitiveWordConfig" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/sensitive-word/set": { "post": { "operationId": "sensitive-word.set", "summary": "覆盖设置敏感词（<=500 词，单词 <=64 字符）与处置动作。", "description": "覆盖设置敏感词（<=500 词，单词 <=64 字符）与处置动作。\n\noperationId: sensitive-word.set", "tags": [ "sensitive-word" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "words": { "type": "array", "items": { "type": "string" } }, "action": { "type": "string", "description": "block|replace" } }, "required": [ "words", "action" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SensitiveWordConfig" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/callback/config/get": { "post": { "operationId": "callback.config.get", "summary": "查询回调配置（secret 脱敏）。", "description": "查询回调配置（secret 脱敏）。\n\noperationId: callback.config.get", "tags": [ "callback" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/CallbackConfig" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/callback/config/set": { "post": { "operationId": "callback.config.set", "summary": "设置回调配置：URL、事件订阅、签名密钥、重试策略、启停。", "description": "设置回调配置：URL、事件订阅、签名密钥、重试策略、启停。\n\noperationId: callback.config.set", "tags": [ "callback" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1024 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": "string" }, "secret": { "type": "string" }, "events": { "type": "array", "items": { "type": "object", "x-idl-type": "CallbackEventType" } }, "retry": { "type": "object", "additionalProperties": true, "description": "{maxAttempts:1..5,backoffMs:1000..60000}" } }, "required": [ "enabled", "events" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/CallbackConfig" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/callback/delivery/list": { "post": { "operationId": "callback.delivery.list", "summary": "回调投递日志查询（时间范围/事件类型/状态，分页）。", "description": "回调投递日志查询（时间范围/事件类型/状态，分页）。\n\noperationId: callback.delivery.list", "tags": [ "callback" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "eventType": { "type": "object", "x-idl-type": "CallbackEventType" }, "status": { "type": "string", "description": "pending|success|failed|dropped" }, "from": { "type": "integer", "format": "int64" }, "to": { "type": "integer", "format": "int64" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/CallbackDeliveryPage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/callback/delivery/retry": { "post": { "operationId": "callback.delivery.retry", "summary": "手动重试一次失败的回调投递。", "description": "手动重试一次失败的回调投递。\n\noperationId: callback.delivery.retry", "tags": [ "callback" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 2004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deliveryId": { "type": "string" } }, "required": [ "deliveryId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/CallbackDelivery" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/service/activation/get": { "post": { "operationId": "service.activation.get", "summary": "查询应用服务开通项与配额。", "description": "查询应用服务开通项与配额。\n\noperationId: service.activation.get", "tags": [ "service" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ServiceActivation" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/service/activation/set": { "post": { "operationId": "service.activation.set", "summary": "设置应用服务开通项（关闭后相关接口返回 1021）。", "description": "设置应用服务开通项（关闭后相关接口返回 1021）。\n\noperationId: service.activation.set", "tags": [ "service" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "services": { "type": "object", "additionalProperties": { "type": "boolean" }, "x-idl-key-type": "ServiceKey" }, "quotas": { "type": "object", "additionalProperties": true } }, "required": [ "services" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ServiceActivation" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/stats/app": { "post": { "operationId": "stats.app", "summary": "应用维度统计（用户/消息/在线）。", "description": "应用维度统计（用户/消息/在线）。\n\noperationId: stats.app", "tags": [ "stats" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AppStats" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/stats/trend": { "post": { "operationId": "stats.trend", "summary": "运营趋势（按天）：DAU/消息量/在线峰值/错误率。", "description": "运营趋势（按天）：DAU/消息量/在线峰值/错误率。\n\noperationId: stats.trend", "tags": [ "stats" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "days": { "type": "integer", "format": "uint32", "minimum": 0, "description": "默认 7，上限 90" } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/OpsStats" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/join": { "post": { "operationId": "group.join", "summary": "加入群：公开群/超级群（joinPolicy=open）直接加入；邀请制群需群主/管理员邀请，否则 1003。", "description": "加入群：公开群/超级群（joinPolicy=open）直接加入；邀请制群需群主/管理员邀请，否则 1003。\n\noperationId: group.join", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1005, 1015 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/transfer": { "post": { "operationId": "group.transfer", "summary": "转让群主：仅当前群主可操作，目标必须是群成员。", "description": "转让群主：仅当前群主可操作，目标必须是群成员。\n\noperationId: group.transfer", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1005 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "fromUserId": { "type": "string" }, "toUserId": { "type": "string" } }, "required": [ "groupId", "fromUserId", "toUserId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Group" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/kv/set": { "post": { "operationId": "chatroom.kv.set", "summary": "设置聊天室 KV（房间级键值，随房间销毁；ttlMs 可选）。", "description": "设置聊天室 KV（房间级键值，随房间销毁；ttlMs 可选）。\n\noperationId: chatroom.kv.set", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" }, "ttlMs": { "type": "integer", "format": "uint64", "minimum": 0 } }, "required": [ "chatroomId", "key", "value" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomKv" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/kv/get": { "post": { "operationId": "chatroom.kv.get", "summary": "读取聊天室 KV（keys 省略返回全部）。", "description": "读取聊天室 KV（keys 省略返回全部）。\n\noperationId: chatroom.kv.get", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" } } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomKvList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/kv/remove": { "post": { "operationId": "chatroom.kv.remove", "summary": "删除聊天室 KV。", "description": "删除聊天室 KV。\n\noperationId: chatroom.kv.remove", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" } } }, "required": [ "chatroomId", "keys" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomKvList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/mute": { "post": { "operationId": "chatroom.mute", "summary": "聊天室成员禁言/解禁（mutedUntil=0 解禁；房主/管理员可操作）。", "description": "聊天室成员禁言/解禁（mutedUntil=0 解禁；房主/管理员可操作）。\n\noperationId: chatroom.mute", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1012, 1014 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userId": { "type": "string" }, "mutedUntil": { "type": "integer", "format": "uint64", "minimum": 0 } }, "required": [ "chatroomId", "userId", "mutedUntil" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Chatroom" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/ban": { "post": { "operationId": "chatroom.ban", "summary": "聊天室封禁/解封成员（封禁后被踢出且不可再加入）。", "description": "聊天室封禁/解封成员（封禁后被踢出且不可再加入）。\n\noperationId: chatroom.ban", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1012, 1014 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userId": { "type": "string" }, "banned": { "type": "boolean" } }, "required": [ "chatroomId", "userId", "banned" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Chatroom" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/whitelist/add": { "post": { "operationId": "chatroom.whitelist.add", "summary": "聊天室白名单：加入（白名单内用户不受封禁/禁言限制）。", "description": "聊天室白名单：加入（白名单内用户不受封禁/禁言限制）。\n\noperationId: chatroom.whitelist.add", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "chatroomId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/whitelist/remove": { "post": { "operationId": "chatroom.whitelist.remove", "summary": "聊天室白名单：移除。", "description": "聊天室白名单：移除。\n\noperationId: chatroom.whitelist.remove", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "chatroomId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/whitelist/list": { "post": { "operationId": "chatroom.whitelist.list", "summary": "聊天室白名单：查询。", "description": "聊天室白名单：查询。\n\noperationId: chatroom.whitelist.list", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/whitelist/add": { "post": { "operationId": "user.whitelist.add", "summary": "用户私聊白名单：仅白名单用户可给该用户发私聊（空表示不启用）。", "description": "用户私聊白名单：仅白名单用户可给该用户发私聊（空表示不启用）。\n\noperationId: user.whitelist.add", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "allowedUserIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userId", "allowedUserIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/whitelist/remove": { "post": { "operationId": "user.whitelist.remove", "summary": "用户私聊白名单：移除。", "description": "用户私聊白名单：移除。\n\noperationId: user.whitelist.remove", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "allowedUserIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userId", "allowedUserIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/whitelist/list": { "post": { "operationId": "user.whitelist.list", "summary": "用户私聊白名单：查询。", "description": "用户私聊白名单：查询。\n\noperationId: user.whitelist.list", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/token/revoke": { "post": { "operationId": "user.token.revoke", "summary": "主动作废用户全部客户端 token（tokenVersion++，旧 JWT 立即失效）。", "description": "主动作废用户全部客户端 token（tokenVersion++，旧 JWT 立即失效）。\n\noperationId: user.token.revoke", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserTokenState" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/batch/get": { "post": { "operationId": "user.batch.get", "summary": "批量获取用户资料（上限 100；不存在的 userId 返回在 missing）。", "description": "批量获取用户资料（上限 100；不存在的 userId 返回在 missing）。\n\noperationId: user.batch.get", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserBatch" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/expansion/set": { "post": { "operationId": "message.expansion.set", "summary": "设置消息扩展 KV（key/value，随消息存储；用于业务透传/标记/回应数据）。", "description": "设置消息扩展 KV（key/value，随消息存储；用于业务透传/标记/回应数据）。\n\noperationId: message.expansion.set", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "messageId", "key", "value" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageExpansion" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/expansion/get": { "post": { "operationId": "message.expansion.get", "summary": "读取消息扩展 KV。", "description": "读取消息扩展 KV。\n\noperationId: message.expansion.get", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageExpansion" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/expansion/remove": { "post": { "operationId": "message.expansion.remove", "summary": "删除消息扩展 KV。", "description": "删除消息扩展 KV。\n\noperationId: message.expansion.remove", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" }, "keys": { "type": "array", "items": { "type": "string" } } }, "required": [ "messageId", "keys" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageExpansion" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/modify": { "post": { "operationId": "message.modify", "summary": "服务端修改消息内容（单聊/群/超级群统一；仅发送者或应用管理员可改）。修改后历史与拉取返回新内容。", "description": "服务端修改消息内容（单聊/群/超级群统一；仅发送者或应用管理员可改）。修改后历史与拉取返回新内容。\n\noperationId: message.modify", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004, 1007 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content" }, "operatorId": { "type": "string", "description": "操作者（用于权限校验；省略时按发送者）" } }, "required": [ "messageId", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Message" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/history/clean": { "post": { "operationId": "message.history.clean", "summary": "清除远端会话历史消息（beforeTimestamp 省略表示全部；仅应用管理员/会话参与者可调用）。", "description": "清除远端会话历史消息（beforeTimestamp 省略表示全部；仅应用管理员/会话参与者可调用）。\n\noperationId: message.history.clean", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "beforeTimestamp": { "type": "integer", "format": "int64" }, "userId": { "type": "string", "description": "仅清理该用户视角（省略=全局清理）" } }, "required": [ "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageCleanResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/chat/mute": { "post": { "operationId": "user.chat.mute", "summary": "设置/解除单聊禁言（mutedUntil=0 解除；禁言后该用户向目标发私聊返回 1009）。", "description": "设置/解除单聊禁言（mutedUntil=0 解除；禁言后该用户向目标发私聊返回 1009）。\n\noperationId: user.chat.mute", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "targetUserId": { "type": "string" }, "mutedUntil": { "type": "integer", "format": "uint64", "minimum": 0 } }, "required": [ "userId", "targetUserId", "mutedUntil" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatMuteItem" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/chat/mute/list": { "post": { "operationId": "user.chat.mute.list", "summary": "查询用户的单聊禁言列表。", "description": "查询用户的单聊禁言列表。\n\noperationId: user.chat.mute.list", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatMuteList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/tag/set": { "post": { "operationId": "user.tag.set", "summary": "设置用户标签（全量覆盖，最多 20 个，每个 ≤32 字符）。", "description": "设置用户标签（全量覆盖，最多 20 个，每个 ≤32 字符）。\n\noperationId: user.tag.set", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "userId", "tags" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserTags" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/tag/get": { "post": { "operationId": "user.tag.get", "summary": "获取用户标签。", "description": "获取用户标签。\n\noperationId: user.tag.get", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserTags" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/tag/batch/set": { "post": { "operationId": "user.tag.batch.set", "summary": "批量设置用户标签（上限 100 条，返回 updated/failed）。", "description": "批量设置用户标签（上限 100 条，返回 updated/failed）。\n\noperationId: user.tag.batch.set", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" }, "description": "[{userId,tags:string[]}]" } }, "required": [ "items" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserTagBatchResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/set": { "post": { "operationId": "conversation.tag.set", "summary": "将会话归入标签（同一会话可属多个标签，最多 20 个）。", "description": "将会话归入标签（同一会话可属多个标签，最多 20 个）。\n\noperationId: conversation.tag.set", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tag": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" } }, "required": [ "userId", "tag", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagItem" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/remove": { "post": { "operationId": "conversation.tag.remove", "summary": "将会话从标签移除。", "description": "将会话从标签移除。\n\noperationId: conversation.tag.remove", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tag": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" } }, "required": [ "userId", "tag", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/list": { "post": { "operationId": "conversation.tag.list", "summary": "查询用户的会话标签（tag 省略返回全部标签及其会话）。", "description": "查询用户的会话标签（tag 省略返回全部标签及其会话）。\n\noperationId: conversation.tag.list", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tag": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/mute-all": { "post": { "operationId": "chatroom.mute-all", "summary": "设置/取消聊天室全体禁言（房主/管理员可操作；白名单成员不受限）。", "description": "设置/取消聊天室全体禁言（房主/管理员可操作；白名单成员不受限）。\n\noperationId: chatroom.mute-all", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1012, 1013 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "muted": { "type": "boolean" }, "operatorId": { "type": "string" } }, "required": [ "chatroomId", "muted" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMuteAll" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/mute-all/get": { "post": { "operationId": "chatroom.mute-all.get", "summary": "查询聊天室全体禁言状态。", "description": "查询聊天室全体禁言状态。\n\noperationId: chatroom.mute-all.get", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMuteAll" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/mute-all": { "post": { "operationId": "group.mute-all", "summary": "设置/取消群组全员禁言（群主/管理员可操作；白名单成员不受限，覆盖融云 /group/ban/add|rollback）。", "description": "设置/取消群组全员禁言（群主/管理员可操作；白名单成员不受限，覆盖融云 /group/ban/add|rollback）。\n\noperationId: group.mute-all", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1003, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "muted": { "type": "boolean" }, "operatorId": { "type": "string" } }, "required": [ "groupId", "muted" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupMuteAll" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/mute-all/get": { "post": { "operationId": "group.mute-all.get", "summary": "查询群组全员禁言状态（覆盖融云 /group/ban/query）。", "description": "查询群组全员禁言状态（覆盖融云 /group/ban/query）。\n\noperationId: group.mute-all.get", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupMuteAll" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/ban/list": { "post": { "operationId": "user.ban.list", "summary": "获取封禁用户列表（分页）。", "description": "获取封禁用户列表（分页）。\n\noperationId: user.ban.list", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0, "description": "默认 50，上限 100" } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserBanPage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/delete": { "post": { "operationId": "user.delete", "summary": "删除用户（开发/测试环境；物理删除用户及其会话关系）。", "description": "删除用户（开发/测试环境；物理删除用户及其会话关系）。\n\noperationId: user.delete", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/profile/clean": { "post": { "operationId": "user.profile.clean", "summary": "清理用户托管资料（保留 userId，清空 name/avatarUrl 等自定义字段）。", "description": "清理用户托管资料（保留 userId，清空 name/avatarUrl 等自定义字段）。\n\noperationId: user.profile.clean", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/User" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/subscription/set": { "post": { "operationId": "user.subscription.set", "summary": "设置用户订阅关系（全量覆盖，最多 100 个）。", "description": "设置用户订阅关系（全量覆盖，最多 100 个）。\n\noperationId: user.subscription.set", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "subscribeUserIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userId", "subscribeUserIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserSubscription" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/subscription/get": { "post": { "operationId": "user.subscription.get", "summary": "查询用户订阅关系。", "description": "查询用户订阅关系。\n\noperationId: user.subscription.get", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserSubscription" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/check": { "post": { "operationId": "friend.check", "summary": "检查两人是否为好友关系。", "description": "检查两人是否为好友关系。\n\noperationId: friend.check", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "targetUserId": { "type": "string" } }, "required": [ "userId", "targetUserId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/FriendCheckResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/clean": { "post": { "operationId": "friend.clean", "summary": "批量清理好友关系（单向/双向）。", "description": "批量清理好友关系（单向/双向）。\n\noperationId: friend.clean", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "targetUserIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userId", "targetUserIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/FriendCleanResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/permission/set": { "post": { "operationId": "friend.permission.set", "summary": "设置添加好友验证等级（open=无需验证 / verify=需验证 / closed=禁止）。", "description": "设置添加好友验证等级（open=无需验证 / verify=需验证 / closed=禁止）。\n\noperationId: friend.permission.set", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "level": { "type": "string" } }, "required": [ "userId", "level" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/FriendPermission" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/permission/get": { "post": { "operationId": "friend.permission.get", "summary": "查询添加好友验证等级。", "description": "查询添加好友验证等级。\n\noperationId: friend.permission.get", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/FriendPermission" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/friend/profile/set": { "post": { "operationId": "friend.profile.set", "summary": "设置好友自定义属性（备注名/扩展字段，仅本人可见）。", "description": "设置好友自定义属性（备注名/扩展字段，仅本人可见）。\n\noperationId: friend.profile.set", "tags": [ "friend" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "targetUserId": { "type": "string" }, "name": { "type": "string" }, "extra": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } }, "required": [ "userId", "targetUserId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/FriendProfile" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/ban/whitelist/add": { "post": { "operationId": "group.ban.whitelist.add", "summary": "加入群组全体禁言白名单（白名单成员不受 group.mute 全员禁言限制）。", "description": "加入群组全体禁言白名单（白名单成员不受 group.mute 全员禁言限制）。\n\noperationId: group.ban.whitelist.add", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupBanWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/ban/whitelist/remove": { "post": { "operationId": "group.ban.whitelist.remove", "summary": "移出群组全体禁言白名单。", "description": "移出群组全体禁言白名单。\n\noperationId: group.ban.whitelist.remove", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupBanWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/ban/whitelist/list": { "post": { "operationId": "group.ban.whitelist.list", "summary": "查询群组全体禁言白名单。", "description": "查询群组全体禁言白名单。\n\noperationId: group.ban.whitelist.list", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupBanWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/import": { "post": { "operationId": "group.import", "summary": "批量导入群组（上限 50，逐条幂等；返回 imported/failed）。", "description": "批量导入群组（上限 50，逐条幂等；返回 imported/failed）。\n\noperationId: group.import", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" }, "description": "[{groupId,name,owner,members?,groupType?}]" } }, "required": [ "groups" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupImportResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/member/update": { "post": { "operationId": "group.member.update", "summary": "设置群成员资料（群昵称/扩展字段）。", "description": "设置群成员资料（群昵称/扩展字段）。\n\noperationId: group.member.update", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1005 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "name": { "type": "string" }, "extra": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupMember" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/destroy/policy/set": { "post": { "operationId": "chatroom.destroy.policy.set", "summary": "设置聊天室销毁策略（idle=空闲销毁，idleMs 默认 1800000；fixed=定时销毁，destroyAt 由创建时间+idleMs 计算）。", "description": "设置聊天室销毁策略（idle=空闲销毁，idleMs 默认 1800000；fixed=定时销毁，destroyAt 由创建时间+idleMs 计算）。\n\noperationId: chatroom.destroy.policy.set", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "destroyType": { "type": "string" }, "idleMs": { "type": "integer", "format": "uint64", "minimum": 0 } }, "required": [ "chatroomId", "destroyType" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Chatroom" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/usergroup/create": { "post": { "operationId": "supergroup.usergroup.create", "summary": "创建超级群用户组。", "description": "创建超级群用户组。\n\noperationId: supergroup.usergroup.create", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userGroupId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "groupId", "userGroupId", "name" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroup" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/usergroup/list": { "post": { "operationId": "supergroup.usergroup.list", "summary": "查询超级群用户组列表。", "description": "查询超级群用户组列表。\n\noperationId: supergroup.usergroup.list", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroupList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/usergroup/delete": { "post": { "operationId": "supergroup.usergroup.delete", "summary": "删除超级群用户组。", "description": "删除超级群用户组。\n\noperationId: supergroup.usergroup.delete", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userGroupId": { "type": "string" } }, "required": [ "groupId", "userGroupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroupDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/usergroup/members/add": { "post": { "operationId": "supergroup.usergroup.members.add", "summary": "向用户组添加成员。", "description": "向用户组添加成员。\n\noperationId: supergroup.usergroup.members.add", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userGroupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userGroupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroup" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/usergroup/members/remove": { "post": { "operationId": "supergroup.usergroup.members.remove", "summary": "从用户组移出成员。", "description": "从用户组移出成员。\n\noperationId: supergroup.usergroup.members.remove", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userGroupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userGroupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroup" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/usergroup/by-user": { "post": { "operationId": "supergroup.usergroup.byUser", "summary": "查询用户所属的用户组。", "description": "查询用户所属的用户组。\n\noperationId: supergroup.usergroup.byUser", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroupList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/usergroup/channels": { "post": { "operationId": "supergroup.usergroup.channels", "summary": "查询用户组绑定的私有频道（同时覆盖融云“查询用户所属私有频道”）。", "description": "查询用户组绑定的私有频道（同时覆盖融云“查询用户所属私有频道”）。\n\noperationId: supergroup.usergroup.channels", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userGroupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroupChannels" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/reaction/add": { "post": { "operationId": "message.reaction.add", "summary": "添加消息回应（reaction；同一用户同一表情幂等）。", "description": "添加消息回应（reaction；同一用户同一表情幂等）。\n\noperationId: message.reaction.add", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" }, "userId": { "type": "string" }, "reaction": { "type": "string", "description": "表情标识，1-32 字符" } }, "required": [ "messageId", "userId", "reaction" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageReaction" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/reaction/remove": { "post": { "operationId": "message.reaction.remove", "summary": "移除消息回应。", "description": "移除消息回应。\n\noperationId: message.reaction.remove", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" }, "userId": { "type": "string" }, "reaction": { "type": "string" } }, "required": [ "messageId", "userId", "reaction" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ReactionRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/reaction/list": { "post": { "operationId": "message.reaction.list", "summary": "查询消息回应汇总（按表情聚合 count/userIds）。", "description": "查询消息回应汇总（按表情聚合 count/userIds）。\n\noperationId: message.reaction.list", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" } }, "required": [ "messageId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageReactionSummary" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/reaction/users": { "post": { "operationId": "message.reaction.users", "summary": "查询某表情的回应用户列表。", "description": "查询某表情的回应用户列表。\n\noperationId: message.reaction.users", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageId": { "type": "string" }, "reaction": { "type": "string" } }, "required": [ "messageId", "reaction" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ReactionUsers" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/reaction/batch": { "post": { "operationId": "message.reaction.batch", "summary": "批量查询多条消息的回应摘要（上限 50）。", "description": "批量查询多条消息的回应摘要（上限 50）。\n\noperationId: message.reaction.batch", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "messageIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "messageIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ReactionBatch" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/template/publish": { "post": { "operationId": "message.template.publish", "summary": "发送模板消息：templateId 指向内置模板，params 填充占位符后按普通消息下发（单聊/群/系统通知）。", "description": "发送模板消息：templateId 指向内置模板，params 填充占位符后按普通消息下发（单聊/群/系统通知）。\n\noperationId: message.template.publish", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1007 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "templateId": { "type": "string", "description": "welcome / notification / order 之一或自定义模板名" }, "params": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" }, "clientMsgId": { "type": "string" } }, "required": [ "fromUserId", "conversationType", "targetId", "templateId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Message" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/deactivate": { "post": { "operationId": "user.deactivate", "summary": "注销用户（合规能力：保留记录但禁止登录/收发，踢下线）。", "description": "注销用户（合规能力：保留记录但禁止登录/收发，踢下线）。\n\noperationId: user.deactivate", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1016 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserDeactivation" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/reactivate": { "post": { "operationId": "user.reactivate", "summary": "重新激活已注销用户。", "description": "重新激活已注销用户。\n\noperationId: user.reactivate", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/User" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/deactivated/list": { "post": { "operationId": "user.deactivated.list", "summary": "查询已注销用户列表（分页）。", "description": "查询已注销用户列表（分页）。\n\noperationId: user.deactivated.list", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserDeactivationList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/create": { "post": { "operationId": "supergroup.channel.create", "summary": "创建超级群私有/公开频道。", "description": "创建超级群私有/公开频道。\n\noperationId: supergroup.channel.create", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "description": "private（默认）| public" } }, "required": [ "groupId", "channelId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Channel" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/list": { "post": { "operationId": "supergroup.channel.list", "summary": "查询超级群频道列表。", "description": "查询超级群频道列表。\n\noperationId: supergroup.channel.list", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChannelList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/delete": { "post": { "operationId": "supergroup.channel.delete", "summary": "删除超级群频道。", "description": "删除超级群频道。\n\noperationId: supergroup.channel.delete", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" } }, "required": [ "groupId", "channelId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChannelDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/type/set": { "post": { "operationId": "supergroup.channel.type.set", "summary": "变更频道类型（private/public）。", "description": "变更频道类型（private/public）。\n\noperationId: supergroup.channel.type.set", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "type": { "type": "string" } }, "required": [ "groupId", "channelId", "type" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Channel" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/members/add": { "post": { "operationId": "supergroup.channel.members.add", "summary": "添加私有频道成员。", "description": "添加私有频道成员。\n\noperationId: supergroup.channel.members.add", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "channelId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Channel" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/members/remove": { "post": { "operationId": "supergroup.channel.members.remove", "summary": "移除私有频道成员。", "description": "移除私有频道成员。\n\noperationId: supergroup.channel.members.remove", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "channelId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Channel" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/members/list": { "post": { "operationId": "supergroup.channel.members.list", "summary": "查询私有频道成员列表。", "description": "查询私有频道成员列表。\n\noperationId: supergroup.channel.members.list", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" } }, "required": [ "groupId", "channelId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChannelMembers" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/usergroup/bind": { "post": { "operationId": "supergroup.channel.usergroup.bind", "summary": "绑定频道与用户组（用户组成员自动获得频道访问）。", "description": "绑定频道与用户组（用户组成员自动获得频道访问）。\n\noperationId: supergroup.channel.usergroup.bind", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "userGroupId": { "type": "string" } }, "required": [ "groupId", "channelId", "userGroupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChannelBinding" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/usergroup/unbind": { "post": { "operationId": "supergroup.channel.usergroup.unbind", "summary": "解绑频道与用户组。", "description": "解绑频道与用户组。\n\noperationId: supergroup.channel.usergroup.unbind", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "userGroupId": { "type": "string" } }, "required": [ "groupId", "channelId", "userGroupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChannelBinding" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/supergroup/channel/usergroup/list": { "post": { "operationId": "supergroup.channel.usergroup.list", "summary": "查询频道与用户组的绑定关系（channelId 或 userGroupId 二选一，至少一个）。", "description": "查询频道与用户组的绑定关系（channelId 或 userGroupId 二选一，至少一个）。\n\noperationId: supergroup.channel.usergroup.list", "tags": [ "supergroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "userGroupId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChannelBindingList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/message/priority/set": { "post": { "operationId": "chatroom.message.priority.set", "summary": "设置聊天室低优先级消息类型（全量覆盖）。", "description": "设置聊天室低优先级消息类型（全量覆盖）。\n\noperationId: chatroom.message.priority.set", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "messageTypes": { "type": "array", "items": { "type": "string" } } }, "required": [ "chatroomId", "messageTypes" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomPriority" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/message/priority/list": { "post": { "operationId": "chatroom.message.priority.list", "summary": "查询聊天室低优先级消息类型。", "description": "查询聊天室低优先级消息类型。\n\noperationId: chatroom.message.priority.list", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomPriority" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/stream/start": { "post": { "operationId": "message.stream.start", "summary": "开始流式消息（大模型输出场景）：创建流并预分配 messageId，后续 append 追加增量。", "description": "开始流式消息（大模型输出场景）：创建流并预分配 messageId，后续 append 追加增量。\n\noperationId: message.stream.start", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1007 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content", "description": "初始内容（通常为空 text）" } }, "required": [ "fromUserId", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/StreamInfo" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/stream/append": { "post": { "operationId": "message.stream.append", "summary": "向流追加文本增量（幂等 seq 可选；重复 seq 覆盖）。", "description": "向流追加文本增量（幂等 seq 可选；重复 seq 覆盖）。\n\noperationId: message.stream.append", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "streamId": { "type": "string" }, "delta": { "type": "string" }, "seq": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "streamId", "delta" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/StreamInfo" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/stream/end": { "post": { "operationId": "message.stream.end", "summary": "结束流式消息：落库为普通消息并按会话下发（返回最终 Message）。", "description": "结束流式消息：落库为普通消息并按会话下发（返回最终 Message）。\n\noperationId: message.stream.end", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1007 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "streamId": { "type": "string" } }, "required": [ "streamId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Message" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/stream/get": { "post": { "operationId": "message.stream.get", "summary": "获取流内容与状态（覆盖融云 /message/get_stream）。", "description": "获取流内容与状态（覆盖融云 /message/get_stream）。\n\noperationId: message.stream.get", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "streamId": { "type": "string" } }, "required": [ "streamId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/StreamInfo" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/broadcast": { "post": { "operationId": "message.broadcast", "summary": "发送全量用户落地通知（写入系统会话并下发；支持指定用户子集）。", "description": "发送全量用户落地通知（写入系统会话并下发；支持指定用户子集）。\n\noperationId: message.broadcast", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1007 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content" }, "targetUserIds": { "type": "array", "items": { "type": "string" }, "description": "省略=全应用用户" } }, "required": [ "fromUserId", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BroadcastResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/broadcast/recall": { "post": { "operationId": "message.broadcast.recall", "summary": "撤回全量用户落地通知。", "description": "撤回全量用户落地通知。\n\noperationId: message.broadcast.recall", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "broadcastId": { "type": "string" } }, "required": [ "broadcastId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BroadcastRecallResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/online/broadcast": { "post": { "operationId": "message.online.broadcast", "summary": "发送在线用户广播（仅推给当前在线连接，不落离线历史）。", "description": "发送在线用户广播（仅推给当前在线连接，不落离线历史）。\n\noperationId: message.online.broadcast", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1007 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content" } }, "required": [ "fromUserId", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BroadcastResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/push/send": { "post": { "operationId": "push.send", "summary": "发送推送通知（scope=all|tag|package|user|users；不落地，按应用推送配置的 webhook 投递并记录推送日志）。", "description": "发送推送通知（scope=all|tag|package|user|users；不落地，按应用推送配置的 webhook 投递并记录推送日志）。\n\noperationId: push.send", "tags": [ "push" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string" }, "target": { "type": "string", "description": "tag/package/userId；users 用 targetUserIds" }, "targetUserIds": { "type": "array", "items": { "type": "string" } }, "title": { "type": "string" }, "content": { "type": "string" }, "extras": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } }, "required": [ "scope", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/push/log/list": { "post": { "operationId": "push.log.list", "summary": "查询推送日志（覆盖融云 /message/push/detail/history）。", "description": "查询推送日志（覆盖融云 /message/push/detail/history）。\n\noperationId: push.log.list", "tags": [ "push" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "pushId": { "type": "string" } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushLogPage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/push/stats/day": { "post": { "operationId": "push.stats.day", "summary": "推送聚合统计（按天；覆盖融云 /stat/getDayPushData）。", "description": "推送聚合统计（按天；覆盖融云 /stat/getDayPushData）。\n\noperationId: push.stats.day", "tags": [ "push" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY-MM-DD，省略=今天" } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushStats" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/push/stats/by-id": { "post": { "operationId": "push.stats.byId", "summary": "单次推送统计（覆盖融云 /stat/getPushIdData）。", "description": "单次推送统计（覆盖融云 /stat/getPushIdData）。\n\noperationId: push.stats.byId", "tags": [ "push" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pushId": { "type": "string" } }, "required": [ "pushId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushStats" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/push/period/set": { "post": { "operationId": "user.push.period.set", "summary": "设置用户推送免打扰时段（startMinute/endMinute 为当天分钟数 0-1439）。", "description": "设置用户推送免打扰时段（startMinute/endMinute 为当天分钟数 0-1439）。\n\noperationId: user.push.period.set", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "startMinute": { "type": "integer", "format": "uint32", "minimum": 0 }, "endMinute": { "type": "integer", "format": "uint32", "minimum": 0 }, "enabled": { "type": "boolean" } }, "required": [ "userId", "startMinute", "endMinute" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushPeriod" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/push/period/get": { "post": { "operationId": "user.push.period.get", "summary": "查询用户推送免打扰时段。", "description": "查询用户推送免打扰时段。\n\noperationId: user.push.period.get", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushPeriod" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/push/period/remove": { "post": { "operationId": "user.push.period.remove", "summary": "删除用户推送免打扰时段。", "description": "删除用户推送免打扰时段。\n\noperationId: user.push.period.remove", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushPeriodRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/push/remark/set": { "post": { "operationId": "push.remark.set", "summary": "设置推送备注名（scope=user|group；覆盖融云 /user/remarks/* 与 /group/remarks/*）。", "description": "设置推送备注名（scope=user|group；覆盖融云 /user/remarks/* 与 /group/remarks/*）。\n\noperationId: push.remark.set", "tags": [ "push" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "string" }, "targetId": { "type": "string" }, "scope": { "type": "string" }, "remark": { "type": "string" } }, "required": [ "ownerId", "targetId", "scope", "remark" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushRemark" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/push/remark/get": { "post": { "operationId": "push.remark.get", "summary": "查询推送备注名。", "description": "查询推送备注名。\n\noperationId: push.remark.get", "tags": [ "push" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "string" }, "targetId": { "type": "string" }, "scope": { "type": "string" } }, "required": [ "ownerId", "targetId", "scope" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushRemark" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/push/remark/remove": { "post": { "operationId": "push.remark.remove", "summary": "删除推送备注名。", "description": "删除推送备注名。\n\noperationId: push.remark.remove", "tags": [ "push" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ownerId": { "type": "string" }, "targetId": { "type": "string" }, "scope": { "type": "string" } }, "required": [ "ownerId", "targetId", "scope" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/PushRemarkRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/member/follow/add": { "post": { "operationId": "group.member.follow.add", "summary": "设置用户对群成员的特别关注（仅本人视角，推送置顶提示）。", "description": "设置用户对群成员的特别关注（仅本人视角，推送置顶提示）。\n\noperationId: group.member.follow.add", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1005 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "targetUserId": { "type": "string" } }, "required": [ "groupId", "userId", "targetUserId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupFollow" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/member/follow/remove": { "post": { "operationId": "group.member.follow.remove", "summary": "取消对群成员的特别关注。", "description": "取消对群成员的特别关注。\n\noperationId: group.member.follow.remove", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "targetUserId": { "type": "string" } }, "required": [ "groupId", "userId", "targetUserId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupFollow" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/member/follow/list": { "post": { "operationId": "group.member.follow.list", "summary": "查询用户在该群的特别关注成员列表。", "description": "查询用户在该群的特别关注成员列表。\n\noperationId: group.member.follow.list", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupFollowList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/group/kick-all": { "post": { "operationId": "user.group.kickAll", "summary": "将指定用户踢出其加入的所有群组（应用管理员操作）。", "description": "将指定用户踢出其加入的所有群组（应用管理员操作）。\n\noperationId: user.group.kickAll", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupKickAllResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/remark/set": { "post": { "operationId": "group.remark.set", "summary": "设置用户对群名称的备注名（仅本人视角）。", "description": "设置用户对群名称的备注名（仅本人视角）。\n\noperationId: group.remark.set", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "groupId": { "type": "string" }, "remark": { "type": "string" } }, "required": [ "userId", "groupId", "remark" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupRemark" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/remark/get": { "post": { "operationId": "group.remark.get", "summary": "查询用户对群名称的备注名。", "description": "查询用户对群名称的备注名。\n\noperationId: group.remark.get", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "groupId": { "type": "string" } }, "required": [ "userId", "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupRemark" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/remark/remove": { "post": { "operationId": "group.remark.remove", "summary": "删除用户对群名称的备注名。", "description": "删除用户对群名称的备注名。\n\noperationId: group.remark.remove", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "groupId": { "type": "string" } }, "required": [ "userId", "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupRemarkRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/bot/create": { "post": { "operationId": "bot.create", "summary": "创建机器人账号（用于自动回复/托管；运行时对话能力需外部模型）。", "description": "创建机器人账号（用于自动回复/托管；运行时对话能力需外部模型）。\n\noperationId: bot.create", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "description": { "type": "string" } }, "required": [ "botId", "name" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Bot" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/bot/get": { "post": { "operationId": "bot.get", "summary": "获取指定机器人。", "description": "获取指定机器人。\n\noperationId: bot.get", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "string" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Bot" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/bot/list": { "post": { "operationId": "bot.list", "summary": "列出机器人（分页）。", "description": "列出机器人（分页）。\n\noperationId: bot.list", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BotList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/bot/update": { "post": { "operationId": "bot.update", "summary": "更新机器人资料。", "description": "更新机器人资料。\n\noperationId: bot.update", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "description": { "type": "string" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Bot" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/bot/delete": { "post": { "operationId": "bot.delete", "summary": "删除机器人。", "description": "删除机器人。\n\noperationId: bot.delete", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "string" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BotDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/create": { "post": { "operationId": "agent.create", "summary": "创建 Agent（对话代理配置；对话生成需外部模型接入）。", "description": "创建 Agent（对话代理配置；对话生成需外部模型接入）。\n\noperationId: agent.create", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "model": { "type": "string" } }, "required": [ "agentId", "name" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Agent" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/get": { "post": { "operationId": "agent.get", "summary": "获取指定 Agent。", "description": "获取指定 Agent。\n\noperationId: agent.get", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" } }, "required": [ "agentId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Agent" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/list": { "post": { "operationId": "agent.list", "summary": "列出 Agent（分页）。", "description": "列出 Agent（分页）。\n\noperationId: agent.list", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/update": { "post": { "operationId": "agent.update", "summary": "更新 Agent 配置。", "description": "更新 Agent 配置。\n\noperationId: agent.update", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "model": { "type": "string" } }, "required": [ "agentId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/Agent" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/delete": { "post": { "operationId": "agent.delete", "summary": "删除 Agent。", "description": "删除 Agent。\n\noperationId: agent.delete", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" } }, "required": [ "agentId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/restriction/set": { "post": { "operationId": "agent.restriction.set", "summary": "设置用户对 Agent 的使用限制（level=blocked|limited）。", "description": "设置用户对 Agent 的使用限制（level=blocked|limited）。\n\noperationId: agent.restriction.set", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "userId": { "type": "string" }, "level": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "agentId", "userId", "level" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentRestriction" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/restriction/get": { "post": { "operationId": "agent.restriction.get", "summary": "获取用户 Agent 限制记录。", "description": "获取用户 Agent 限制记录。\n\noperationId: agent.restriction.get", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "agentId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentRestriction" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/restriction/remove": { "post": { "operationId": "agent.restriction.remove", "summary": "删除用户 Agent 限制记录。", "description": "删除用户 Agent 限制记录。\n\noperationId: agent.restriction.remove", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "agentId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentRestrictionRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/restriction/list": { "post": { "operationId": "agent.restriction.list", "summary": "查询 Agent 的用户限制列表（分页）。", "description": "查询 Agent 的用户限制列表（分页）。\n\noperationId: agent.restriction.list", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "agentId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentRestrictionList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/rtc/bind": { "post": { "operationId": "chatroom.rtc.bind", "summary": "绑定聊天室与音视频房间（RTC 房间号仅存储，音视频能力需外部服务）。", "description": "绑定聊天室与音视频房间（RTC 房间号仅存储，音视频能力需外部服务）。\n\noperationId: chatroom.rtc.bind", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "rtcRoomId": { "type": "string" } }, "required": [ "chatroomId", "rtcRoomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomRtc" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/rtc/get": { "post": { "operationId": "chatroom.rtc.get", "summary": "查询聊天室绑定的音视频房间。", "description": "查询聊天室绑定的音视频房间。\n\noperationId: chatroom.rtc.get", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomRtc" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/chat/generate": { "post": { "operationId": "agent.chat.generate", "summary": "Agent 对话生成（转发到应用配置的 AI 服务端点；未配置返回 1021 服务未开通）。覆盖融云 /v3/chat/generate。", "description": "Agent 对话生成（转发到应用配置的 AI 服务端点；未配置返回 1021 服务未开通）。覆盖融云 /v3/chat/generate。\n\noperationId: agent.chat.generate", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "userId": { "type": "string" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" }, "description": "[{role:user|assistant|system, content:string}]" }, "maxTokens": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "agentId", "userId", "messages" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentChatResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/agent/chat/suggest": { "post": { "operationId": "agent.chat.suggest", "summary": "生成回复建议（转发到 AI 服务端点；未配置返回 1021）。覆盖融云 /v3/chat/suggest。", "description": "生成回复建议（转发到 AI 服务端点；未配置返回 1021）。覆盖融云 /v3/chat/suggest。\n\noperationId: agent.chat.suggest", "tags": [ "agent" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" } }, "lastMessage": { "type": "string" }, "count": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "userId", "history", "lastMessage" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/AgentChatResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/translate": { "post": { "operationId": "message.translate", "summary": "文本翻译（转发到应用配置的翻译服务；未配置返回 1021）。覆盖融云 /v3/translate。", "description": "文本翻译（转发到应用配置的翻译服务；未配置返回 1021）。覆盖融云 /v3/translate。\n\noperationId: message.translate", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string" }, "targetLang": { "type": "string" }, "sourceLang": { "type": "string" } }, "required": [ "text", "targetLang" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/TranslateResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/proxychat/start": { "post": { "operationId": "user.proxychat.start", "summary": "开启用户代聊（绑定 Agent，收到私聊时由 Agent 自动回复；回复生成依赖 AI 端点）。覆盖融云 /v3/user/proxychat/start。", "description": "开启用户代聊（绑定 Agent，收到私聊时由 Agent 自动回复；回复生成依赖 AI 端点）。覆盖融云 /v3/user/proxychat/start。\n\noperationId: user.proxychat.start", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "agentId": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "userId", "agentId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ProxyChatState" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/proxychat/stop": { "post": { "operationId": "user.proxychat.stop", "summary": "停止用户代聊。覆盖融云 /v3/user/proxychat/stop。", "description": "停止用户代聊。覆盖融云 /v3/user/proxychat/stop。\n\noperationId: user.proxychat.stop", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ProxyChatState" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/proxychat/list": { "post": { "operationId": "user.proxychat.list", "summary": "查询用户代聊列表（userId 省略返回应用全部）。覆盖融云 /v3/user/proxychat/query。", "description": "查询用户代聊列表（userId 省略返回应用全部）。覆盖融云 /v3/user/proxychat/query。\n\noperationId: user.proxychat.list", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ProxyChatList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/profile/moderation/sync": { "post": { "operationId": "user.profile.moderation.sync", "summary": "接收托管资料审核结果并落库（approved/rejected；rejected 可回滚指定资料字段）。覆盖融云 /user/profile/sync。", "description": "接收托管资料审核结果并落库（approved/rejected；rejected 可回滚指定资料字段）。覆盖融云 /user/profile/sync。\n\noperationId: user.profile.moderation.sync", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "status": { "type": "string" }, "reason": { "type": "string" }, "fields": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } }, "required": [ "userId", "status" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ModerationSyncResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/user/block/list": { "post": { "operationId": "chatroom.ban.list", "summary": "查询聊天室封禁用户列表（分页）。覆盖融云 /chatroom/user/block/list.json；time 为解禁时间（UTC），空串表示封禁未设置时长。", "description": "查询聊天室封禁用户列表（分页）。覆盖融云 /chatroom/user/block/list.json；time 为解禁时间（UTC），空串表示封禁未设置时长。\n\noperationId: chatroom.ban.list", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomBanList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/keepalive/query": { "post": { "operationId": "chatroom.keepalive.get", "summary": "查询应用下已设置保活状态的聊天室列表。覆盖融云 /chatroom/keepalive/query.json。", "description": "查询应用下已设置保活状态的聊天室列表。覆盖融云 /chatroom/keepalive/query.json。\n\noperationId: chatroom.keepalive.get", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1021 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomKeepaliveList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/keepalive/remove": { "post": { "operationId": "chatroom.keepalive.remove", "summary": "移除聊天室保活状态并恢复空闲销毁计时。覆盖融云 /chatroom/keepalive/remove.json。", "description": "移除聊天室保活状态并恢复空闲销毁计时。覆盖融云 /chatroom/keepalive/remove.json。\n\noperationId: chatroom.keepalive.remove", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomKeepaliveState" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/user/exist": { "post": { "operationId": "chatroom.members.exists", "summary": "查询指定用户是否在聊天室中。覆盖融云 /chatroom/user/exist.json。", "description": "查询指定用户是否在聊天室中。覆盖融云 /chatroom/user/exist.json。\n\noperationId: chatroom.members.exists", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "chatroomId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMemberExists" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/users/exist": { "post": { "operationId": "chatroom.members.existsBatch", "summary": "批量查询用户是否在聊天室中（单次 <=1000；isInChrm 1=在 0=不在）。覆盖融云 /chatroom/users/exist.json。", "description": "批量查询用户是否在聊天室中（单次 <=1000；isInChrm 1=在 0=不在）。覆盖融云 /chatroom/users/exist.json。\n\noperationId: chatroom.members.existsBatch", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "chatroomId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMembersExists" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/user/gag/list": { "post": { "operationId": "chatroom.mute.list", "summary": "查询聊天室禁言用户列表（仅返回未到期记录，time 为解禁时间）。覆盖融云 /chatroom/user/gag/list.json。", "description": "查询聊天室禁言用户列表（仅返回未到期记录，time 为解禁时间）。覆盖融云 /chatroom/user/gag/list.json。\n\noperationId: chatroom.mute.list", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "chatroomId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMuteList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/user/ban/add": { "post": { "operationId": "chatroom.globalMute.set", "summary": "全局禁言用户：应用下所有聊天室生效，仅约束客户端发送；单次 <=20 用户，minute 1..=43200。覆盖融云 /chatroom/user/ban/add.json。", "description": "全局禁言用户：应用下所有聊天室生效，仅约束客户端发送；单次 <=20 用户，minute 1..=43200。覆盖融云 /chatroom/user/ban/add.json。\n\noperationId: chatroom.globalMute.set", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "minute": { "type": "integer", "format": "uint32", "minimum": 0 }, "extra": { "type": "string" }, "needNotify": { "type": "boolean" } }, "required": [ "userIds", "minute" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomGlobalMute" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/user/ban/remove": { "post": { "operationId": "chatroom.globalMute.remove", "summary": "解除用户全局禁言（单次 <=20 用户；幂等）。覆盖融云 /chatroom/user/ban/remove.json。", "description": "解除用户全局禁言（单次 <=20 用户；幂等）。覆盖融云 /chatroom/user/ban/remove.json。\n\noperationId: chatroom.globalMute.remove", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "extra": { "type": "string" }, "needNotify": { "type": "boolean" } }, "required": [ "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomGlobalMuteRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/user/ban/query": { "post": { "operationId": "chatroom.globalMute.list", "summary": "查询应用下已被全局禁言的用户列表（含解禁时间；到期记录惰性清理）。覆盖融云 /chatroom/user/ban/query.json。", "description": "查询应用下已被全局禁言的用户列表（含解禁时间；到期记录惰性清理）。覆盖融云 /chatroom/user/ban/query.json。\n\noperationId: chatroom.globalMute.list", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1021 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomGlobalMuteList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/whitelist/add.json": { "post": { "operationId": "chatroom.messageWhitelist.add", "summary": "添加消息类型到聊天室消息白名单（应用级共享，<=20 种，标识 <=32 字符；重复添加幂等）。覆盖融云 /chatroom/whitelist/add.json；路径带 .json 以避开 rev4 用户白名单占用的 /chatroom/whitelist/add。", "description": "添加消息类型到聊天室消息白名单（应用级共享，<=20 种，标识 <=32 字符；重复添加幂等）。覆盖融云 /chatroom/whitelist/add.json；路径带 .json 以避开 rev4 用户白名单占用的 /chatroom/whitelist/add。\n\noperationId: chatroom.messageWhitelist.add", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectnames": { "type": "array", "items": { "type": "string" } } }, "required": [ "objectnames" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMessageWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/whitelist/query.json": { "post": { "operationId": "chatroom.messageWhitelist.list", "summary": "查询应用全局的聊天室消息类型白名单。覆盖融云 /chatroom/whitelist/query.json。", "description": "查询应用全局的聊天室消息类型白名单。覆盖融云 /chatroom/whitelist/query.json。\n\noperationId: chatroom.messageWhitelist.list", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1021 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMessageWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/whitelist/delete.json": { "post": { "operationId": "chatroom.messageWhitelist.remove", "summary": "从聊天室消息白名单移除消息类型（幂等）。覆盖融云 /chatroom/whitelist/delete.json。", "description": "从聊天室消息白名单移除消息类型（幂等）。覆盖融云 /chatroom/whitelist/delete.json。\n\noperationId: chatroom.messageWhitelist.remove", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "objectnames": { "type": "array", "items": { "type": "string" } } }, "required": [ "objectnames" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomMessageWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/user/gag/list": { "post": { "operationId": "group.mute.list", "summary": "查询群成员禁言列表；groupId 省略时返回应用下所有群（items 携带 groupId）。覆盖融云 /group/user/gag/list.json。", "description": "查询群成员禁言列表；groupId 省略时返回应用下所有群（items 携带 groupId）。覆盖融云 /group/user/gag/list.json。\n\noperationId: group.mute.list", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1005 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupMuteList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/user/group/query": { "post": { "operationId": "user.groups.list", "summary": "查询用户所在的群组（page/size 分页；page 缺省或 0 返回前 5000 个）。覆盖融云 /user/group/query.json。", "description": "查询用户所在的群组（page/size 分页；page 缺省或 0 返回前 5000 个）。覆盖融云 /user/group/query.json。\n\noperationId: user.groups.list", "tags": [ "user" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "size": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/UserGroups" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/chatroom/broadcast": { "post": { "operationId": "chatroom.broadcast", "summary": "向应用下所有聊天室广播消息（仅广播当时在线成员，不落聊天室历史；默认不同步发件人）。覆盖融云 /message/chatroom/broadcast.json。", "description": "向应用下所有聊天室广播消息（仅广播当时在线成员，不落聊天室历史；默认不同步发件人）。覆盖融云 /message/chatroom/broadcast.json。\n\noperationId: chatroom.broadcast", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1007, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "objectName": { "type": "string" }, "content": { "type": "string" }, "isIncludeSender": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "fromUserId", "objectName", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomBroadcastResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/sensitiveword/add": { "post": { "operationId": "sensitiveword.add", "summary": "增量添加敏感词（不覆盖既有词，重复添加幂等；单词 <=32 字符，总数 <=500）。覆盖融云 /sensitiveword/add.json；replaceWord 会把应用处置动作切换为 replace。", "description": "增量添加敏感词（不覆盖既有词，重复添加幂等；单词 <=32 字符，总数 <=500）。覆盖融云 /sensitiveword/add.json；replaceWord 会把应用处置动作切换为 replace。\n\noperationId: sensitiveword.add", "tags": [ "sensitiveword" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "word": { "type": "string" }, "replaceWord": { "type": "string" } }, "required": [ "word" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SensitiveWordAddResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/sensitiveword/batch/add": { "post": { "operationId": "sensitiveword.batch.add", "summary": "批量增量添加敏感词（1..=50 条，合并既有列表，总数 <=500）。words 支持字符串或 {word,replaceWord} 对象。覆盖融云 /sensitiveword/batch/add.json。", "description": "批量增量添加敏感词（1..=50 条，合并既有列表，总数 <=500）。words 支持字符串或 {word,replaceWord} 对象。覆盖融云 /sensitiveword/batch/add.json。\n\noperationId: sensitiveword.batch.add", "tags": [ "sensitiveword" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "words": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" } } }, "required": [ "words" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SensitiveWordBatchAddResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/sensitiveword/delete": { "post": { "operationId": "sensitiveword.delete", "summary": "移除单个敏感词（幂等；不存在时 removed=false）。覆盖融云 /sensitiveword/delete.json。", "description": "移除单个敏感词（幂等；不存在时 removed=false）。覆盖融云 /sensitiveword/delete.json。\n\noperationId: sensitiveword.delete", "tags": [ "sensitiveword" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "word": { "type": "string" } }, "required": [ "word" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SensitiveWordDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/sensitiveword/batch/delete": { "post": { "operationId": "sensitiveword.batch.delete", "summary": "批量移除敏感词（1..=50 条，幂等）。覆盖融云 /sensitiveword/batch/delete.json。", "description": "批量移除敏感词（1..=50 条，幂等）。覆盖融云 /sensitiveword/batch/delete.json。\n\noperationId: sensitiveword.batch.delete", "tags": [ "sensitiveword" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "words": { "type": "array", "items": { "type": "string" } } }, "required": [ "words" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SensitiveWordBatchDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/statusmessage/private/publish": { "post": { "operationId": "statusmessage.private.publish", "summary": "发送单聊状态消息：仅投递当时在线的目标会话，不存储、不计未读、不落离线；离线目标 online=false。服务端下发 WS status 帧。覆盖融云 /statusmessage/private/publish.json。", "description": "发送单聊状态消息：仅投递当时在线的目标会话，不存储、不计未读、不落离线；离线目标 online=false。服务端下发 WS status 帧。覆盖融云 /statusmessage/private/publish.json。\n\noperationId: statusmessage.private.publish", "tags": [ "statusmessage" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "toUserId": { "type": "array", "items": { "type": "string" } }, "objectName": { "type": "string" }, "content": { "type": "string" }, "isIncludeSender": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "fromUserId", "toUserId", "objectName", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/StatusMessagePrivateResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/statusmessage/group/publish": { "post": { "operationId": "statusmessage.group.publish", "summary": "发送群聊状态消息：向当时在线的群成员扇出（默认不同步发件人），不存储、不计未读。服务端下发 WS status 帧。覆盖融云 /statusmessage/group/publish.json。", "description": "发送群聊状态消息：向当时在线的群成员扇出（默认不同步发件人），不存储、不计未读。服务端下发 WS status 帧。覆盖融云 /statusmessage/group/publish.json。\n\noperationId: statusmessage.group.publish", "tags": [ "statusmessage" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1005, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "toGroupId": { "type": "array", "items": { "type": "string" } }, "objectName": { "type": "string" }, "content": { "type": "string" }, "isIncludeSender": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "fromUserId", "toGroupId", "objectName", "content" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/StatusMessageGroupResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/history": { "post": { "operationId": "message.history", "summary": "分页查询应用历史消息审计记录（userId/conversationType/targetId/from/to 过滤；page 从 1 开始，size 上限 100）。审计视图由已持久化消息派生，聊天室等 ephemeral 消息不在范围内。", "description": "分页查询应用历史消息审计记录（userId/conversationType/targetId/from/to 过滤；page 从 1 开始，size 上限 100）。审计视图由已持久化消息派生，聊天室等 ephemeral 消息不在范围内。\n\noperationId: message.history", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "from": { "type": "integer", "format": "int64", "description": "epoch 毫秒（含）" }, "to": { "type": "integer", "format": "int64", "description": "epoch 毫秒（含）" }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "size": { "type": "integer", "format": "uint32", "minimum": 0, "description": "默认 20，上限 100" } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageHistoryPage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/message/history/delete": { "post": { "operationId": "message.history.delete", "summary": "按时间区间删除历史消息审计记录（from/to 至少传一个，epoch 毫秒闭区间；只记录审计删除区间，不清理在线会话消息存储；重叠区间合并）。", "description": "按时间区间删除历史消息审计记录（from/to 至少传一个，epoch 毫秒闭区间；只记录审计删除区间，不清理在线会话消息存储；重叠区间合并）。\n\noperationId: message.history.delete", "tags": [ "message" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001 ], "x-idl-idempotent": true, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "integer", "format": "int64" }, "to": { "type": "integer", "format": "int64" } } } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/MessageHistoryDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/entry/batch/set": { "post": { "operationId": "chatroom.entry.batch.set", "summary": "批量设置聊天室自定义属性（按 entryOwnerId 隔离，单次 <=100 对；同 key 覆盖）。覆盖融云 /chatroom/entry/batch/set.json。", "description": "批量设置聊天室自定义属性（按 entryOwnerId 隔离，单次 <=100 对；同 key 覆盖）。覆盖融云 /chatroom/entry/batch/set.json。\n\noperationId: chatroom.entry.batch.set", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "entryOwnerId": { "type": "string" }, "entryInfo": { "type": "string", "description": "JSON 对象或序列化后的 JSON 字符串" } }, "required": [ "chatroomId", "entryOwnerId", "entryInfo" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomEntryBatchSetResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/chatroom/entry/batch/remove": { "post": { "operationId": "chatroom.entry.batch.remove", "summary": "批量移除聊天室自定义属性（<=100 个 key，按 entryOwnerId 隔离，幂等）。覆盖融云 /chatroom/entry/batch/remove.json。", "description": "批量移除聊天室自定义属性（<=100 个 key，按 entryOwnerId 隔离，幂等）。覆盖融云 /chatroom/entry/batch/remove.json。\n\noperationId: chatroom.entry.batch.remove", "tags": [ "chatroom" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1012, 1013, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "entryOwnerId": { "type": "string" }, "entryKeys": { "type": "array", "items": { "type": "string" } } }, "required": [ "chatroomId", "entryOwnerId", "entryKeys" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ChatroomEntryBatchRemoveResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/entrust/joined/group/query": { "post": { "operationId": "entrust.joined.group.query", "summary": "分页查询用户加入的群（page/size；role 0=全部/1=成员/2=管理员/3=群主；order 0=正序/1=倒序，默认倒序；size 上限 100）。覆盖融云 /entrust/joined/group/query.json。", "description": "分页查询用户加入的群（page/size；role 0=全部/1=成员/2=管理员/3=群主；order 0=正序/1=倒序，默认倒序；size 上限 100）。覆盖融云 /entrust/joined/group/query.json。\n\noperationId: entrust.joined.group.query", "tags": [ "entrust" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "size": { "type": "integer", "format": "uint32", "minimum": 0, "description": "默认 50，上限 100" }, "role": { "type": "integer", "format": "uint32", "minimum": 0 }, "order": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/JoinedGroupPage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/group/sync": { "post": { "operationId": "group.sync", "summary": "全量同步用户所在群组：groups 内缺失群自动创建（用户为群主），已存在群幂等加入并可按 name 更新群名；列表外的应用内群移除该用户成员关系（groups 省略表示解绑全部）。覆盖融云 /group/sync.json。", "description": "全量同步用户所在群组：groups 内缺失群自动创建（用户为群主），已存在群幂等加入并可按 name 更新群名；列表外的应用内群移除该用户成员关系（groups 省略表示解绑全部）。覆盖融云 /group/sync.json。\n\noperationId: group.sync", "tags": [ "group" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" }, "description": "[{groupId,name?}]、{groupId:name} 或字符串数组" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/GroupSyncResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/attribute/get": { "post": { "operationId": "conversation.attribute.get", "summary": "查询单个会话属性：置顶、免打扰（notificationLevel/mute）、未读数、草稿、@ 计数、标签与最后一条消息；会话不存在返回缺省值（不创建会话）。覆盖融云 /conversation/attribute/get.json。", "description": "查询单个会话属性：置顶、免打扰（notificationLevel/mute）、未读数、草稿、@ 计数、标签与最后一条消息；会话不存在返回缺省值（不创建会话）。覆盖融云 /conversation/attribute/get.json。\n\noperationId: conversation.attribute.get", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "targetId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" } }, "required": [ "userId", "targetId", "conversationType" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationAttribute" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/notdisturb/get": { "post": { "operationId": "ultragroup.notdisturb.get", "summary": "查询超级群（或指定频道）的默认免打扰级别：0 全部通知 / 1 仅 @ 通知 / 2 免打扰；未设置返回 0。groupType 必须为 super（否则 1005）。覆盖融云 /ultragroup/notdisturb/get.json。", "description": "查询超级群（或指定频道）的默认免打扰级别：0 全部通知 / 1 仅 @ 通知 / 2 免打扰；未设置返回 0。groupType 必须为 super（否则 1005）。覆盖融云 /ultragroup/notdisturb/get.json。\n\noperationId: ultragroup.notdisturb.get", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupNotDisturb" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/notdisturb/set": { "post": { "operationId": "ultragroup.notdisturb.set", "summary": "设置超级群（或频道）默认免打扰，对全体成员生效；scope=all 为群级、scope=channel 需同时传 channelId。覆盖融云 /ultragroup/notdisturb/set.json（兼容 unpushLevel 入参别名）。", "description": "设置超级群（或频道）默认免打扰，对全体成员生效；scope=all 为群级、scope=channel 需同时传 channelId。覆盖融云 /ultragroup/notdisturb/set.json（兼容 unpushLevel 入参别名）。\n\noperationId: ultragroup.notdisturb.set", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "notdisturbLevel": { "type": "integer", "format": "int32" }, "scope": { "type": "string" }, "channelId": { "type": "string" } }, "required": [ "groupId", "notdisturbLevel" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupNotDisturb" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/globalbanned/set": { "post": { "operationId": "ultragroup.globalbanned.set", "summary": "设置/取消超级群全体禁言（status=true/false，duration 秒可选，缺省为永久）；群级状态写入既有 group.mute-all 状态，因此会真实拦截非群主/管理员/白名单成员的发送（1009）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/globalbanned/set.json。", "description": "设置/取消超级群全体禁言（status=true/false，duration 秒可选，缺省为永久）；群级状态写入既有 group.mute-all 状态，因此会真实拦截非群主/管理员/白名单成员的发送（1009）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/globalbanned/set.json。\n\noperationId: ultragroup.globalbanned.set", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "status": { "type": "boolean" }, "duration": { "type": "integer", "format": "uint64", "minimum": 0 }, "channelId": { "type": "string" } }, "required": [ "groupId", "status" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupGlobalBan" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/globalbanned/get": { "post": { "operationId": "ultragroup.globalbanned.get", "summary": "查询超级群（或频道）全体禁言状态：status 为当前有效状态（带时长的禁言到期后视为 false），until 为到期时间（0=永久）。覆盖融云 /ultragroup/globalbanned/get.json。", "description": "查询超级群（或频道）全体禁言状态：status 为当前有效状态（带时长的禁言到期后视为 false），until 为到期时间（0=永久）。覆盖融云 /ultragroup/globalbanned/get.json。\n\noperationId: ultragroup.globalbanned.get", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupGlobalBan" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/banned/whitelist/add": { "post": { "operationId": "ultragroup.banned.whitelist.add", "summary": "把用户加入超级群全体禁言白名单（userIds 支持数组或逗号分隔字符串，单次 <=20，幂等，白名单总人数 <=1000）；白名单成员在全体禁言期间仍可发送。覆盖融云 /ultragroup/banned/whitelist/add.json。", "description": "把用户加入超级群全体禁言白名单（userIds 支持数组或逗号分隔字符串，单次 <=20，幂等，白名单总人数 <=1000）；白名单成员在全体禁言期间仍可发送。覆盖融云 /ultragroup/banned/whitelist/add.json。\n\noperationId: ultragroup.banned.whitelist.add", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1005, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupBanWhitelistAdd" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/banned/whitelist/del": { "post": { "operationId": "ultragroup.banned.whitelist.del", "summary": "把用户移出超级群全体禁言白名单（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/banned/whitelist/del.json。", "description": "把用户移出超级群全体禁言白名单（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/banned/whitelist/del.json。\n\noperationId: ultragroup.banned.whitelist.del", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupBanWhitelistRemove" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/banned/whitelist/get": { "post": { "operationId": "ultragroup.banned.whitelist.get", "summary": "分页查询超级群全体禁言白名单（page 从 1 开始，pageSize 默认 50、上限 200；同时返回 users[{id}] 与 userIds）。覆盖融云 /ultragroup/banned/whitelist/get.json。", "description": "分页查询超级群全体禁言白名单（page 从 1 开始，pageSize 默认 50、上限 200；同时返回 users[{id}] 与 userIds）。覆盖融云 /ultragroup/banned/whitelist/get.json。\n\noperationId: ultragroup.banned.whitelist.get", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "pageSize": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupBanWhitelist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/userbanned/add": { "post": { "operationId": "ultragroup.userbanned.add", "summary": "禁言指定超级群成员（userIds 单次 <=20，duration 秒可选，缺省永久；群级写入既有成员禁言 Group.muted 并真实拦截发送；单群禁言人数 <=100）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/userbanned/add.json。", "description": "禁言指定超级群成员（userIds 单次 <=20，duration 秒可选，缺省永久；群级写入既有成员禁言 Group.muted 并真实拦截发送；单群禁言人数 <=100）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/userbanned/add.json。\n\noperationId: ultragroup.userbanned.add", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1005, 1006, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } }, "duration": { "type": "integer", "format": "uint64", "minimum": 0 }, "channelId": { "type": "string" } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupUserBanAdd" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/userbanned/del": { "post": { "operationId": "ultragroup.userbanned.del", "summary": "解除指定超级群成员禁言（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/userbanned/del.json。", "description": "解除指定超级群成员禁言（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/userbanned/del.json。\n\noperationId: ultragroup.userbanned.del", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } }, "channelId": { "type": "string" } }, "required": [ "groupId", "userIds" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupUserBanRemove" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/userbanned/get": { "post": { "operationId": "ultragroup.userbanned.get", "summary": "分页查询被禁言的超级群成员（含 until 到期时间与 permanent 标记；pageSize 默认 50、上限 100）。覆盖融云 /ultragroup/userbanned/get.json。", "description": "分页查询被禁言的超级群成员（含 until 到期时间与 permanent 标记；pageSize 默认 50、上限 100）。覆盖融云 /ultragroup/userbanned/get.json。\n\noperationId: ultragroup.userbanned.get", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1005, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "pageSize": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "groupId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupUserBanList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/ultragroup/member/exist": { "post": { "operationId": "ultragroup.member.exist", "summary": "查询用户是否为指定超级群成员：status=true/false。覆盖融云 /ultragroup/member/exist.json。", "description": "查询用户是否为指定超级群成员：status=true/false。覆盖融云 /ultragroup/member/exist.json。\n\noperationId: ultragroup.member.exist", "tags": [ "ultragroup" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004, 1005, 1021 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "groupId", "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/SupergroupMemberExist" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/type/notification/get": { "post": { "operationId": "conversation.type.notification.get", "summary": "查询用户按会话类型设置的默认通知级别：0 全部通知 / 1 仅 @ / 2 免打扰；未设置返回 0。conversationType 支持 1 单聊 / 2 群 / 3 聊天室 / 6 系统 / 10 超级群。覆盖融云 /conversation/type/notification/get.json。", "description": "查询用户按会话类型设置的默认通知级别：0 全部通知 / 1 仅 @ / 2 免打扰；未设置返回 0。conversationType 支持 1 单聊 / 2 群 / 3 聊天室 / 6 系统 / 10 超级群。覆盖融云 /conversation/type/notification/get.json。\n\noperationId: conversation.type.notification.get", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" } }, "required": [ "userId", "conversationType" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTypeNotification" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/type/notification/set": { "post": { "operationId": "conversation.type.notification.set", "summary": "设置用户按会话类型的默认通知级别（0 全部 / 1 仅 @ / 2 免打扰），按 {app}:{user}:{conversationType} 持久化。覆盖融云 /conversation/type/notification/set.json（unpushLevel/isMuted 均可作为入参别名）。", "description": "设置用户按会话类型的默认通知级别（0 全部 / 1 仅 @ / 2 免打扰），按 {app}:{user}:{conversationType} 持久化。覆盖融云 /conversation/type/notification/set.json（unpushLevel/isMuted 均可作为入参别名）。\n\noperationId: conversation.type.notification.set", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "unpushLevel": { "type": "integer", "format": "int32" } }, "required": [ "userId", "conversationType", "unpushLevel" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTypeNotification" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/v3/bot/integration/create": { "post": { "operationId": "bot.integration.create", "summary": "为已存在的机器人（bot.create 产出）登记 Webhook 回调集成：每个机器人一份配置、应用内 <=10 份；events 取 bot.message.private / bot.message.group / bot.message.chatroom / bot.chatroom.user.join。secret 缺省自动生成；回调签名与既有回调一致。覆盖融云 /v3/bot/integration/create.json。", "description": "为已存在的机器人（bot.create 产出）登记 Webhook 回调集成：每个机器人一份配置、应用内 <=10 份；events 取 bot.message.private / bot.message.group / bot.message.chatroom / bot.chatroom.user.join。secret 缺省自动生成；回调签名与既有回调一致。覆盖融云 /v3/bot/integration/create.json。\n\noperationId: bot.integration.create", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "string" }, "name": { "type": "string" }, "webhookUrl": { "type": "string" }, "secret": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" } }, "required": [ "botId", "webhookUrl", "events" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BotIntegration" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/v3/bot/integration/update": { "post": { "operationId": "bot.integration.update", "summary": "更新机器人 Webhook 集成（name / webhookUrl / secret / events / enabled 均可选，只覆盖传入字段）。覆盖融云 /v3/bot/integration/update.json。", "description": "更新机器人 Webhook 集成（name / webhookUrl / secret / events / enabled 均可选，只覆盖传入字段）。覆盖融云 /v3/bot/integration/update.json。\n\noperationId: bot.integration.update", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "x-idl-idempotent": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "string" }, "name": { "type": "string" }, "webhookUrl": { "type": "string" }, "secret": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BotIntegration" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/v3/bot/integration/delete": { "post": { "operationId": "bot.integration.delete", "summary": "删除机器人 Webhook 集成配置；配置不存在返回 1001（不静默成功）。覆盖融云 /v3/bot/integration/delete.json。", "description": "删除机器人 Webhook 集成配置；配置不存在返回 1001（不静默成功）。覆盖融云 /v3/bot/integration/delete.json。\n\noperationId: bot.integration.delete", "tags": [ "bot" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.0.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "botId": { "type": "string" } }, "required": [ "botId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/BotIntegrationDelete" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/create": { "post": { "operationId": "conversation.tag.create", "summary": "创建会话标签：tagName ≤16 字符；tagId 可选（≤32 字符，[A-Za-z0-9_.-]，缺省由 tagName 派生）；单用户最多 20 个标签（超出 1031）。覆盖融云 /conversation/tag/create.json。", "description": "创建会话标签：tagName ≤16 字符；tagId 可选（≤32 字符，[A-Za-z0-9_.-]，缺省由 tagName 派生）；单用户最多 20 个标签（超出 1031）。覆盖融云 /conversation/tag/create.json。\n\noperationId: conversation.tag.create", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1031 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagName": { "type": "string" }, "tagId": { "type": "string" } }, "required": [ "userId", "tagName" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTag" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/update": { "post": { "operationId": "conversation.tag.update", "summary": "重命名会话标签（tagId 不变）。覆盖融云 /conversation/tag/update.json。", "description": "重命名会话标签（tagId 不变）。覆盖融云 /conversation/tag/update.json。\n\noperationId: conversation.tag.update", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1032 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "tagName": { "type": "string" } }, "required": [ "userId", "tagId", "tagName" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTag" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/delete": { "post": { "operationId": "conversation.tag.delete", "summary": "删除会话标签，同时清除标签内会话引用；标签不存在返回 1032。覆盖融云 /conversation/tag/delete.json。", "description": "删除会话标签，同时清除标签内会话引用；标签不存在返回 1032。覆盖融云 /conversation/tag/delete.json。\n\noperationId: conversation.tag.delete", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1032 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" } }, "required": [ "userId", "tagId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/get": { "post": { "operationId": "conversation.tag.get", "summary": "查询用户全部标签（含 conversationCount），按创建顺序返回。覆盖融云 /conversation/tag/get.json。", "description": "查询用户全部标签（含 conversationCount），按创建顺序返回。覆盖融云 /conversation/tag/get.json。\n\noperationId: conversation.tag.get", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" } }, "required": [ "userId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/conversations/add": { "post": { "operationId": "conversation.tag.conversations.add", "summary": "把会话加入标签：单次 ≤100 条（items 支持对象数组或 \"type:target\" 字符串），幂等；单标签最多 1000 个会话（超出 1033）。覆盖融云 /conversation/tag/conversations/add.json。", "description": "把会话加入标签：单次 ≤100 条（items 支持对象数组或 \"type:target\" 字符串），幂等；单标签最多 1000 个会话（超出 1033）。覆盖融云 /conversation/tag/conversations/add.json。\n\noperationId: conversation.tag.conversations.add", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1032, 1033 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" } } }, "required": [ "userId", "tagId", "items" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagMembershipResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/conversations/remove": { "post": { "operationId": "conversation.tag.conversations.remove", "summary": "把会话移出标签：单次 ≤100 条，幂等。覆盖融云 /conversation/tag/conversations/remove.json。", "description": "把会话移出标签：单次 ≤100 条，幂等。覆盖融云 /conversation/tag/conversations/remove.json。\n\noperationId: conversation.tag.conversations.remove", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1032 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationRef" } } }, "required": [ "userId", "tagId", "items" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagMembershipResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/conversations/get": { "post": { "operationId": "conversation.tag.conversations.get", "summary": "分页查询标签内会话（含 top、unreadCount、lastMessageAt；limit 默认 50 上限 200）。覆盖融云 /conversation/tag/conversations/get.json。", "description": "分页查询标签内会话（含 top、unreadCount、lastMessageAt；limit 默认 50 上限 200）。覆盖融云 /conversation/tag/conversations/get.json。\n\noperationId: conversation.tag.conversations.get", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1032 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "userId", "tagId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagConversationsPage" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/of/conversation": { "post": { "operationId": "conversation.tag.of.conversation", "summary": "查询某个会话所属标签列表。覆盖融云 /conversation/tag/of/conversation.json。", "description": "查询某个会话所属标签列表。覆盖融云 /conversation/tag/of/conversation.json。\n\noperationId: conversation.tag.of.conversation", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" } }, "required": [ "userId", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagList" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/unread/get": { "post": { "operationId": "conversation.tag.unread.get", "summary": "标签内未读汇总（unreadCount 消息总数 + unreadConversations 有未读的会话数）。覆盖融云 /conversation/tag/unread/get.json。", "description": "标签内未读汇总（unreadCount 消息总数 + unreadConversations 有未读的会话数）。覆盖融云 /conversation/tag/unread/get.json。\n\noperationId: conversation.tag.unread.get", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1032 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" } }, "required": [ "userId", "tagId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagUnread" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/tag/top/set": { "post": { "operationId": "conversation.tag.top.set", "summary": "标签内置顶/取消置顶会话，同时更新会话 is_pinned；会话不在标签内返回 1034。覆盖融云 /conversation/tag/top/set.json。", "description": "标签内置顶/取消置顶会话，同时更新会话 is_pinned；会话不在标签内返回 1034。覆盖融云 /conversation/tag/top/set.json。\n\noperationId: conversation.tag.top.set", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004, 1032, 1034 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "top": { "type": "boolean" } }, "required": [ "userId", "tagId", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationTagTopResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } }, "/conversation/delete": { "post": { "operationId": "conversation.delete", "summary": "删除会话记录（列表项/未读/草稿/置顶），历史消息保留；同时从该用户所有标签移除；幂等（removed=false 表示本就不存在）。覆盖融云 /conversation/delete.json。", "description": "删除会话记录（列表项/未读/草稿/置顶），历史消息保留；同时从该用户所有标签移除；幂等（removed=false 表示本就不存在）。覆盖融云 /conversation/delete.json。\n\noperationId: conversation.delete", "tags": [ "conversation" ], "security": [ { "AppKeySignature": [] } ], "x-idl-since": "1.2.0", "x-idl-errors": [ 1001, 1004 ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" } }, "required": [ "userId", "conversationType", "targetId" ] } } } }, "responses": { "200": { "description": "成功：统一响应包络", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "integer", "const": 0, "description": "0 表示成功" }, "msg": { "type": "string" }, "data": { "$ref": "#/components/schemas/ConversationDeleteResult" }, "requestId": { "type": "string" } }, "required": [ "code" ] } } } }, "400": { "description": "参数错误（1001/1007/1010/1015/1022/1023/1024）" }, "401": { "description": "签名错误 / 时间戳过期 / Nonce 重放（1018/1019/1020）" }, "403": { "description": "权限或服务未开通（1003/1006/1009/1011/1014/1016/1017/1021）" }, "404": { "description": "对象不存在（1004/1005/1012）" }, "429": { "description": "接口级限频（1008），响应头带 Retry-After: 1" } } } } }, "components": { "securitySchemes": { "AppKeySignature": { "type": "apiKey", "in": "header", "name": "Signature", "description": "四个头共同完成鉴权：App-Key、Nonce（8-64 字符，5 分钟不可重放）、Timestamp（epoch 毫秒，±300000ms）、Signature = hex(sha1(AppSecret + Nonce + Timestamp))。" } }, "schemas": { "RcResult": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "description": "0=成功；非 0 见 errors.json" }, "data": {}, "msg": { "type": "string" } }, "description": "SDK 统一返回（客户端）", "required": [ "code" ] }, "OpenApiResponse": { "type": "object", "properties": { "code": { "type": "integer", "format": "int32", "description": "0=成功" }, "msg": { "type": "string" }, "data": {}, "requestId": { "type": "string" } }, "description": "Open API 统一响应（服务端到服务端）", "required": [ "code" ] }, "Page": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "required": [ "total", "hasMore" ] }, "User": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64", "description": "epoch ms" }, "banned": { "type": "boolean" } }, "required": [ "userId", "name", "createdAt" ] }, "UserProfile": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" } }, "required": [ "userId", "name" ] }, "MentionedInfo": { "type": "object", "properties": { "type": { "type": "object", "x-idl-type": "MentionType" }, "userIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "type", "userIds" ] }, "Quote": { "type": "object", "properties": { "messageId": { "type": "string" }, "senderId": { "type": "string" }, "type": { "type": "string" }, "text": { "type": "string" } }, "required": [ "messageId", "type" ] }, "Content": { "type": "object", "properties": { "type": { "type": "object", "x-idl-type": "ContentType" }, "text": { "type": "string", "description": "text：非空" }, "url": { "type": "string", "description": "image/file/voice 必填" }, "name": { "type": "string", "description": "file" }, "size": { "type": "integer", "format": "uint64", "minimum": 0 }, "mime": { "type": "string" }, "width": { "type": "integer", "format": "uint32", "minimum": 0 }, "height": { "type": "integer", "format": "uint32", "minimum": 0 }, "duration": { "type": "integer", "format": "uint32", "minimum": 0, "description": "voice 1..300 秒" }, "latitude": { "type": "number", "format": "double", "description": "location [-90,90]" }, "longitude": { "type": "number", "format": "double", "description": "location [-180,180]" }, "address": { "type": "string", "description": "location，<=200 字" }, "data": { "description": "custom 任意 JSON" }, "mentionedInfo": { "$ref": "#/components/schemas/MentionedInfo", "description": "仅群聊/超级群" }, "quote": { "$ref": "#/components/schemas/Quote" }, "recallMessageId": { "type": "string", "description": "recall 占位" }, "operatorId": { "type": "string", "description": "recall 操作者" }, "systemType": { "type": "object", "x-idl-type": "SystemType", "description": "system 消息子类型" }, "extra": { "type": "string", "description": "system 消息扩展 JSON 字符串" }, "title": { "type": "string", "description": "combine：合并转发标题，必填、非空、<=64 字（IDL rev19）" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CombineItem" }, "description": "combine：合并转发条目，必填、1..=100 条、顺序即展示顺序；全部条目 text 合计 <=16KB（IDL rev19）" } }, "description": "消息内容联合体，按 type 取字段；服务端校验序列化后 <=5KB（1007）。", "required": [ "type" ] }, "CombineItem": { "type": "object", "properties": { "senderId": { "type": "string", "description": "原消息发送者 userId（非空）" }, "senderName": { "type": "string", "description": "发送者昵称，<=64 字" }, "contentType": { "type": "object", "x-idl-type": "ContentType", "description": "原消息 content.type（非空，取值见 ContentType 枚举）" }, "text": { "type": "string", "description": "摘要文本（非文本消息由客户端生成，如 `[图片]`）" }, "timestamp": { "type": "integer", "format": "int64", "description": "原消息时间戳 epoch ms（非负）" } }, "description": "合并转发条目（`Content.type='combine'` 的 items 元素）。字段固定、不可嵌套；服务端原样持久化与投递。", "required": [ "senderId", "contentType" ] }, "CombineContent": { "type": "object", "properties": { "type": { "type": "object", "x-idl-type": "ContentType", "description": "固定为 `combine`" }, "title": { "type": "string", "description": "标题，<=64 字" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/CombineItem" }, "description": "条目 1..=100，顺序即展示顺序" } }, "description": "合并转发内容（`Content.type='combine'` 的规范化视图；SDK `combineMessages` 的返回对象）。客户端 `sendMessage` 时作为 content 直接发送，服务端校验后原样落库并按普通消息投递。", "required": [ "type", "title", "items" ] }, "Message": { "type": "object", "properties": { "messageId": { "type": "string" }, "clientMsgId": { "type": "string" }, "conversationType": { "type": "object", "x-idl-type": "ConversationType" }, "targetId": { "type": "string" }, "channelId": { "type": "string", "description": "超级群频道 ID（IDL rev23）：conversationType=SUPER_GROUP 时可指定；仅该频道成员接收，历史按 channelId 过滤；为空表示群级消息。" }, "senderId": { "type": "string" }, "seq": { "type": "integer", "format": "uint64", "minimum": 0, "description": "会话内单调递增，服务端分配" }, "timestamp": { "type": "integer", "format": "int64", "description": "epoch ms" }, "content": { "$ref": "#/components/schemas/Content" }, "direction": { "type": "object", "x-idl-type": "Direction" } }, "required": [ "messageId", "conversationType", "targetId", "senderId", "seq", "timestamp", "content", "direction" ] }, "Conversation": { "type": "object", "properties": { "conversationType": { "type": "object", "x-idl-type": "ConversationType" }, "targetId": { "type": "string" }, "targetName": { "type": "string" }, "unreadCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "mentionedCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "lastMessage": { "$ref": "#/components/schemas/Message" }, "updatedAt": { "type": "integer", "format": "int64" }, "isPinned": { "type": "boolean" }, "draft": { "type": "string" }, "notificationLevel": { "type": "object", "x-idl-type": "NotificationLevel" }, "groupType": { "type": "object", "x-idl-type": "GroupType", "description": "IDL rev21（additive）：仅群会话有值——群存在时 \"normal\"|\"super\"，群已删除或非群会话为 null。用于客户端在会话列表标注超级群，不改变 conversationType（超级群仍是 GROUP=2）。" } }, "required": [ "conversationType", "targetId", "unreadCount", "updatedAt", "isPinned" ] }, "Group": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" }, "groupType": { "type": "object", "x-idl-type": "GroupType" }, "owner": { "type": "string" }, "ownerName": { "type": "string" }, "members": { "type": "array", "items": { "type": "string" } }, "memberCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "admins": { "type": "array", "items": { "type": "string" } }, "muted": { "type": "object", "additionalProperties": { "type": "integer", "format": "uint64", "minimum": 0 }, "x-idl-key-type": "string", "description": "userId -> mutedUntil epoch ms" }, "notice": { "type": "string" }, "avatarUrl": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "maxMembers": { "type": "integer", "format": "uint32", "minimum": 0 } }, "required": [ "groupId", "name", "groupType", "owner", "createdAt" ] }, "GroupMember": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "object", "x-idl-type": "GroupRole" }, "mutedUntil": { "type": "integer", "format": "uint64", "minimum": 0 }, "joinedAt": { "type": "integer", "format": "int64" } }, "required": [ "userId", "role" ] }, "Chatroom": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "memberCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "onlineCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "alive": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64" }, "destroyAt": { "type": "integer", "format": "int64" } }, "description": "聊天室：在线态会话，不落离线历史，默认只广播在线成员；保活/销毁由生命周期策略控制。", "required": [ "chatroomId", "name", "memberCount", "onlineCount", "alive", "createdAt" ] }, "ChatroomMember": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "online": { "type": "boolean" }, "joinedAt": { "type": "integer", "format": "int64" } }, "required": [ "userId", "online" ] }, "SupergroupChannel": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string", "description": "客户端 REST 创建时为服务端生成的 `ch_`（应用内唯一）；Open API 可由调用方指定。" }, "name": { "type": "string" }, "type": { "type": "object", "x-idl-type": "ChannelType", "description": "public：群成员可直接加入；private：需邀请（群主/管理员除外）。" }, "joinPolicy": { "type": "object", "x-idl-type": "JoinPolicy", "description": "由 type 推导：public→open、private→invite（不单独落库，客户端视图回显）。" }, "userIds": { "type": "array", "items": { "type": "string" }, "description": "频道成员（加入/离开由 join/leave 维护）。" }, "userGroupIds": { "type": "array", "items": { "type": "string" }, "description": "已绑定的用户组（与 UserGroup.channelIds 双向维护）。" } }, "description": "超级群频道（IDL rev21 C17，`domain` 类型对齐服务端 rev7 `ChannelState`）：群内的公开/私有子会话单元，可绑定用户组做批量可见性。", "required": [ "groupId", "channelId", "name", "type" ] }, "UserGroup": { "type": "object", "properties": { "groupId": { "type": "string" }, "userGroupId": { "type": "string" }, "name": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } }, "channelIds": { "type": "array", "items": { "type": "string" } } } }, "PushToken": { "type": "object", "properties": { "tokenId": { "type": "string" }, "userId": { "type": "string" }, "platform": { "type": "string", "description": "ios|android|web|huawei|xiaomi|oppo|vivo|fcm" }, "token": { "type": "string", "description": "厂商下发设备 token 原文（非服务端密钥）" }, "deviceId": { "type": "string" }, "appVersion": { "type": "string" }, "active": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "FriendRequest": { "type": "object", "properties": { "requestId": { "type": "string" }, "appkey": { "type": "string" }, "fromUserId": { "type": "string" }, "toUserId": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "object", "x-idl-type": "FriendRequestStatus" }, "fromName": { "type": "string" }, "toName": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" } }, "required": [ "requestId", "appkey", "fromUserId", "toUserId", "status", "createdAt", "updatedAt" ] }, "Friend": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "remark": { "type": "string" }, "online": { "type": "boolean" }, "blacklisted": { "type": "boolean" } }, "required": [ "userId" ] }, "BlacklistEntry": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "userId" ] }, "ReadReceipt": { "type": "object", "properties": { "conversationType": { "type": "object", "x-idl-type": "ConversationType" }, "targetId": { "type": "string" }, "readerId": { "type": "string" }, "messageIds": { "type": "array", "items": { "type": "string" } }, "readCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "uint32", "minimum": 0 }, "x-idl-key-type": "string" }, "totalMembers": { "type": "integer", "format": "uint32", "minimum": 0 }, "timestamp": { "type": "integer", "format": "int64" }, "readAt": { "type": "integer", "format": "int64" }, "unreadCounts": { "type": "object", "additionalProperties": { "type": "integer", "format": "uint32", "minimum": 0 }, "x-idl-key-type": "string" } }, "required": [ "conversationType", "targetId", "readerId", "messageIds", "timestamp" ] }, "MessageReadDetailItem": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "read": { "type": "object", "x-idl-type": "boolean" }, "readAt": { "type": "integer", "format": "int64" } }, "description": "已读详情名单项（`getMessageReadDetail` 返回的 items 元素）", "required": [ "userId", "name", "read" ] }, "MessageTrace": { "type": "object", "properties": { "messageId": { "type": "string" }, "conversationType": { "type": "object", "x-idl-type": "ConversationType" }, "targetId": { "type": "string" }, "senderId": { "type": "string" }, "seq": { "type": "integer", "format": "uint64", "minimum": 0 }, "status": { "type": "string", "description": "stored|delivered|offline_queued|routed|failed" }, "ackAt": { "type": "integer", "format": "int64" }, "deliveredSessions": { "type": "integer", "format": "uint32", "minimum": 0 }, "offlineQueued": { "type": "boolean" }, "routed": { "type": "boolean" }, "callbackDeliveries": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackDelivery" } } }, "description": "消息流转查询（控制台/运营后台）", "required": [ "messageId", "conversationType", "targetId", "senderId", "seq", "status" ] }, "CallbackConfig": { "type": "object", "properties": { "appkey": { "type": "string" }, "enabled": { "type": "boolean" }, "url": { "type": "string" }, "secret": { "type": "string", "description": "HMAC-SHA256 签名密钥；读取时脱敏" }, "events": { "type": "array", "items": { "type": "object", "x-idl-type": "CallbackEventType" } }, "retry": { "type": "object", "additionalProperties": true, "description": "{maxAttempts:1..5, backoffMs:1000..60000}" }, "updatedAt": { "type": "integer", "format": "int64" } }, "required": [ "appkey", "enabled", "events", "updatedAt" ] }, "CallbackDelivery": { "type": "object", "properties": { "deliveryId": { "type": "string" }, "appkey": { "type": "string" }, "eventType": { "type": "object", "x-idl-type": "CallbackEventType" }, "eventId": { "type": "string" }, "url": { "type": "string" }, "status": { "type": "string", "description": "pending|success|failed|dropped" }, "attempts": { "type": "integer", "format": "uint32", "minimum": 0 }, "responseCode": { "type": "integer", "format": "int32" }, "error": { "type": "string" }, "lastAttemptAt": { "type": "integer", "format": "int64" } }, "required": [ "deliveryId", "appkey", "eventType", "eventId", "url", "status", "attempts" ] }, "CallbackEnvelope": { "type": "object", "properties": { "eventType": { "type": "object", "x-idl-type": "CallbackEventType" }, "eventId": { "type": "string" }, "appkey": { "type": "string" }, "timestamp": { "type": "integer", "format": "int64" }, "nonce": { "type": "string" }, "data": {} }, "description": "服务端回调到应用服务器的统一信封；HTTP header X-IM-Signature = HMAC-SHA256(secret, timestamp + '.' + nonce + '.' + rawBody)", "required": [ "eventType", "eventId", "appkey", "timestamp", "nonce", "data" ] }, "ServiceActivation": { "type": "object", "properties": { "appkey": { "type": "string" }, "services": { "type": "object", "additionalProperties": { "type": "boolean" }, "x-idl-key-type": "ServiceKey" }, "quotas": { "type": "object", "additionalProperties": true, "description": "{maxGroupMembers,maxSuperGroupMembers,maxChatroomMembers,messageRatePerMinute}" }, "updatedAt": { "type": "integer", "format": "int64" } }, "required": [ "appkey", "services", "updatedAt" ] }, "AdminApp": { "type": "object", "properties": { "appkey": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "userCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "messageCount": { "type": "integer", "format": "uint64", "minimum": 0 }, "onlineCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "services": { "type": "object", "additionalProperties": { "type": "boolean" }, "x-idl-key-type": "ServiceKey" }, "callbackEnabled": { "type": "boolean" } }, "required": [ "appkey", "name", "createdAt" ] }, "OpsStats": { "type": "object", "properties": { "apps": { "type": "integer", "format": "uint32", "minimum": 0 }, "users": { "type": "integer", "format": "uint32", "minimum": 0 }, "messagesToday": { "type": "integer", "format": "uint64", "minimum": 0 }, "onlinePeakToday": { "type": "integer", "format": "uint32", "minimum": 0 }, "errorRate": { "type": "number", "format": "double" }, "trend": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{date, dau, messages, onlinePeak, errors}]" } }, "required": [ "apps", "users", "messagesToday", "onlinePeakToday" ] }, "ContractIntrospection": { "type": "object", "properties": { "idlVersion": { "type": "string" }, "routes": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{method,path,auth,handler,domain}]" }, "wsFrames": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{direction,type,since}]" }, "errorCodes": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "services": { "type": "array", "items": { "type": "object", "x-idl-type": "ServiceKey" } }, "callbackEvents": { "type": "array", "items": { "type": "object", "x-idl-type": "CallbackEventType" } } }, "description": "服务端契约自省端点（供契约校验器自动比对 IDL 与运行时）", "required": [ "idlVersion", "routes", "wsFrames", "errorCodes", "services", "callbackEvents" ] }, "ChatroomBanEntry": { "type": "object", "properties": { "userId": { "type": "string" }, "time": { "type": "string" } } }, "ChatroomBanList": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/ChatroomBanEntry" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomKeepaliveList": { "type": "object", "properties": { "chatroomIds": { "type": "array", "items": { "type": "string" } } } }, "ChatroomKeepaliveState": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "keepalive": { "type": "boolean" }, "destroyAt": { "type": "integer", "format": "int64" } } }, "ChatroomMemberExists": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userId": { "type": "string" }, "isInChrm": { "type": "boolean" } } }, "ChatroomMemberExistItem": { "type": "object", "properties": { "userId": { "type": "string" }, "isInChrm": { "type": "integer", "format": "int32" } } }, "ChatroomMembersExists": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "result": { "type": "array", "items": { "$ref": "#/components/schemas/ChatroomMemberExistItem" } } } }, "ChatroomMuteEntry": { "type": "object", "properties": { "userId": { "type": "string" }, "time": { "type": "string" } } }, "ChatroomMuteList": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/ChatroomMuteEntry" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomGlobalMute": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "mutedUntil": { "type": "integer", "format": "int64" } } }, "ChatroomGlobalMuteRemoveResult": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string" } }, "removed": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomGlobalMuteList": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/ChatroomMuteEntry" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomMessageWhitelist": { "type": "object", "properties": { "whitelistMsgType": { "type": "array", "items": { "type": "string" } } } }, "GroupMuteEntry": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "time": { "type": "string" } } }, "GroupMuteList": { "type": "object", "properties": { "groupId": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMuteEntry" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "UserGroupBrief": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "UserGroups": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupBrief" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomBroadcastResult": { "type": "object", "properties": { "fromUserId": { "type": "string" }, "objectName": { "type": "string" }, "chatroomCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "deliveredUsers": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "TokenInfo": { "type": "object", "properties": { "userId": { "type": "string" }, "token": { "type": "string" }, "expireAt": { "type": "integer", "format": "int64" } } }, "OnlineStatus": { "type": "object", "properties": { "userId": { "type": "string" }, "online": { "type": "boolean" }, "sessionCount": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "OnlineStatusBatch": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OnlineStatus" } } } }, "FriendList": { "type": "object", "properties": { "friends": { "type": "array", "items": { "$ref": "#/components/schemas/Friend" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "BlacklistList": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/BlacklistEntry" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "MessagePage": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "hasMore": { "type": "boolean" }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "SystemPublishResult": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/Message" }, "deliveredUsers": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ReadCount": { "type": "object", "properties": { "messageId": { "type": "string" }, "readCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "totalMembers": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "GroupMemberList": { "type": "object", "properties": { "groupId": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/GroupMember" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "GroupMemberChange": { "type": "object", "properties": { "groupId": { "type": "string" }, "added": { "type": "array", "items": { "type": "string" } }, "removed": { "type": "array", "items": { "type": "string" } }, "group": { "$ref": "#/components/schemas/Group" } } }, "ChatroomMemberList": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/ChatroomMember" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ConversationList": { "type": "object", "properties": { "conversations": { "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } } } }, "SensitiveWordConfig": { "type": "object", "properties": { "appkey": { "type": "string" }, "words": { "type": "array", "items": { "type": "string" } }, "action": { "type": "string" } } }, "CallbackDeliveryPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackDelivery" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" } } }, "AppStats": { "type": "object", "properties": { "appkey": { "type": "string" }, "users": { "type": "integer", "format": "uint32", "minimum": 0 }, "groups": { "type": "integer", "format": "uint32", "minimum": 0 }, "chatrooms": { "type": "integer", "format": "uint32", "minimum": 0 }, "messages": { "type": "integer", "format": "uint64", "minimum": 0 }, "online": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomKv": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "key": { "type": "string" }, "value": { "type": "string" }, "updatedAt": { "type": "integer", "format": "int64" }, "ttlMs": { "type": "integer", "format": "uint64", "minimum": 0 } } }, "ChatroomKvList": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "kv": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } } }, "ChatroomWhitelist": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } } }, "UserWhitelist": { "type": "object", "properties": { "userId": { "type": "string" }, "allowedUserIds": { "type": "array", "items": { "type": "string" } } } }, "UserTokenState": { "type": "object", "properties": { "userId": { "type": "string" }, "tokenVersion": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "UserBatch": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "missing": { "type": "array", "items": { "type": "string" } } } }, "MessageExpansion": { "type": "object", "properties": { "messageId": { "type": "string" }, "expansion": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } } }, "MessageCleanResult": { "type": "object", "properties": { "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "userId": { "type": "string" }, "cleared": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatMuteItem": { "type": "object", "properties": { "userId": { "type": "string" }, "targetUserId": { "type": "string" }, "mutedUntil": { "type": "integer", "format": "uint64", "minimum": 0 } } }, "ChatMuteList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChatMuteItem" } } } }, "UserTags": { "type": "object", "properties": { "userId": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } } }, "UserTagBatchResult": { "type": "object", "properties": { "updated": { "type": "integer", "format": "uint32", "minimum": 0 }, "failed": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "ConversationTagItem": { "type": "object", "properties": { "userId": { "type": "string" }, "tag": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" } } }, "ConversationTagRemoveResult": { "type": "object", "properties": { "userId": { "type": "string" }, "tag": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "removed": { "type": "boolean" } } }, "ConversationTagList": { "type": "object", "properties": { "userId": { "type": "string" }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationTag" } }, "total": { "type": "integer", "format": "int32" } } }, "ChatroomMuteAll": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "muted": { "type": "boolean" }, "operatorId": { "type": "string" }, "until": { "type": "integer", "format": "int64", "description": "到期时间 epoch ms；0=持续禁言" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "UserBanPage": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "UserDeleteResult": { "type": "object", "properties": { "userId": { "type": "string" }, "deleted": { "type": "boolean" } } }, "UserSubscription": { "type": "object", "properties": { "userId": { "type": "string" }, "subscribeUserIds": { "type": "array", "items": { "type": "string" } } } }, "FriendCheckResult": { "type": "object", "properties": { "userId": { "type": "string" }, "targetUserId": { "type": "string" }, "isFriend": { "type": "boolean" } } }, "FriendCleanResult": { "type": "object", "properties": { "userId": { "type": "string" }, "removed": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "FriendPermission": { "type": "object", "properties": { "userId": { "type": "string" }, "level": { "type": "string" } } }, "FriendProfile": { "type": "object", "properties": { "userId": { "type": "string" }, "targetUserId": { "type": "string" }, "name": { "type": "string" }, "extra": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } } }, "GroupBanWhitelist": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } } }, "GroupImportResult": { "type": "object", "properties": { "imported": { "type": "integer", "format": "uint32", "minimum": 0 }, "failed": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "UserGroupList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } } } }, "UserGroupDeleteResult": { "type": "object", "properties": { "groupId": { "type": "string" }, "userGroupId": { "type": "string" }, "deleted": { "type": "boolean" } } }, "UserGroupChannels": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelIds": { "type": "array", "items": { "type": "string" } } } }, "GroupMuteAll": { "type": "object", "properties": { "groupId": { "type": "string" }, "muted": { "type": "boolean" }, "operatorId": { "type": "string" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "MessageReaction": { "type": "object", "properties": { "messageId": { "type": "string" }, "userId": { "type": "string" }, "reaction": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" } } }, "ReactionRemoveResult": { "type": "object", "properties": { "messageId": { "type": "string" }, "userId": { "type": "string" }, "reaction": { "type": "string" }, "removed": { "type": "boolean" } } }, "ReactionItem": { "type": "object", "properties": { "reaction": { "type": "string" }, "count": { "type": "integer", "format": "uint32", "minimum": 0 }, "userIds": { "type": "array", "items": { "type": "string" } } } }, "MessageReactionSummary": { "type": "object", "properties": { "messageId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReactionItem" } } } }, "ReactionUsers": { "type": "object", "properties": { "messageId": { "type": "string" }, "reaction": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } } }, "ReactionBatchItem": { "type": "object", "properties": { "messageId": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReactionItem" } } } }, "ReactionBatch": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReactionBatchItem" } } } }, "UserDeactivation": { "type": "object", "properties": { "userId": { "type": "string" }, "deactivatedAt": { "type": "integer", "format": "int64" } } }, "UserDeactivationList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/UserDeactivation" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "Channel": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } }, "userGroupIds": { "type": "array", "items": { "type": "string" } } } }, "ChannelList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Channel" } } } }, "ChannelDeleteResult": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "deleted": { "type": "boolean" } } }, "ChannelMembers": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } } } }, "ChannelBinding": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "userGroupId": { "type": "string" }, "bound": { "type": "boolean" } } }, "ChannelBindingList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelBinding" } } } }, "ChatroomPriority": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "lowPriorityTypes": { "type": "array", "items": { "type": "string" } } } }, "StreamInfo": { "type": "object", "properties": { "streamId": { "type": "string" }, "messageId": { "type": "string" }, "status": { "type": "string" }, "text": { "type": "string" }, "chunks": { "type": "array", "items": { "type": "string" } } } }, "BroadcastResult": { "type": "object", "properties": { "broadcastId": { "type": "string" }, "deliveredUsers": { "type": "integer", "format": "uint32", "minimum": 0 }, "createdAt": { "type": "integer", "format": "int64" } } }, "BroadcastRecallResult": { "type": "object", "properties": { "broadcastId": { "type": "string" }, "recalled": { "type": "boolean" } } }, "PushResult": { "type": "object", "properties": { "pushId": { "type": "string" }, "scope": { "type": "string" }, "targets": { "type": "integer", "format": "uint32", "minimum": 0 }, "delivered": { "type": "integer", "format": "uint32", "minimum": 0 }, "createdAt": { "type": "integer", "format": "int64" } } }, "PushLog": { "type": "object", "properties": { "pushId": { "type": "string" }, "scope": { "type": "string" }, "target": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "delivered": { "type": "integer", "format": "uint32", "minimum": 0 }, "failed": { "type": "integer", "format": "uint32", "minimum": 0 }, "createdAt": { "type": "integer", "format": "int64" } } }, "PushLogPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PushLog" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "PushStats": { "type": "object", "properties": { "appkey": { "type": "string" }, "date": { "type": "string" }, "sent": { "type": "integer", "format": "uint64", "minimum": 0 }, "delivered": { "type": "integer", "format": "uint64", "minimum": 0 }, "failed": { "type": "integer", "format": "uint64", "minimum": 0 }, "trend": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{date,sent,delivered,failed}]" }, "source": { "type": "string" }, "channelStatsAvailable": { "type": "boolean" }, "tokenCounts": { "type": "object", "additionalProperties": true, "description": "{total,active,byPlatform:{ios:{active,total},...},perUserLimit}" }, "deliveryCounts": { "type": "object", "additionalProperties": true, "description": "{total,byStatus:{no_token,not_configured,queued,sent,failed},retentionLimit,retentionTruncated}" }, "adapters": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{platform,provider,status:'not_configured',sendImplemented,channelConfigStored,channelEnabled,reason}]" }, "sendImplemented": { "type": "boolean" }, "notes": { "type": "array", "items": { "type": "string" } } } }, "PushPeriod": { "type": "object", "properties": { "userId": { "type": "string" }, "startMinute": { "type": "integer", "format": "uint32", "minimum": 0 }, "endMinute": { "type": "integer", "format": "uint32", "minimum": 0 }, "enabled": { "type": "boolean" } } }, "PushPeriodRemoveResult": { "type": "object", "properties": { "userId": { "type": "string" }, "removed": { "type": "boolean" } } }, "PushRemark": { "type": "object", "properties": { "ownerId": { "type": "string" }, "targetId": { "type": "string" }, "scope": { "type": "string" }, "remark": { "type": "string" } } }, "PushRemarkRemoveResult": { "type": "object", "properties": { "ownerId": { "type": "string" }, "targetId": { "type": "string" }, "scope": { "type": "string" }, "removed": { "type": "boolean" } } }, "GroupFollow": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "targetUserId": { "type": "string" }, "followed": { "type": "boolean" } } }, "GroupFollowList": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "targetUserIds": { "type": "array", "items": { "type": "string" } } } }, "GroupKickAllResult": { "type": "object", "properties": { "userId": { "type": "string" }, "kicked": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "GroupRemark": { "type": "object", "properties": { "userId": { "type": "string" }, "groupId": { "type": "string" }, "remark": { "type": "string" } } }, "GroupRemarkRemoveResult": { "type": "object", "properties": { "userId": { "type": "string" }, "groupId": { "type": "string" }, "removed": { "type": "boolean" } } }, "Bot": { "type": "object", "properties": { "botId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" } } }, "BotList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Bot" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "BotDeleteResult": { "type": "object", "properties": { "botId": { "type": "string" }, "deleted": { "type": "boolean" } } }, "Agent": { "type": "object", "properties": { "agentId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "model": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" } } }, "AgentList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Agent" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "AgentDeleteResult": { "type": "object", "properties": { "agentId": { "type": "string" }, "deleted": { "type": "boolean" } } }, "AgentRestriction": { "type": "object", "properties": { "agentId": { "type": "string" }, "userId": { "type": "string" }, "level": { "type": "string" }, "reason": { "type": "string" } } }, "AgentRestrictionList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AgentRestriction" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "AgentRestrictionRemoveResult": { "type": "object", "properties": { "agentId": { "type": "string" }, "userId": { "type": "string" }, "removed": { "type": "boolean" } } }, "ChatroomRtc": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "rtcRoomId": { "type": "string" }, "bound": { "type": "boolean" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "AgentChatResult": { "type": "object", "properties": { "text": { "type": "string" }, "suggestions": { "type": "array", "items": { "type": "string" } }, "model": { "type": "string" }, "usage": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" } } }, "TranslateResult": { "type": "object", "properties": { "text": { "type": "string" }, "sourceLang": { "type": "string" }, "targetLang": { "type": "string" } } }, "ProxyChatState": { "type": "object", "properties": { "userId": { "type": "string" }, "agentId": { "type": "string" }, "enabled": { "type": "boolean" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "ProxyChatList": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ProxyChatState" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ModerationSyncResult": { "type": "object", "properties": { "userId": { "type": "string" }, "status": { "type": "string" }, "applied": { "type": "boolean" }, "reason": { "type": "string" } } }, "SensitiveWordAddResult": { "type": "object", "properties": { "word": { "type": "string" }, "replaceWord": { "type": "string" }, "added": { "type": "boolean" }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "action": { "type": "string" } } }, "SensitiveWordBatchAddResult": { "type": "object", "properties": { "added": { "type": "integer", "format": "uint32", "minimum": 0 }, "skipped": { "type": "integer", "format": "uint32", "minimum": 0 }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "action": { "type": "string" } } }, "SensitiveWordDeleteResult": { "type": "object", "properties": { "word": { "type": "string" }, "removed": { "type": "boolean" }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "SensitiveWordBatchDeleteResult": { "type": "object", "properties": { "removed": { "type": "integer", "format": "uint32", "minimum": 0 }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "StatusMessageUID": { "type": "object", "properties": { "userId": { "type": "string" }, "groupId": { "type": "string" }, "messageUID": { "type": "string" } } }, "StatusMessagePrivateResult": { "type": "object", "properties": { "online": { "type": "boolean" }, "messageUIDs": { "type": "array", "items": { "$ref": "#/components/schemas/StatusMessageUID" } }, "delivered": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "StatusMessageGroupResult": { "type": "object", "properties": { "messageUIDs": { "type": "array", "items": { "$ref": "#/components/schemas/StatusMessageUID" } }, "groups": { "type": "integer", "format": "uint32", "minimum": 0 }, "deliveredUsers": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "MessageAuditRecord": { "type": "object", "properties": { "messageId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "fromUserId": { "type": "string" }, "content": { "$ref": "#/components/schemas/Content" }, "timestamp": { "type": "integer", "format": "int64" } } }, "MessageHistoryPage": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageAuditRecord" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "size": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" } } }, "MessageHistoryDeleteResult": { "type": "object", "properties": { "from": { "type": "integer", "format": "int64" }, "to": { "type": "integer", "format": "int64" }, "deleted": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomEntryBatchSetResult": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "entryOwnerId": { "type": "string" }, "updated": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ChatroomEntryBatchRemoveResult": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "entryOwnerId": { "type": "string" }, "removed": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "JoinedGroup": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "count": { "type": "integer", "format": "uint32", "minimum": 0 }, "role": { "type": "integer", "format": "int32" }, "createTime": { "type": "integer", "format": "int64" }, "joinTime": { "type": "integer", "format": "int64" }, "portraitUrl": { "type": "string" }, "remarkName": { "type": "string" }, "groupProfile": { "type": "string" } } }, "JoinedGroupPage": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/JoinedGroup" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "size": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" }, "pageToken": { "type": "string" } } }, "GroupSyncItem": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" } } }, "GroupSyncResult": { "type": "object", "properties": { "userId": { "type": "string" }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GroupSyncItem" } }, "created": { "type": "integer", "format": "uint32", "minimum": 0 }, "joined": { "type": "integer", "format": "uint32", "minimum": 0 }, "left": { "type": "integer", "format": "uint32", "minimum": 0 }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ConversationTop": { "type": "object", "properties": { "top": { "type": "boolean" }, "topTime": { "type": "integer", "format": "int64" } } }, "ConversationMute": { "type": "object", "properties": { "mute": { "type": "integer", "format": "int32" } } }, "ConversationSettings": { "type": "object", "properties": { "draft": { "type": "string" }, "isPinned": { "type": "boolean" }, "mentionedCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "tags": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } }, "ConversationAttribute": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "unreadCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "notificationLevel": { "type": "integer", "format": "int32" }, "top": { "$ref": "#/components/schemas/ConversationTop" }, "mute": { "$ref": "#/components/schemas/ConversationMute" }, "settings": { "$ref": "#/components/schemas/ConversationSettings" }, "lastMessage": { "$ref": "#/components/schemas/Message" } } }, "SupergroupNotDisturb": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "scope": { "type": "string" }, "notdisturbLevel": { "type": "integer", "format": "int32" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "SupergroupGlobalBan": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "status": { "type": "boolean" }, "until": { "type": "integer", "format": "int64" }, "permanent": { "type": "boolean" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "SupergroupBanWhitelist": { "type": "object", "properties": { "groupId": { "type": "string" }, "userIds": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "pageSize": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "SupergroupBanWhitelistAdd": { "type": "object", "properties": { "groupId": { "type": "string" }, "added": { "type": "integer", "format": "uint32", "minimum": 0 }, "userIds": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "SupergroupBanWhitelistRemove": { "type": "object", "properties": { "groupId": { "type": "string" }, "removed": { "type": "integer", "format": "uint32", "minimum": 0 }, "userIds": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "SupergroupBannedMember": { "type": "object", "properties": { "userId": { "type": "string" }, "until": { "type": "integer", "format": "int64" }, "permanent": { "type": "boolean" } } }, "SupergroupUserBanList": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/SupergroupBannedMember" } }, "userIds": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "page": { "type": "integer", "format": "uint32", "minimum": 0 }, "pageSize": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "SupergroupUserBanAdd": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "added": { "type": "integer", "format": "uint32", "minimum": 0 }, "userIds": { "type": "array", "items": { "type": "string" } }, "until": { "type": "integer", "format": "int64" }, "permanent": { "type": "boolean" } } }, "SupergroupUserBanRemove": { "type": "object", "properties": { "groupId": { "type": "string" }, "channelId": { "type": "string" }, "removed": { "type": "integer", "format": "uint32", "minimum": 0 }, "userIds": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "SupergroupMemberExist": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "status": { "type": "boolean" } } }, "ConversationTypeNotification": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "notificationLevel": { "type": "integer", "format": "int32" }, "isMuted": { "type": "integer", "format": "int32" } } }, "BotDeliveryStatus": { "type": "object", "properties": { "eventType": { "type": "string" }, "status": { "type": "string" }, "delivered": { "type": "boolean" }, "attempts": { "type": "integer", "format": "uint32", "minimum": 0 }, "responseCode": { "type": "integer", "format": "int32" }, "error": { "type": "string" }, "at": { "type": "integer", "format": "int64" } } }, "BotIntegration": { "type": "object", "properties": { "botId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "description": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "callbackUrl": { "type": "string" }, "events": { "type": "array", "items": { "type": "string" } }, "enabled": { "type": "boolean" }, "secretMasked": { "type": "string" }, "secretSet": { "type": "boolean" }, "lastDelivery": { "type": "object", "additionalProperties": true }, "configured": { "type": "boolean" }, "deleted": { "type": "boolean" } } }, "BotIntegrationDelete": { "type": "object", "properties": { "botId": { "type": "string" }, "deleted": { "type": "boolean" } } }, "ConversationTag": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "tagName": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "conversationCount": { "type": "integer", "format": "int32" } } }, "ConversationTagDeleteResult": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "removed": { "type": "boolean" } } }, "ConversationTagMembershipResult": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "added": { "type": "integer", "format": "int32" }, "existing": { "type": "integer", "format": "int32" }, "removed": { "type": "integer", "format": "int32" }, "conversationCount": { "type": "integer", "format": "int32" } } }, "ConversationTagConversationItem": { "type": "object", "properties": { "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "top": { "type": "boolean" }, "addedAt": { "type": "integer", "format": "int64" }, "unreadCount": { "type": "integer", "format": "int32" }, "lastMessageAt": { "type": "integer", "format": "int64" } } }, "ConversationTagConversationsPage": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationTagConversationItem" } } } }, "ConversationTagUnread": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "unreadCount": { "type": "integer", "format": "int32" }, "unreadConversations": { "type": "integer", "format": "int32" }, "conversationCount": { "type": "integer", "format": "int32" } } }, "ConversationTagTopResult": { "type": "object", "properties": { "userId": { "type": "string" }, "tagId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "top": { "type": "boolean" } } }, "ConversationDeleteResult": { "type": "object", "properties": { "userId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" }, "removed": { "type": "boolean" }, "messagesRetained": { "type": "boolean" } } }, "ConversationRef": { "type": "object", "properties": { "conversationType": { "type": "integer", "format": "int32" }, "targetId": { "type": "string" } } }, "AdminAppSecret": { "type": "object", "properties": { "appkey": { "type": "string" }, "name": { "type": "string" }, "appSecret": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" } } }, "AdminUserPage": { "type": "object", "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "online": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "AdminUserDetail": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "avatarUrl": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "online": { "type": "boolean" }, "sessionCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "banned": { "type": "boolean" }, "mutedUntil": { "type": "integer", "format": "uint64", "minimum": 0 }, "tokenVersion": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "MetricsOverview": { "type": "object", "properties": { "appkey": { "type": "string" }, "today": { "$ref": "#/components/schemas/OpsStats" }, "days": { "$ref": "#/components/schemas/OpsStats" } } }, "AdminGroupPage": { "type": "object", "properties": { "groups": { "type": "array", "items": { "$ref": "#/components/schemas/Group" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "ConnectionPage": { "type": "object", "properties": { "connections": { "type": "array", "items": { "$ref": "#/components/schemas/Connection" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "Connection": { "type": "object", "properties": { "userId": { "type": "string" }, "sessionId": { "type": "string" }, "appkey": { "type": "string" }, "connectedAt": { "type": "integer", "format": "int64" }, "lastHeartbeatAt": { "type": "integer", "format": "int64" }, "device": { "type": "string" } } }, "ConnectionStats": { "type": "object", "properties": { "onlineUsers": { "type": "integer", "format": "uint32", "minimum": 0 }, "sessions": { "type": "integer", "format": "uint32", "minimum": 0 }, "peakToday": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "PushConfig": { "type": "object", "properties": { "appkey": { "type": "string" }, "enabled": { "type": "boolean" }, "webhookUrl": { "type": "string" } } }, "ApiMetadata": { "type": "object", "properties": { "idlVersion": { "type": "string" }, "operations": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{operationId,method,path,summary,params:[{name,type,required}]}]" } } }, "AdminBatchRegisterResult": { "type": "object", "properties": { "created": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "failed": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{userId,reason}]" }, "total": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "MessageExport": { "type": "object", "properties": { "format": { "type": "string" }, "count": { "type": "integer", "format": "uint32", "minimum": 0 }, "csv": { "type": "string" } } }, "ChatroomDestroyResult": { "type": "object", "properties": { "chatroomId": { "type": "string" }, "destroyed": { "type": "boolean" }, "reason": { "type": "string" } } }, "AuditEntry": { "type": "object", "properties": { "id": { "type": "integer", "format": "uint64", "minimum": 0 }, "timestamp": { "type": "integer", "format": "int64" }, "actor": { "type": "string" }, "action": { "type": "string" }, "appkey": { "type": "string" }, "object": { "type": "string" }, "result": { "type": "string", "description": "success | failure | partial" }, "detail": { "type": "string" }, "ip": { "type": "string", "description": "自托管单令牌模式不记录来源 IP，保留空串" } } }, "AdminAuditPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEntry" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" } } }, "FeatureConfig": { "type": "object", "properties": { "appkey": { "type": "string" }, "features": { "type": "object", "additionalProperties": { "type": "boolean" }, "x-idl-key-type": "string", "description": "friend/group/chatroom/push/sensitiveWord/messageCallbacks" }, "mapping": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string", "description": "开关 -> 既有数据源（services.* / app.pushEnabled）" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "RateLimitConfig": { "type": "object", "properties": { "appkey": { "type": "string" }, "enabled": { "type": "boolean" }, "overrides": { "type": "object", "additionalProperties": { "type": "integer", "format": "uint32", "minimum": 0 }, "x-idl-key-type": "string", "description": "operationId -> qps" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "PushTestResult": { "type": "object", "properties": { "appkey": { "type": "string" }, "userId": { "type": "string" }, "delivered": { "type": "boolean" }, "attempts": { "type": "integer", "format": "uint32", "minimum": 0 }, "statusCode": { "type": "integer", "format": "uint32", "minimum": 0, "description": "webhook 非 2xx 时的状态码；2xx 成功时不透出（null）" }, "error": { "type": "string" }, "webhookUrl": { "type": "string" }, "timestamp": { "type": "integer", "format": "int64" } } }, "AppLifecycle": { "type": "object", "properties": { "appkey": { "type": "string" }, "deleted": { "type": "boolean" }, "deletedAt": { "type": "integer", "format": "int64" }, "deletedBy": { "type": "string" }, "reason": { "type": "string" }, "restoredAt": { "type": "integer", "format": "int64" }, "disabled": { "type": "boolean", "description": "与 app.disabled 同源：删除后 Open API/WS 返回 1017" }, "dataRetained": { "type": "boolean" } } }, "AdminAccount": { "type": "object", "properties": { "accountId": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string", "description": "owner | admin | operator | viewer" }, "disabled": { "type": "boolean" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "lastUsedAt": { "type": "integer", "format": "int64" }, "createdBy": { "type": "string" } } }, "AdminAccountPage": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/AdminAccount" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "roles": { "type": "array", "items": { "type": "string" } }, "caller": { "type": "object", "additionalProperties": true, "description": "{actor, role, root}" } } }, "AdminAccountToken": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/AdminAccount" }, "token": { "type": "string", "description": "仅本次返回；服务端只存 SHA-256 摘要" }, "tokenIssuedAt": { "type": "integer", "format": "int64" } } }, "ModerationTask": { "type": "object", "properties": { "taskId": { "type": "string" }, "appkey": { "type": "string" }, "messageId": { "type": "string", "description": "replace 模式已入库消息 id；block 模式为空" }, "senderId": { "type": "string" }, "targetId": { "type": "string" }, "conversationType": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "matchedWords": { "type": "array", "items": { "type": "string" } }, "action": { "type": "string", "description": "blocked | replaced" }, "status": { "type": "string", "description": "pending | approved | rejected" }, "createdAt": { "type": "integer", "format": "int64" }, "decidedAt": { "type": "integer", "format": "int64" }, "decidedBy": { "type": "string" }, "reason": { "type": "string" }, "blocked": { "type": "boolean", "description": "reject 后是否已标记已入库消息" } } }, "ModerationTaskPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ModerationTask" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" }, "counts": { "type": "object", "additionalProperties": true, "description": "{pending, approved, rejected, all}" } } }, "AlertRule": { "type": "object", "properties": { "metric": { "type": "string" }, "threshold": { "type": "number", "format": "float", "description": "计数阈值；online_drop 为窗口内在线回落人数" }, "windowSec": { "type": "integer", "format": "uint32", "minimum": 0, "description": "评估窗口（1..=86400 秒）" }, "webhookUrl": { "type": "string" }, "enabled": { "type": "boolean" } } }, "AlertRules": { "type": "object", "properties": { "appkey": { "type": "string" }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/AlertRule" } }, "metrics": { "type": "array", "items": { "type": "string" } }, "updatedAt": { "type": "integer", "format": "int64" } } }, "AlertEvent": { "type": "object", "properties": { "eventId": { "type": "string" }, "appkey": { "type": "string" }, "metric": { "type": "string" }, "threshold": { "type": "number", "format": "float" }, "observed": { "type": "number", "format": "float" }, "windowSec": { "type": "integer", "format": "uint32", "minimum": 0 }, "triggeredAt": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "delivered": { "type": "boolean" }, "webhookStatus": { "type": "integer", "format": "int32", "description": "0=未配置/未投递；其余为 HTTP 状态码" }, "webhookError": { "type": "string" } } }, "AlertEventPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AlertEvent" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" }, "counters": { "type": "object", "additionalProperties": true, "description": "{rateLimited, callbackFailure, error5xx, online, onlineDrop}（近 300s）" } } }, "AdminGroupDetail": { "type": "object", "properties": { "groupId": { "type": "string" }, "name": { "type": "string" }, "owner": { "type": "string" }, "ownerName": { "type": "string" }, "notice": { "type": "string" }, "groupType": { "type": "string" }, "joinPolicy": { "type": "string" }, "memberCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "adminCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "onlineMembers": { "type": "integer", "format": "uint32", "minimum": 0 }, "mutedMembers": { "type": "integer", "format": "uint32", "minimum": 0 }, "maxMembers": { "type": "integer", "format": "uint32", "minimum": 0 }, "admins": { "type": "array", "items": { "type": "string" } }, "muted": { "type": "object", "additionalProperties": { "type": "integer", "format": "int64" }, "x-idl-key-type": "string" }, "muteAll": { "$ref": "#/components/schemas/AdminGroupMuteAll" }, "ext": { "type": "object", "additionalProperties": { "type": "string" }, "x-idl-key-type": "string" }, "membersPreview": { "type": "array", "items": { "$ref": "#/components/schemas/AdminGroupMember" } }, "stats": { "type": "object", "additionalProperties": true, "description": "{groupMessages}" }, "createdAt": { "type": "integer", "format": "int64" } } }, "AdminGroupMember": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string", "description": "owner | admin | member" }, "online": { "type": "boolean" }, "muted": { "type": "boolean" }, "mutedUntil": { "type": "integer", "format": "int64" }, "testUser": { "type": "boolean" } } }, "AdminGroupMemberPage": { "type": "object", "properties": { "groupId": { "type": "string" }, "members": { "type": "array", "items": { "$ref": "#/components/schemas/AdminGroupMember" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" }, "muteAll": { "$ref": "#/components/schemas/AdminGroupMuteAll" } } }, "AdminGroupMemberMutation": { "type": "object", "properties": { "groupId": { "type": "string" }, "userId": { "type": "string" }, "muted": { "type": "boolean" }, "mutedUntil": { "type": "integer", "format": "int64" }, "durationSec": { "type": "integer", "format": "uint32", "minimum": 0 }, "removed": { "type": "boolean" }, "memberCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "operator": { "type": "string" }, "enforced": { "type": "boolean" } } }, "AdminGroupMuteAll": { "type": "object", "properties": { "muted": { "type": "boolean" }, "storedMuted": { "type": "boolean" }, "until": { "type": "integer", "format": "int64" }, "operatorId": { "type": "string" }, "updatedAt": { "type": "integer", "format": "int64" } } }, "AdminGroupMutation": { "type": "object", "properties": { "groupId": { "type": "string" }, "dismissed": { "type": "boolean" }, "owner": { "type": "string" }, "previousOwner": { "type": "string" }, "memberCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "operator": { "type": "string" }, "group": { "type": "object", "additionalProperties": true, "description": "Group 视图" } } }, "AdminBanEntry": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "banned": { "type": "boolean" }, "deactivated": { "type": "boolean" }, "reason": { "type": "string" }, "operator": { "type": "string" }, "bannedAt": { "type": "integer", "format": "int64" }, "until": { "type": "integer", "format": "int64" }, "durationSec": { "type": "integer", "format": "uint32", "minimum": 0 }, "expiresInSec": { "type": "integer", "format": "uint32", "minimum": 0 }, "action": { "type": "string" }, "at": { "type": "integer", "format": "int64" }, "enforced": { "type": "boolean" } } }, "AdminBanHistory": { "type": "object", "properties": { "id": { "type": "integer", "format": "uint64", "minimum": 0 }, "userId": { "type": "string" }, "action": { "type": "string", "description": "ban | unban | deactivate | restore | expire" }, "reason": { "type": "string" }, "operator": { "type": "string" }, "at": { "type": "integer", "format": "int64" }, "until": { "type": "integer", "format": "int64" }, "durationSec": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "AdminBanPage": { "type": "object", "properties": { "appkey": { "type": "string" }, "status": { "type": "string" }, "bans": { "type": "array", "items": { "$ref": "#/components/schemas/AdminBanEntry" } }, "activeTotal": { "type": "integer", "format": "uint32", "minimum": 0 }, "deactivated": { "type": "array", "items": { "$ref": "#/components/schemas/AdminBanEntry" } }, "deactivatedTotal": { "type": "integer", "format": "uint32", "minimum": 0 }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/AdminBanHistory" } }, "historyTotal": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" } } }, "AdminTestUser": { "type": "object", "properties": { "userId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "online": { "type": "boolean" }, "testUser": { "type": "boolean" }, "markedAt": { "type": "integer", "format": "int64" }, "markedBy": { "type": "string" } } }, "AdminTestUserPage": { "type": "object", "properties": { "appkey": { "type": "string" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/AdminTestUser" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "limitConfigured": { "type": "integer", "format": "uint32", "minimum": 0 }, "limitDefault": { "type": "integer", "format": "uint32", "minimum": 0 }, "limitMax": { "type": "integer", "format": "uint32", "minimum": 0 }, "usage": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" } } }, "AdminTestUserLimit": { "type": "object", "properties": { "appkey": { "type": "string" }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "usage": { "type": "integer", "format": "uint32", "minimum": 0 }, "remaining": { "type": "integer", "format": "int64" }, "limitDefault": { "type": "integer", "format": "uint32", "minimum": 0 }, "limitMax": { "type": "integer", "format": "uint32", "minimum": 0 } } }, "AdminStatsDimensions": { "type": "object", "properties": { "appkey": { "type": "string" }, "generatedAt": { "type": "integer", "format": "int64" }, "days": { "type": "integer", "format": "uint32", "minimum": 0 }, "totals": { "type": "object", "additionalProperties": true, "description": "{users,groups,groupMessages,chatrooms,chatroomMessages,messages,online}" }, "trend": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "[{date,dau,messages,groupMessages,chatroomMessages,onlinePeak,errors}]" }, "dimensions": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "array", "items": { "type": "string" } } } }, "PushChannelSet": { "type": "object", "properties": { "appkey": { "type": "string" }, "channels": { "type": "object", "additionalProperties": true, "description": "{apns,fcm,huawei,xiaomi,oppo,vivo} -> {enabled,fields,secretsSet,configured,missingFields,updatedAt,updatedBy}" }, "supported": { "type": "array", "items": { "type": "string" } }, "updatedAt": { "type": "integer", "format": "int64" }, "storage": { "type": "string" }, "deliveryImplemented": { "type": "boolean" } } }, "PushChannelTest": { "type": "object", "properties": { "appkey": { "type": "string" }, "channel": { "type": "string" }, "configured": { "type": "boolean" }, "enabled": { "type": "boolean" }, "missingFields": { "type": "array", "items": { "type": "string" } }, "implemented": { "type": "boolean" }, "delivered": { "type": "boolean" }, "reason": { "type": "string" }, "at": { "type": "integer", "format": "int64" } } }, "TranslationConfig": { "type": "object", "properties": { "appkey": { "type": "string" }, "enabled": { "type": "boolean" }, "provider": { "type": "string", "description": "none | http（mock 已弃用）" }, "sourceLang": { "type": "string" }, "targetLangs": { "type": "array", "items": { "type": "string" } }, "endpoint": { "type": "string" }, "updatedAt": { "type": "integer", "format": "int64" }, "configured": { "type": "boolean", "description": "运行时以 IM_TRANSLATE_ENDPOINT 为准" }, "storedConfigured": { "type": "boolean" }, "runtimeSource": { "type": "string", "description": "env | unconfigured" }, "mockDeprecated": { "type": "boolean" }, "notes": { "type": "array", "items": { "type": "string" } } } }, "BotIntegrationPage": { "type": "object", "properties": { "appkey": { "type": "string" }, "bots": { "type": "array", "items": { "$ref": "#/components/schemas/BotIntegration" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" }, "events": { "type": "array", "items": { "type": "string" } } } }, "EmbedToken": { "type": "object", "properties": { "token": { "type": "string" }, "appkey": { "type": "string" }, "appName": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "integer", "format": "int64" }, "expiresAt": { "type": "integer", "format": "int64" }, "ttlSec": { "type": "integer", "format": "uint32", "minimum": 0 }, "oneTime": { "type": "boolean" }, "used": { "type": "boolean" }, "createdBy": { "type": "string" }, "sessionPath": { "type": "string" }, "embedUrl": { "type": "string" }, "origin": { "type": "string" }, "securityNotes": { "type": "array", "items": { "type": "string" } } } }, "PushTokenPage": { "type": "object", "properties": { "appkey": { "type": "string" }, "tokens": { "type": "array", "items": { "$ref": "#/components/schemas/PushToken" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" }, "platforms": { "type": "array", "items": { "type": "string" } }, "filters": { "type": "object", "additionalProperties": true }, "perUserLimit": { "type": "integer", "format": "uint32", "minimum": 0 }, "source": { "type": "string" } } }, "PushDeliveryAttempt": { "type": "object", "properties": { "attempt": { "type": "integer", "format": "uint32", "minimum": 0 }, "status": { "type": "string" }, "provider": { "type": "string" }, "error": { "type": "string" }, "at": { "type": "integer", "format": "int64" } } }, "PushDelivery": { "type": "object", "properties": { "deliveryId": { "type": "string" }, "userId": { "type": "string" }, "tokenId": { "type": "string" }, "platform": { "type": "string" }, "status": { "type": "string", "description": "no_token | not_configured | queued | sent | failed" }, "provider": { "type": "string" }, "attempts": { "type": "integer", "format": "uint32", "minimum": 0 }, "error": { "type": "string" }, "createdAt": { "type": "integer", "format": "int64" }, "updatedAt": { "type": "integer", "format": "int64" }, "title": { "type": "string" }, "body": { "type": "string" }, "extras": { "type": "object", "additionalProperties": true }, "retryOf": { "type": "string" }, "attemptLog": { "type": "array", "items": { "$ref": "#/components/schemas/PushDeliveryAttempt" } } } }, "PushDeliveryPage": { "type": "object", "properties": { "appkey": { "type": "string" }, "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/PushDelivery" } }, "total": { "type": "integer", "format": "uint32", "minimum": 0 }, "offset": { "type": "integer", "format": "uint32", "minimum": 0 }, "limit": { "type": "integer", "format": "uint32", "minimum": 0 }, "hasMore": { "type": "boolean" }, "statuses": { "type": "array", "items": { "type": "string" } }, "counts": { "type": "object", "additionalProperties": true }, "filters": { "type": "object", "additionalProperties": true }, "retryableStatuses": { "type": "array", "items": { "type": "string" } } } }, "PushDeliveryCreateResult": { "type": "object", "properties": { "appkey": { "type": "string" }, "requested": { "type": "integer", "format": "uint32", "minimum": 0 }, "userIds": { "type": "array", "items": { "type": "string" } }, "deliveries": { "type": "array", "items": { "$ref": "#/components/schemas/PushDelivery" } }, "counts": { "type": "object", "additionalProperties": true }, "sent": { "type": "integer", "format": "uint32", "minimum": 0 }, "delivered": { "type": "integer", "format": "uint32", "minimum": 0 }, "notConfigured": { "type": "integer", "format": "uint32", "minimum": 0 }, "noToken": { "type": "integer", "format": "uint32", "minimum": 0 }, "adapters": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "notes": { "type": "array", "items": { "type": "string" } } } } } }, "x-idl-source": "ni-paas-idl", "x-idl-operation-count": 230 }