创建分组

创建一个分组，并将一个或多个 P 系列云 PBX 实例添加到该分组中。

请求 URL

POST {base_url}/dm/open_api/v1/groups

请求参数

请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
groupName 是 String 分组名称。
注： 长度不可超过 127 个字符。
pbxIdList 否 Array<Integer> 要添加到分组的 P 系列云 PBX 的 ID。
注：
  • 可使用 查询所有云 PBX 查询云 PBX ID。
  • 使用半角逗号 , 分隔多个 ID。例如，[389283,96569]。

响应参数

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

示例

请求示例

创建一个分组。

POST /dm/open_api/v1/groups HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******
Content-Type: application/json

{
    "groupName":"API-Created Group",
    "pbxIdList":[389283,96569]
}

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "id": 20039
    },
    "requestId": "5a2815c66a3eedeea5f1938d36a914d5",
    "status": "Success",
    "time": 1775724942
}