{ "info": { "name": "NI PaaS IM Open API", "description": "由平台契约自动生成（Postman Collection v2.1）。\n使用前把集合变量 host / appKey / appSecret 改成自己的值；Nonce / Timestamp / Signature 由集合级前置脚本自动计算。\n共 230 个接口，按能力分 20 个文件夹。\n契约变更后通过发布流程重新生成。", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "host", "value": "http://127.0.0.1:8080", "type": "string" }, { "key": "appKey", "value": "demo", "type": "string" }, { "key": "appSecret", "value": "YOUR_APP_SECRET", "type": "string" }, { "key": "nonce", "value": "", "type": "string" }, { "key": "timestamp", "value": "", "type": "string" }, { "key": "signature", "value": "", "type": "string" } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "// 由 generate.mjs 生成的集合级前置脚本：自动计算 App-Key 签名。", "// Signature = hex(sha1(AppSecret + Nonce + Timestamp))，与服务端实现一致。", "const CryptoJS = require('crypto-js');", "", "const appSecret = pm.collectionVariables.get('appSecret') || '';", "const nonce = CryptoJS.lib.WordArray.random(8).toString(); // 16 位 hex，满足 8-64 字符", "const timestamp = String(Date.now());", "", "pm.collectionVariables.set('nonce', nonce);", "pm.collectionVariables.set('timestamp', timestamp);", "pm.collectionVariables.set('signature', CryptoJS.SHA1(appSecret + nonce + timestamp).toString());" ] } } ], "item": [ { "name": "用户", "description": "domain: user（33 个接口）", "item": [ { "name": "注册用户；userId 幂等（已存在则更新 name/avatarUrl 并返回现有用户）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"name\": \"Alice\",\n \"avatarUrl\": \"https://cdn.example.com/avatar/alice.png\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/register", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "register" ] }, "description": "operationId: user.register\n注册用户；userId 幂等（已存在则更新 name/avatarUrl 并返回现有用户）。\n自版本: 1.0.0\n可能错误码: 1001, 1016\n幂等：是" }, "response": [] }, { "name": "更新用户资料。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"name\": \"Alice\",\n \"avatarUrl\": \"https://cdn.example.com/avatar/alice.png\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/update", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "update" ] }, "description": "operationId: user.update\n更新用户资料。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1016" }, "response": [] }, { "name": "查询用户。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "get" ] }, "description": "operationId: user.get\n查询用户。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "签发用户 JWT（供客户端 SDK connect 使用），有效期 7 天。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/token/issue", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "token", "issue" ] }, "description": "operationId: user.token.issue\n签发用户 JWT（供客户端 SDK connect 使用），有效期 7 天。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1016" }, "response": [] }, { "name": "查询用户在线状态。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/online/check", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "online", "check" ] }, "description": "operationId: user.online.check\n查询用户在线状态。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "封禁/解封用户；封禁后在线连接被 kick，新连接返回 1016。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"banned\": true,\n \"reason\": \"offline\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/ban", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "ban" ] }, "description": "operationId: user.ban\n封禁/解封用户；封禁后在线连接被 kick，新连接返回 1016。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "用户私聊白名单：仅白名单用户可给该用户发私聊（空表示不启用）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"allowedUserIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/whitelist/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "whitelist", "add" ] }, "description": "operationId: user.whitelist.add\n用户私聊白名单：仅白名单用户可给该用户发私聊（空表示不启用）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "用户私聊白名单：移除。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"allowedUserIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/whitelist/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "whitelist", "remove" ] }, "description": "operationId: user.whitelist.remove\n用户私聊白名单：移除。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "用户私聊白名单：查询。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/whitelist/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "whitelist", "list" ] }, "description": "operationId: user.whitelist.list\n用户私聊白名单：查询。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "主动作废用户全部客户端 token（tokenVersion++，旧 JWT 立即失效）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/token/revoke", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "token", "revoke" ] }, "description": "operationId: user.token.revoke\n主动作废用户全部客户端 token（tokenVersion++，旧 JWT 立即失效）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "批量获取用户资料（上限 100；不存在的 userId 返回在 missing）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/batch/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "batch", "get" ] }, "description": "operationId: user.batch.get\n批量获取用户资料（上限 100；不存在的 userId 返回在 missing）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "设置/解除单聊禁言（mutedUntil=0 解除；禁言后该用户向目标发私聊返回 1009）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"targetUserId\": \"string\",\n \"mutedUntil\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/chat/mute", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "chat", "mute" ] }, "description": "operationId: user.chat.mute\n设置/解除单聊禁言（mutedUntil=0 解除；禁言后该用户向目标发私聊返回 1009）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "查询用户的单聊禁言列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/chat/mute/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "chat", "mute", "list" ] }, "description": "operationId: user.chat.mute.list\n查询用户的单聊禁言列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置用户标签（全量覆盖，最多 20 个，每个 ≤32 字符）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tags\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/tag/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "tag", "set" ] }, "description": "operationId: user.tag.set\n设置用户标签（全量覆盖，最多 20 个，每个 ≤32 字符）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "获取用户标签。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/tag/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "tag", "get" ] }, "description": "operationId: user.tag.get\n获取用户标签。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "批量设置用户标签（上限 100 条，返回 updated/failed）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/tag/batch/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "tag", "batch", "set" ] }, "description": "operationId: user.tag.batch.set\n批量设置用户标签（上限 100 条，返回 updated/failed）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "获取封禁用户列表（分页）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/ban/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "ban", "list" ] }, "description": "operationId: user.ban.list\n获取封禁用户列表（分页）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "删除用户（开发/测试环境；物理删除用户及其会话关系）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "delete" ] }, "description": "operationId: user.delete\n删除用户（开发/测试环境；物理删除用户及其会话关系）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "清理用户托管资料（保留 userId，清空 name/avatarUrl 等自定义字段）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/profile/clean", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "profile", "clean" ] }, "description": "operationId: user.profile.clean\n清理用户托管资料（保留 userId，清空 name/avatarUrl 等自定义字段）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置用户订阅关系（全量覆盖，最多 100 个）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"subscribeUserIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/subscription/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "subscription", "set" ] }, "description": "operationId: user.subscription.set\n设置用户订阅关系（全量覆盖，最多 100 个）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "查询用户订阅关系。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/subscription/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "subscription", "get" ] }, "description": "operationId: user.subscription.get\n查询用户订阅关系。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "注销用户（合规能力：保留记录但禁止登录/收发，踢下线）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/deactivate", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "deactivate" ] }, "description": "operationId: user.deactivate\n注销用户（合规能力：保留记录但禁止登录/收发，踢下线）。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1016" }, "response": [] }, { "name": "重新激活已注销用户。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/reactivate", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "reactivate" ] }, "description": "operationId: user.reactivate\n重新激活已注销用户。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询已注销用户列表（分页）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/deactivated/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "deactivated", "list" ] }, "description": "operationId: user.deactivated.list\n查询已注销用户列表（分页）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "设置用户推送免打扰时段（startMinute/endMinute 为当天分钟数 0-1439）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"startMinute\": 0,\n \"endMinute\": 0,\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/push/period/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "push", "period", "set" ] }, "description": "operationId: user.push.period.set\n设置用户推送免打扰时段（startMinute/endMinute 为当天分钟数 0-1439）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "查询用户推送免打扰时段。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/push/period/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "push", "period", "get" ] }, "description": "operationId: user.push.period.get\n查询用户推送免打扰时段。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "删除用户推送免打扰时段。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/push/period/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "push", "period", "remove" ] }, "description": "operationId: user.push.period.remove\n删除用户推送免打扰时段。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "将指定用户踢出其加入的所有群组（应用管理员操作）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/group/kick-all", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "group", "kick-all" ] }, "description": "operationId: user.group.kickAll\n将指定用户踢出其加入的所有群组（应用管理员操作）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "开启用户代聊（绑定 Agent，收到私聊时由 Agent 自动回复；回复生成依赖 AI 端点）。覆盖融云 /v3/user/proxychat/start。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"agentId\": \"string\",\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/proxychat/start", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "proxychat", "start" ] }, "description": "operationId: user.proxychat.start\n开启用户代聊（绑定 Agent，收到私聊时由 Agent 自动回复；回复生成依赖 AI 端点）。覆盖融云 /v3/user/proxychat/start。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "停止用户代聊。覆盖融云 /v3/user/proxychat/stop。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/proxychat/stop", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "proxychat", "stop" ] }, "description": "operationId: user.proxychat.stop\n停止用户代聊。覆盖融云 /v3/user/proxychat/stop。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询用户代聊列表（userId 省略返回应用全部）。覆盖融云 /v3/user/proxychat/query。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/proxychat/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "proxychat", "list" ] }, "description": "operationId: user.proxychat.list\n查询用户代聊列表（userId 省略返回应用全部）。覆盖融云 /v3/user/proxychat/query。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "接收托管资料审核结果并落库（approved/rejected；rejected 可回滚指定资料字段）。覆盖融云 /user/profile/sync。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"status\": \"pending\",\n \"reason\": \"offline\",\n \"fields\": {\n \"key\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/profile/moderation/sync", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "profile", "moderation", "sync" ] }, "description": "operationId: user.profile.moderation.sync\n接收托管资料审核结果并落库（approved/rejected；rejected 可回滚指定资料字段）。覆盖融云 /user/profile/sync。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询用户所在的群组（page/size 分页；page 缺省或 0 返回前 5000 个）。覆盖融云 /user/group/query.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"page\": 0,\n \"size\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/user/group/query", "host": [ "{{host}}" ], "path": [ "im", "v2", "user", "group", "query" ] }, "description": "operationId: user.groups.list\n查询用户所在的群组（page/size 分页；page 缺省或 0 返回前 5000 个）。覆盖融云 /user/group/query.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] } ] }, { "name": "好友关系链", "description": "domain: friend（8 个接口）", "item": [ { "name": "直接建立双向好友关系（应用服务器代操作，不经过申请流程）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"friendId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "add" ] }, "description": "operationId: friend.add\n直接建立双向好友关系（应用服务器代操作，不经过申请流程）。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1011\n幂等：是" }, "response": [] }, { "name": "删除双向好友关系。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"friendId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "remove" ] }, "description": "operationId: friend.remove\n删除双向好友关系。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "好友列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "list" ] }, "description": "operationId: friend.list\n好友列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "检查两人是否为好友关系。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"targetUserId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/check", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "check" ] }, "description": "operationId: friend.check\n检查两人是否为好友关系。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "批量清理好友关系（单向/双向）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"targetUserIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/clean", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "clean" ] }, "description": "operationId: friend.clean\n批量清理好友关系（单向/双向）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置添加好友验证等级（open=无需验证 / verify=需验证 / closed=禁止）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"level\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/permission/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "permission", "set" ] }, "description": "operationId: friend.permission.set\n设置添加好友验证等级（open=无需验证 / verify=需验证 / closed=禁止）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "查询添加好友验证等级。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/permission/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "permission", "get" ] }, "description": "operationId: friend.permission.get\n查询添加好友验证等级。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置好友自定义属性（备注名/扩展字段，仅本人可见）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"targetUserId\": \"string\",\n \"name\": \"Alice\",\n \"extra\": {\n \"key\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/friend/profile/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "friend", "profile", "set" ] }, "description": "operationId: friend.profile.set\n设置好友自定义属性（备注名/扩展字段，仅本人可见）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] } ] }, { "name": "黑名单", "description": "domain: blacklist（3 个接口）", "item": [ { "name": "加入黑名单（幂等）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"targetId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/blacklist/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "blacklist", "add" ] }, "description": "operationId: blacklist.add\n加入黑名单（幂等）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "移出黑名单（幂等）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"targetId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/blacklist/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "blacklist", "remove" ] }, "description": "operationId: blacklist.remove\n移出黑名单（幂等）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "黑名单列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/blacklist/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "blacklist", "list" ] }, "description": "operationId: blacklist.list\n黑名单列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] } ] }, { "name": "消息", "description": "domain: message（30 个接口）", "item": [ { "name": "以指定用户身份发送单聊消息；返回服务端消息（含 seq）。幂等键 clientMsgId。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"toUserId\": \"bob\",\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n },\n \"clientMsgId\": \"c_9f2a\",\n \"push\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/private/publish", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "private", "publish" ] }, "description": "operationId: message.private.publish\n以指定用户身份发送单聊消息；返回服务端消息（含 seq）。幂等键 clientMsgId。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1007, 1008, 1010, 1011, 1016, 1021" }, "response": [] }, { "name": "发送群/超级群消息。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"groupId\": \"g_1001\",\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n },\n \"clientMsgId\": \"c_9f2a\",\n \"isMentionAll\": true,\n \"mentionedUserIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/group/publish", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "group", "publish" ] }, "description": "operationId: message.group.publish\n发送群/超级群消息。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1005, 1006, 1007, 1008, 1009, 1010, 1021" }, "response": [] }, { "name": "发送聊天室消息（仅广播在线成员，不落离线）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"chatroomId\": \"cr_2001\",\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n },\n \"clientMsgId\": \"c_9f2a\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/chatroom/publish", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "chatroom", "publish" ] }, "description": "operationId: message.chatroom.publish\n发送聊天室消息（仅广播在线成员，不落离线）。\n自版本: 1.0.0\n可能错误码: 1001, 1007, 1008, 1010, 1012, 1013, 1014, 1021" }, "response": [] }, { "name": "发送系统通知给一批用户；落库、离线补发、多端同步，客户端展示为“系统通知”会话。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"toUserIds\": [\n \"string\"\n ],\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n },\n \"clientMsgId\": \"c_9f2a\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/system/publish", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "system", "publish" ] }, "description": "operationId: message.system.publish\n发送系统通知给一批用户；落库、离线补发、多端同步，客户端展示为“系统通知”会话。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1007, 1008, 1021" }, "response": [] }, { "name": "撤回消息（发送者或应用服务器；时限 recallWindowMs，超时 1022）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"messageId\": \"m_10001\",\n \"isAdmin\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/recall", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "recall" ] }, "description": "operationId: message.recall\n撤回消息（发送者或应用服务器；时限 recallWindowMs，超时 1022）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1022, 1023" }, "response": [] }, { "name": "查询历史消息（倒序分页，beforeSeq 向前翻页）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"conversationType\": 1,\n \"targetId\": \"bob\",\n \"userId\": \"alice\",\n \"limit\": 0,\n \"beforeSeq\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/history/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "history", "get" ] }, "description": "operationId: message.history.get\n查询历史消息（倒序分页，beforeSeq 向前翻页）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1005" }, "response": [] }, { "name": "查询消息已读人数。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/read/count", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "read", "count" ] }, "description": "operationId: message.read.count\n查询消息已读人数。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "按用户搜索文本消息。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"keyword\": \"你好\",\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/search", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "search" ] }, "description": "operationId: message.search\n按用户搜索文本消息。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "消息投递轨迹（存储/ACK/离线补偿/回调路由），控制台消息流转查询使用。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/trace/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "trace", "get" ] }, "description": "operationId: message.trace.get\n消息投递轨迹（存储/ACK/离线补偿/回调路由），控制台消息流转查询使用。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置消息扩展 KV（key/value，随消息存储；用于业务透传/标记/回应数据）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\",\n \"key\": \"string\",\n \"value\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/expansion/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "expansion", "set" ] }, "description": "operationId: message.expansion.set\n设置消息扩展 KV（key/value，随消息存储；用于业务透传/标记/回应数据）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "读取消息扩展 KV。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/expansion/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "expansion", "get" ] }, "description": "operationId: message.expansion.get\n读取消息扩展 KV。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "删除消息扩展 KV。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\",\n \"keys\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/expansion/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "expansion", "remove" ] }, "description": "operationId: message.expansion.remove\n删除消息扩展 KV。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "服务端修改消息内容（单聊/群/超级群统一；仅发送者或应用管理员可改）。修改后历史与拉取返回新内容。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\",\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n },\n \"operatorId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/modify", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "modify" ] }, "description": "operationId: message.modify\n服务端修改消息内容（单聊/群/超级群统一；仅发送者或应用管理员可改）。修改后历史与拉取返回新内容。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1007" }, "response": [] }, { "name": "清除远端会话历史消息（beforeTimestamp 省略表示全部；仅应用管理员/会话参与者可调用）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"conversationType\": 0,\n \"targetId\": \"bob\",\n \"beforeTimestamp\": 0,\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/history/clean", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "history", "clean" ] }, "description": "operationId: message.history.clean\n清除远端会话历史消息（beforeTimestamp 省略表示全部；仅应用管理员/会话参与者可调用）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004" }, "response": [] }, { "name": "添加消息回应（reaction；同一用户同一表情幂等）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\",\n \"userId\": \"alice\",\n \"reaction\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/reaction/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "reaction", "add" ] }, "description": "operationId: message.reaction.add\n添加消息回应（reaction；同一用户同一表情幂等）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "移除消息回应。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\",\n \"userId\": \"alice\",\n \"reaction\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/reaction/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "reaction", "remove" ] }, "description": "operationId: message.reaction.remove\n移除消息回应。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询消息回应汇总（按表情聚合 count/userIds）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/reaction/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "reaction", "list" ] }, "description": "operationId: message.reaction.list\n查询消息回应汇总（按表情聚合 count/userIds）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询某表情的回应用户列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageId\": \"m_10001\",\n \"reaction\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/reaction/users", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "reaction", "users" ] }, "description": "operationId: message.reaction.users\n查询某表情的回应用户列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "批量查询多条消息的回应摘要（上限 50）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"messageIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/reaction/batch", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "reaction", "batch" ] }, "description": "operationId: message.reaction.batch\n批量查询多条消息的回应摘要（上限 50）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "发送模板消息：templateId 指向内置模板，params 填充占位符后按普通消息下发（单聊/群/系统通知）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"conversationType\": 0,\n \"targetId\": \"bob\",\n \"templateId\": \"string\",\n \"params\": {\n \"key\": \"string\"\n },\n \"clientMsgId\": \"c_9f2a\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/template/publish", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "template", "publish" ] }, "description": "operationId: message.template.publish\n发送模板消息：templateId 指向内置模板，params 填充占位符后按普通消息下发（单聊/群/系统通知）。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1007" }, "response": [] }, { "name": "开始流式消息（大模型输出场景）：创建流并预分配 messageId，后续 append 追加增量。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"conversationType\": 0,\n \"targetId\": \"bob\",\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/stream/start", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "stream", "start" ] }, "description": "operationId: message.stream.start\n开始流式消息（大模型输出场景）：创建流并预分配 messageId，后续 append 追加增量。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1007" }, "response": [] }, { "name": "向流追加文本增量（幂等 seq 可选；重复 seq 覆盖）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"streamId\": \"string\",\n \"delta\": \"string\",\n \"seq\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/stream/append", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "stream", "append" ] }, "description": "operationId: message.stream.append\n向流追加文本增量（幂等 seq 可选；重复 seq 覆盖）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "结束流式消息：落库为普通消息并按会话下发（返回最终 Message）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"streamId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/stream/end", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "stream", "end" ] }, "description": "operationId: message.stream.end\n结束流式消息：落库为普通消息并按会话下发（返回最终 Message）。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1007" }, "response": [] }, { "name": "获取流内容与状态（覆盖融云 /message/get_stream）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"streamId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/stream/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "stream", "get" ] }, "description": "operationId: message.stream.get\n获取流内容与状态（覆盖融云 /message/get_stream）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "发送全量用户落地通知（写入系统会话并下发；支持指定用户子集）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n },\n \"targetUserIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/broadcast", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "broadcast" ] }, "description": "operationId: message.broadcast\n发送全量用户落地通知（写入系统会话并下发；支持指定用户子集）。\n自版本: 1.0.0\n可能错误码: 1001, 1007" }, "response": [] }, { "name": "撤回全量用户落地通知。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"broadcastId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/broadcast/recall", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "broadcast", "recall" ] }, "description": "operationId: message.broadcast.recall\n撤回全量用户落地通知。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "发送在线用户广播（仅推给当前在线连接，不落离线历史）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"content\": {\n \"type\": \"text\",\n \"text\": \"你好，IM PaaS\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/online/broadcast", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "online", "broadcast" ] }, "description": "operationId: message.online.broadcast\n发送在线用户广播（仅推给当前在线连接，不落离线历史）。\n自版本: 1.0.0\n可能错误码: 1001, 1007" }, "response": [] }, { "name": "文本翻译（转发到应用配置的翻译服务；未配置返回 1021）。覆盖融云 /v3/translate。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"text\": \"你好，IM PaaS\",\n \"targetLang\": \"string\",\n \"sourceLang\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/translate", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "translate" ] }, "description": "operationId: message.translate\n文本翻译（转发到应用配置的翻译服务；未配置返回 1021）。覆盖融云 /v3/translate。\n自版本: 1.0.0\n可能错误码: 1001, 1021" }, "response": [] }, { "name": "分页查询应用历史消息审计记录（userId/conversationType/targetId/from/to 过滤；page 从 1 开始，size 上限 100）。审计视图由已持久化消息派生，聊天室等 ephemeral 消息不在范围内。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationType\": 0,\n \"targetId\": \"bob\",\n \"from\": 0,\n \"to\": 0,\n \"page\": 0,\n \"size\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/history", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "history" ] }, "description": "operationId: message.history\n分页查询应用历史消息审计记录（userId/conversationType/targetId/from/to 过滤；page 从 1 开始，size 上限 100）。审计视图由已持久化消息派生，聊天室等 ephemeral 消息不在范围内。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "按时间区间删除历史消息审计记录（from/to 至少传一个，epoch 毫秒闭区间；只记录审计删除区间，不清理在线会话消息存储；重叠区间合并）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"from\": 0,\n \"to\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/history/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "history", "delete" ] }, "description": "operationId: message.history.delete\n按时间区间删除历史消息审计记录（from/to 至少传一个，epoch 毫秒闭区间；只记录审计删除区间，不清理在线会话消息存储；重叠区间合并）。\n自版本: 1.0.0\n可能错误码: 1001\n幂等：是" }, "response": [] } ] }, { "name": "群组", "description": "domain: group（28 个接口）", "item": [ { "name": "创建群/超级群；groupId 可指定（幂等）或服务端生成。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"name\": \"Alice\",\n \"owner\": \"string\",\n \"members\": [\n \"string\"\n ],\n \"groupType\": \"normal\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "create" ] }, "description": "operationId: group.create\n创建群/超级群；groupId 可指定（幂等）或服务端生成。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1015, 1021" }, "response": [] }, { "name": "更新群信息（name/notice/avatarUrl）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"name\": \"Alice\",\n \"notice\": \"本周五 20:00 全员复盘\",\n \"avatarUrl\": \"https://cdn.example.com/avatar/alice.png\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/update", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "update" ] }, "description": "operationId: group.update\n更新群信息（name/notice/avatarUrl）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1005" }, "response": [] }, { "name": "查询群信息。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "get" ] }, "description": "operationId: group.get\n查询群信息。\n自版本: 1.0.0\n可能错误码: 1001, 1005" }, "response": [] }, { "name": "群成员列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/members/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "members", "list" ] }, "description": "operationId: group.members.list\n群成员列表。\n自版本: 1.0.0\n可能错误码: 1001, 1005" }, "response": [] }, { "name": "批量拉人入群。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/members/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "members", "add" ] }, "description": "operationId: group.members.add\n批量拉人入群。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1005, 1015" }, "response": [] }, { "name": "批量移除群成员。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/members/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "members", "remove" ] }, "description": "operationId: group.members.remove\n批量移除群成员。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1005" }, "response": [] }, { "name": "用户退群（群主需先转让）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/quit", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "quit" ] }, "description": "operationId: group.quit\n用户退群（群主需先转让）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1005, 1006" }, "response": [] }, { "name": "解散群（群主或应用强制）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"operatorId\": \"alice\",\n \"force\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/dismiss", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "dismiss" ] }, "description": "operationId: group.dismiss\n解散群（群主或应用强制）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1005" }, "response": [] }, { "name": "设置群管理员（幂等）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/admin/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "admin", "add" ] }, "description": "operationId: group.admin.add\n设置群管理员（幂等）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1005\n幂等：是" }, "response": [] }, { "name": "取消群管理员。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/admin/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "admin", "remove" ] }, "description": "operationId: group.admin.remove\n取消群管理员。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1005\n幂等：是" }, "response": [] }, { "name": "禁言/解禁群成员（mutedUntil=0 解禁）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\",\n \"mutedUntil\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/mute", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "mute" ] }, "description": "operationId: group.mute\n禁言/解禁群成员（mutedUntil=0 解禁）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1005, 1006" }, "response": [] }, { "name": "加入群：公开群/超级群（joinPolicy=open）直接加入；邀请制群需群主/管理员邀请，否则 1003。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/join", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "join" ] }, "description": "operationId: group.join\n加入群：公开群/超级群（joinPolicy=open）直接加入；邀请制群需群主/管理员邀请，否则 1003。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1005, 1015\n幂等：是" }, "response": [] }, { "name": "转让群主：仅当前群主可操作，目标必须是群成员。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"fromUserId\": \"alice\",\n \"toUserId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/transfer", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "transfer" ] }, "description": "operationId: group.transfer\n转让群主：仅当前群主可操作，目标必须是群成员。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004, 1005" }, "response": [] }, { "name": "设置/取消群组全员禁言（群主/管理员可操作；白名单成员不受限，覆盖融云 /group/ban/add|rollback）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"muted\": true,\n \"operatorId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/mute-all", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "mute-all" ] }, "description": "operationId: group.mute-all\n设置/取消群组全员禁言（群主/管理员可操作；白名单成员不受限，覆盖融云 /group/ban/add|rollback）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004\n幂等：是" }, "response": [] }, { "name": "查询群组全员禁言状态（覆盖融云 /group/ban/query）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/mute-all/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "mute-all", "get" ] }, "description": "operationId: group.mute-all.get\n查询群组全员禁言状态（覆盖融云 /group/ban/query）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "加入群组全体禁言白名单（白名单成员不受 group.mute 全员禁言限制）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/ban/whitelist/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "ban", "whitelist", "add" ] }, "description": "operationId: group.ban.whitelist.add\n加入群组全体禁言白名单（白名单成员不受 group.mute 全员禁言限制）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "移出群组全体禁言白名单。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/ban/whitelist/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "ban", "whitelist", "remove" ] }, "description": "operationId: group.ban.whitelist.remove\n移出群组全体禁言白名单。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询群组全体禁言白名单。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/ban/whitelist/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "ban", "whitelist", "list" ] }, "description": "operationId: group.ban.whitelist.list\n查询群组全体禁言白名单。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "批量导入群组（上限 50，逐条幂等；返回 imported/failed）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groups\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/import", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "import" ] }, "description": "operationId: group.import\n批量导入群组（上限 50，逐条幂等；返回 imported/failed）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "设置群成员资料（群昵称/扩展字段）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\",\n \"name\": \"Alice\",\n \"extra\": {\n \"key\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/member/update", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "member", "update" ] }, "description": "operationId: group.member.update\n设置群成员资料（群昵称/扩展字段）。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1005\n幂等：是" }, "response": [] }, { "name": "设置用户对群成员的特别关注（仅本人视角，推送置顶提示）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\",\n \"targetUserId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/member/follow/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "member", "follow", "add" ] }, "description": "operationId: group.member.follow.add\n设置用户对群成员的特别关注（仅本人视角，推送置顶提示）。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1005\n幂等：是" }, "response": [] }, { "name": "取消对群成员的特别关注。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\",\n \"targetUserId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/member/follow/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "member", "follow", "remove" ] }, "description": "operationId: group.member.follow.remove\n取消对群成员的特别关注。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询用户在该群的特别关注成员列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/member/follow/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "member", "follow", "list" ] }, "description": "operationId: group.member.follow.list\n查询用户在该群的特别关注成员列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置用户对群名称的备注名（仅本人视角）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"groupId\": \"g_1001\",\n \"remark\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/remark/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "remark", "set" ] }, "description": "operationId: group.remark.set\n设置用户对群名称的备注名（仅本人视角）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "查询用户对群名称的备注名。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/remark/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "remark", "get" ] }, "description": "operationId: group.remark.get\n查询用户对群名称的备注名。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "删除用户对群名称的备注名。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/remark/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "remark", "remove" ] }, "description": "operationId: group.remark.remove\n删除用户对群名称的备注名。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询群成员禁言列表；groupId 省略时返回应用下所有群（items 携带 groupId）。覆盖融云 /group/user/gag/list.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/user/gag/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "user", "gag", "list" ] }, "description": "operationId: group.mute.list\n查询群成员禁言列表；groupId 省略时返回应用下所有群（items 携带 groupId）。覆盖融云 /group/user/gag/list.json。\n自版本: 1.0.0\n可能错误码: 1005" }, "response": [] }, { "name": "全量同步用户所在群组：groups 内缺失群自动创建（用户为群主），已存在群幂等加入并可按 name 更新群名；列表外的应用内群移除该用户成员关系（groups 省略表示解绑全部）。覆盖融云 /group/sync.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"groups\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/group/sync", "host": [ "{{host}}" ], "path": [ "im", "v2", "group", "sync" ] }, "description": "operationId: group.sync\n全量同步用户所在群组：groups 内缺失群自动创建（用户为群主），已存在群幂等加入并可按 name 更新群名；列表外的应用内群移除该用户成员关系（groups 省略表示解绑全部）。覆盖融云 /group/sync.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1021\n幂等：是" }, "response": [] } ] }, { "name": "超级群", "description": "domain: supergroup（18 个接口）", "item": [ { "name": "设置超级群加入策略：invite（默认）/ open。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"joinPolicy\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/join-policy/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "join-policy", "set" ] }, "description": "operationId: supergroup.join.policy.set\n设置超级群加入策略：invite（默认）/ open。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1005, 1021" }, "response": [] }, { "name": "创建超级群用户组。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userGroupId\": \"string\",\n \"name\": \"Alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/usergroup/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "usergroup", "create" ] }, "description": "operationId: supergroup.usergroup.create\n创建超级群用户组。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询超级群用户组列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/usergroup/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "usergroup", "list" ] }, "description": "operationId: supergroup.usergroup.list\n查询超级群用户组列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "删除超级群用户组。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userGroupId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/usergroup/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "usergroup", "delete" ] }, "description": "operationId: supergroup.usergroup.delete\n删除超级群用户组。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "向用户组添加成员。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userGroupId\": \"string\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/usergroup/members/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "usergroup", "members", "add" ] }, "description": "operationId: supergroup.usergroup.members.add\n向用户组添加成员。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "从用户组移出成员。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userGroupId\": \"string\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/usergroup/members/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "usergroup", "members", "remove" ] }, "description": "operationId: supergroup.usergroup.members.remove\n从用户组移出成员。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询用户所属的用户组。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/usergroup/by-user", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "usergroup", "by-user" ] }, "description": "operationId: supergroup.usergroup.byUser\n查询用户所属的用户组。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询用户组绑定的私有频道（同时覆盖融云“查询用户所属私有频道”）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userGroupId\": \"string\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/usergroup/channels", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "usergroup", "channels" ] }, "description": "operationId: supergroup.usergroup.channels\n查询用户组绑定的私有频道（同时覆盖融云“查询用户所属私有频道”）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "创建超级群私有/公开频道。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"name\": \"Alice\",\n \"type\": \"text\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "create" ] }, "description": "operationId: supergroup.channel.create\n创建超级群私有/公开频道。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询超级群频道列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "list" ] }, "description": "operationId: supergroup.channel.list\n查询超级群频道列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "删除超级群频道。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "delete" ] }, "description": "operationId: supergroup.channel.delete\n删除超级群频道。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "变更频道类型（private/public）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"type\": \"text\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/type/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "type", "set" ] }, "description": "operationId: supergroup.channel.type.set\n变更频道类型（private/public）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "添加私有频道成员。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/members/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "members", "add" ] }, "description": "operationId: supergroup.channel.members.add\n添加私有频道成员。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "移除私有频道成员。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/members/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "members", "remove" ] }, "description": "operationId: supergroup.channel.members.remove\n移除私有频道成员。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询私有频道成员列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/members/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "members", "list" ] }, "description": "operationId: supergroup.channel.members.list\n查询私有频道成员列表。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "绑定频道与用户组（用户组成员自动获得频道访问）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"userGroupId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/usergroup/bind", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "usergroup", "bind" ] }, "description": "operationId: supergroup.channel.usergroup.bind\n绑定频道与用户组（用户组成员自动获得频道访问）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "解绑频道与用户组。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"userGroupId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/usergroup/unbind", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "usergroup", "unbind" ] }, "description": "operationId: supergroup.channel.usergroup.unbind\n解绑频道与用户组。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询频道与用户组的绑定关系（channelId 或 userGroupId 二选一，至少一个）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"userGroupId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/supergroup/channel/usergroup/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "supergroup", "channel", "usergroup", "list" ] }, "description": "operationId: supergroup.channel.usergroup.list\n查询频道与用户组的绑定关系（channelId 或 userGroupId 二选一，至少一个）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] } ] }, { "name": "聊天室", "description": "domain: chatroom（35 个接口）", "item": [ { "name": "创建聊天室（幂等：同 chatroomId 已存在则返回现有）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"name\": \"Alice\",\n \"owner\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "create" ] }, "description": "operationId: chatroom.create\n创建聊天室（幂等：同 chatroomId 已存在则返回现有）。\n自版本: 1.0.0\n可能错误码: 1001, 1015, 1021\n幂等：是" }, "response": [] }, { "name": "销毁聊天室：踢出所有在线成员、广播 destroyed。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/destroy", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "destroy" ] }, "description": "operationId: chatroom.destroy\n销毁聊天室：踢出所有在线成员、广播 destroyed。\n自版本: 1.0.0\n可能错误码: 1001, 1012" }, "response": [] }, { "name": "聊天室信息（含在线数）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "get" ] }, "description": "operationId: chatroom.get\n聊天室信息（含在线数）。\n自版本: 1.0.0\n可能错误码: 1001, 1012" }, "response": [] }, { "name": "聊天室在线成员列表。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/members/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "members", "list" ] }, "description": "operationId: chatroom.members.list\n聊天室在线成员列表。\n自版本: 1.0.0\n可能错误码: 1001, 1012" }, "response": [] }, { "name": "刷新聊天室空闲销毁时间（默认 30 分钟无活动销毁）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/keepalive", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "keepalive" ] }, "description": "operationId: chatroom.keepalive\n刷新聊天室空闲销毁时间（默认 30 分钟无活动销毁）。\n自版本: 1.0.0\n可能错误码: 1001, 1012" }, "response": [] }, { "name": "设置聊天室 KV（房间级键值，随房间销毁；ttlMs 可选）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"key\": \"string\",\n \"value\": \"string\",\n \"ttlMs\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/kv/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "kv", "set" ] }, "description": "operationId: chatroom.kv.set\n设置聊天室 KV（房间级键值，随房间销毁；ttlMs 可选）。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013\n幂等：是" }, "response": [] }, { "name": "读取聊天室 KV（keys 省略返回全部）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"keys\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/kv/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "kv", "get" ] }, "description": "operationId: chatroom.kv.get\n读取聊天室 KV（keys 省略返回全部）。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "删除聊天室 KV。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"keys\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/kv/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "kv", "remove" ] }, "description": "operationId: chatroom.kv.remove\n删除聊天室 KV。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "聊天室成员禁言/解禁（mutedUntil=0 解禁；房主/管理员可操作）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"userId\": \"alice\",\n \"mutedUntil\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/mute", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "mute" ] }, "description": "operationId: chatroom.mute\n聊天室成员禁言/解禁（mutedUntil=0 解禁；房主/管理员可操作）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1012, 1014" }, "response": [] }, { "name": "聊天室封禁/解封成员（封禁后被踢出且不可再加入）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"userId\": \"alice\",\n \"banned\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/ban", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "ban" ] }, "description": "operationId: chatroom.ban\n聊天室封禁/解封成员（封禁后被踢出且不可再加入）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1012, 1014" }, "response": [] }, { "name": "聊天室白名单：加入（白名单内用户不受封禁/禁言限制）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/whitelist/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "whitelist", "add" ] }, "description": "operationId: chatroom.whitelist.add\n聊天室白名单：加入（白名单内用户不受封禁/禁言限制）。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "聊天室白名单：移除。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/whitelist/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "whitelist", "remove" ] }, "description": "operationId: chatroom.whitelist.remove\n聊天室白名单：移除。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "聊天室白名单：查询。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/whitelist/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "whitelist", "list" ] }, "description": "operationId: chatroom.whitelist.list\n聊天室白名单：查询。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "设置/取消聊天室全体禁言（房主/管理员可操作；白名单成员不受限）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"muted\": true,\n \"operatorId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/mute-all", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "mute-all" ] }, "description": "operationId: chatroom.mute-all\n设置/取消聊天室全体禁言（房主/管理员可操作；白名单成员不受限）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1012, 1013\n幂等：是" }, "response": [] }, { "name": "查询聊天室全体禁言状态。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/mute-all/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "mute-all", "get" ] }, "description": "operationId: chatroom.mute-all.get\n查询聊天室全体禁言状态。\n自版本: 1.0.0\n可能错误码: 1001, 1012" }, "response": [] }, { "name": "设置聊天室销毁策略（idle=空闲销毁，idleMs 默认 1800000；fixed=定时销毁，destroyAt 由创建时间+idleMs 计算）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"destroyType\": \"string\",\n \"idleMs\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/destroy/policy/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "destroy", "policy", "set" ] }, "description": "operationId: chatroom.destroy.policy.set\n设置聊天室销毁策略（idle=空闲销毁，idleMs 默认 1800000；fixed=定时销毁，destroyAt 由创建时间+idleMs 计算）。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "设置聊天室低优先级消息类型（全量覆盖）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"messageTypes\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/message/priority/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "message", "priority", "set" ] }, "description": "operationId: chatroom.message.priority.set\n设置聊天室低优先级消息类型（全量覆盖）。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013\n幂等：是" }, "response": [] }, { "name": "查询聊天室低优先级消息类型。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/message/priority/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "message", "priority", "list" ] }, "description": "operationId: chatroom.message.priority.list\n查询聊天室低优先级消息类型。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "绑定聊天室与音视频房间（RTC 房间号仅存储，音视频能力需外部服务）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"rtcRoomId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/rtc/bind", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "rtc", "bind" ] }, "description": "operationId: chatroom.rtc.bind\n绑定聊天室与音视频房间（RTC 房间号仅存储，音视频能力需外部服务）。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013\n幂等：是" }, "response": [] }, { "name": "查询聊天室绑定的音视频房间。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/rtc/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "rtc", "get" ] }, "description": "operationId: chatroom.rtc.get\n查询聊天室绑定的音视频房间。\n自版本: 1.0.0\n可能错误码: 1001, 1012" }, "response": [] }, { "name": "查询聊天室封禁用户列表（分页）。覆盖融云 /chatroom/user/block/list.json；time 为解禁时间（UTC），空串表示封禁未设置时长。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/user/block/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "user", "block", "list" ] }, "description": "operationId: chatroom.ban.list\n查询聊天室封禁用户列表（分页）。覆盖融云 /chatroom/user/block/list.json；time 为解禁时间（UTC），空串表示封禁未设置时长。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "查询应用下已设置保活状态的聊天室列表。覆盖融云 /chatroom/keepalive/query.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/keepalive/query", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "keepalive", "query" ] }, "description": "operationId: chatroom.keepalive.get\n查询应用下已设置保活状态的聊天室列表。覆盖融云 /chatroom/keepalive/query.json。\n自版本: 1.0.0\n可能错误码: 1021" }, "response": [] }, { "name": "移除聊天室保活状态并恢复空闲销毁计时。覆盖融云 /chatroom/keepalive/remove.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/keepalive/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "keepalive", "remove" ] }, "description": "operationId: chatroom.keepalive.remove\n移除聊天室保活状态并恢复空闲销毁计时。覆盖融云 /chatroom/keepalive/remove.json。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013\n幂等：是" }, "response": [] }, { "name": "查询指定用户是否在聊天室中。覆盖融云 /chatroom/user/exist.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/user/exist", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "user", "exist" ] }, "description": "operationId: chatroom.members.exists\n查询指定用户是否在聊天室中。覆盖融云 /chatroom/user/exist.json。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "批量查询用户是否在聊天室中（单次 <=1000；isInChrm 1=在 0=不在）。覆盖融云 /chatroom/users/exist.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/users/exist", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "users", "exist" ] }, "description": "operationId: chatroom.members.existsBatch\n批量查询用户是否在聊天室中（单次 <=1000；isInChrm 1=在 0=不在）。覆盖融云 /chatroom/users/exist.json。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "查询聊天室禁言用户列表（仅返回未到期记录，time 为解禁时间）。覆盖融云 /chatroom/user/gag/list.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/user/gag/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "user", "gag", "list" ] }, "description": "operationId: chatroom.mute.list\n查询聊天室禁言用户列表（仅返回未到期记录，time 为解禁时间）。覆盖融云 /chatroom/user/gag/list.json。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013" }, "response": [] }, { "name": "全局禁言用户：应用下所有聊天室生效，仅约束客户端发送；单次 <=20 用户，minute 1..=43200。覆盖融云 /chatroom/user/ban/add.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userIds\": [\n \"string\"\n ],\n \"minute\": 0,\n \"extra\": \"string\",\n \"needNotify\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/user/ban/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "user", "ban", "add" ] }, "description": "operationId: chatroom.globalMute.set\n全局禁言用户：应用下所有聊天室生效，仅约束客户端发送；单次 <=20 用户，minute 1..=43200。覆盖融云 /chatroom/user/ban/add.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1021\n幂等：是" }, "response": [] }, { "name": "解除用户全局禁言（单次 <=20 用户；幂等）。覆盖融云 /chatroom/user/ban/remove.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userIds\": [\n \"string\"\n ],\n \"extra\": \"string\",\n \"needNotify\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/user/ban/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "user", "ban", "remove" ] }, "description": "operationId: chatroom.globalMute.remove\n解除用户全局禁言（单次 <=20 用户；幂等）。覆盖融云 /chatroom/user/ban/remove.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "查询应用下已被全局禁言的用户列表（含解禁时间；到期记录惰性清理）。覆盖融云 /chatroom/user/ban/query.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/user/ban/query", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "user", "ban", "query" ] }, "description": "operationId: chatroom.globalMute.list\n查询应用下已被全局禁言的用户列表（含解禁时间；到期记录惰性清理）。覆盖融云 /chatroom/user/ban/query.json。\n自版本: 1.0.0\n可能错误码: 1021" }, "response": [] }, { "name": "添加消息类型到聊天室消息白名单（应用级共享，<=20 种，标识 <=32 字符；重复添加幂等）。覆盖融云 /chatroom/whitelist/add.json；路径带 .json 以避开 rev4 用户白名单占用的 /chatroom/whitelist/add。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"objectnames\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/whitelist/add.json", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "whitelist", "add.json" ] }, "description": "operationId: chatroom.messageWhitelist.add\n添加消息类型到聊天室消息白名单（应用级共享，<=20 种，标识 <=32 字符；重复添加幂等）。覆盖融云 /chatroom/whitelist/add.json；路径带 .json 以避开 rev4 用户白名单占用的 /chatroom/whitelist/add。\n自版本: 1.0.0\n可能错误码: 1001, 1021\n幂等：是" }, "response": [] }, { "name": "查询应用全局的聊天室消息类型白名单。覆盖融云 /chatroom/whitelist/query.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/whitelist/query.json", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "whitelist", "query.json" ] }, "description": "operationId: chatroom.messageWhitelist.list\n查询应用全局的聊天室消息类型白名单。覆盖融云 /chatroom/whitelist/query.json。\n自版本: 1.0.0\n可能错误码: 1021" }, "response": [] }, { "name": "从聊天室消息白名单移除消息类型（幂等）。覆盖融云 /chatroom/whitelist/delete.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"objectnames\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/whitelist/delete.json", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "whitelist", "delete.json" ] }, "description": "operationId: chatroom.messageWhitelist.remove\n从聊天室消息白名单移除消息类型（幂等）。覆盖融云 /chatroom/whitelist/delete.json。\n自版本: 1.0.0\n可能错误码: 1001, 1021\n幂等：是" }, "response": [] }, { "name": "向应用下所有聊天室广播消息（仅广播当时在线成员，不落聊天室历史；默认不同步发件人）。覆盖融云 /message/chatroom/broadcast.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"objectName\": \"string\",\n \"content\": \"string\",\n \"isIncludeSender\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/message/chatroom/broadcast", "host": [ "{{host}}" ], "path": [ "im", "v2", "message", "chatroom", "broadcast" ] }, "description": "operationId: chatroom.broadcast\n向应用下所有聊天室广播消息（仅广播当时在线成员，不落聊天室历史；默认不同步发件人）。覆盖融云 /message/chatroom/broadcast.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1007, 1021" }, "response": [] }, { "name": "批量设置聊天室自定义属性（按 entryOwnerId 隔离，单次 <=100 对；同 key 覆盖）。覆盖融云 /chatroom/entry/batch/set.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"entryOwnerId\": \"string\",\n \"entryInfo\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/entry/batch/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "entry", "batch", "set" ] }, "description": "operationId: chatroom.entry.batch.set\n批量设置聊天室自定义属性（按 entryOwnerId 隔离，单次 <=100 对；同 key 覆盖）。覆盖融云 /chatroom/entry/batch/set.json。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013, 1021\n幂等：是" }, "response": [] }, { "name": "批量移除聊天室自定义属性（<=100 个 key，按 entryOwnerId 隔离，幂等）。覆盖融云 /chatroom/entry/batch/remove.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"chatroomId\": \"cr_2001\",\n \"entryOwnerId\": \"string\",\n \"entryKeys\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/chatroom/entry/batch/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "chatroom", "entry", "batch", "remove" ] }, "description": "operationId: chatroom.entry.batch.remove\n批量移除聊天室自定义属性（<=100 个 key，按 entryOwnerId 隔离，幂等）。覆盖融云 /chatroom/entry/batch/remove.json。\n自版本: 1.0.0\n可能错误码: 1001, 1012, 1013, 1021\n幂等：是" }, "response": [] } ] }, { "name": "会话", "description": "domain: conversation（20 个接口）", "item": [ { "name": "用户会话列表（置顶优先/updatedAt 倒序）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationTypes\": [\n 1\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "list" ] }, "description": "operationId: conversation.list\n用户会话列表（置顶优先/updatedAt 倒序）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置会话置顶/草稿/提醒级别（服务端代操作）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationType\": 1,\n \"targetId\": \"bob\",\n \"isPinned\": true,\n \"draft\": \"明天见\",\n \"notificationLevel\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/settings", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "settings" ] }, "description": "operationId: conversation.settings\n设置会话置顶/草稿/提醒级别（服务端代操作）。\n自版本: 1.0.0\n可能错误码: 1001, 1003, 1004" }, "response": [] }, { "name": "清空会话未读。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationType\": 1,\n \"targetId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/unread/clear", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "unread", "clear" ] }, "description": "operationId: conversation.unread.clear\n清空会话未读。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "将会话归入标签（同一会话可属多个标签，最多 20 个）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tag\": \"string\",\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "set" ] }, "description": "operationId: conversation.tag.set\n将会话归入标签（同一会话可属多个标签，最多 20 个）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "将会话从标签移除。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tag\": \"string\",\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "remove" ] }, "description": "operationId: conversation.tag.remove\n将会话从标签移除。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询用户的会话标签（tag 省略返回全部标签及其会话）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tag\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "list" ] }, "description": "operationId: conversation.tag.list\n查询用户的会话标签（tag 省略返回全部标签及其会话）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询单个会话属性：置顶、免打扰（notificationLevel/mute）、未读数、草稿、@ 计数、标签与最后一条消息；会话不存在返回缺省值（不创建会话）。覆盖融云 /conversation/attribute/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"targetId\": \"bob\",\n \"conversationType\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/attribute/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "attribute", "get" ] }, "description": "operationId: conversation.attribute.get\n查询单个会话属性：置顶、免打扰（notificationLevel/mute）、未读数、草稿、@ 计数、标签与最后一条消息；会话不存在返回缺省值（不创建会话）。覆盖融云 /conversation/attribute/get.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询用户按会话类型设置的默认通知级别：0 全部通知 / 1 仅 @ / 2 免打扰；未设置返回 0。conversationType 支持 1 单聊 / 2 群 / 3 聊天室 / 6 系统 / 10 超级群。覆盖融云 /conversation/type/notification/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationType\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/type/notification/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "type", "notification", "get" ] }, "description": "operationId: conversation.type.notification.get\n查询用户按会话类型设置的默认通知级别：0 全部通知 / 1 仅 @ / 2 免打扰；未设置返回 0。conversationType 支持 1 单聊 / 2 群 / 3 聊天室 / 6 系统 / 10 超级群。覆盖融云 /conversation/type/notification/get.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置用户按会话类型的默认通知级别（0 全部 / 1 仅 @ / 2 免打扰），按 {app}:{user}:{conversationType} 持久化。覆盖融云 /conversation/type/notification/set.json（unpushLevel/isMuted 均可作为入参别名）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationType\": 0,\n \"unpushLevel\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/type/notification/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "type", "notification", "set" ] }, "description": "operationId: conversation.type.notification.set\n设置用户按会话类型的默认通知级别（0 全部 / 1 仅 @ / 2 免打扰），按 {app}:{user}:{conversationType} 持久化。覆盖融云 /conversation/type/notification/set.json（unpushLevel/isMuted 均可作为入参别名）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "创建会话标签：tagName ≤16 字符；tagId 可选（≤32 字符，[A-Za-z0-9_.-]，缺省由 tagName 派生）；单用户最多 20 个标签（超出 1031）。覆盖融云 /conversation/tag/create.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagName\": \"string\",\n \"tagId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "create" ] }, "description": "operationId: conversation.tag.create\n创建会话标签：tagName ≤16 字符；tagId 可选（≤32 字符，[A-Za-z0-9_.-]，缺省由 tagName 派生）；单用户最多 20 个标签（超出 1031）。覆盖融云 /conversation/tag/create.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1031" }, "response": [] }, { "name": "重命名会话标签（tagId 不变）。覆盖融云 /conversation/tag/update.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagId\": \"string\",\n \"tagName\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/update", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "update" ] }, "description": "operationId: conversation.tag.update\n重命名会话标签（tagId 不变）。覆盖融云 /conversation/tag/update.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1032" }, "response": [] }, { "name": "删除会话标签，同时清除标签内会话引用；标签不存在返回 1032。覆盖融云 /conversation/tag/delete.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "delete" ] }, "description": "operationId: conversation.tag.delete\n删除会话标签，同时清除标签内会话引用；标签不存在返回 1032。覆盖融云 /conversation/tag/delete.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1032" }, "response": [] }, { "name": "查询用户全部标签（含 conversationCount），按创建顺序返回。覆盖融云 /conversation/tag/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "get" ] }, "description": "operationId: conversation.tag.get\n查询用户全部标签（含 conversationCount），按创建顺序返回。覆盖融云 /conversation/tag/get.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "把会话加入标签：单次 ≤100 条（items 支持对象数组或 \"type:target\" 字符串），幂等；单标签最多 1000 个会话（超出 1033）。覆盖融云 /conversation/tag/conversations/add.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagId\": \"string\",\n \"items\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/conversations/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "conversations", "add" ] }, "description": "operationId: conversation.tag.conversations.add\n把会话加入标签：单次 ≤100 条（items 支持对象数组或 \"type:target\" 字符串），幂等；单标签最多 1000 个会话（超出 1033）。覆盖融云 /conversation/tag/conversations/add.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1032, 1033" }, "response": [] }, { "name": "把会话移出标签：单次 ≤100 条，幂等。覆盖融云 /conversation/tag/conversations/remove.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagId\": \"string\",\n \"items\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/conversations/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "conversations", "remove" ] }, "description": "operationId: conversation.tag.conversations.remove\n把会话移出标签：单次 ≤100 条，幂等。覆盖融云 /conversation/tag/conversations/remove.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1032" }, "response": [] }, { "name": "分页查询标签内会话（含 top、unreadCount、lastMessageAt；limit 默认 50 上限 200）。覆盖融云 /conversation/tag/conversations/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagId\": \"string\",\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/conversations/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "conversations", "get" ] }, "description": "operationId: conversation.tag.conversations.get\n分页查询标签内会话（含 top、unreadCount、lastMessageAt；limit 默认 50 上限 200）。覆盖融云 /conversation/tag/conversations/get.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1032" }, "response": [] }, { "name": "查询某个会话所属标签列表。覆盖融云 /conversation/tag/of/conversation.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/of/conversation", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "of", "conversation" ] }, "description": "operationId: conversation.tag.of.conversation\n查询某个会话所属标签列表。覆盖融云 /conversation/tag/of/conversation.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "标签内未读汇总（unreadCount 消息总数 + unreadConversations 有未读的会话数）。覆盖融云 /conversation/tag/unread/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/unread/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "unread", "get" ] }, "description": "operationId: conversation.tag.unread.get\n标签内未读汇总（unreadCount 消息总数 + unreadConversations 有未读的会话数）。覆盖融云 /conversation/tag/unread/get.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1032" }, "response": [] }, { "name": "标签内置顶/取消置顶会话，同时更新会话 is_pinned；会话不在标签内返回 1034。覆盖融云 /conversation/tag/top/set.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"tagId\": \"string\",\n \"conversationType\": 0,\n \"targetId\": \"bob\",\n \"top\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/tag/top/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "tag", "top", "set" ] }, "description": "operationId: conversation.tag.top.set\n标签内置顶/取消置顶会话，同时更新会话 is_pinned；会话不在标签内返回 1034。覆盖融云 /conversation/tag/top/set.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004, 1032, 1034" }, "response": [] }, { "name": "删除会话记录（列表项/未读/草稿/置顶），历史消息保留；同时从该用户所有标签移除；幂等（removed=false 表示本就不存在）。覆盖融云 /conversation/delete.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/conversation/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "conversation", "delete" ] }, "description": "operationId: conversation.delete\n删除会话记录（列表项/未读/草稿/置顶），历史消息保留；同时从该用户所有标签移除；幂等（removed=false 表示本就不存在）。覆盖融云 /conversation/delete.json。\n自版本: 1.2.0\n可能错误码: 1001, 1004" }, "response": [] } ] }, { "name": "在线状态", "description": "domain: presence（1 个接口）", "item": [ { "name": "批量在线状态（<=100）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/presence/batch", "host": [ "{{host}}" ], "path": [ "im", "v2", "presence", "batch" ] }, "description": "operationId: presence.batch\n批量在线状态（<=100）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] } ] }, { "name": "敏感词", "description": "domain: sensitive-word（2 个接口）", "item": [ { "name": "查询敏感词配置。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/sensitive-word/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "sensitive-word", "list" ] }, "description": "operationId: sensitive-word.list\n查询敏感词配置。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "覆盖设置敏感词（<=500 词，单词 <=64 字符）与处置动作。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"words\": [\n \"string\"\n ],\n \"action\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/sensitive-word/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "sensitive-word", "set" ] }, "description": "operationId: sensitive-word.set\n覆盖设置敏感词（<=500 词，单词 <=64 字符）与处置动作。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] } ] }, { "name": "回调配置与投递", "description": "domain: callback（4 个接口）", "item": [ { "name": "查询回调配置（secret 脱敏）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/callback/config/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "callback", "config", "get" ] }, "description": "operationId: callback.config.get\n查询回调配置（secret 脱敏）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "设置回调配置：URL、事件订阅、签名密钥、重试策略、启停。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"enabled\": true,\n \"url\": \"https://cdn.example.com/a.png\",\n \"secret\": \"****\",\n \"events\": [\n \"message.routed\"\n ],\n \"retry\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/callback/config/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "callback", "config", "set" ] }, "description": "operationId: callback.config.set\n设置回调配置：URL、事件订阅、签名密钥、重试策略、启停。\n自版本: 1.0.0\n可能错误码: 1001, 1024\n幂等：是" }, "response": [] }, { "name": "回调投递日志查询（时间范围/事件类型/状态，分页）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"eventType\": \"message.routed\",\n \"status\": \"pending\",\n \"from\": 0,\n \"to\": 0,\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/callback/delivery/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "callback", "delivery", "list" ] }, "description": "operationId: callback.delivery.list\n回调投递日志查询（时间范围/事件类型/状态，分页）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "手动重试一次失败的回调投递。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"deliveryId\": \"dlv_3001\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/callback/delivery/retry", "host": [ "{{host}}" ], "path": [ "im", "v2", "callback", "delivery", "retry" ] }, "description": "operationId: callback.delivery.retry\n手动重试一次失败的回调投递。\n自版本: 1.0.0\n可能错误码: 1001, 2004" }, "response": [] } ] }, { "name": "服务开通", "description": "domain: service（2 个接口）", "item": [ { "name": "查询应用服务开通项与配额。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/service/activation/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "service", "activation", "get" ] }, "description": "operationId: service.activation.get\n查询应用服务开通项与配额。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "设置应用服务开通项（关闭后相关接口返回 1021）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"services\": {\n \"private_chat\": true\n },\n \"quotas\": {}\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/service/activation/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "service", "activation", "set" ] }, "description": "operationId: service.activation.set\n设置应用服务开通项（关闭后相关接口返回 1021）。\n自版本: 1.0.0\n可能错误码: 1001, 1021\n幂等：是" }, "response": [] } ] }, { "name": "运营统计", "description": "domain: stats（2 个接口）", "item": [ { "name": "应用维度统计（用户/消息/在线）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/stats/app", "host": [ "{{host}}" ], "path": [ "im", "v2", "stats", "app" ] }, "description": "operationId: stats.app\n应用维度统计（用户/消息/在线）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "运营趋势（按天）：DAU/消息量/在线峰值/错误率。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"days\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/stats/trend", "host": [ "{{host}}" ], "path": [ "im", "v2", "stats", "trend" ] }, "description": "operationId: stats.trend\n运营趋势（按天）：DAU/消息量/在线峰值/错误率。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] } ] }, { "name": "AI 助理代理", "description": "domain: agent（11 个接口）", "item": [ { "name": "创建 Agent（对话代理配置；对话生成需外部模型接入）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\",\n \"name\": \"Alice\",\n \"description\": \"string\",\n \"model\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "create" ] }, "description": "operationId: agent.create\n创建 Agent（对话代理配置；对话生成需外部模型接入）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "获取指定 Agent。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "get" ] }, "description": "operationId: agent.get\n获取指定 Agent。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "列出 Agent（分页）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "list" ] }, "description": "operationId: agent.list\n列出 Agent（分页）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "更新 Agent 配置。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\",\n \"name\": \"Alice\",\n \"description\": \"string\",\n \"model\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/update", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "update" ] }, "description": "operationId: agent.update\n更新 Agent 配置。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "删除 Agent。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "delete" ] }, "description": "operationId: agent.delete\n删除 Agent。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置用户对 Agent 的使用限制（level=blocked|limited）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\",\n \"userId\": \"alice\",\n \"level\": \"string\",\n \"reason\": \"offline\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/restriction/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "restriction", "set" ] }, "description": "operationId: agent.restriction.set\n设置用户对 Agent 的使用限制（level=blocked|limited）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "获取用户 Agent 限制记录。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/restriction/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "restriction", "get" ] }, "description": "operationId: agent.restriction.get\n获取用户 Agent 限制记录。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "删除用户 Agent 限制记录。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/restriction/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "restriction", "remove" ] }, "description": "operationId: agent.restriction.remove\n删除用户 Agent 限制记录。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询 Agent 的用户限制列表（分页）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\",\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/restriction/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "restriction", "list" ] }, "description": "operationId: agent.restriction.list\n查询 Agent 的用户限制列表（分页）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "Agent 对话生成（转发到应用配置的 AI 服务端点；未配置返回 1021 服务未开通）。覆盖融云 /v3/chat/generate。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"agentId\": \"string\",\n \"userId\": \"alice\",\n \"messages\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ],\n \"maxTokens\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/chat/generate", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "chat", "generate" ] }, "description": "operationId: agent.chat.generate\nAgent 对话生成（转发到应用配置的 AI 服务端点；未配置返回 1021 服务未开通）。覆盖融云 /v3/chat/generate。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1021" }, "response": [] }, { "name": "生成回复建议（转发到 AI 服务端点；未配置返回 1021）。覆盖融云 /v3/chat/suggest。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"history\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ],\n \"lastMessage\": \"string\",\n \"count\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/agent/chat/suggest", "host": [ "{{host}}" ], "path": [ "im", "v2", "agent", "chat", "suggest" ] }, "description": "operationId: agent.chat.suggest\n生成回复建议（转发到 AI 服务端点；未配置返回 1021）。覆盖融云 /v3/chat/suggest。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1021" }, "response": [] } ] }, { "name": "机器人", "description": "domain: bot（8 个接口）", "item": [ { "name": "创建机器人账号（用于自动回复/托管；运行时对话能力需外部模型）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"botId\": \"string\",\n \"name\": \"Alice\",\n \"avatarUrl\": \"https://cdn.example.com/avatar/alice.png\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/bot/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "bot", "create" ] }, "description": "operationId: bot.create\n创建机器人账号（用于自动回复/托管；运行时对话能力需外部模型）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "获取指定机器人。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"botId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/bot/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "bot", "get" ] }, "description": "operationId: bot.get\n获取指定机器人。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "列出机器人（分页）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"offset\": 0,\n \"limit\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/bot/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "bot", "list" ] }, "description": "operationId: bot.list\n列出机器人（分页）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "更新机器人资料。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"botId\": \"string\",\n \"name\": \"Alice\",\n \"avatarUrl\": \"https://cdn.example.com/avatar/alice.png\",\n \"description\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/bot/update", "host": [ "{{host}}" ], "path": [ "im", "v2", "bot", "update" ] }, "description": "operationId: bot.update\n更新机器人资料。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "删除机器人。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"botId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/bot/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "bot", "delete" ] }, "description": "operationId: bot.delete\n删除机器人。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "为已存在的机器人（bot.create 产出）登记 Webhook 回调集成：每个机器人一份配置、应用内 <=10 份；events 取 bot.message.private / bot.message.group / bot.message.chatroom / bot.chatroom.user.join。secret 缺省自动生成；回调签名与既有回调一致。覆盖融云 /v3/bot/integration/create.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"botId\": \"string\",\n \"name\": \"Alice\",\n \"webhookUrl\": \"string\",\n \"secret\": \"****\",\n \"events\": [\n \"string\"\n ],\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/v3/bot/integration/create", "host": [ "{{host}}" ], "path": [ "im", "v2", "v3", "bot", "integration", "create" ] }, "description": "operationId: bot.integration.create\n为已存在的机器人（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自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "更新机器人 Webhook 集成（name / webhookUrl / secret / events / enabled 均可选，只覆盖传入字段）。覆盖融云 /v3/bot/integration/update.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"botId\": \"string\",\n \"name\": \"Alice\",\n \"webhookUrl\": \"string\",\n \"secret\": \"****\",\n \"events\": [\n \"string\"\n ],\n \"enabled\": true\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/v3/bot/integration/update", "host": [ "{{host}}" ], "path": [ "im", "v2", "v3", "bot", "integration", "update" ] }, "description": "operationId: bot.integration.update\n更新机器人 Webhook 集成（name / webhookUrl / secret / events / enabled 均可选，只覆盖传入字段）。覆盖融云 /v3/bot/integration/update.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "删除机器人 Webhook 集成配置；配置不存在返回 1001（不静默成功）。覆盖融云 /v3/bot/integration/delete.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"botId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/v3/bot/integration/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "v3", "bot", "integration", "delete" ] }, "description": "operationId: bot.integration.delete\n删除机器人 Webhook 集成配置；配置不存在返回 1001（不静默成功）。覆盖融云 /v3/bot/integration/delete.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] } ] }, { "name": "推送通道", "description": "domain: push（7 个接口）", "item": [ { "name": "发送推送通知（scope=all|tag|package|user|users；不落地，按应用推送配置的 webhook 投递并记录推送日志）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"scope\": \"string\",\n \"target\": \"string\",\n \"targetUserIds\": [\n \"string\"\n ],\n \"title\": \"string\",\n \"content\": \"string\",\n \"extras\": {\n \"key\": \"string\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/push/send", "host": [ "{{host}}" ], "path": [ "im", "v2", "push", "send" ] }, "description": "operationId: push.send\n发送推送通知（scope=all|tag|package|user|users；不落地，按应用推送配置的 webhook 投递并记录推送日志）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "查询推送日志（覆盖融云 /message/push/detail/history）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"offset\": 0,\n \"limit\": 0,\n \"pushId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/push/log/list", "host": [ "{{host}}" ], "path": [ "im", "v2", "push", "log", "list" ] }, "description": "operationId: push.log.list\n查询推送日志（覆盖融云 /message/push/detail/history）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "推送聚合统计（按天；覆盖融云 /stat/getDayPushData）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"date\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/push/stats/day", "host": [ "{{host}}" ], "path": [ "im", "v2", "push", "stats", "day" ] }, "description": "operationId: push.stats.day\n推送聚合统计（按天；覆盖融云 /stat/getDayPushData）。\n自版本: 1.0.0\n可能错误码: 1001" }, "response": [] }, { "name": "单次推送统计（覆盖融云 /stat/getPushIdData）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"pushId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/push/stats/by-id", "host": [ "{{host}}" ], "path": [ "im", "v2", "push", "stats", "by-id" ] }, "description": "operationId: push.stats.byId\n单次推送统计（覆盖融云 /stat/getPushIdData）。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "设置推送备注名（scope=user|group；覆盖融云 /user/remarks/* 与 /group/remarks/*）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"ownerId\": \"string\",\n \"targetId\": \"bob\",\n \"scope\": \"string\",\n \"remark\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/push/remark/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "push", "remark", "set" ] }, "description": "operationId: push.remark.set\n设置推送备注名（scope=user|group；覆盖融云 /user/remarks/* 与 /group/remarks/*）。\n自版本: 1.0.0\n可能错误码: 1001, 1004\n幂等：是" }, "response": [] }, { "name": "查询推送备注名。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"ownerId\": \"string\",\n \"targetId\": \"bob\",\n \"scope\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/push/remark/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "push", "remark", "get" ] }, "description": "operationId: push.remark.get\n查询推送备注名。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] }, { "name": "删除推送备注名。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"ownerId\": \"string\",\n \"targetId\": \"bob\",\n \"scope\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/push/remark/remove", "host": [ "{{host}}" ], "path": [ "im", "v2", "push", "remark", "remove" ] }, "description": "operationId: push.remark.remove\n删除推送备注名。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] } ] }, { "name": "sensitiveword", "description": "domain: sensitiveword（4 个接口）", "item": [ { "name": "增量添加敏感词（不覆盖既有词，重复添加幂等；单词 <=32 字符，总数 <=500）。覆盖融云 /sensitiveword/add.json；replaceWord 会把应用处置动作切换为 replace。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"word\": \"string\",\n \"replaceWord\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/sensitiveword/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "sensitiveword", "add" ] }, "description": "operationId: sensitiveword.add\n增量添加敏感词（不覆盖既有词，重复添加幂等；单词 <=32 字符，总数 <=500）。覆盖融云 /sensitiveword/add.json；replaceWord 会把应用处置动作切换为 replace。\n自版本: 1.0.0\n可能错误码: 1001, 1021\n幂等：是" }, "response": [] }, { "name": "批量增量添加敏感词（1..=50 条，合并既有列表，总数 <=500）。words 支持字符串或 {word,replaceWord} 对象。覆盖融云 /sensitiveword/batch/add.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"words\": [\n {\n \"conversationType\": 0,\n \"targetId\": \"bob\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/sensitiveword/batch/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "sensitiveword", "batch", "add" ] }, "description": "operationId: sensitiveword.batch.add\n批量增量添加敏感词（1..=50 条，合并既有列表，总数 <=500）。words 支持字符串或 {word,replaceWord} 对象。覆盖融云 /sensitiveword/batch/add.json。\n自版本: 1.0.0\n可能错误码: 1001, 1021\n幂等：是" }, "response": [] }, { "name": "移除单个敏感词（幂等；不存在时 removed=false）。覆盖融云 /sensitiveword/delete.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"word\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/sensitiveword/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "sensitiveword", "delete" ] }, "description": "operationId: sensitiveword.delete\n移除单个敏感词（幂等；不存在时 removed=false）。覆盖融云 /sensitiveword/delete.json。\n自版本: 1.0.0\n可能错误码: 1001, 1021\n幂等：是" }, "response": [] }, { "name": "批量移除敏感词（1..=50 条，幂等）。覆盖融云 /sensitiveword/batch/delete.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"words\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/sensitiveword/batch/delete", "host": [ "{{host}}" ], "path": [ "im", "v2", "sensitiveword", "batch", "delete" ] }, "description": "operationId: sensitiveword.batch.delete\n批量移除敏感词（1..=50 条，幂等）。覆盖融云 /sensitiveword/batch/delete.json。\n自版本: 1.0.0\n可能错误码: 1001, 1021\n幂等：是" }, "response": [] } ] }, { "name": "statusmessage", "description": "domain: statusmessage（2 个接口）", "item": [ { "name": "发送单聊状态消息：仅投递当时在线的目标会话，不存储、不计未读、不落离线；离线目标 online=false。服务端下发 WS status 帧。覆盖融云 /statusmessage/private/publish.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"toUserId\": [\n \"bob\"\n ],\n \"objectName\": \"string\",\n \"content\": \"string\",\n \"isIncludeSender\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/statusmessage/private/publish", "host": [ "{{host}}" ], "path": [ "im", "v2", "statusmessage", "private", "publish" ] }, "description": "operationId: statusmessage.private.publish\n发送单聊状态消息：仅投递当时在线的目标会话，不存储、不计未读、不落离线；离线目标 online=false。服务端下发 WS status 帧。覆盖融云 /statusmessage/private/publish.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1021" }, "response": [] }, { "name": "发送群聊状态消息：向当时在线的群成员扇出（默认不同步发件人），不存储、不计未读。服务端下发 WS status 帧。覆盖融云 /statusmessage/group/publish.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"fromUserId\": \"alice\",\n \"toGroupId\": [\n \"string\"\n ],\n \"objectName\": \"string\",\n \"content\": \"string\",\n \"isIncludeSender\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/statusmessage/group/publish", "host": [ "{{host}}" ], "path": [ "im", "v2", "statusmessage", "group", "publish" ] }, "description": "operationId: statusmessage.group.publish\n发送群聊状态消息：向当时在线的群成员扇出（默认不同步发件人），不存储、不计未读。服务端下发 WS status 帧。覆盖融云 /statusmessage/group/publish.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1005, 1021" }, "response": [] } ] }, { "name": "entrust", "description": "domain: entrust（1 个接口）", "item": [ { "name": "分页查询用户加入的群（page/size；role 0=全部/1=成员/2=管理员/3=群主；order 0=正序/1=倒序，默认倒序；size 上限 100）。覆盖融云 /entrust/joined/group/query.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"userId\": \"alice\",\n \"page\": 0,\n \"size\": 0,\n \"role\": 0,\n \"order\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/entrust/joined/group/query", "host": [ "{{host}}" ], "path": [ "im", "v2", "entrust", "joined", "group", "query" ] }, "description": "operationId: entrust.joined.group.query\n分页查询用户加入的群（page/size；role 0=全部/1=成员/2=管理员/3=群主；order 0=正序/1=倒序，默认倒序；size 上限 100）。覆盖融云 /entrust/joined/group/query.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004" }, "response": [] } ] }, { "name": "ultragroup", "description": "domain: ultragroup（11 个接口）", "item": [ { "name": "查询超级群（或指定频道）的默认免打扰级别：0 全部通知 / 1 仅 @ 通知 / 2 免打扰；未设置返回 0。groupType 必须为 super（否则 1005）。覆盖融云 /ultragroup/notdisturb/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/notdisturb/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "notdisturb", "get" ] }, "description": "operationId: ultragroup.notdisturb.get\n查询超级群（或指定频道）的默认免打扰级别：0 全部通知 / 1 仅 @ 通知 / 2 免打扰；未设置返回 0。groupType 必须为 super（否则 1005）。覆盖融云 /ultragroup/notdisturb/get.json。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021" }, "response": [] }, { "name": "设置超级群（或频道）默认免打扰，对全体成员生效；scope=all 为群级、scope=channel 需同时传 channelId。覆盖融云 /ultragroup/notdisturb/set.json（兼容 unpushLevel 入参别名）。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"notdisturbLevel\": 0,\n \"scope\": \"string\",\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/notdisturb/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "notdisturb", "set" ] }, "description": "operationId: ultragroup.notdisturb.set\n设置超级群（或频道）默认免打扰，对全体成员生效；scope=all 为群级、scope=channel 需同时传 channelId。覆盖融云 /ultragroup/notdisturb/set.json（兼容 unpushLevel 入参别名）。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021\n幂等：是" }, "response": [] }, { "name": "设置/取消超级群全体禁言（status=true/false，duration 秒可选，缺省为永久）；群级状态写入既有 group.mute-all 状态，因此会真实拦截非群主/管理员/白名单成员的发送（1009）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/globalbanned/set.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"status\": true,\n \"duration\": 0,\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/globalbanned/set", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "globalbanned", "set" ] }, "description": "operationId: ultragroup.globalbanned.set\n设置/取消超级群全体禁言（status=true/false，duration 秒可选，缺省为永久）；群级状态写入既有 group.mute-all 状态，因此会真实拦截非群主/管理员/白名单成员的发送（1009）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/globalbanned/set.json。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021\n幂等：是" }, "response": [] }, { "name": "查询超级群（或频道）全体禁言状态：status 为当前有效状态（带时长的禁言到期后视为 false），until 为到期时间（0=永久）。覆盖融云 /ultragroup/globalbanned/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/globalbanned/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "globalbanned", "get" ] }, "description": "operationId: ultragroup.globalbanned.get\n查询超级群（或频道）全体禁言状态：status 为当前有效状态（带时长的禁言到期后视为 false），until 为到期时间（0=永久）。覆盖融云 /ultragroup/globalbanned/get.json。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021" }, "response": [] }, { "name": "把用户加入超级群全体禁言白名单（userIds 支持数组或逗号分隔字符串，单次 <=20，幂等，白名单总人数 <=1000）；白名单成员在全体禁言期间仍可发送。覆盖融云 /ultragroup/banned/whitelist/add.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/banned/whitelist/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "banned", "whitelist", "add" ] }, "description": "operationId: ultragroup.banned.whitelist.add\n把用户加入超级群全体禁言白名单（userIds 支持数组或逗号分隔字符串，单次 <=20，幂等，白名单总人数 <=1000）；白名单成员在全体禁言期间仍可发送。覆盖融云 /ultragroup/banned/whitelist/add.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1005, 1021\n幂等：是" }, "response": [] }, { "name": "把用户移出超级群全体禁言白名单（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/banned/whitelist/del.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/banned/whitelist/del", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "banned", "whitelist", "del" ] }, "description": "operationId: ultragroup.banned.whitelist.del\n把用户移出超级群全体禁言白名单（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/banned/whitelist/del.json。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021\n幂等：是" }, "response": [] }, { "name": "分页查询超级群全体禁言白名单（page 从 1 开始，pageSize 默认 50、上限 200；同时返回 users[{id}] 与 userIds）。覆盖融云 /ultragroup/banned/whitelist/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"page\": 0,\n \"pageSize\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/banned/whitelist/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "banned", "whitelist", "get" ] }, "description": "operationId: ultragroup.banned.whitelist.get\n分页查询超级群全体禁言白名单（page 从 1 开始，pageSize 默认 50、上限 200；同时返回 users[{id}] 与 userIds）。覆盖融云 /ultragroup/banned/whitelist/get.json。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021" }, "response": [] }, { "name": "禁言指定超级群成员（userIds 单次 <=20，duration 秒可选，缺省永久；群级写入既有成员禁言 Group.muted 并真实拦截发送；单群禁言人数 <=100）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/userbanned/add.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ],\n \"duration\": 0,\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/userbanned/add", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "userbanned", "add" ] }, "description": "operationId: ultragroup.userbanned.add\n禁言指定超级群成员（userIds 单次 <=20，duration 秒可选，缺省永久；群级写入既有成员禁言 Group.muted 并真实拦截发送；单群禁言人数 <=100）。频道级（channelId）仅保存状态。覆盖融云 /ultragroup/userbanned/add.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1005, 1006, 1021\n幂等：是" }, "response": [] }, { "name": "解除指定超级群成员禁言（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/userbanned/del.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userIds\": [\n \"string\"\n ],\n \"channelId\": \"string\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/userbanned/del", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "userbanned", "del" ] }, "description": "operationId: ultragroup.userbanned.del\n解除指定超级群成员禁言（单次 <=20，幂等；不存在时 removed=0）。覆盖融云 /ultragroup/userbanned/del.json。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021\n幂等：是" }, "response": [] }, { "name": "分页查询被禁言的超级群成员（含 until 到期时间与 permanent 标记；pageSize 默认 50、上限 100）。覆盖融云 /ultragroup/userbanned/get.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"channelId\": \"string\",\n \"page\": 0,\n \"pageSize\": 0\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/userbanned/get", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "userbanned", "get" ] }, "description": "operationId: ultragroup.userbanned.get\n分页查询被禁言的超级群成员（含 until 到期时间与 permanent 标记；pageSize 默认 50、上限 100）。覆盖融云 /ultragroup/userbanned/get.json。\n自版本: 1.0.0\n可能错误码: 1001, 1005, 1021" }, "response": [] }, { "name": "查询用户是否为指定超级群成员：status=true/false。覆盖融云 /ultragroup/member/exist.json。", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "App-Key", "value": "{{appKey}}" }, { "key": "Nonce", "value": "{{nonce}}" }, { "key": "Timestamp", "value": "{{timestamp}}" }, { "key": "Signature", "value": "{{signature}}" } ], "body": { "mode": "raw", "raw": "{\n \"groupId\": \"g_1001\",\n \"userId\": \"alice\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{host}}/im/v2/ultragroup/member/exist", "host": [ "{{host}}" ], "path": [ "im", "v2", "ultragroup", "member", "exist" ] }, "description": "operationId: ultragroup.member.exist\n查询用户是否为指定超级群成员：status=true/false。覆盖融云 /ultragroup/member/exist.json。\n自版本: 1.0.0\n可能错误码: 1001, 1004, 1005, 1021" }, "response": [] } ] } ] }