搜索特定 IVR
在 IVR 列表中搜索特定的 IVR。
请求 URL
GET {base_url}/{api_path}/ivr/search?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
page | 否 | Integer | 定义显示第几个页面。 |
page_size | 否 | Integer | 定义每页显示几项查询结果。 |
sort_by | 否 | String | 定义排序字段。 取值范围:
|
order_by | 否 | String | 定义显示顺序。 取值范围:
|
search_value | 否 | String | 搜索关键字。 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
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
:允许。
示例
请求示例
搜索号码为 “6200” 的 IVR。
GET /openapi/v1.0/ivr/search?access_token=Jh5d63SPHsNMnv6nzoOgUeKDyXSuOGxg&search_value=6200 HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 1,
"data": [
{
"id": 1,
"number": "6200",
"name": "客户服务",
"dial_ext_option": "allow",
"enb_dial_outb_routes": 1
}
]
}