查询分配给云 PBX 的共享中继

查询与指定云 PBX 关联的共享中继。

请求 URL

GET {base_url}/dm/open_api/v1/shared_trunk/pbx/used

请求参数

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

格式：Bearer {access_token}。
查询参数
参数 是否必填 类型 说明
cloudPbxId 是 Long 指定云 PBX 的 ID。
注： 可使用 查询所有云 PBX 接口查询云 PBX ID。

响应参数

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

示例

请求示例

GET /dm/open_api/v1/shared_trunk/pbx/used?cloudPbxId=4769 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "sharedTrunkIds": [
            6680
        ]
    },
    "requestId": "12e9bd8936d05ca4dd67c85d0e4796f1",
    "status": "Success",
    "time": 1747032632
}