搜索特定 IVR

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

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：允许。
client_unique_ringtone	String	分机用户接收到来自该 IVR 来电时，其 Linkus 客户端将播放的特色铃声。
enable_time_condition	Integer	是否启用时间条件。 0：禁用 1：启用
time_condition_type	String	时间条件类型。 unified：所有按键使用统一的时间条件。 custom：各个按键分别使用自定义时间条件。
time_base_mode	String	时间类型。 global_office_time：使用各时区配置的办公时间。 custom_office_time：使用自定义办公时间。 custom_time_periods：使用自定义时间段。
time_conditions	Array<Time_Condition>	时间条件配置。
press_key_option_list	Array<Keypress_Setting>	IVR 按键配置。

Time_Condition

参数	类型	说明
id	Integer	记录 ID。
ivr_id	Integer	IVR ID。
allow_out_record	Integer	通话路由至按键目的地后，是否停止对该通话进行录音。 0：禁用。 1：启用。
months	String	办公时间适用的月份。 all：每月 jan：一月 feb：二月 mar：三月 apr：四月 may：五月 jun：六月 jul：七月 aug：八月 sep：九月 oct：十月 nov：十一月 dec：十二月
days_of_week	String	办公时间适用的星期。 all：每天 sun：周日 mon：周一 tue：周二 wed：周三 thu：周四 fri：周五 sat：周六
days	String	办公时间适用的日期。 all：每月的每一天 1-31：每月指定的日期
office_times	Array<Time_Period>	办公时间段列表。
time_condition_switch	Integer	是否启用高级时间条件。 0：禁用。 1：启用。
dest	String	目的地类型。 end_call：挂断。 extension：分机。 ext_vm：分机语音信箱。 ivr：IVR。 call_flow：通话流程。 ai_receptionist：AI 接待员。 ring_group：响铃组。 queue：队列。 group_vm：群语音信箱。 conference：会议室。 dial_by_name：通过名称呼叫。 external_num：外部号码。 play_greeting：播放提示音后退出。 play_prompt：播放提示音后返回当前 IVR。 send_sms：发送 SMS 消息。 send_whatsapp：发送 WhatsApp 消息。
dest_prefix	String	目的地前缀。具体返回值取决于按键的目的地类型。 当目的地类型为 external_num 时，此参数返回外部号码的拨号前缀。 当目的地类型为 play_greeting 或 play_prompt 时，此参数返回提示音的播放次数。
dest_value	String	目的地取值。具体返回值取决于按键的目的地类型。 当目的地类型为 play_greeting 或 play_prompt 时，此参数返回自定义提示音的文件名。例如：demo.wav。 当目的地类型为 extension、ext_vm、ivr、call_flow、ring_group、queue、group_vm、或 conference 时，此参数返回目的地的 ID。 例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。 当目的地的类型为 external_num 时，此参数返回外部号码。
dest_caller_id_name	String	按键的附加来电显示名称。 当来电通过按键路由至响铃组或队列时，该名称会添加到原来的来电显示名称之前，并显示在被叫的来电窗口中。
entity	String	时间条件关联的对象。
pos	Integer	排序位置。
press_key_option_id	Integer	按键选项 ID。

Keypress_Setting

参数	类型	说明
id	Integer	记录 ID。
ivr_id	Integer	IVR ID。
allow_out_record	Integer	通话路由至按键目的地后，是否停止对该通话进行录音。 0：禁用。 1：启用。
months	String	办公时间适用的月份。 all：每月 jan：一月 feb：二月 mar：三月 apr：四月 may：五月 jun：六月 jul：七月 aug：八月 sep：九月 oct：十月 nov：十一月 dec：十二月
days_of_week	String	办公时间适用的星期。 all：每天 sun：周日 mon：周一 tue：周二 wed：周三 thu：周四 fri：周五 sat：周六
days	String	办公时间适用的日期。 all：每月的每一天 1-31：每月指定的日期
office_times	Array<Time_Period>	办公时间段列表。
time_condition_switch	Integer	是否启用高级时间条件。 0：禁用。 1：启用。
dest	String	目的地类型。 end_call：挂断。 extension：分机。 ext_vm：分机语音信箱。 ivr：IVR。 call_flow：通话流程。 ai_receptionist：AI 接待员。 ring_group：响铃组。 queue：队列。 group_vm：群语音信箱。 conference：会议室。 dial_by_name：通过名称呼叫。 external_num：外部号码。 play_greeting：播放提示音后退出。 play_prompt：播放提示音后返回当前 IVR。 send_sms：发送 SMS 消息。 send_whatsapp：发送 WhatsApp 消息。
dest_prefix	String	目的地前缀。具体返回值取决于按键的目的地类型。 当目的地类型为 external_num 时，此参数返回外部号码的拨号前缀。 当目的地类型为 play_greeting 或 play_prompt 时，此参数返回提示音的播放次数。
dest_value	String	目的地取值。具体返回值取决于按键的目的地类型。 当目的地类型为 play_greeting 或 play_prompt 时，此参数返回自定义提示音的文件名。例如：demo.wav。 当目的地类型为 extension、ext_vm、ivr、call_flow、ring_group、queue、group_vm、或 conference 时，此参数返回目的地的 ID。 例如：目的地为分机 2002，则该参数返回分机 2002 的 ID 2。 当目的地的类型为 external_num 时，此参数返回外部号码。
dest_caller_id_name	String	按键的附加来电显示名称。 当来电通过按键路由至响铃组或队列时，该名称会添加到原来的来电显示名称之前，并显示在被叫的来电窗口中。
entity	String	时间条件关联的对象。
pos	Integer	排序位置。
press_key_option_id	Integer	按键选项 ID。

Time_Period

参数	类型	说明
value	String	时间段，格式为 HH:MM-HH:MM。

GET /openapi/v1.0/ivr/search?access_token=Jh5d63SPHsNMnv6nzoOgUeKDyXSuOGxg&search_value=6200 HTTP/1.1
Host: 192.168.5.150:8088

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,
            "client_unique_ringtone": "Ring1.mp3"
        }
    ]
}