查询特定分组

请求 URL

GET {base_url}/dm/open_api/v1/groups/{id}

请求参数

路径参数


参数	是否必填	类型	说明
id	是	Integer	分组 ID。注：可使用查询所有分组查询分组 ID。

请求头


参数	是否必填	类型	说明
Authorization	是	String	在请求头中传递访问 Token。格式：Bearer `{access_token}`。

响应参数


参数	类型	说明
data	Object<Details>	详情。
requestId	String	请求 ID，作为该请求的唯一标识，用于快速定位请求。
status	String	请求结果。 `Success`：请求成功。 `Failed`：请求失败。
time	Long	请求响应的时间。注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见将时间戳转换为日期和时间。

Details


参数	类型	说明
id	Integer	分组 ID。
groupName	String	分组名称。
createTime	Long	分组的创建时间 (Unix 时间戳格式，单位为秒)。
updateTime	Long	分组的最后更新时间 (Unix 时间戳格式，单位为秒)。
selectedDeviceList	Array<Device_List>	已添加到该分组的远程连接设备的信息列表。
selectedPbxList	Array<CloudPBX_List>	已添加到该分组的 P 系列云 PBX 的信息列表。

Device_List


参数	类型	说明
id	Integer	远程连接设备的 ID。
name	String	远程连接设备的名称。
sn	String	远程连接设备的序列号 (SN)。

CloudPBX_List


参数	类型	说明
id	Integer	云 PBX 的 ID。
name	String	云 PBX 的名称。
sn	String	云 PBX 的序列号 (SN)。

示例

查询某分组 (ID：20036) 的详细信息。

请求示例

GET /dm/open_api/v1/groups/20036 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "id": 20036,
        "groupName": "Group1",
        "createTime": 1775719421,
        "updateTime": 1775721030,
        "selectedDeviceList": [
            {
                "id": 1072434,
                "name": "PAE",
                "sn": "36xxxxxxxx88"
            },
            {
                "id": 1053054,
                "name": "PSE",
                "sn": "36xxxxxxxx00"
            }
        ],
        "selectedPbxList": [
            {
                "id": 389283,
                "name": "PCE Demo1",
                "sn": "36xxxxxxxxxxxxPE"
            },
            {
                "id": 276931,
                "name": "PCE Demo2",
                "sn": "36xxxxxxxxxxxxHV"
            },
            {
                "id": 96569,
                "name": "PCE Demo3",
                "sn": "36xxxxxxxxxxxxZK"
            }
        ]
    },
    "requestId": "9d58cc9a5cd746ee5620dc25c9e1d1a4",
    "status": "Success",
    "time": 1775722298
}