Query a Specific Group

Query the detailed information of a specific group.

Request URL

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

Request parameters

Path parameter
Parameter Required Type Description
id Yes Integer The ID of the group.
Note: You can query the group ID using Query All the Groups.
Headers
Parameter Required Type Description
Authorization Yes String Pass the access token in the header.

Format: Bearer {access_token}.

Response parameters

Parameter Type Description
data Object<Details> The detailed information.
requestId String The unique ID of the request, which can be used to quickly locate the request.
status String Request result:
  • Success
  • Failed
time Long The response time.
Note: The YCM API response returns a timestamp, you can convert the timestamp to detailed date and time as needed. For more information, see Convert Timestamp to Local Date and Time.
Details
Parameter Type Description
id Integer The ID of the group.
groupName String Group name.
createTime Long The time when the group was created (Unix timestamp in seconds).
updateTime Long The time when the group was last updated (Unix timestamp in seconds).
selectedDeviceList Array<Device_List> The information list of the remotely connected devices that are added to the group.
selectedPbxList Array<CloudPBX_List> The information list of the P-Series Cloud PBXs that are added to the group.
Device_List
Parameter Type Description
id Integer The ID of the remotely connected device.
name String The name of the remotely connected device.
sn String The serial number (SN) of the remotely connected device.
CloudPBX_List
Parameter Type Description
id Integer The ID of the Cloud PBX.
name String The name of the Cloud PBX.
sn String The serial number (SN) of the Cloud PBX.

Example

Query the information of a group (ID: 20036).

Request example

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

Response example

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
}