查询指定共享中继的状态

查询指定共享中继的状态。

请求 URL

GET {base_url}/dm/open_api/v1/shared_trunk/{id}/status

请求参数

路径参数

参数 是否必填 类型 说明
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。
status String 共享中继的状态。
  • E_REGISTER_SUCCESS_STATE：注册成功 / 连接成功。
  • E_REGISTER_ING_STATE：注册中 / 连接中。
  • E_REGISTER_FAILED_STATE：注册失败 / 连接失败。
statusFailedReason String 共享中继失败状态的原因。
  • REASON_AUTH：认证失败。
  • REASON_TIMEOUT：超时。
  • REASON_ERROR：错误。

示例

请求示例

查询注册中继 (ID: 6680) 的状态。

GET /dm/open_api/v1/shared_trunk/6680/status HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******

响应示例

HTTP/1.1 200 OK
{
    "data": {
        "id": 6680,
        "status": "E_REGISTER_SUCCESS_STATE",
        "statusFailedReason": ""
    },
    "requestId": "11bc7135cfaa97ad61747775176e133e",
    "status": "Success",
    "time": 1747031006
}