查询 IVR 列表

查询 PBX 的 IVR 列表。

请求 URL

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

请求参数

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

取值范围：

  • id
  • number
  • name
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer IVR 总数。
data Array <IVR_List> 每个 IVR 的信息。
IVR_List
参数 类型 说明
id Integer IVR 的唯一 ID。
number String IVR 号码。
name String IVR 的名称。
dial_ext_option String 是否允许呼叫者通过该 IVR 拨打分机。
  • disable：禁止拨打分机。
  • all：允许拨打所有分机。
  • allow：允许拨打指定的分机。
  • restrict：禁止拨打指定的分机。
enb_dial_outb_routes Integer 是否允许呼叫者在 IVR 中使用呼出路由拨打外线电话。
  • 0：禁止。
  • 1：允许。

示例

请求示例

GET /openapi/v1.0/ivr/list?access_token=Jh5d63SPHsNMnv6nzoOgUeKDyXSuOGxg&page=1&page_size=20&sort_by=id&order_by=asc HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 4,
    "data": [
        {
            "id": 1,
            "number": "6202",
            "name": "信息查询",
            "dial_ext_option": "disable",
            "enb_dial_outb_routes": 0
        },
        {
            "id": 2,
            "number": "6203",
            "name": "语音导航",
            "dial_ext_option": "disable",
            "enb_dial_outb_routes": 0
        },
        {
            "id": 3,
            "number": "6200",
            "name": "客户服务",
            "dial_ext_option": "allow",
            "enb_dial_outb_routes": 1
        },
        {
            "id": 4,
            "number": "6201",
            "name": "自助服务",
            "dial_ext_option": "all",
            "enb_dial_outb_routes": 1
        }
    ]
}