Skip to content

分组列表

请求路径

  • 请求方式:POST
  • 请求头:Content-Type:application/json
  • 接口地址:https://gateway.nuoyunapi.com/Api/Room/getRoomGroupList/2.0.0
  • 频率限制:10秒100次

请求参数

参数必选类型描述
pageinteger第几页(最小值1)
page_sizeinteger一页显示多少(最小值1,最大值100)
search_namestring要搜索的名称(可传空字符串)

请求示例

示例1:获取所有分组

json
{
    "search_name": "",
    "page": 1,
    "page_size": 10
}

示例2:搜索指定名称的分组

json
{
    "search_name": "直播",
    "page": 1,
    "page_size": 20
}

响应参数

参数必选类型描述
codeinteger状态码:200-成功,400-失败
msgstring提示信息
dataobject分组数据

data 参数结构

参数必选类型描述
totalinteger分组总量
listarray分组列表

list 参数结构

参数必选类型描述
idinteger分组ID
namestring分组名称
sortinteger排序值(值越小越靠前)
create_timestring创建时间

响应示例

成功响应示例

json
{
    "code": 200,
    "msg": "Success",
    "data": {
        "total": 5,
        "list": [
            {
                "id": 1001,
                "name": "产品直播间",
                "sort": 1,
                "create_time": "2025-08-01 10:30:00"
            },
            {
                "id": 1002,
                "name": "营销活动",
                "sort": 2,
                "create_time": "2025-08-01 11:15:30"
            },
            {
                "id": 1003,
                "name": "培训教育",
                "sort": 3,
                "create_time": "2025-08-02 09:20:15"
            },
            {
                "id": 1004,
                "name": "品牌宣传",
                "sort": 4,
                "create_time": "2025-08-02 14:45:20"
            },
            {
                "id": 1005,
                "name": "客户服务",
                "sort": 5,
                "create_time": "2025-08-03 16:10:45"
            }
        ]
    }
}

搜索无结果示例

json
{
    "code": 200,
    "msg": "Success",
    "data": {
        "total": 0,
        "list": []
    }
}

错误响应示例

json
{
    "code": 400,
    "msg": "请选择第几页",
    "data": {}
}