查询固定会议室列表

查询通过 PBX 管理网页或 API 请求创建的固定会议室列表。

请求 URL

GET {base_url}/{api_path}/conference/list?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
page 是 Integer 定义显示第几个页面。
page_size 是 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • number (默认)
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc；升序 (默认)。
  • desc：降序。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 固定会议室总数。
data Array<Conference_Info> 固定会议室信息。
Conference_Info
表 3.
参数 类型 说明
id Integer 会议室 ID。
name String 会议室名称。
number String 会议室号码。
moderator_list Array<Moderator_List> 会议室管理员信息列表。
Moderator_List
参数 类型 说明
id String 会议室管理员 ID。
name String 会议室管理员名称。
type String 会议室管理员类型。
  • extension：分机。
  • ext_group：分机组。

示例

请求示例

GET /openapi/v1.0/conference/list?access_token=4mZxlzE08rl3g7rE7wjoMIowMoVkMvUr&page=1&page_size=5 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "data": [
        {
            "id": 1,
            "name": "Sales Weekly Meeting",
            "number": "6500",
            "moderator_list": [
                {
                    "id": "50",
                    "name": "Emily Parker",
                    "type": "extension"
                }
            ]
        },
        {
            "id": 2,
            "name": "Support Case Review",
            "number": "6501",
            "moderator_list": [
                {
                    "id": "47",
                    "name": "Michael Harris",
                    "type": "extension"
                }
            ]
        },
        {
            "id": 3,
            "name": "Marketing Planning Room",
            "number": "6502",
            "moderator_list": [
                {
                    "id": "55",
                    "name": "Kevin Thompson",
                    "type": "extension"
                },
                {
                    "id": "202",
                    "name": "Krisin Hale",
                    "type": "extension"
                }
            ]
        }
    ]
}