查询单个队列信息

查询单个队列的详细信息。

请求 URL

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

请求参数

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

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
data Object <Queue_DetailInfo> 队列的详细信息。
Queue_DetailInfo
参数 类型 说明
id Integer 队列的唯一 ID。
number String 队列号码。
name String 队列的名称。
ring_strategy String 队列的响铃策略。
  • ring_all:同时响铃。
  • least_recent:最久未被叫响铃。
  • fewest_calls:最少接通响铃。
  • random:随机响铃。
  • rrmemory:循环响铃。
  • linear:线性响铃。
moh String 向在队列中等待的呼叫者播放的音乐名称。
max_wait_time Integer 队列的最大等待时间,即呼叫者在队列中等待坐席接听的最长时间 (单位:秒)。
fail_dest String 队列呼叫失败的目的地类型。
  • end_call:挂断。
  • extension:分机。
  • ext_vm:分机语音信箱。
  • group_vm:群语音信箱。
  • ivr:IVR。
  • ring_group:响铃组。
  • queue:队列。
  • external_num:外部号码。
  • play_greeting:播放提示音后退出。
fail_dest_prefix String 队列呼叫失败的目的地类型 (fail_dest) 不同,返回的参数值也不同。
  • 当目的地类型为 external_num 时,此参数返回外部号码的拨号前缀。
  • 当目的地类型为 play_greeting 时,此参数返回提示音的播放次数。
fail_dest_value String 队列呼叫失败的目的地。目的地类型 (fail_dest) 不同,返回的参数值也不同。
  • 当目的地类型为 play_greeting 时,此参数返回自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionext_vmgroup_vmivrring_group、或 queue 时,此参数返回目的地的 ID。

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

  • 当目的地的类型为 external_num 时,此参数返回外部号码。
agent_timeout Integer 坐席响铃的超时时长 (单位:秒)。
retry_time Integer 上一个在线坐席响铃超时后,继续响铃下一个坐席的时间间隔 (单位:秒)。
wrap_up_time Integer 坐席的休息时间,可用于在完成服务后处理上一通通话相关事务 (单位:秒)。
注: 在设置的休息时间结束后,坐席才会根据响铃策略接收队列来电。
enb_ring_in_use Integer 是否允许向通话中的坐席分配队列中的来电。
  • 0:禁止。
  • 1:允许。
agent_prompt String 坐席接听队列来电时,向坐席播放的提示音。
enb_auto_pause Integer 当坐席在队列内的连续未接来电数量达到阈值时,系统自动暂停该坐席并向其发送通知邮件。
  • 0:禁用。
  • 1:启用。
max_pause_miss_call Integer 坐席连续未接来电数量的阈值。

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

enb_email_miss_call Integer 在队列中有未接来电时发送邮件通知管理员。
  • 0:禁用。
  • 1:启用。
enb_email_abandon_call Integer 在已呼入队列的呼叫者放弃等待时发送邮件通知管理员。
  • 0:禁用。
  • 1:启用。
enb_email_sla_alarm Integer 在队列服务水平协议 (SLA) 低于设置的警报阈值时发送邮件通知管理员。
  • 0:禁用。
  • 1:启用。
callback_enb_request_email Integer 在呼叫者成功请求队列回拨时发送邮件通知队列管理员。
  • 0:禁用。
  • 1:启用。
callback_enb_failed_email Integer 在呼叫者请求队列回拨失败时发送邮件通知队列管理员。
  • 0:禁用。
  • 1:启用。
max_calls Integer 队列中允许等待的最大通话数。
alert_info String INVITE 请求中 Alert-info 头域携带的 “info” 标签值,用于触发话机进行区别振铃。
enb_leave_empty Integer 队列内无坐席时,将来电转移到呼叫失败的目的地 (fail_dest)。
  • 0:禁用。
  • 1:启用。
empty_defined_for_leave_empty String 视为无坐席的场景。在此场景下强制呼叫者退出队列。
注: 当所有坐席都签出时,该队列默认处于 “无坐席” 状态。
  • 1:所有坐席都未注册在线
  • 2:所有坐席都处于暂停状态
  • 3:所有坐席都在使用中
enb_disallow_to_join_when_empty Integer 队列内无坐席时,禁止呼入。
  • 0:禁用。
  • 1:启用。
empty_defined_for_disallow_to_join_when_empty String 视为无坐席的场景。在此场景下不允许呼叫者呼入队列。
注: 当所有坐席都签出时,该队列默认处于 “无坐席” 状态。
  • 1:所有坐席都未注册在线
  • 2:所有坐席都处于暂停状态
  • 3:所有坐席都在使用中
enb_callback Integer 是否启用队列回拨。
  • 0:禁用。
  • 1:启用。
callback_timeout String 队列保留回拨请求的超时时间的类型。
  • queue_max_wait_time:队列的最大等待时间。
  • custom:自定义的超时时间。
callback_timeout_num Integer 队列保留回拨请求的超时时间 (单位:秒)。

如果到达超时时间后,队列中仍无空闲坐席,系统会终止该回拨请求。

callback_method String 当队列忙时呼叫者触发回拨请求的方法。
  • digit:由呼叫者按键触发回拨。
  • timeout:超时后自动触发回拨。
callback_press_key String callback_method 取值为 digit 时,用于请求回拨的按键值。
callback_outbound_prefix String 用于回拨的呼出路由的前缀。
callback_trigger_timeout Integer callback_method 取值为 timeout 时,用于触发回拨的超时时间 (单位:秒)。
sla_time Integer 服务水平协议 (SLA) 时间 (单位:秒)。
sla_interval Integer 评价时间间隔 (单位:分钟)。

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

sla_alarm_threshold Integer 队列的服务水平 (SLA) 警报阈值。
join_prompt String 在呼叫者加入队列时播放的提示音名称。
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 系统周期性播报前方等待人数的时间间隔 (单位:秒)。
sys_announce_prompt String 队列公告的提示音名称,即在呼叫者进入队列后,系统周期性播放的提示音。
sys_announce_freq Integer 周期性播放队列公告的时间间隔 (单位:秒)。
satisfa_survey_prompt String 坐席挂断通话后,系统向呼叫者播放的满意度调查提示音名称。
satisfa_survey_end_prompt String 在呼叫者按下满意调查按键后,系统向呼叫者播放的提示音。
press_key String 触发按键事件的按键。

呼叫者根据提示音操作按下此键后,通话将被转移至指定的目的地。

key_dest String 按键的目的地类型。
  • end_call:挂断。
  • extension:分机。
  • ext_vm:分机语音信箱。
  • group_vm:群语音信箱。
  • ivr:IVR。
  • ring_group:响铃组。
  • queue:队列。
  • external_num:外部号码。
  • play_greeting:播放提示音后退出。
key_dest_prefix String 按键的目的地类型 (key_dest) 不同,返回的参数值也不同。
  • 当目的地类型为 external_num 时,此参数返回外部号码的拨号前缀。
  • 当目的地类型为 play_greeting 时,此参数返回提示音的播放次数。
key_dest_value String 按键的目的地。按键的目的地类型 (key_dest) 不同,返回的参数值也不同。
  • 当目的地类型为 play_greeting 时,此参数返回自定义提示音的文件名。例如:demo.wav
  • 当目的地类型为 extensionext_vmgroup_vmivrring_group、或 queue 时,此参数返回目的地的 ID。

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

  • 当目的地的类型为 external_num 时,此参数返回外部号码。
dynamic_agent_list Array <Dynamic_Agent_List> 动态坐席成员的信息。
static_agent_list Array <Static_Agent_List> 静态坐席成员的信息。
manager_list Array <Manager_List> 队列管理员的信息。
satisfaction_survey_point_list Array <Satisfaction_Survey_Point_List> 满意度调查分值。不同的按键对应不同的分值。
Dynamic_Agent_List
参数 类型 说明
text String 动态坐席成员的姓名。
text2 String 动态坐席成员的分机号码。
value String 动态坐席成员的分机 ID。
type String 动态坐席成员的类型。
  • extension:分机。
number_value Integer 动态坐席的技能水平。
Static_Agent_List
参数 类型 说明
text String 静态坐席成员的姓名。
text2 String 静态坐席成员的分机号码。
value String 静态坐席成员的分机 ID。
type String 静态坐席成员的类型。
  • extension:分机。
number_value Integer 静态坐席的技能水平。
Manager_List
参数 类型 说明
text String 队列管理员的姓名。
text2 String 队列管理员的分机号码。
value String 队列管理员的分机 ID。
type String 队列管理员的类型。
  • extension:分机。
Satisfaction_Survey_Point_List
参数 类型 说明
K String 满意度调查评分按键。
  • 数字 0 - 9
  • *
P Integer 满意度调查分值。

示例

请求示例

查询 ID 为 3 的 队列详细信息。

GET /openapi/v1.0/queue/get?access_token=mlF8b3omcSD822Sosdc6kyiFkdYkC8UG&id=3 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 3,
        "number": "6402",
        "name": "技术支持",
        "ring_strategy": "ring_all",
        "moh": "default",
        "max_wait_time": 1800,
        "fail_dest": "end_call",
        "fail_dest_prefix": "",
        "fail_dest_value": "",
        "agent_timeout": 30,
        "retry_time": 30,
        "wrap_up_time": 30,
        "enb_ring_in_use": 0,
        "agent_prompt": "",
        "enb_auto_pause": 0,
        "max_pause_miss_call": 0,
        "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": 3,
        "alert_info": "",
        "enb_leave_empty": 1,
        "empty_defined_for_leave_empty": [
            "1",
            "2",
            "3"
        ],
        "enb_disallow_to_join_when_empty": 1,
        "empty_defined_for_disallow_to_join_when_empty": [ 
            "1",
            "2"
        ],
        "enb_callback": 1,
        "callback_timeout": "queue_max_wait_time",
        "callback_timeout_num": 180,
        "callback_method": "digit",
        "callback_press_key": "1",
        "callback_outbound_prefix": "",
        "callback_trigger_timeout": 0,
        "sla_time": 60,
        "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": 60,
        "satisfa_survey_prompt": "",
        "press_key": "",
        "key_dest": "end_call",
        "key_dest_prefix": "",
        "key_dest_value": "",
        "dynamic_agent_list": [
            {
                "text": "Leo Ball",
                "text2": "1000",
                "value": "73",
                "type": "extension",
                "number_value": 1
            },
            {
                "text": "Phillip Huff",
                "text2": "1001",
                "value": "85",
                "type": "extension",
                "number_value": 1
            }
        ],
        "static_agent_list": [
            {
                "text": "Madison Cooper",
                "text2": "1004",
                "value": "96",
                "type": "extension",
                "number_value": 1
            },
            {
                "text": "Kevin Connor",
                "text2": "1005",
                "value": "97",
                "type": "extension",
                "number_value": 1
            },
            {
                "text": "Kristin Hale",
                "text2": "1006",
                "value": "92",
                "type": "extension",
                "number_value": 1
            }
        ],
        "manager_list": [
            {
                "text": "Leo Ball",
                "text2": "1000",
                "value": "73",
                "type": "extension"
            }
        ],
        "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": 0
            },
            {
                "k": "6",
                "p": 0
            },
            {
                "k": "7",
                "p": 0
            },
            {
                "k": "8",
                "p": 0
            },
            {
                "k": "9",
                "p": 0
            },
            {
                "k": "*",
                "p": 0
            }
        ]
    }
}