查询中继状态监控设置

查询 API 功能中的中继状态监控设置。

请求 URL

GET {base_url}/{api_path}/trunk_status_monitor/list?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • trunk_id
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 中继的总数。
data Array<Monitoring_Settings> 中继的状态监控设置。
Monitoring_Settings
参数 类型 说明
trunk_id Integer 中继的唯一 ID。
name String 中继名称。
enb_call_status Integer
是否启用了通话监控状态。
  • 0：禁用
  • 1：启用
enb_control_inbound_call Integer 是否启用了呼入来电控制，以允许控制由此中继呼入的来电。
  • 0：禁用
  • 1：启用

示例

请求示例

GET /openapi/v1.0/trunk_status_monitor/list?access_token=QytWnoLcod7RFB5f0S5oX4ORMbKPbU5t&page=1&page_size=2&sort_by=trunk_id&order_by=asc HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 6,
    "data": [
        {
            "trunk_id": 14,
            "name": "Register1",
            "enb_call_status": 0,
            "enb_control_inbound_call": 1
        },
        {
            "trunk_id": 15,
            "name": "Register2",
            "enb_call_status": 0,
            "enb_control_inbound_call": 1
        }
    ]
}