在线技能组接口文档

新增在线技能组接口

HTTP请求方式：POST
请求链接：{HOST}/v20210827/webChat/addQueue/{ACCOUNTID}?sig=SIG
请求时请将{HOST}换成[对接数据
查询](data-query.md)中获取到的请求域名，ACCOUNTID替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
请求频次限制：20次／分钟
鉴权文档：接口鉴权

接口参数如下：

字段名	字段类型	是否必须	字段描述
assignRule	string	是	分配策略，默认随机（随机：random、轮流：queue、最少：least、优先：priority）
displayName	String	是	技能组名称
isMemory	bool	是	记忆分配开关，默认为false
memoryTime	String	否	记忆分配时长，记忆分配开关为true时必填。（仅可填写以下四种，2小时：120,一天：1440,一周:10080,30天: 43200）
assignMembers	array[Object]	否	技能组坐席列表，传入参数为坐席工号agentNumber(string) 坐席优先级priority(number 不填写默认为0) 例如：[{“agentNumber”: “8000”, “ priority”: 0}]

注意：新增时，请满足以下约束条件。

坐席工号需存在，该坐席不存在时跳过该坐席的添加
请求字段填写错误时，按照默认处理。

请求体示例

{
    "assignRule":"priority",
    "displayName":"阿瓦达哇多",
    "isMemory":true,
    "memoryTime":"120",
    "assignMembers": [
        {
            "agentNumber": "8000",
            "priority": 0
        }
    ]
}

返回参数

字段名	字段类型	字段描述
code	number	返回状态
success	bool	是否成功
message	object	返回数据
data	字段类型	字段描述

date

字段名	字段类型	字段描述
exten	string	技能组编号

返回示例

{
    "code": 200,
    "success": true,
    "message": "success!",
    "data": {
        "exten": "10018578"
    }
}

{
    "code": 400,
    "success": false,
    "message": "create Queue error"
}

修改在线技能组坐席接口

HTTP请求方式：POST
请求链接：{HOST}/v20210827/webChat/updateQueueAssignMembers/{ACCOUNTID}?sig=SIG
请求时请将{HOST}换成对接数据查询中获取到的请求域名，ACCOUNTID替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
请求频次限制：20次／分钟
鉴权文档：接口鉴权

接口参数如下：

字段名	字段类型	是否必须	字段描述
exten	string	是	技能组编号
assignMembers	array[Object]	是	技能组坐席列表，传入参数为坐席工号agentNumber(string) 坐席优先级priority(number 不填写默认为0) 例如：[{“agentNumber”: “8000”, “ priority”: 0}]

注意：新增时，请满足以下约束条件。

坐席工号需存在，该坐席不存在时跳过该坐席的添加
assignMembers会覆盖之前已有的坐席列表进行替换处理
请求字段填写错误时，按照默认处理。

请求体示例

{
    "exten": "10018578",
    "assignMembers": [
        {
            "agentNumber": "8000",
            "priority": 0
        }
    ]
}

返回参数

字段名	字段类型	字段描述
code	number	返回状态
success	bool	是否成功
message	object	处理结果

返回示例

{
    "code": 200,
    "success": true,
    "message": "success!"
}

{
    "code": 400,
    "success": false,
    "message": "create Queue error"
}

查询在线技能组坐席接口

HTTP请求方式：POST
请求链接：{HOST}/v20210827/webChat/queueQueue/{ACCOUNTID}?sig=SIG
请求时请将{HOST}换成对接数据查询中获取到的请求域名，ACCOUNTID替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
请求频次限制：20次／分钟
鉴权文档：接口鉴权

接口参数如下：

字段名	字段类型	是否必须	字段描述
exten	string	否	技能组编号
displayName	string	否，默认1	名称查询
page	number	否	页数
pageSize	number	否,默认10	每页大小

注意:
1. 填写技能组编号时，会忽略其他传入参数，只返回当前技能组编号信息。 2. 技能组编号为错误时，会返回空结果。

请求体示例：

{
  "displayName":"mail_test1",
  "exten":"10058823",
  "page":1,
  "pageSize":10
}

返回参数

字段名	字段类型	字段描述
code	number	返回状态
success	bool	是否成功
message	object	处理结果
count	number	总数
data	Array[object]	返回数据

注意：总数可能大于页大小，根据返回值可进行翻页查询

dataObject

字段名	字段类型	字段描述
displayName	string	技能组名称
exten	string	技能组编号
assignRule	string	分配策略（随机：random、轮流：queue、最少：least、优先：priority）
isMemory	bool	是否启用记忆分配
memoryTime	string	记忆分配时长
updateTime	string	最后更新时间
updateAgent	string	最后更新坐席工号（可能为空）
assignMembers	Array[object]	技能组坐席信息

assignMember Object

字段名	字段类型	字段描述
agentNumber	string	坐席工号
agentName	string	坐席名称
priority	string	优先级

返回示例

{
    "success": true,
    "data": {
        "count": 2,
        "list": [
            {
                "displayName": "阿瓦达哇多23",
                "exten": "10018590",
                "assignRule": "priority",
                "isMemory": true,
                "memoryTime": "120",
                "updateTime": "2022-01-04 16:17:27",
                "updateAgent": "",
                "assignMembers": [
                    {
                        "agentNumber": "23234",
                        "agentName": "yanxiaoqi",
                        "priority": "0"
                    }
                ]
            },
            {
                "displayName": "阿瓦达哇多23",
                "exten": "10018587",
                "assignRule": "priority",
                "isMemory": true,
                "memoryTime": "120",
                "updateTime": "2021-12-27 11:23:50",
                "updateAgent": "",
                "assignMembers": [
                    {
                        "agentNumber": "23235",
                        "agentName": "23235",
                        "priority": "0"
                    }
                ]
            }
        ]
    },
    "message": "200 ok!"
}

查询技能组内坐席领取状态接口

1、接口简介

该接口通过技能组编号/技能组的名称，查询该技能组下所有座席的领取状态，包含（PC在线/PC忙碌/APP开启/APP关闭）

2、接口请求

HTTP请求方式：POST
请求链接：{HOST}/v20210827/webChat/queueQueueAgentClaimStatus/{ACCOUNTID}?sig=SIG
请求时请将{HOST}换成对接数据查询中获取到的请求域名，{ACCOUNTID}替换为账户编号，SIG是根据鉴权规则生成的，请看鉴权文档，查看具体的生成规则
鉴权方式：接口鉴权
请求频次：100次/分钟

3、接口参数如下:

请求参数：

字段	类型	是否必须	备注
displayName	string	否	技能组名称
exten	string	否	技能组编号
page	number	否,默认1	页数
pageSize	number	否,默认10	每页大小

请求体示例：

{
    "displayName": "30003",
    "exten": "10019345",
    "page":1,
    "pageSize":10
}

4、返回参数：

字段	字段类型	字段描述
code	number	返回状态
success	bool	是否成功
message	string	处理结果
count	number	总数
data	Array[object]	返回数据

注意：总数可能大于页大小，根据返回值可进行翻页查询

5、返回示例：

{
    "success": true,
    "data": {
        "count": 1,
        "list": [
            {
                "displayName": "30003",
                "exten": "10019345",
                "assignRule": "random",
                "assignMembers": [
                    {
                        "agentNumber": "30003",
                        "agentName": "测试外呼选号",
                        "pcAutoClaim": true,
                        "mobileAutoClaim": true,
                        "priority": "0",
                        "phone": "15711356914"
                    }
                ]
            }
        ]
    },
    "message": "200 ok!"
}

data参数说明：

字段	字段类型	字段描述
displayName	string	技能组名称
exten	string	技能组编号
assignRule	string	分配策略（随机：random、轮流：queue、最少：least、优先：priority）
assignMembers	array	技能组成员
assignMembers[].agentNumber	string	座席工号
assignMembers[].agentName	string	座席昵称
assignMembers[].pcAutoClaim	bool	PC领取状态
assignMembers[].mobileAutoClaim	bool	APP领取状态
assignMembers[].priority	string	优先级
assignMembers[].phone	string	手机号