即时通信
  1. 聊天室成员
即时通信
  • API在线调试指南
  • IM账号管理
    • 注册云信IM账号
      POST
    • 更新账号属性
      PATCH
    • 刷新 Token
      PATCH
    • 封禁账号
      PATCH
    • 更新移动端推送配置
      PATCH
    • 查询账号属性
      GET
    • 批量查询账号信息
      GET
    • 强制账号退出登录
      POST
  • 用户名片管理
    • 更新用户名片
    • 查询用户名片
    • 批量查询用户名片
    • 批量获取账号在线状态
  • 好友管理
    • 添加好友
    • 删除好友
    • 更新好友信息
    • 查询好友信息
    • 分页查询好友列表
    • 同意/拒绝添加好友
  • 静音管理
    • 分页查询静音列表
    • 解除静音
    • 设置静音
  • 黑名单管理
    • 列入黑名单
    • 移出黑名单
    • 分页查询黑名单列表
  • 消息管理
    • 发送消息
    • 批量发送单聊消息
    • 撤回/删除消息
    • 删除会话中漫游/历史消息
    • 发送单聊已读回执
    • 发送高级群已读回执
    • 查询群消息已读未读详情
    • 查询单条消息
    • 分页查询历史消息
    • 发送聊天室消息
    • 批量发送聊天室消息
    • 撤回/删除聊天室历史消息
    • 分页查询聊天室历史消息
    • 更新消息
    • 根据消息 ID 查询历史消息
    • 查询 Thread 消息
    • 添加快捷评论
    • 删除快捷评论
    • 查询快捷评论
    • 检索历史消息
    • 发送流式消息
  • 会话功能
    • 会话管理
      • 创建会话
      • 更新会话
      • 删除会话
      • 批量删除会话
      • 查询会话信息
      • 批量查询会话信息
      • 分页查询账号的所有会话列表
    • 会话未读数管理
      • 获取会话总未读数
    • 会话分组
      • 创建会话分组
      • 更新会话分组
      • 删除会话分组
      • 查询会话分组信息
      • 批量查询会话分组信息
      • 查询所有会话分组信息
  • 群组功能
    • 群成员
      • 拉人入群
      • 踢人出群
      • 主动退群
      • 更新群成员信息
      • 批量禁言群成员
      • 分页查询指定账号已加入的群组信息
    • 群组管理
      • 创建群组
      • 更新群组信息
      • 转让群主
      • 添加管理员
      • 移除管理员
      • 解散群组
      • 查询群组信息
      • 批量查询群组信息列表
      • 查询高级群在线成员列表
      • 批量查询高级群的在线成员数
      • 分页查询群成员列表
  • 聊天室功能
    • 聊天室管理
      • 创建聊天室
      • 获取聊天室地址
      • 查询聊天室信息
      • 更新聊天室信息
      • 开放/关闭聊天室
      • 聊天室禁言
      • 开启/关闭进出聊天室事件通知
      • 查询开放状态的聊天室
      • 分页查询聊天室在线成员列表
      • 查询聊天室固定成员列表
    • 聊天室成员
      • 设置聊天室成员角色
        POST
      • 更新聊天室在线成员信息
        PATCH
      • 禁言聊天室成员
        PATCH
      • 临时禁言聊天室成员
        PATCH
      • 查询聊天室的禁言列表
        GET
      • 拉黑聊天室成员
        PATCH
      • 聊天室标签禁言
        PATCH
      • 查询聊天室黑名单列表
        GET
      • 聊天室标签禁言
        PATCH
      • 修改聊天室在线成员标签
        PATCH
      • 查询标签下的在线成员数
        GET
      • 分页查询标签下的在线成员列表
        GET
      • 批量查询聊天室固定成员信息
        GET
      • 添加聊天室虚构用户
        POST
      • 删除聊天室虚构用户
        DELETE
      • 清空聊天室虚构用户
        DELETE
      • 查询聊天室虚构用户
        GET
    • 聊天室队列
      • 初始化聊天室队列
      • 删除聊天室队列
      • 更新聊天室队列
      • 查询聊天室队列元素
      • 从聊天室队列中取出元素
  • 广播消息管理
    • 发送广播消息
    • 删除广播消息
    • 查询广播消息
    • 分页查询广播消息
    • 发送聊天室全服广播消息
  • 系统通知管理
    • 发送自定义系统通知
    • 批量发送自定义系统通知
  • 发布订阅
    • 订阅在线状态事件
    • 查询在线状态事件订阅关系
    • 取消在线状态事件订阅
  • 翻译
    • 文本翻译
  1. 聊天室成员

批量查询聊天室固定成员信息

GET
/im/v2/room_members/{room_id}/actions/batch

请求参数

Path 参数
room_id
integer 
聊天室 ID。
必需
Query 参数
account_ids
array[string]
必需
需要查询的聊天室成员列表,一次最多查询 200 个账号。
Header 参数
AppKey
string 
必需
默认值:
{{AppKey}}
X-custom-traceid
string 
可选
默认值:
{% mock 'uuid' %}
Nonce
string 
必需
默认值:
{{Nonce}}
CurTime
string 
必需
默认值:
{{CurTime}}
CheckSum
string 
必需
默认值:
{{CheckSum}}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://open.yunxinapi.com/im/v2/room_members//actions/batch?account_ids' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
msg
string 
必需
data
object 
必需
failed_list
array [object {3}] 
可选
success_list
array [object {17}] 
必需
room_id
number 
聊天室ID
必需
account_id
string 
成员的帐号ID
必需
room_nick
string 
成员昵称
必需
room_avatar
string 
成员头像
必需
extension
string 
开发者扩展字段
必需
member_role
integer 
必需
角色类型:
查询固定成员的类型
0: 普通用户(非游客)
1: 创建者(非游客)
2: 管理员(非游客)
3:普通游客
4: 匿名游客
tags
string 
必需
只有在线成员且登录时指定了标签才会有此字段
notify_target_tags
string 
必需
只有在线成员且登录时指定了通知标签才会有此字段
member_level
integer 
必需
成员级别(若未设置成员级别,则无此字段)
is_online
boolean 
是否在线
必需
enter_time
number 
进入聊天室的时间点
必需
blocked
boolean 
是否在黑名单中
必需
chat_banned
boolean 
是否被禁言
必需
temp_chat_banned
boolean 
是否被临时禁言
必需
temp_chat_banned_time
number 
必需
临时禁言的解除时长,单位秒
online_info_list
array [object {6}] 
在线的成员信息
必需
online_count
string 
在线端的数量
必需
示例
{
    "code": 200,
    "msg": "ok",
    "data": {
        "success_list": [
            {
                "extension": "magna Lorem 01",
                "account_id": "yx1",
                "room_nick": "黄涛03",
                "room_avatar": "incididunt ad",
                "member_role": "MANAGER",
                "is_online": false,
                "blocked": false,
                "chat_banned": false,
                "temp_chat_banned": false
            }
        ],
        "failed_list": [
            {
                "account_id": "yx6",
                "error_code": 114404,
                "error_msg": "chatroom member does not exist"
            }
        ]
    }
}
🟢200成功
🟢200请求参数错误
🟢200服务器错误
上一页
分页查询标签下的在线成员列表
下一页
添加聊天室虚构用户
Built with