编辑 IVR
编辑 IVR 的配置。
请求 URL
POST {base_url}/{api_path}/ivr/update?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
id | 是 | Integer | IVR 的唯一 ID。 注: 可使用 搜索特定 IVR 接口查询 IVR 的
ID。
|
number | 否 | String | IVR 号码。 |
name | 否 | String | IVR 的名称。 |
prompt | 否 | String | IVR 提示音的名称。 取值范围:
注:
|
prompt_repeat | 否 | Integer | IVR 提示音重复播放的最大次数。 取值范围: |
resp_timeout | 否 | Integer | IVR 提示音播放完成后,系统等待呼叫者输入按键的响应超时时长
(单位:秒)。 取值范围: 注: 若超时未响应,系统将重复播放 IVR 提示音直至达到最大次数,若此时仍超时无响应,通话将被转移至 响应超时目的地。 |
digit_timeout | 否 | Integer | 呼叫者输入的按键和下一个按键间隔的超时时长
(单位:秒)。 取值范围: |
alert_info | 否 | String | INVITE 请求中 Alert-info 头域携带的 “info” 标签值,用于触发话机进行区别振铃。 |
dial_ext_option | 否 | String | 是否允许呼叫者通过该 IVR 拨打分机。 取值范围:
|
dial_ext_list | 否 | Array <Allow_Ext_List> | 允许呼叫者在 IVR 中呼叫的分机或分机组。 |
restrict_dial_ext_list | 否 | Array <Restrict_Ext_List> | 禁止呼叫者在 IVR 中呼叫的分机或分机组。 |
enb_dial_outb_routes | 否 | Integer | 是否允许呼叫者在 IVR 中使用呼出路由拨打外线电话。 取值范围:
|
dial_outb_route_list | 否 | Array <Allow_Route_List> | 允许呼叫者在 IVR 中使用的呼出路由。 |
enb_dial_check_vm | 否 | Integer | 是否允许呼叫者通过 IVR 查阅语音留言。 取值范围:
|
prompt_manger_enb | 否 | Integer | 是否允许呼叫者拨打特征码 #9 修改 IVR
提示音。取值范围:
|
prompt_manger_password | 否 | String | 设置用于修改 IVR 提示音的密码。 |
pressX_dest | 否 | String | 按键 X 的目的地类型。 注: X 指代 0-9 之间的具体数字。 取值范围:
|
pressX_dest_prefix | 否 | String |
此参数的设置取决于按键 X 的目的地类型 (pressX_dest)。 注: X 指代 0-9
之间的具体数字。
|
pressX_dest_value | 否 | String | 设置按键 X 的目的地。此参数的设置取决于按键
X 的目的地类型 (pressX_dest)。 注: X 指代 0-9
之间的具体数字。
|
allow_out_recordX | 否 | Integer | 通话路由至按键 X 的目的地后,停止对该通话进行录音。 注: X 指代 0-9
之间的具体数字。
取值范围:
|
press_hash_dest | 否 | String | 按键 # 的目的地类型。取值范围:
|
press_hash_dest_prefix | 否 | String | 此参数的设置取决于按键 # 的目的地类型。
|
press_hash_dest_value | 否 | String | 按键 # 的目的地。此参数的设置取决于按键 #
的目的地类型。
|
allow_out_record_hash | 否 | Integer | 通话路由至按键 #
的目的地后,停止对该通话进行录音。取值范围:
|
press_star_dest | 否 | String | 按键 * 的目的地类型。取值范围:
|
press_star_dest_prefix | 否 | String | 此参数的设置取决于按键 * 的目的地类型。
|
press_star_dest_value | 否 | String | 按键 * 的目的地。此参数的设置取决于按键 *
的目的地类型。
|
allow_out_record_star | 否 | Integer | 通话路由至按键 *
的目的地后,停止对该通话进行录音。取值范围:
|
timeout_dest | 否 | String | 响应超时的目的地类型。 注: 响应超时是指当系统重复播放提示音达到最大次数后,呼叫者在限定时间内仍未执行任何操作。 取值范围:
|
timeout_dest_prefix | 否 | String | 此参数的设置取决于响应超时的目的地类型。
|
timeout_dest_value | 否 | String | 响应超时的目的地。此参数的设置取决于响应超时的目的地类型。
|
allow_out_record_timeout | 否 | Integer | 通话路由至响应超时的目的地后,停止对该通话进行录音。 取值范围:
|
invalid_dest | 否 | String | 无效按键的目的地类型。 取值范围:
|
invalid_dest_prefix | 否 | String | 此参数的设置取决于无效按键的目的地类型。
|
invalid_dest_value | 否 | String | 无效按键的目的地。此参数的设置取决于无效按键的目的地类型。
|
allow_out_record_invalid | 否 | Integer | 通话路由至无效按键的目的地后,停止对该通话进行录音。 取值范围:
|
- Allow_Ext_List
-
参数 是否必填 类型 说明 value 是 String 允许呼叫的分机 / 分机组 / 部门的 ID。 注: 可使用 获取菜单选项 接口查询分机、分机组及部门的 ID。type 是 String 允许呼叫对象的类型。 取值范围:
extension
:分机。ext_group
:分机组。organization
:部门。
- Restrict_Ext_List
-
参数 是否必填 类型 说明 value 是 String 禁止呼叫的分机 / 分机组 / 部门的 ID。 注: 可使用 获取菜单选项 接口查询分机、分机组及部门的 ID。type 是 String 禁止呼叫对象的类型。 取值范围:
extension
:分机。ext_group
:分机组。organization
:部门。
- Allow_Route_List
-
参数 是否必填 类型 说明 text 否 String 允许呼叫者使用的呼出路由的名称。 value 是 String 允许呼叫者使用的呼出路由的 ID。 注: 可使用 搜索特定呼出路由 接口查询呼出路由的 ID。
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
示例
请求示例
更新 ID 为 1 的 IVR
配置:
- 替换名称为 “自助语音导航”。
- 允许呼叫者通过 IVR 拨打 ID 为 85 的分机。
- 修改按键
#
的事件为播放两次提示音后退出。
POST /openapi/v1.0/ivr/update?access_token=sRuPSzYcPflKgdwSVpA1lhxlVLw0q0z1 HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
"id":1,
"name": "自助语音导航",
"dial_ext_option": "allow",
"dial_ext_list": [
{
"value": "85",
"type": "extension"
}
],
"press_hash_dest": "play_greeting",
"press_hash_dest_prefix": "2",
"press_hash_dest_value": "IVR.wav"
}
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS"
}