添加队列

添加并配置队列。

请求 URL

POST {base_url}/{api_path}/queue/create?access_token={access_token}

请求参数

参数 是否必填 类型 说明
number 是 String 队列号码。
name 是 String 队列的名称。
enb_queue_skill_based_routing 否 Integer 是否基于坐席的技能水平路由队列来电。
取值范围：
  • 0：禁用。
  • 1：启用。
ring_strategy 是 String 队列的响铃策略。

取值范围：

  • ring_all：同时响铃。
  • least_recent：最久未被叫响铃。
  • fewest_calls：最少接通响铃。
  • random：随机响铃。
  • rrmemory：循环响铃。
  • linear：线性响铃。
注： 当 enb_queue_skill_based_routing 取值为 1 时，系统将根据坐席水平由高到低的顺序路由队列来电，响铃策略将仅应用于具有相同技能水平的坐席中。
moh 否 String 队列的等待音乐。
取值范围：
  • default：默认等待音乐列表。
  • PBX 系统中已有的等待音乐列表名称 (查看路径：PBX 设置 > 提示音 > 等待音乐)。
max_wait_time 否 Integer 队列的最大等待时间，即呼叫者在队列中等待坐席接听的最长时间 (单位：秒)。
取值范围：0 - 9999999。
注： 若取值为 0，则表示不限制呼叫者在队列中的等待时间。
fail_dest 是 String 队列呼叫失败的目的地类型。
注： 此目的地应用于以下场景：

取值范围：

  • end_call：挂断。
  • extension：分机。
  • ext_vm：分机语音信箱。
  • group_vm：群语音信箱。
  • ivr：IVR。
  • call_flow：通话流程。
  • ring_group：响铃组。
  • queue：队列。
  • external_num：外部号码。
  • play_greeting：播放提示音后退出。
fail_dest_prefix 否 String 此参数的设置取决于队列呼叫失败的目的地类型 (fail_dest)。
  • 当目的地类型为 external_num 时，此参数用于指定外部号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数指定播放提示音的次数，其取值范围为 1 - 5。
fail_dest_value 否 String 队列呼叫失败的目的地。此参数的设置取决于队列呼叫失败的目的地类型 (fail_dest)。
  • 当目的地类型为 play_greeting 时，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ext_vm、group_vm、ivr、call_flow、ring_group、或 queue 时，此参数用于指定目的地的 ID。

    例如：目的地为分机 2002，则将该参数设置为分机 2002 的 ID 2。

  • 当目的地的类型为 external_num 时，此参数用于指定外部号码。
agent_timeout 否 Integer 坐席响铃的超时时长 (单位：秒)。
取值范围：1 - 9999999。
注： 若响铃超时后坐席仍未接听来电，则按照响铃策略，下一个在线坐席响铃。
retry_time 否 Integer 上一个在线坐席响铃超时后，继续响铃下一个坐席的时间间隔 (单位：秒)。

取值范围：1 - 9999999。
wrap_up_time 否 Integer 坐席的休息时间，可用于在完成服务后处理通话相关事务 (单位：秒)。

取值范围：1 - 9999999。

注： 在设置的休息时间结束后，坐席才会根据响铃策略接收队列来电。
agent_prompt 否 String 设置坐席应答提示音。

取值范围：PBX 系统中已有的自定义提示音名称 (查看路径：PBX 设置 > 提示音 > 自定义提示音)。
enb_ring_in_use 否 Integer 是否允许向通话中的坐席分配队列中的来电。

取值范围：

  • 0：禁止。
  • 1：允许。
enb_auto_pause 否 Integer 当坐席在队列内的连续未接来电数量达到阈值时，系统将自动暂停该坐席并向其发送通知邮件。

取值范围：

  • 0：禁用。
  • 1：启用。
max_pause_miss_call 否 Integer 连续未接来电数量的阈值。

当达到此阈值后，系统将自动暂停该坐席并向其发送通知邮件。

取值范围：1 - 5。

注： 当 enb_auto_pause 取值为 1 时，此参数必填。
dynamic_agent_list 否 Array <Dynamic_Agent_List> 动态坐席成员的信息。
static_agent_list 否 Array <Static_Agent_List> 静态坐席成员的信息。
manager_list 否 Array <Manager_List> 队列管理员的信息。
enb_email_miss_call 否 Integer 当队列中有未接来电时发送邮件通知管理员。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_email_abandon_call 否 Integer 当已呼入队列的呼叫者放弃等待时发送邮件通知管理员。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_email_sla_alarm 否 Integer 当队列服务水平协议 (SLA) 低于设置的警报阈值时发送邮件通知管理员。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_ip_phone_missed_call_display 否 Integer 在坐席的 IP 话机上显示队列未接来电记录。
取值范围：
  • 0：禁用。
  • 1：启用。
callback_enb_request_email 否 Integer 当呼叫者成功请求队列回拨时发送邮件通知队列管理员。

取值范围：

  • 0：禁用。
  • 1：启用。
callback_enb_failed_email 否 Integer 当呼叫者请求队列回拨失败时发送邮件通知队列管理员。

取值范围：

  • 0：禁用。
  • 1：启用。
max_calls 否 Integer 队列中允许等待的最大通话数。

取值范围：1 - 9999。
alert_info 否 String INVITE 请求中 Alert-info 头域携带的 “info” 标签值，用于触发话机进行区别振铃。
client_unique_ringtone 否 String 坐席接收到此队列来电时，其 Linkus 客户端将播放的特色铃声。
取值范围：
  • 内置铃声：Ring{x}.mp3 (其中 x 为 0 - 10)。
  • 自定义铃声：PBX 上已存在的自定义铃声文件名 (路径：PBX设置 > 提示音 > 自定义铃声)。例如，example.wav。
enb_leave_empty 否 Integer 队列内无坐席时，强制呼叫者退出队列。

取值范围：

  • 0：禁用。
  • 1：启用。
empty_defined_for_leave_empty 否 Array<String> 定义队列内无坐席的场景。在此场景下强制呼叫者退出队列，并将来电转移到呼叫失败的目的地 (fail_dest)。
注：
  • 如果你没有设置该参数，则默认赋值 ["1","2"]。
  • 此参数仅适用于 84.23.0.24 或之前的版本。对于 84.23.0.83 或更高版本，请参见 leave_empty_no_agent_list 参数。
取值范围：
  • 1：所有坐席都未注册在线
  • 2：所有坐席都处于暂停状态
  • 3：所有坐席都在使用中
leave_empty_no_agent_list 否 Array<Leave_Empty_Rules> 视为无坐席的场景。在此场景下强制呼叫者退出队列，并将呼叫路由到指定目的地。
注：
  • 若 enb_leave_empty 为 1，此参数必传。
  • 此参数仅适用于 84.23.0.83 或更高版本。
enb_disallow_to_join_when_empty 否 Integer 队列内无坐席时，禁止呼叫者进入队列。

取值范围：

  • 0：禁用。
  • 1：启用。
empty_defined_for_disallow_to_join_when_empty 否 Array<String> 定义队列内无坐席的场景。在此场景下不允许呼叫者呼入队列，并将来电转移到呼叫失败的目的地 (fail_dest)。
注：
  • 如果你没有设置该参数，则默认赋值 ["1","2"]。
  • 此参数仅适用于 84.23.0.24 或之前的版本。对于 84.23.0.83 或更高版本，请参见 join_empty_no_agent_list 参数。
取值范围：
  • 1：所有坐席都未注册在线
  • 2：所有坐席都处于暂停状态
  • 3：所有坐席都在使用中
join_empty_no_agent_list 否 Array<Join_Empty_Rules> 视为无坐席的场景。在此场景下禁止呼叫者进入队列，并将呼叫路由到指定目的地。
注：
  • 若 enb_disallow_to_join_when_empty 为 1，此参数必传。
  • 此参数仅适用于 84.23.0.83 或更高版本。
sla_time 否 Integer 服务水平协议 (SLA) 时间 (单位：秒)。

取值范围：1 - 9999。
sla_interval 否 Integer 评价时间间隔 (单位：分钟)。

将队列的 SLA 与警报阈值进行比较的时间间隔，以便系统可以相应地发送邮件通知。

取值范围：1 - 9999。
sla_alarm_threshold 否 Integer 队列的服务水平 (SLA) 警报阈值。

取值范围：1 - 999。
join_prompt 否 String 设置呼叫者加入队列时播放的提示音。

取值范围：PBX 系统中已有的自定义提示音名称 (查看路径：PBX 设置 > 提示音 > 自定义提示音)。
play_full_join_prompt 否 Integer 系统是否播完欢迎提示音后再响铃成员。
取值范围：
  • 0：启用。
  • 1：禁用。
ringback_tone 否 String 自定义提示音的文件名 (如 demo.wav) 或等待音乐播放列表的名称。在成员接听来电之前，系统会向呼叫者播放指定的音频。
注： 可使用 获取菜单选项 接口查询自定义提示音的文件名 ("menu":"custom_prompt")，或使用 查询等待音乐列表 接口查询等待音乐播放列表的名称。
enb_announce_agent_id 否 Integer 向呼叫者播报坐席工号。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_announce_default_prompt 否 Integer 周期性地向呼叫者播放 “谢谢您的耐心等待” 提示音。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_announce_pos 否 Integer 周期性地向呼叫者播报前方等待人数。

取值范围：

  • 0：禁用。
  • 1：启用。
enb_announce_hold_time 否 Integer 周期性地向呼叫者播报预计等待时间。

取值范围：

  • 0：禁用。
  • 1：启用。
caller_announce_freq 否 Integer 系统周期性播报前方等待人数的时间间隔 (单位：秒)。

取值范围：1 - 999。
sys_announce_prompt 否 String 设置队列公告的提示音，即在呼叫者进入队列后，系统将周期性播放的提示音。

取值范围：PBX 系统中已有的自定义提示音名称 (查看路径：PBX 设置 > 提示音 > 自定义提示音)。
sys_announce_freq 否 Integer 周期性播放队列公告的时间间隔 (单位：秒)。

取值范围：1 - 9999。
satisfa_survey_prompt 否 String 坐席挂断通话后，系统向呼叫者播放的满意度调查提示音。

取值范围：

  • default：默认提示音。
  • PBX 系统中已有的自定义提示音名称 (查看路径：PBX 设置 > 提示音 > 自定义提示音)。
satisfa_survey_end_prompt 否 String 在呼叫者按下满意调查按键后，系统向呼叫者播放的提示音。

取值范围：

  • default：默认提示音。
  • PBX 系统中已有的自定义提示音名称 (查看路径：PBX 设置 > 提示音 > 自定义提示音)。
注： 此参数只在已设置 satisfa_survey_prompt 时生效。
satisfaction_survey_point_list 否 Array <Satisfaction_Survey_Point_List> 满意度调查分值。不同的按键对应不同的分值。
press_key 否 String 触发按键事件的按键。呼叫者根据提示音操作按键后，通话将被转移至指定的目的地。
取值范围：
  • 数字 0 - 9
  • *
  • #
key_dest 否 String 按键的目的地类型。
取值范围：
  • end_call：挂断。
  • extension：分机。
  • ext_vm：分机语音信箱。
  • group_vm：群语音信箱。
  • ivr：IVR。
  • call_flow：通话流程。
  • ring_group：响铃组。
  • queue：队列。
  • external_num：外部号码。
  • play_greeting：播放提示音后退出。
key_dest_prefix 否 String 此参数的设置取决于按键的目的地类型 (key_dest) 。
  • 当目的地类型为 external_num 时，此参数用于指定外部号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数指定播放提示音的次数，其取值范围为 1 - 5。
key_dest_value 否 String 设置按键的目的地。此参数的设置取决于按键的目的地类型 (key_dest)。
  • 当目的地类型为 play_greeting 时，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ext_vm、group_vm、ivr、call_flow、ring_group、或 queue 时，此参数用于指定目的地的 ID。

    例如：目的地为分机 2002，则将该参数设置为分机 2002 的 ID 2。

  • 当目的地的类型为 external_num 时，此参数用于指定外部号码。
enb_callback 否 Integer 是否启用队列回拨。

取值范围：

  • 0：禁用。
  • 1：启用。
callback_method 否 String 当队列忙时呼叫者触发回拨请求的方法。

取值范围：

  • digit：由呼叫者按键触发回拨。
  • timeout：超时后自动触发回拨。
callback_press_key 否 String 用于触发回拨的按键值。
注： 当 callback_method 取值为 digit 时，此参数必填。

取值范围：

  • 数字 0 - 9
  • *
  • #
callback_trigger_timeout 否 Integer 用于触发回拨的超时时间 (单位：秒)。
注： 当 callback_method 取值为 timeout 时，此参数必填。

取值范围：0 - 1800
callback_outbound_prefix 否 String 用于回拨的呼出路由的前缀。
callback_timeout 否 String 设置队列保留回拨请求的超时时间的类型。

取值范围：

  • queue_max_wait_time：队列的最大等待时间。
  • custom：自定义的超时时间。
callback_timeout_num 否 Integer 队列保留回拨请求的超时时间 (单位：秒)。
如果到达超时时间后，队列中仍无空闲坐席，系统会终止该回拨请求。
注： 当 callback_timeout 取值为 custom 时，此参数必填。

取值范围：0 - 1800
enb_priority_queue 否 Integer 是否启用优先队列。
取值范围：
  • 0：禁用。
  • 1：启用。
weight 否 Integer 队列初始权重。

取值范围：1 - 999
enb_acceleration_weight 否 Integer 是否启用加速权重。
取值范围：
  • 0：禁用。
  • 1：启用。
acceleration 否 Integer 在来电等待多长时间 (单位：秒) 后权重会加 1。

取值范围：10 - 1800
enb_custom_language 否 Integer

是否为队列启用自定义系统提示音语言。

取值范围：
  • 0：禁用。
  • 1：启用。
prompt_language 否 String 队列的自定义系统提示音语言。

取值范围：PBX 系统中已存在的提示音语言。

注： 可使用 获取菜单选项 接口查询已存在的系统提示音语言 ("menu":"system_prompt")。
Dynamic_Agent_List
参数 是否必填 类型 说明
value 是 String 动态坐席成员的分机 ID。
注： 可通过 搜索特定分机 接口查询成员的分机 ID。
type 否 String 动态坐席成员的类型。

取值范围：

  • extension：分机。
number_value 否 Integer 动态坐席的技能水平。
取值范围：1 - 99
注：
  • 数字越小，技能水平越高，则响铃的优先级也越高。
  • 如果你没有设置此参数，则默认赋值 1 (最高技能水平)。
  • 此参数仅在 enb_queue_skill_based_routing 取值为 1 时生效。
Static_Agent_List
参数 是否必填 类型 说明
value 是 String 静态坐席成员的分机 ID。
注： 可通过 搜索特定分机 接口查询成员的分机 ID。
type 否 String 静态坐席成员的类型。

取值范围：

  • extension：分机。
number_value 否 Integer 静态坐席的技能水平。
取值范围：1 - 99
注：
  • 数字越小，技能水平越高，则响铃的优先级也越高。
  • 如果你没有设置此参数，则默认赋值 1 (最高技能水平)。
  • 此参数仅在 enb_queue_skill_based_routing 取值为 1 时生效。
Manager_List
参数 是否必填 类型 说明
value 是 String 队列管理员的分机 ID。
注： 可通过 搜索特定分机 接口查询管理员的分机 ID。
type 否 String 队列管理员的类型。

取值范围：

  • extension：分机。
Leave_Empty_Rules/Join_Empty_Rules
参数 是否必填 类型 说明
no_agent_include_list 是 Array<String> 指定可视为无坐席的场景。
取值范围：
  • 1：所有坐席都未注册在线
  • 2：所有坐席都处于暂停状态
  • 3：所有坐席都在使用中
dest_to 是 String 无坐席场景的呼叫路由目的地的类型。

取值范围：

  • end_call：挂断。
  • extension：分机。
  • ext_vm：分机语音信箱。
  • group_vm：群语音信箱。
  • ivr：IVR。
  • call_flow：通话流程。
  • ring_group：响铃组。
  • queue：队列。
  • external_num：外部号码。
  • play_greeting：播放提示音后退出。
dest_prefix 否 String 此参数的设置取决于目的地类型 (dest_to)。
注： 此参数在 dest_to 为 play_greeting 时必传。
  • 当目的地类型为 external_num 时，此参数用于指定外部号码的拨号前缀。
  • 当目的地类型为 play_greeting 时，此参数指定播放提示音的次数，其取值范围为 1 - 5。
dest_value 否 String 无坐席场景的呼叫路由目的地。指定目的地类型 (dest_to) 不同，此参数返回的值也不同。
注： 此参数在 dest_to 为除 end_call 外的类型时必传。
  • 当目的地类型为 play_greeting 时，此参数用于指定自定义提示音的文件名。例如：demo.wav。
  • 当目的地类型为 extension、ext_vm、group_vm、ivr、call_flow、ring_group、或 queue 时，此参数用于指定目的地的 ID。

    例如：目的地为分机 2002，则将该参数设置为分机 2002 的 ID 2。

  • 当目的地的类型为 external_num 时，此参数用于指定外部号码。
Satisfaction_Survey_Point_List
参数 是否必填 类型 说明
K 是 String 满意度调查评分按键。

取值范围：

  • 数字 0 - 9
  • *
P 是 Integer 满意度调查分值。

取值范围：-99 - 99

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
id Integer 队列的唯一 ID。

示例

请求示例

POST /openapi/v1.0/queue/create?access_token=sRuPSzYcPflKgdwSVpA1lhxlVLw0q0z1 HTTP/1.1 

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json
{
    "number": "6410",
    "name": "技术支持",
    "enb_queue_skill_based_routing": 1,
    "ring_strategy": "random",
    "moh": "default",
    "max_wait_time": 1200,
    "fail_dest": "play_greeting",
    "fail_dest_prefix": "3",
    "fail_dest_value": "IVR.wav",
    "agent_timeout": 15,
    "retry_time":5,
    "wrap_up_time": 30,
    "agent_prompt": "",
    "enb_ring_in_use": 0,
    "enb_auto_pause": 1,
    "max_pause_miss_call": 3,
    "dynamic_agent_list": [
         {
            "value":"72",
            "type":"extension",
            "number_value": 1
        }
    ],
    "static_agent_list": [
        {
            "value":"73",
            "type":"extension"，,
            "number_value": 1
        },
        {
            "value":"76",
            "type":"extension",
            "number_value": 2
        }
    ],
    "manager_list": [
        {
            "value":"78",
            "type":"extension"
        }
    ],
    "enb_email_miss_call": 1,
    "enb_email_abandon_call": 1,
    "enb_email_sla_alarm": 1,
    "callback_enb_request_email": 1,
    "callback_enb_failed_email": 1,
    "max_calls": 1,
    "alert_info": "",
    "client_unique_ringtone": "example-1.wav",
    "enb_leave_empty": 1,
    "leave_empty_no_agent_list":[ {
         "no_agent_include_list":["1","2"],
         "dest_to":"play_greeting",
         "dest_value":"BusyNow.wav",
         "dest_prefix":"1"
         }
         
    ]   
    "enb_disallow_to_join_when_empty": 0,
    "enb_custom_language": 1,
    "prompt_language": "sound-de",
    "enb_priority_queue": 0,
    "weight": 0,
    "enb_acceleration_weight": 0,
    "acceleration": 30,
    "sla_time": 30,
    "sla_interval": 30,
    "sla_alarm_threshold": 80,
    "join_prompt": "", 
    "enb_announce_agent_id": 0, 
    "enb_announce_default_prompt": 1, 
    "enb_announce_pos": 1, 
    "enb_announce_hold_time": 1, 
    "caller_announce_freq": 30, 
    "sys_announce_prompt": "", 
    "sys_announce_freq": 30, 
    "satisfa_survey_prompt": "default", 
    "satisfa_survey_end_prompt": "default", 
    "satisfaction_survey_point_list": [
        {
            "k": "0",
            "p": -5
        },
        {
            "k": "1",
            "p": -2
        },
        {
            "k": "2",
            "p": 0
        },
        {
            "k": "3",
            "p": 2
        },
        {
            "k": "4",
            "p": 5
        },
        {
            "k": "5",
            "p": 1
        },
        {
            "k": "6",
            "p": 1
        },
        {
            "k": "7",
            "p": 1
        },
        {
            "k": "8",
            "p": 1
        },
        {
            "k": "9",
            "p": 1
        },
        {
            "k": "*",
            "p": 10
        }
    ],
    "press_key": "#", 
    "key_dest": "end_call", 
    "key_dest_value": "",
    "key_dest_prefix": "",
    "enb_callback": 1,
    "callback_method": "digit", 
    "callback_press_key": "1", 
    "callback_trigger_timeout": 30, 
    "callback_outbound_prefix": "6",
    "callback_timeout": "custom",
    "callback_timeout_num": 120 
}
请求示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 6
}