坐席管理
静态坐席签入
静态坐席批量签入接口
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/login
实例 | |
---|---|
Method | post |
Content-Type | application/x-www-form-urlencoded |
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
data | String | 是 | [{"ag_num":"8001","phone":"13811112222"},{"ag_num":"8002","phone":"13811112223"}] | 详细数据 |
返回结果外层编码说明
code | 说明 |
---|---|
200 | ok |
500 | 错误 |
返回结果内层编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
405 | 号码为空 |
406 | 号码格式不对,要求为多个号码逗号分隔的字符串 |
407 | 坐席已经初始化 |
408 | 号码中包含非数字字符 |
409 | 坐席工号或分机号不存在 |
结果示例
{"code":200,"message":"ok"}
{
"code": 500,
"message": "错误",
"errors": [
{
"code": 409,
"message": "分机号不存在",
"data": {
"ag_num": "10011",
"phone": "15623828691"
}
}
]
}
静态坐席签出
静态坐席批量注销接口
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/logout
实例 | |
---|---|
Method | post |
Content-Type | application/x-www-form-urlencoded |
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
data | String | 是 | [{"ag_num":"1001"},{"ag_num":"1002"}] | 注销的坐席工号 |
结果外层错误编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
404 | 参数中详细数据data为空 |
415 | 参数data不能为空 |
417 | data格式非json |
200 | ok |
500 | 错误 |
结果内层错误编码说明
code | 说明 |
---|---|
405 | 参数中详细数据data格式不对,要求为数组 |
406 | 参数中详细数据data数组格式不对,必须包含工号ag_num |
407 | 坐席不存在或坐席没有签入 |
408 | 不是静态坐席 |
409 | 坐席已从页面登录 |
410 | 格式错误 |
411 | 签出失败 |
结果示例
{"code":200, "message":"ok"}
删除坐席
批量删除坐席接口
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/delete
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ag_ids | String | 是 | [1001, 1002] | 删除的坐席ID集合(JSON字符串) |
ag_nums | String | 是 | ["n9001", "n9002"] | 删除的坐席工号集合(JSON字符串) |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 坐席ag_ids为空、坐席ag_ids或ag_nums至少有一个不能为空 |
404 | 坐席ID包含非数字字符 |
405 | 删除失败 |
406 | 坐席在登陆状态 |
500 | 结果 |
结果示例
{
"code": 500,
"message": "结果",
"data": [{
"code": 404,
"message": "坐席ID包含非数字字符",
"ag_id": 2
}, {
"code": 406,
"message": "坐席在登陆状态",
"ag_id": 5
}]
}
编辑坐席
编辑坐席基础信息
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/edit
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ag_id | Integer | 否 | 1001 | 坐席ID |
ag_num | String | 否 | 1111 | 坐席工号 |
ag_name | String | 是 | 刘慧 | 坐席名称 |
ag_password | String | 否 | zd*23kd593 | 坐席密码 |
ag_nickname | String | 否 | 小刘 | 坐席昵称 |
ag_role | String | 否 | 0 | 坐席类型(-1 =>非坐席,0=>普通坐席,1=>班长坐席) |
user_role | String | 否 | 坐席角色 |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 企业ID不存在或坐席ID和工号不能都为空 |
404 | 坐席ID包含非数字字符 |
405 | 坐席名称为空 |
406 | 坐席类型不正确 |
407 | 角色不属于该企业 |
409 | 坐席数量已经超标 |
410 | 更新坐席失败 |
200 | ok |
结果示例
{"code":200, "message":"ok"}
添加坐席
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/add
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ag_num | String | 是 | 1001 | 坐席工号 |
ag_name | String | 是 | 刘慧 | 坐席名称 |
ag_nickname | String | 否 | 小刘 | 坐席昵称 |
ag_password | String | 是 | zd*302ksdf23 | 坐席密码 |
ag_role | Integer | 否 | 0 | 坐席前台类型(-1 =>非坐席,0=>普通坐席,1=>班长坐席) |
user_role | Integer | 是 | 123 | 坐席角色 |
belong_queues | String | 是 | [1001, 1002] | 所属技能组(格式为数组json[]eg:[技能组id,技能组id2]) |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在或企业ID包含非数字字符 |
403 | 企业ID不存在 |
407 | 坐席工号为空 |
409 | 坐席工号已经存在 |
410 | 坐席名称为空 |
411 | 坐席密码为空 |
412 | 坐席类型不正确 |
413 | 角色不属于该企业 |
414 | 添加坐席失败 |
415 | 坐席已经数量达到极限 |
416 | belong_queues非json格式 |
419 | 角色ID不能为空 |
420 | 技能组ID不存在 |
200 | ok |
结果示例
{"code":200, "message":"ok"}
获取坐席列表数据
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/list
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
que_id | Integer | 否 | 123 | 技能组ID |
ag_id | Integer | 否 | 123 | 坐席ID |
info | Integer | 否 | {"pagination": {"rows": 1000, "page": 1}, "filter":{"keyword":"1001,8001,小王", //关键字可包含(坐席工号、坐席名称) "id":12,//筛选坐席id "user_role":"2",//坐席角色ID "notid":"11,14,15,23"//不包含坐席ID集合 } } | 筛选条件(json串) |
参数filter中字段说明
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
keyword | String | 否 | 刘 | 坐席工号or坐席名称(两个字段or的模糊搜索) 如果想一次搜多个就用逗号隔开 |
id | Integer | 否 | 123 | 坐席id和上面的ag_id参数一样的意思 |
user_role | Integer | 否 | 123 | 坐席角色id |
notid | String | 否 | 123,1001,2002 | 不包含坐席ID集合 |
参数 pagination 中字段说明
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
rows | Integer | 否 | 100 | 每页数据量 |
page | Integer | 否 | 1 | 页码 |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 坐席ID包含非数字字符 |
404 | info格式非json |
200 | ok |
结果示例
{
"code": 200,
"message": "ok",
"total": "1",
"page": 1,
"totalPage": 1,
"data": [{
"ag_id": "200503",
"vcc_id": "2000005",
"ag_num": "1004",
"ag_name": "\u8f9b\u5efa\u534e",
"ag_nickname": "",
"ag_password": "e10adc3949ba59abbe56e057f20f883e",
"ag_role": "1",
"group_id": "0",
"user_type": "0",
"crm_datarole": "1",
"user_role": "8",
"role_name": "\u5750\u5e2d",
"ag_type": "1",
"pho_num": "",
"belong_queues_info": {
"828": "技能组名称"
}
}]
}
结果字段说明
字段 | 说明 |
---|---|
ag_id | 坐席ID |
vcc_id | 企业id和企业代码一一对应 |
ag_num | 坐席工号 |
ag_name | 坐席名称 |
ag_nickname | 坐席昵称 |
ag_password | 坐席密码 |
ag_role | 坐席种类(-1 =>非坐席,0=>普通坐席,1=>班长坐席) |
group_id | 业务组ID |
user_type | 数据权限(0:不限, 1:技能组, 2:坐席, 3:业务组) |
crm_datarole | CRM角色 |
user_role | 坐席角色 |
role_name | 坐席角色名称 |
ag_type | 坐席类型(1主管 2坐席) |
pho_num | 分机号 |
belong_queues_info | 坐席所属技能组({技能组1id:技能组1名称,技能组2id:技能组2名称}) |
修改坐席密码
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/password/update
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ag_id | Integer | 是 | 100 | 每页数据量 |
old_password | String | 是 | zd*23sldf3 | 旧密码 |
new_password | String | 是 | sdfsldf3 | 新密码 |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 坐席ID为空 |
404 | 坐席ID包含非数字字符 |
405 | 旧密码为空 |
406 | 旧密码错误 |
407 | 新密码为空 |
408 | 修改失败 |
409 | 新密码和原始密码一样,无需修改 |
200 | ok |
结果示例
{"code":200,"message":"ok"}
坐席登录
坐席无分机进行登录验证
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/signin
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ag_num | String | 是 | 1001 | 坐席工号 |
password | String | 是 | kd*32342 | 坐席密码 |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 坐席工号为空 |
404 | 密码为空 |
405 | 工号不存在 |
408 | 坐席工号或密码错误 |
200 | ok |
结果示例
{
"code": 200,
"message": "ok",
"data": {
"ag_id": "200500",
"vcc_id": "2000005",
"db_main_ip": "",
"db_slave_ip": "",
"db_name": null,
"db_user": null,
"db_password": null,
"role_action": null
}
}
结果字段说明
字段 | 说明 |
---|---|
ag_id | 坐席ID |
vcc_id | 企业id和企业代码一一对应 |
db_main_ip | 主服务器IP |
db_slave_ip | 从服务器IP |
db_name | 数据库名 |
db_user | 数据库登录用户 |
db_password | 数据库登录密码 |
role_action | 权限列表 |
获取空闲坐席
获取空闲坐席列表数据
接口地址
GET http://m.icsoc.net/v2/wintelapi/agent/free
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
jsonpcallback | String | 否 | callbackFunc | 设置jsonp调用的回调的方法名 |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
200 | ok |
结果示例
{
"code": 200,
"message": "ok",
"data": [
{
"ag_id": "200500",
"pho_num": "8001",
"ag_name": "\u738b\u6210",
"ag_num": "1001"
}
]
}
callback({"code":200,"message":"ok","data":[{"ag_id":"200500","pho_num":"8001","ag_name":"\u738b\u6210","ag_num":"1001"}]})
结果字段说明
字段 | 说明 |
---|---|
ag_id | 坐席ID |
pho_num | 分机号 |
ag_name | 坐席名称 |
ag_num | 坐席工号 |
设置坐席转接电话
设置转电话功能
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/agextphone
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ag_id | String | 是 | 1001 | 坐席ID |
phone | String | 是 | 15088432656 | 电话号码 |
state | String | 是 | 0 | 坐席状态(0空闲、1忙碌) |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 坐席ID为空 |
404 | 坐席ID包含非数字字符 |
405 | 手机号为空 |
406 | 手机号码含非数字字符 |
407 | 手机号码不是11位 |
408 | 状态值不是0或1 |
409 | 对应的坐席不存在 |
410 | 设置失败 |
200 | ok |
结果示例
{"code":200,"message":"ok"}
设置坐席电话呼入呼出权限
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/set/callstatus
接口参数
字段 | 类型 | 是否必填 | 示例值 | 说明 |
---|---|---|---|---|
ag_id | String | 是 | 1001 | 坐席ID |
call_status | String | 是 | 0 | 呼叫状态(0既不呼出又不呼入1呼入2呼出3呼入呼出) |
结果编码说明
code | 说明 |
---|---|
401 | 企业代码为空 |
402 | 企业代码不存在 |
403 | 呼叫状态的值不在允许的范围[0,1,2,3]内 |
404 | 更新失败 |
405 | 坐席ID为空或非数字 |
406 | 对应的坐席不存在 |
200 | ok |
结果示例
{"code":200,"message":"ok"}
设置坐席外呼主叫号码
接口地址
POST http://m.icsoc.net/v2/wintelapi/agent/set/outcaller
接口参数
{
"ag_ids":[1019540,1019535], // 需要设置坐席id 必须
"outbound_caller":1, // 是否开启外呼号码设置,1 开启 0 关闭 必须
"outbound_caller_auto":1, // 是否开启auto, 1是 0否 非必须
"outbound_caller_relay":["01057624342"], // 外呼中继号 非必须
"outbound_caller_phoneGroup":["test1"] // 外呼号码组 非必须
}
结果编码说明
code | 说明 |
---|---|
0 | ok |
-1 | 失败 |
curl实例
curl -X POST \
http://m.icsoc.net/v2/wintelapi/agent/set/outcaller \
-H 'Authorization: Bearer 655845024d086fxxxxx9b007ce815fc4f48a1dd' \
-d '{
"ag_ids":[1019540,1019535],
"outbound_caller":1,
"outbound_caller_auto":1,
"outbound_caller_relay":["01057624342"],
"outbound_caller_phoneGroup":["test1"]
}'
结果示例
{"code":0,"message":"ok"}