查询单个 IVR 信息

查询单个 IVR 的详细信息。

请求 URL

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

请求参数

参数 是否必填 类型 说明
id Integer IVR 的唯一 ID。
注: 可使用 搜索特定 IVR 接口查询 IVR 的 ID。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
data Object <IVR_DetailInfo> IVR 的详细信息。
IVR_DetailInfo
参数 类型 说明
id Integer IVR 的唯一 ID。
number String IVR 号码。
name String IVR 的名称。
prompt String IVR 提示音的名称。
prompt_repeat Integer IVR 提示音重复播放的最大次数。
resp_timeout Integer IVR 提示音播放完成后,系统等待呼叫者输入按键的响应超时时长 (单位:秒)。
注: 若超时未响应,系统将重复播放 IVR 提示音直至达到最大次数,若此时仍超时无响应,通话将被转移至 响应超时目的地
digit_timeout Integer 呼叫者输入的按键和下一个按键间隔的超时时长 (单位:秒)。
dial_ext_option String 是否允许呼叫者通过该 IVR 拨打分机。
  • disable:禁止拨打分机。
  • all:允许拨打所有分机。
  • allow:允许拨打指定的分机。
  • restrict:禁止拨打指定的分机。
enb_dial_outb_routes Integer 是否允许呼叫者在 IVR 中使用呼出路由拨打外线电话。
  • 0:禁止。
  • 1:允许。
enb_dial_check_vm Integer 是否允许呼叫者通过 IVR 查阅语音留言。
  • 0:禁止。
  • 1:允许。
pressX_dest String 按键 X 的目的地类型。
注: X 指代 0-9 之间的具体数字。
  • end_call:挂断。
  • extension:分机。
  • ext_vm:分机语音信箱。
  • ivr:IVR。
  • ring_group:响铃组。
  • queue:队列。
  • group_vm:群语音信箱。
  • conference:会议室。
  • dial_by_name:通过名称呼叫。
  • external_num:外部号码。
  • play_greeting:播放提示音后退出。
  • play_prompt:播放提示音后返回当前 IVR。
pressX_dest_prefix String

按键 X 的目的地类型 (pressX_dest) 不同,返回的参数值也不同。

注: X 指代 0-9 之间的具体数字。
  • 当目的地类型为 external_num 时,此参数返回外部号码的拨号前缀。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回提示音的播放次数。
pressX_dest_value String 按键 X 的目的地。按键 X 的目的地类型 (pressX_dest) 不同,返回的参数值也不同。
注: X 指代 0-9 之间的具体数字。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionext_vmivrring_groupqueuegroup_vm、或 conference 时,此参数返回目的地的 ID。

    例如:目的地为分机 2002,则该参数返回分机 2002 的 ID 2

  • 当目的地的类型为 external_num 时,此参数返回外部号码。
allow_out_recordX Integer 通话路由至按键 X 的目的地后,停止对该通话进行录音。
注: X 指代 0-9 之间的具体数字。
  • 0:禁用。
  • 1:启用。
press_hash_dest String 按键 # 的目的地类型。
  • end_call:挂断。
  • extension:分机。
  • ext_vm:分机语音信箱。
  • ivr:IVR。
  • ring_group:响铃组。
  • queue:队列。
  • group_vm:群语音信箱。
  • conference:会议室。
  • dial_by_name:通过名称呼叫。
  • external_num:外部号码。
  • play_greeting:播放提示音后退出。
  • play_prompt:播放提示音后返回当前 IVR。
press_hash_dest_prefix String 按键 # 的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 external_num 时,此参数返回外部号码的拨号前缀。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回提示音的播放次数。
press_hash_dest_value String 按键 # 的目的地。按键 # 的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionext_vmivrring_groupqueuegroup_vm、或 conference 时,此参数返回目的地的 ID。

    例如:目的地为分机 2002,则该参数返回分机 2002 的 ID 2

  • 当目的地的类型为 external_num 时,此参数返回外部号码。
allow_out_record_hash Integer 通话路由至按键 # 的目的地后,停止对该通话进行录音。
  • 0:禁用。
  • 1:启用。
press_star_dest String 按键 * 的目的地类型。
  • end_call:挂断。
  • extension:分机。
  • ext_vm:分机语音信箱。
  • ivr:IVR。
  • ring_group:响铃组。
  • queue:队列。
  • group_vm:群语音信箱。
  • conference:会议室。
  • dial_by_name:通过名称呼叫。
  • external_num:外部号码。
  • play_greeting:播放提示音后退出。
  • play_prompt:播放提示音后返回当前 IVR。
press_star_dest_prefix String 按键 * 的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 external_num 时,此参数返回外部号码的拨号前缀。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回提示音的播放次数。
press_star_dest_value String 按键 * 的目的地。按键 * 的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionext_vmivrring_groupqueuegroup_vm、或 conference 时,此参数返回目的地的 ID。

    例如:目的地为分机 2002,则该参数返回分机 2002 的 ID 2

  • 当目的地的类型为 external_num 时,此参数返回外部号码。
allow_out_record_star Integer 通话路由至按键 * 的目的地后,停止对该通话进行录音。
  • 0:禁用。
  • 1:启用。
timeout_dest String 响应超时的目的地类型。
注: 响应超时是指当系统重复播放提示音达到最大次数后,呼叫者在限定时间内仍未执行任何操作。
  • end_call:挂断。
  • extension:分机。
  • ext_vm:分机语音信箱。
  • ivr:IVR。
  • ring_group:响铃组。
  • queue:队列。
  • group_vm:群语音信箱。
  • conference:会议室。
  • dial_by_name:通过名称呼叫。
  • external_num:外部号码。
  • play_greeting:播放提示音后退出。
  • play_prompt:播放提示音后返回当前 IVR。
timeout_dest_prefix String 响应超时的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 external_num 时,此参数返回外部号码的拨号前缀。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回提示音的播放次数。
timeout_dest_value String 响应超时的目的地。响应超时的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionext_vmivrring_groupqueuegroup_vm、或 conference 时,此参数返回目的地的 ID。

    例如:目的地为分机 2002,则该参数返回分机 2002 的 ID 2

  • 当目的地的类型为 external_num 时,此参数返回外部号码。
allow_out_record_timeout Integer 通话路由至响应超时的目的地后,停止对该通话进行录音。
  • 0:禁用。
  • 1:启用。
invalid_dest String 无效按键的目的地类型。
  • end_call:挂断。
  • extension:分机。
  • ext_vm:分机语音信箱。
  • ivr:IVR。
  • ring_group:响铃组。
  • queue:队列。
  • group_vm:群语音信箱。
  • conference:会议室。
  • dial_by_name:通过名称呼叫。
  • external_num:外部号码。
  • play_greeting:播放提示音后退出。
  • play_prompt:播放提示音后返回当前 IVR。
invalid_dest_prefix String 无效按键的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 external_num 时,此参数返回外部号码的拨号前缀。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回提示音的播放次数。
invalid_dest_value String 无效按键的目的地。无效按键的目的地类型不同,返回的参数值也不同。
  • 当目的地类型为 play_greetingplay_prompt 时,此参数返回自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionext_vmivrring_groupqueuegroup_vm、或 conference 时,此参数返回目的地的 ID。

    例如:目的地为分机 2002,则该参数返回分机 2002 的 ID 2

  • 当目的地的类型为 external_num 时,此参数返回外部号码。
allow_out_record_invalid Integer 通话路由至无效按键的目的地后,停止对该通话进行录音。
  • 0:禁用。
  • 1:启用。
dial_ext_list Array <Allow_Ext_List> 允许呼叫者在 IVR 中呼叫的分机或分机组。
restrict_dial_ext_list Array <Restrict_Ext_List> 禁止呼叫者在 IVR 中呼叫的分机或分机组。
dial_outb_route_list Array <Allow_Route_List> 允许呼叫者在 IVR 中使用的呼出路由。
alert_info String INVITE 请求中 Alert-info 头域携带的 “info” 标签值,用于触发话机进行区别振铃。
prompt_manger_enb Integer 是否允许呼叫者拨打特征码 #9 修改 IVR 提示音。
  • 0:禁止。
  • 1:允许。
prompt_manger_password String 用于修改 IVR 提示音的密码。
Allow_Ext_List
参数 类型 说明
text String 允许呼叫的分机 / 分机组 / 部门名称。
text2 String 允许呼叫的分机号,或分机组 / 部门的名称。
value String 允许呼叫的分机 / 分机组 / 部门的 ID。
type String 允许呼叫对象的类型。
  • extension:分机。
  • ext_group:分机组。
  • organization:部门。
Restrict_Ext_List
参数 类型 说明
text String 禁止呼叫的分机 / 分机组 / 部门名称。
text2 String 禁止呼叫的分机号,或分机组 / 部门的名称。
value String 禁止呼叫的分机 / 分机组 / 部门的 ID。
type String 禁止呼叫对象的类型。
  • extension:分机。
  • ext_group:分机组。
  • organization:部门。
Allow_Route_List
参数 类型 说明
text String 允许呼叫者使用的呼出路由的名称。
value String 允许呼叫者使用的呼出路由的 ID。

示例

请求示例

查询 ID 为 5 的 IVR 详细信息。
GET /openapi/v1.0/ivr/get?access_token=sRuPSzYcPflKgdwSVpA1lhxlVLw0q0z1&id=5 HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 5,
        "number": "6204",
        "name": "语音客服",
        "prompt": "default",
        "prompt_repeat": 3,
        "resp_timeout": 3,
        "digit_timeout": 3,
        "dial_ext_option": "allow",
        "enb_dial_outb_routes": 1,
        "enb_dial_check_vm": 0,
        "press0_dest": "conference",
        "press0_dest_prefix": "",
        "press0_dest_value": "1",
        "allow_out_record0": 0,
        "press1_dest": "extension",
        "press1_dest_prefix": "",
        "press1_dest_value": "73",
        "allow_out_record1": 0,
        "press2_dest": "ext_vm",
        "press2_dest_prefix": "123",
        "press2_dest_value": "73",
        "allow_out_record2": 0,
        "press3_dest": "ivr",
        "press3_dest_prefix": "",
        "press3_dest_value": "1",
        "allow_out_record3": 0,
        "press4_dest": "ring_group",
        "press4_dest_prefix": "",
        "press4_dest_value": "4",
        "allow_out_record4": 0,
        "press5_dest": "queue",
        "press5_dest_prefix": "",
        "press5_dest_value": "1",
        "allow_out_record5": 0,
        "press6_dest": "play_greeting",
        "press6_dest_prefix": "3",
        "press6_dest_value": "IVR.wav",
        "allow_out_record6": 0,
        "press7_dest": "play_prompt",
        "press7_dest_prefix": "5",
        "press7_dest_value": "IVR.wav",
        "allow_out_record7": 0,
        "press8_dest": "external_num",
        "press8_dest_prefix": "123",
        "press8_dest_value": "123456",
        "allow_out_record8": 0,
        "press9_dest": "ext_vm",
        "press9_dest_prefix": "",
        "press9_dest_value": "73",
        "allow_out_record9": 0,
        "press_hash_dest": "",
        "press_hash_dest_prefix": "",
        "press_hash_dest_value": "",
        "allow_out_record_hash": 0,
        "press_star_dest": "",
        "press_star_dest_prefix": "",
        "press_star_dest_value": "",
        "allow_out_record_star": 0,
        "timeout_dest": "",
        "timeout_dest_prefix": "",
        "timeout_dest_value": "",
        "allow_out_record_timeout": 0,
        "invalid_dest": "",
        "invalid_dest_prefix": "",
        "invalid_dest_value": "",
        "allow_out_record_invalid": 0,
        "dial_ext_list": [
            {
                "text": "Support",
                "text2": "Support",
                "value": "86",
                "type": "ext_group"
            },
            {
                "text": "Phillip Huff",
                "text2": "1001",
                "value": "85",
                "type": "extension"
            }
        ],
        "dial_outb_route_list": [
            {
                "text": "to39",
                "value": "1"
            }
        ],
        "alert_info": "",
        "prompt_manger_enb": 0,
        "prompt_manger_password": "****"
    }
}