查询队列
查询单个队列、多个队列或所有队列的详细信息。
请求地址
{base_url}/{api_path}/queue/query?token={token}
请求参数
参数 | 是否必选 | 类型 | 说明 |
---|---|---|---|
number | 是 | String | 队列号码。 取值范围:
|
响应参数
参数 | 类型 | 说明 |
---|---|---|
status | String | 请求结果。
|
queues | Array <QueueInfo> | 队列信息列表。 |
- QueueInfo
-
参数 类型 说明 number String 队列号码。 password String 加入队列动态坐席的密码。 queuename String 队列名称。 ringstrategy String 响铃策略。 - Ring All:全部响铃。
- Least Recent:最近最少被叫响铃。
- Fewest Calls:最少接通响铃。
- Random:随机响铃。
- Rrmemory:顺序响铃。
- Linear:线性响铃。
failoveraction String 呼入失败目的地。 - Hang up:挂机。
- Extension:分机。
- Voicemail:语音信箱。
- IVR:IVR(自动话务员)。
- Ring Group:响铃组。
- Queue:队列。
- Conference:会议室。
- Fax to Email:传真到邮件。
- Dial by name:通过名字呼叫。
failoverdest String 呼入失败具体目的地。 agents String 固定坐席。 dynamicagents String 动态坐席。 agenttimeout String 坐席响铃时间。 agentannounce String 坐席应答提示音。 wrapuptime Integer 坐席结束与客户的通话后,继续接听新来电的时间间隔。 ringinuse String 使用中振铃。 - on:开启。
- off:关闭。
retry Integer 重试间隔时间。 musiconhold String 等待音乐。 maxwaittime Integer 最大等待时间。 joinempty String 无坐席时允许呼入。 - on:开启。
- off:关闭。
disallow_to_join_when_empty String 无坐席时禁止呼入。 - on:无坐席时禁止呼入。
- off:无坐席时允许呼入。
empty_defined_for_disallow_to_join_when_empty String 视为无坐席的场景。在此场景下不允许呼叫者呼入队列。 注: 当所有坐席都签出时,该队列默认处于无坐席状态。- 1:所有坐席都未注册在线
- 2:所有坐席都处于暂停状态
- 3:所有坐席都在使用中
leavewhenempty String 无坐席时结束等待。 - on:开启。
- off:关闭。
empty_defined_for_leave_empty String 视为无坐席的场景。在此场景下强制呼叫者退出队列。 注: 当所有坐席都签出时,该队列默认处于无坐席状态。- 1:所有坐席都未注册在线
- 2:所有坐席都处于暂停状态
- 3:所有坐席都在使用中
joinannounce String 进入队列提示音。 announcepos String 公告当前位置。 - on:开启。
- off:关闭。
announcefreq String 播放用户公告的频率。 announceholdtime String 公告等待时间。 - on:开启。
- off:关闭。
userannounce String 系统公告提示音。 userannouncefreq Integer 播放系统公告的频率。 breakoutkey String 按键 DTMF。 breakoutaction String 按键目标。 - Hang up:挂机。
- Extension:分机。
- Voicemail:语音信箱。
- IVR:自动话务员。
- Ring Group:响铃组。
- Queue:队列。
- Conference:会议室。
- Fax to Email:传真到邮件。
- Dial by Name:通过名字呼叫。
breakoutdest String 按键目标的最终目的地。 satisfactionsurvey String 满意度调查提示音。没有设置则默认不播报。此参数默认值为 None。 idannouncement String 播放坐席工号的提示音。没有设置则默认不播报。此参数默认值为 None。
示例
请求示例
查询队列6700的详细信息。
POST /api/v2.0.0/queue/query?token=1e3b3ebb6a974cb42ed31de5413df52d Content-Type:application/json; charset=utf-8 Host: 192.168.5.150 { "number": "6700" }
HTTP/1.1 200 OK Server: Boa/0.94.14rc21 Accept-Ranges: bytes Connection: close Content-Type: application/json Access-control-allow-origin: * Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE { "status": "Success", "queues": [ { "number": "6700", "password": "", "queuename": "Support", "ringstrategy": "Ring All", "failoveraction": "Extension", "failoverdest": "1000", "agents": "1000,1001,", "agenttimeout": "30", "agentannounce": "[None]", "wrapuptime": "30", "ringinuse": "off", "retry": "30", "musiconhold": "[None]", "maxwaittime": "1800", "joinempty": "on", "disallow_to_join_when_empty": "off", "empty_defined_for_disallow_to_join_when_empty": "1,2,3", "leavewhenempty": "off", "empty_defined_for_leave_empty": "1,2", "joinannounce": "[None]", "announcepos": "on", "announcefreq": "30", "announceholdtime": "on", "userannounce": "[None]", "userannouncefreq": "60", "breakoutkey": "None", "satisfactionsurvey": "None", "idannouncement": "None" } ] }