坐席管理(v3)

如何认证

示例

1. 获取Token
2. 在Header里添加 Authorization: Bearer {ACCESS_TOKEN}

坐席列表接口

坐席列表接口查询

接口地址

POST https://openapi.icsoc.net/ektv3/v3/wintelapi/users/list

接口参数

传参方式: Content-Type: application/json

参数	类型	说明	必填
page	int	当前页	否
rows	int	当前页大小, 默认100,最大500	否
user_num	string	坐席工号	否
user_status	string	坐席状态 1:在职 2:离职 3:冻结	否
user_ids	string	坐席ID 多个英文逗号隔开	否
dept_ids	string	部门ID 多个英文逗号隔开	否
role_ids	string	角色ID 多个英文逗号隔开	否
queue_ids	string	技能组ID 多个英文逗号隔开	否
position_ids	string	岗位ID 多个英文逗号隔开	否
user_type	string	坐席类型 多个英文逗号隔开	否
relations_queues	int	是否查询坐席关联技能组 1:是 0:否 默认0	否
relations_config	int	是否查询坐席关联配置信息 1:是 0:否 默认0	否

结果编码说明

code	说明
0	ok
其它	具体看message返回信息

示例

请求

curl --location --request POST 'https://openapi.icsoc.net/ektv3/v3/wintelapi/users/list' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "page":1,
    "rows":10,
    "user_num":"8001"
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "ubDGUCGGRHsnjfpJc3UtD9GwP2nRUaDZ",
    "data": {
        "current_page": 1,
        "data": [
            {
                "user_id": 1053489,
                "vcc_id": 782,
                "vcc_code": "wuhan",
                "user_num": "8729",
                "user_name": "test",
                "ag_nickname": "xx",
                "avatar": "https://icsoc-ekt-test-files.oss-cn-beijing.aliyuncs.com/default_user.jpg?OSSAccessKeyId=517MkCFjTNBWpH6B&Expires=1701848005&Signature=Zj17FIAMj%2F3NizW8ixgOtwsbi9E%3D",
                "user_email": null,
                "user_sms_phone": null,
                "fixed_phone": null,
                "user_status": 0,
                "dept_id": 1,
                "dept_name": "中通天鸿",
                "crm_id": "",
                "openid": null,
                "check_in": false,
                "last_login_ip": "0.0.0.0",
                "last_login_user_agent": null,
                "create_user_id": 1024437,
                "update_user_id": 1024437,
                "is_auto_locked": 0,
                "login_failed_times": 0,
                "is_first_login": 1,
                "user_type": "1",
                "is_enable_mfa": 0,
                "mfa_secret": "",
                "position_id": 0,
                "supervisor_id": 0,
                "date_update_time": "2023-12-04 17:31:30",
                "date_create_time": "2023-12-04 17:29:10",
                "date_last_login_time": "",
                "date_locked_time": "",
                "user_status_str": "未知",
                "user_type_str": "呼叫中心",
                "is_enable_mfa_str": "未启用",
                "mfa_bind_str": "",
                "position_name": "",
                "supervisor_name": "",
                "role_id": 117085,
                "role_name": "临时",
                "phone": ""
            }
        ],
        "first_page_url": "https://openapi.icsoc.net/ektv3/v3/wintelapi/users/list?page=1",
        "from": 1,
        "last_page": 1052,
        "last_page_url": "https://openapi.icsoc.net/ektv3/v3/wintelapi/users/list?page=1052",
        "next_page_url": "https://openapi.icsoc.net/ektv3/v3/wintelapi/users/list?page=2",
        "path": "https://openapi.icsoc.net/ektv3/v3/wintelapi/users/list",
        "per_page": 1,
        "prev_page_url": null,
        "to": 1,
        "total": 1052
    }
}

响应字段说明

参数	说明
user_id	ID
vcc_id	企业ID
vcc_code	企业代码
user_name	坐席名称
user_num	坐席工号
ag_nickname	坐席昵称
avatar	坐席头像，临时地址
user_email	邮箱
user_sms_phone	手机
fixed_phone	固定分机
user_status	坐席状态 1:在职 2:离职 3:冻结
dept_id	部门ID
dept_name	部门名称
crm_id	第三方对接ID
openid	在线客服绑定得ID
check_in	是否静态签入状态 true签入false未签入
last_login_ip	最后登陆IP
last_login_user_agent	最后登陆浏览器user-agent
create_user_id	创建人ID
update_user_id	修改人ID
is_auto_locked	是否锁定
login_failed_times	登陆失败次数
is_first_login	是否第一次登陆
user_type	用户类型 1.呼叫中心,2.在线客服,3.工单,4.管理,5.语音辅助,6.视频客服,7.文本辅助
is_enable_mfa	是否开启mfa 0关闭 1开启
mfa_secret	mfa密钥
position_id	岗位ID
supervisor_id	直属主管ID
date_update_time	更新时间 yyyy-mm-dd HH:ii:ss
date_create_time	创建时间 yyyy-mm-dd HH:ii:ss
date_last_login_time	最后登陆时间 yyyy-mm-dd HH:ii:ss
date_locked_time	锁定时间 yyyy-mm-dd HH:ii:ss
user_status_str	坐席状态说明
user_type_str	用户类型说明
is_enable_mfa_str	是否开启mfa
mfa_bind_str	mfa是否绑定
position_name	岗位名称
supervisor_name	直属主管名称
role_id	角色ID
role_name	角色名称
phone	静态签入得号码
queue_ids	技能组ID 多个逗号隔（只有入参relations_queues=1才返回）
queue_names	技能组名称 多个逗号隔开（只有入参relations_queues=1才返回）
config	配置信息 object（只有入参relations_config=1才返回）

config配置对象字段意思可以查看下面坐席新增接口中得字段说明

坐席新增

坐席新增接口

接口地址

POST https://openapi.icsoc.net/ektv3/v3/wintelapi/users/add

接口参数

传参方式: Content-Type: application/json

参数	类型	说明	必填
user_num	string	坐席工号 不能重复	是
user_name	string	坐席姓名	是
user_password	string	坐席密码	是
ag_nickname	string	坐席昵称	否
user_email	string	邮箱 不能重复	否
user_sms_phone	string	手机 不能重复	否
fixed_phone	string	固定分机	否
user_status	int	坐席状态 1:在职 2:离职 3:冻结 默认 1	否
dept_id	int	部门ID 默认根部门	否
role_id	int	角色ID	否
crm_id	string	第三方对接ID	否
user_type	string	用户类型 多个用逗号隔开 1.呼叫中心,2.在线客服,3.工单,4.管理,5.语音辅助,6.视频客服,7.文本辅助	否
position_id	int	岗位ID	否
supervisor_id	int	直属主管ID	否
queue_ids	int[]	所属技能组	否
user_phone_type	int	是否开启网页电话 3:关闭 4:开启 默认值为 3	否
user_login_state	int	坐席登录状态 1:空闲 2:忙碌 默认值为 1	否
user_auto_login	int	电话条自动签入 1:是 0:否 默认值为 1	否
is_enable_outbound	bool	是否开启外呼 true:开启 false:关闭 默认值为 true	否
user_outcall_popup	int	外呼弹屏 1:开启 2:关闭 默认值为 1	否
is_enable_mfa	int	双因子认证(MFA) 1:开启 2:关闭 默认值为 2	否
is_forbidden_login	bool	限制登录系统 true:开启 false:关闭 默认值为 false	否
max_sessions	int	会话上限区间范围 最大值, 最大不超过300	否
basic_sessions	int	会话上限区间范围 最小值, 最小不小于1	否
is_enable_update_capcity	int	允许修改会话上限 1:开启 2:关闭 默认值为 1	否
evaluate_config	object	自动转满意度相关配置	否
wait_time_config	object	事后处理时长相关配置	否
notice_config	object	系统通知相关配置	否
user_caller	object	电话条主叫号码相关配置	否
outbound_callers	object	外呼主叫号码相关配置	否
user_display	object	坐席来显号码相关配置	否
wincall_buttons	object	电话条按钮权限相关配置	否
wincall_transfer_ivrs	object	电话条转接IVR相关配置	否
wincall_interact_ivrs	object	电话条IVR交互相关配置	否
wincall_transfer_queues	object	电话条转技能组相关配置	否

evaluate_config 自动转满意度格式

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
is_enable_inbound_auto_evaluate	bool	呼入直接转座席 true:开启 false:关闭 默认值为 false
is_enable_outbound_auto_evaluate	bool	座席手动外呼 true:开启 false:关闭 默认值为 false

wait_time_config 事后处理时长格式

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
next_wait	int	事后处理时长(s) 默认值5
is_enable_busy_cancel_wait	bool	业务忙时取消事后 true:是 false:否 默认值为 false

notice_config 系统通知格式

参数	类型	说明
is_enable_notice	bool	是否开启 true:开启 false:关闭 默认值为 true
is_enable_browser_tab_notice	bool	浏览器标签页通知 true:开启 false:关闭 默认值为 false
notice_type	string	通知方式 system:应用内通知 false:浏览器通知 默认值为 system
system_notice_position	string	通知框位置 bottomRight:右下,topRight:右上,topLeft:左上,bottomLeft:左下 默认值为 bottomRight
is_auto_close	bool	是否自动关闭 true:是 false:否 默认值为 true
auto_close_interval	int	自动关闭时长(s) 默认值5

user_caller 电话条主叫号码格式

号码,号码组,X号获取

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
auto	bool	自动选择 true:开启 false:关闭 默认值为 false
isXtels	bool	X号 true:开启 false:关闭 默认值为 false
isPhones	bool	中继号 true:开启 false:关闭 默认值为 false
isGroups	bool	号码组 true:开启 false:关闭 默认值为 false
groups	string[]	号码组ID
groupNames	string[]	号码组名称
phones	string[]	中继号码
xtels	string[]	X号 小号

outbound_callers 外呼主叫号码码格式

号码,号码组,X号获取

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
isPhones	bool	中继号 true:开启 false:关闭 默认值为 false
isGroups	bool	号码组 true:开启 false:关闭 默认值为 false
groups	string[]	号码组ID
groupNames	string[]	号码组名称
phones	string[]	中继号码

user_display 坐席来显号码格式

号码,号码组,X号获取

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
isPhones	bool	中继号 true:开启 false:关闭 默认值为 false
phones	string[]	中继号码

wincall_buttons 电话条按钮权限格式

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
buttons	object	按钮开关配置

wincall_buttons.buttons 电话条按钮权限格式

参数	类型	说明
consult	bool	咨询 true:开启 false:关闭 默认值为 false
transfer	bool	转接 true:开启 false:关闭 默认值为 false
threeway	bool	三方 true:开启 false:关闭 默认值为 false
evaluation	bool	满意度评价 true:开启 false:关闭 默认值为 false
autocall	bool	预测式外呼 true:开启 false:关闭 默认值为 false
auto_answer	bool	自动接听 true:开启 false:关闭 默认值为 false
outbound_callers	bool	外呼主叫选择 true:开启 false:关闭 默认值为 false
trans_ivr	bool	转IVR true:开启 false:关闭 默认值为 false
switch_phone	bool	切换分机 true:开启 false:关闭 默认值为 false
raise_hand	bool	置忙举手 true:开启 false:关闭 默认值为 false
dining_remind	bool	排班提醒 true:开启 false:关闭 默认值为 false
outcall	bool	外呼 true:开启 false:关闭 默认值为 false
innercall	bool	内呼 true:开启 false:关闭 默认值为 false
queue	bool	排队 true:开启 false:关闭 默认值为 false
logout	bool	签出 true:开启 false:关闭 默认值为 false

wincall_transfer_ivrs 电话条转接IVR格式

ivr获取

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
transfer_ivrs	int[]	IVR ID

wincall_interact_ivrs 电话条IVR交互格式

ivr获取

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
interact_ivrs	int[]	IVR ID

wincall_transfer_queues 电话条转技能组格式

技能组获取

参数	类型	说明
type	int	1:自定义 2:默认 默认值为 2
transfer_queues	int[]	技能组 ID 可以从cc系统中技能组管理获取

结果编码说明

code	说明
0	ok
其它	具体看message返回信息

示例

请求

curl --location --request POST 'https://openapi.icsoc.net/ektv3/v3/wintelapi/users/add' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1S3PezP7HM34xJpN9JITugfdCbI4XnygridosnIu' \
--data-raw '{
    "user_num": "8733",
    "user_name": "testAdd",
    "user_password": "a123456",
    "ag_nickname": "8732昵称",
    "fixed_phone": "8002",
    "dept_id": 115667,
    "user_status": 2,
    "role_id": 1,
    "crm_id": "11111",
    "user_type": "1,2",
    "position_id": 1,
    "supervisor_id": 1,
    "queue_ids": [2373, 2369],
    "user_phone_type": 4,
    "user_login_state": 2,
    "is_enable_outbound": true,
    "user_outcall_popup": 2,
    "is_enable_mfa": 1,
    "user_auto_login": 1,
    "is_forbidden_login": true,
    "max_sessions": 20,
    "basic_sessions": 1,
    "is_enable_update_capcity": 0,
    "evaluate_config": {
        "type": 2,
        "is_enable_inbound_auto_evaluate": false,
        "is_enable_outbound_auto_evaluate": false
    },
    "wait_time_config": {
        "type": 2,
        "next_wait": 5,
        "is_enable_busy_cancel_wait": false
    },
    "notice_config": {
        "is_enable_notice": true,
        "notice_type": "system",
        "system_notice_position": "bottomRight",
        "is_auto_close": true,
        "auto_close_interval": 5,
        "is_enable_browser_tab_notice": true
    },
    "user_caller": {
        "type": 1,
        "auto": true,
        "isGroups": true,
        "groups": [
            "236",
            "254"
        ],
        "groupNames": [
            "test22222",
            "测试号码组"
        ],
        "isPhones": true,
        "phones": [
            "01088881705",
            "0270000999999"
        ],
        "isXtels": true,
        "xtels": [
            "154878784",
            "17695074890"
        ]
    },
    "outbound_callers": {
        "type": 2,
        "isGroups": false,
        "groups": [],
        "groupNames": [],
        "isPhones": false,
        "phones": []
    },
    "user_display": {
        "type": 2,
        "isPhones": false,
        "phones": []
    },
    "wincall_buttons": {
        "type": 1,
        "buttons": {
            "consult": true,
            "transfer": false,
            "threeway": false,
            "evaluation": false,
            "autocall": true,
            "auto_answer": false,
            "outbound_callers": false,
            "trans_ivr": false,
            "switch_phone": false,
            "raise_hand": false,
            "dining_remind": false,
            "outcall": false,
            "innercall": false,
            "queue": false,
            "logout": false

        }
    },
    "wincall_transfer_ivrs": {
        "type": 2,
        "transfer_ivrs": [
            "1033",
            "1071"
        ]
    },
    "wincall_interact_ivrs": {
        "type": 2,
        "interact_ivrs": []
    },
    "wincall_transfer_queues": {
        "type": 1,
        "transfer_queues": [
            "851"
        ]
    }
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "rEJo2PRrjzs6MuCDF1SW4kC4QcNYQUwK",
    "data": {
        "user_num": "8730",
        "user_name": "testAdd",
        "user_password": "dc483e80a7a0bd9ef71d8cf973673924",
        "ag_nickname": "8730昵称",
        "user_email": "test2@qq.com",
        "user_sms_phone": "18310132163",
        "fixed_phone": "8001",
        "user_status": 1,
        "dept_id": 115667,
        "crm_id": "11111",
        "user_type": "1,2",
        "position_id": 1,
        "supervisor_id": 1,
        "vcc_id": 782,
        "vcc_code": "wuhan",
        "create_user_id": 1024437,
        "update_user_id": 1024437,
        "is_first_login": 1,
        "avatar": "//oss-cn-beijing.aliyuncs.com/default_user.jpg",
        "dept_name": "shishi1",
        "user_id": 1053495 
    }
}

坐席编辑

坐席编辑

接口地址

POST https://openapi.icsoc.net/ektv3/v3/wintelapi/users/edit

接口参数

传参方式: Content-Type: application/json

参数	类型	说明	必填
user_id	int	坐席id	是
user_name	string	坐席姓名	否
user_password	string	坐席密码	否
ag_nickname	string	坐席昵称	否
user_email	string	邮箱	否
user_sms_phone	string	手机 不能重复	否
fixed_phone	string	固定分机	否
user_status	int	坐席状态 1:在职 2:离职 3:冻结	否
dept_id	int	部门ID 默认根部门	否
role_id	int	角色ID	否
crm_id	string	第三方对接ID	否
user_type	string	用户类型 多个用逗号隔开 1.呼叫中心,2.在线客服,3.工单,4.管理,5.语音辅助,6.视频客服,7.文本辅助	否
position_id	int	岗位ID	否
supervisor_id	int	直属主管ID	否
queue_ids	int[]	所属技能组	否
user_phone_type	int	是否开启网页电话 3:关闭 4:开启 默认值为 3	否
user_auto_login	int	电话条自动签入 1:是 0:否 默认值为 1	否
user_login_state	int	坐席登录状态 1:空闲 2:忙碌 默认值为 1	否
is_enable_outbound	bool	是否开启外呼 true:开启 false:关闭 默认值为 true	否
user_outcall_popup	int	外呼弹屏 1:开启 2:关闭 默认值为 1	否
is_enable_mfa	int	双因子认证(MFA) 1:开启 2:关闭 默认值为 2	否
is_forbidden_login	bool	限制登录系统 true:开启 false:关闭 默认值为 false	否
max_sessions	int	会话上限区间范围 最大值, 最大不超过300	否
basic_sessions	int	会话上限区间范围 最小值, 最小不小于1	否
is_enable_update_capcity	int	允许修改会话上限 1:开启 2:关闭 默认值为 1	否
evaluate_config	object	自动转满意度相关配置	否
wait_time_config	object	事后处理时长相关配置	否
notice_config	object	系统通知相关配置	否
user_caller	object	电话条主叫号码相关配置	否
outbound_callers	object	外呼主叫号码相关配置	否
user_display	object	坐席来显号码相关配置	否
wincall_buttons	object	电话条按钮权限相关配置	否
wincall_transfer_ivrs	object	电话条转接IVR相关配置	否
wincall_interact_ivrs	object	电话条IVR交互相关配置	否
wincall_transfer_queues	object	电话条转技能组相关配置	否

各object类型说明参照上面坐席新增接口得说明

结果编码说明

code	说明
0	ok
其它	具体看message返回信息

示例

请求

curl --location --request POST 'https://openapi.icsoc.net/ektv3/v3/wintelapi/users/edit' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer 1S3PezP7HM34xJpN9JITugfdCbI4XnygridosnIu' \
--data-raw '{
    "user_id":1053495,
    "user_status": 2,
    "user_name": "testUpdatex",
    "ag_nickname": "testUpdatexxx",
    "role_id":117071

}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "orUw0oaYtjkDnc5arcP8Xw7Zpsqtb08o",
    "data": {
        "user_id": 1053495,
        "vcc_id": 782,
        "vcc_code": "wuhan",
        "user_num": "8730",
        "user_name": "testUpdatex",
        "ag_nickname": "testUpdatexxx",
        "user_password": "dc483e80a7a0bd9ef71d8cf973673924",
        "avatar": "//oss-cn-beijing.aliyuncs.com/default_user.jpg",
        "user_email": "test2@qq.com",
        "user_sms_phone": "18310132163",
        "fixed_phone": "8001",
        "user_status": 2,
        "dept_id": 115667,
        "dept_name": "shishi1",
        "crm_id": "11111",
        "openid": null,
        "check_in": "0",
        "last_login_time": 0,
        "last_login_ip": 0,
        "last_login_user_agent": null,
        "create_user_id": 1024437,
        "update_user_id": 1024437,
        "is_auto_locked": 0,
        "login_failed_times": 0,
        "is_first_login": 1,
        "user_type": "1,2",
        "is_enable_mfa": 0,
        "mfa_secret": "",
        "position_id": 1,
        "supervisor_id": 1
    }
}

坐席删除

坐席删除

接口地址

POST https://openapi.icsoc.net/ektv3/v3/wintelapi/users/delete

接口参数

传参方式: Content-Type: application/json

参数	类型	说明	必填
ids	string	用户ID（列表接口返回得user_id） 多个逗号隔开	是

结果编码说明

code	说明
0	ok
其它	具体看message返回信息

示例

请求

curl --location --request POST 'https://openapi.icsoc.net/ektv3/v3/wintelapi/users/delete' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YP6iqELNsyhXcVNJfl07ebDiOfDwqENcdlbD2vYP' \
--data-raw '{
    "ids":"1053489"
}'

响应

{
    "code": 0,
    "message": "success",
    "request_id": "iHIZMnuj6Ad378IXv2zIMmL9QY3MblMK",
    "data": []
}