黑盒语音接口
  1. 房间接口
黑盒语音接口
  • 教程
  • 开发者服务协议
  • 使用交流
  • 更新日志
  • 开发计划
  • 资源
    • 请求速率限制
    • Websocket
    • Bot命令
  • WEBSOCKET 连接请求
    • 连接到黑盒语音服务
  • HTTP接口
    • 消息接口
      • 发送消息接口的参数
      • 发送消息接口的返回值
      • 发送图片形式的频道消息
      • 发送Markdown文档
      • 更新指定频道消息
      • 删除指定的频道消息
      • 对某条频道消息增加/取消回应(小表情)
      • 发送卡片消息
      • 给用户发送私聊消息
      • 发送频道图片消息
      • 发送频道消息
      • 发送卡片消息
      • 发送频道消息@全体成员/@在线成员
      • 更新指定的频道消息
      • 删除指定的频道消息
      • 对某条频道消息增加/取消回应(小表情)
      • 给用户发送私聊消息
    • 媒体文件上传
      • 上传媒体文件的参数解析
      • 上传媒体文件
    • 房间角色接口
      • 权限相关说明
      • 接口说明
      • 获取房间角色列表
      • 创建角色
      • 更新角色
      • 删除角色
      • 对指定用户授予指定权限
      • 对指定用户剥夺指定权限
    • 房间表情
      • 房间表情包
      • 获取房间上传的表情包
      • 房间删除表情包
      • 房间更新表情包名称
    • 房间接口
      • 房间相关接口文档
      • 修改房间内昵称
        POST
      • 分页获取加入的房间列表
        GET
      • 获取房间信息
        GET
      • 退出房间
        POST
      • 房间踢人
        POST
      • 获取房间用户列表
        POST
  • 服务端推送事件
    • 事件说明
    • 通用推送字段
    • 机器人命令
      • 用户使用Bot命令
    • 频道消息事件
      • 频道消息事件
    • 房间消息事件
      • 房间消息事件
  1. 房间接口

分页获取加入的房间列表

开发中
GET
https://chat.xiaoheihe.cn/chatroom/v2/room/joined

请求参数

Authorization
在 header 添加参数
token
示例:
token: ********************
Query 参数
offset
string 
可选
示例值:
0
limit
string 
可选
示例值:
20
client_type
string 
声明请求黑盒语音
必需
默认值:
heybox_chat
x_client_type
string 
声明客户端类型
必需
默认值:
web
os_type
string 
声明客户端类型
必需
默认值:
web
x_os_type
string 
声明客户端是bot
必需
默认值:
bot
x_app
string 
声明请求黑盒语音
必需
默认值:
heybox_chat
chat_os_type
string 
声明客户端是bot
必需
默认值:
bot
chat_version
string 
必需
客户端版本号,不同版本返回的结果可能有区别
默认值:
1.30.0
Header 参数
Content-Type
string 
必需
示例值:
application/json;charset=UTF-8

示例代码

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://chat.xiaoheihe.cn/chatroom/v2/room/joined?offset=0&limit=20&client_type=&x_client_type=&os_type=&x_os_type=&x_app=&chat_os_type=&chat_version=' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'token;'

返回响应

🟢200成功
application/json
Body
msg
string 
必需
result
object 
必需
rooms
array [object {9}] 
必需
total
integer 
必需
offset
integer 
必需
limit
integer 
必需
status
string 
必需
示例
{
  "msg": "",
  "result": {
    "rooms": {
      "rooms": [
        {
          "room_id": "3581310465924767744",
          "room_name": "酸辣鸡杂面的房间111",
          "room_avatar": "https://imgheybox.max-c.com/web/bbs/2024/05/15/b75155eb87b7291db491f7d71d0b1b1b.png",
          "create_by": 43028164,
          "room_pic": "https://imgheybox.max-c.com/web/bbs/2024/05/15/225d1dff187a7f948a8fd1f2a9f77ae8.png",
          "is_public": 1,
          "public_id": "247023",
          "is_hot": 0,
          "join_time": 1717125593578
        },
        {
          "room_id": "3382196129213980672",
          "room_name": "V我50买个麦旋风的房间",
          "room_avatar": "",
          "create_by": 43028164,
          "room_pic": "",
          "is_public": 0,
          "public_id": "",
          "is_hot": 0,
          "join_time": 1716810434913
        },
        {
          "room_id": "3412263855248646144",
          "room_name": "从军官方社区",
          "room_avatar": "https://imgheybox.max-c.com/web/bbs/2023/09/25/fe926e23fe82b776102b0bf1841e5b85.png",
          "create_by": 18083425,
          "room_pic": "https://imgheybox.max-c.com/web/bbs/2023/12/06/f18ac0643f72211188c1207f0a9bdef1.jpeg",
          "is_public": 1,
          "public_id": "290656",
          "is_hot": 1,
          "join_time": 1716810415963
        },
        {
          "room_id": "3347220983638401024",
          "room_name": "测试房间",
          "room_avatar": "",
          "create_by": 43028164,
          "room_pic": "",
          "is_public": 0,
          "public_id": "",
          "is_hot": 0,
          "join_time": 1716614542385
        }
      ],
      "total": 4,
      "offset": 0,
      "limit": 20
    }
  },
  "status": "ok"
}
修改于 2024-12-10 08:40:30
上一页
修改房间内昵称
下一页
获取房间信息
Built with