Skip to main content

坐席管理(新)

如何认证

示例

  1. 获取Token
  2. 在Header里添加 'Authorization: 9809d533fb70488db9ef759dd2c973c2dade49ce

例子:

curl -X "POST" "https://m.icsoc.net/v3/api/agent/lists/page/1/20" \
     -H 'Authorization: 9809d533fb70488db9ef759dd2c973c2dade49ce' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "groupId": "113105",
  "queId": "267",
  "checkIn": true,
  "userRole": 992,
  "agStatus": 1
}'

坐席列表接口

坐席列表接口查询Page

接口地址

POST http://m.icsoc.net/v3/api/agent/lists/page/{currentPage}/{pageSize}

接口参数

参数说明必填
currentPage当前页是
pageSize当前页大小是
参数说明必填
search坐席工号、姓名、昵称否
userRole角色ID否
checkIn外勤签入状态否
agStatus入职状态1:在职 2:离职 3:冻结否
deptId部门ID否
queId技能组ID否
{
  "userRole": 992,
  "checkIn": true,
  "agStatus": 1,
  "deptId": "113105",
  "queId": "267",
  "search":"15903"
}

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
  "code": "200",
  "result": {
    "size": 20,
    "total": 17,
    "currPage": 1,
    "data": [
      {
        "id": 1013893,
        "vccId": 782,
        "vccCode": "wuhan",
        "agNum": "112233",
        "agName": "112233",
        "agNickname": "1r",
        "smsPhone": "",
        "userEmail": "",
        "deptId": 113065,
        "deptName": "11",
        "agStatus": 1,
        "agStatusString": "在职",
        "agType": 0,
        "checkIn": true,
        "phone": "",
        "userRole": 992,
        "userRoleName": "员工角色",
        "userRoleRoleGradeString": "员工",
        "userRoleDetail": {
          "roleId": 992,
          "vccId": 782,
          "name": "员工角色",
          "roleGrade": 3,
          "roleGradeString": "员工"
        }
      }
    ],
    "empty": false,
    "pageTotal": 1
  },
  "success": true
}
参数说明
idID
agName坐席名称
agNickName坐席昵称
agNum坐席工号
agStatus入职状态
agStatusString入职状态对应码表
agType坐席类型 1动态签入，2 静态签入
checkIn外勤签入状态
deptId部门ID
deptName部门名称
phone签入得分机号
queues所属技能组
queuesDetail队列详情
smsPhone手机号
userEmail用户邮箱
userRole角色ID
userRoleDetail角色详情
userRoleName角色名称
userRoleRoleGradeString角色等级
vccCode企业code
vccId企业ID

坐席新增

坐席新增接口

接口地址

POST https://m.icsoc.net/v3/api/agent/insert

接口参数

参数说明必填
agNum坐席工号是
agPassword密码是
agName坐席姓名是
agNickname坐席昵称否
agStatus员工状态1,在职，2离职是
smsPhone手机号码否
userEmail邮箱号码否
userRole角色是
deptId所在部门是
deptName部门名称是
queues技能组Ids否
userCaller{//坐席外呼
"type": 1, //0 默认 1自定义
"auto": false,//是否自动
"phones": ["123","23"],//中继号
"groups": ["123","23"],//号码组id
"xtels": ["123","23"]//x号
}		是
userDisplay"userDisplay": {//来显
"type": 1,
"phones": [],
"groups": []
},		是
{
    "agName": "哈哈哈4",
    "agNickname": "哈哈哈4",
    "agNum": "1320",
    "agPassword": "1q2w3e4r",
    "agStatus": 0,
    "deptId": 1,
    "deptName": "1",
    "queues": [
        "12"
    ],
    "smsPhone": "18271836397",
    "userCaller": {
        "type": 1, // 0 默认 1 自定义
        "auto": false,
        "phones": [],
        "groups": [],
        "xTels": []
    },
    "userDisplay": {
         "type": 1, // 0 默认 1 自定义
        "phones": [],
        "groups": []
    },
    "userEmail": "22228@163.com",
    "userRole": 10
}

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
  "code": "200",
  "result": {
    "id": 1024830,
    "vccCode": "wuhan",
    "agNum": "12312312123",
    "agName": "jialiangnu",
    "agNickname": "mmmm",
    "smsPhone": "15627117720",
    "userEmail": "",
    "deptName": "中通天鸿"
  },
  "success": true
}

编辑坐席

坐席编辑

接口地址

POST https://m.icsoc.net/v3/api/agent/edit

接口参数

参数说明必填
id坐席id是
agPassword密码否
agName坐席姓名否
agNickname坐席昵称否
agStatus员工状态1,在职，2离职否
smsPhone手机号码否
userEmail邮箱号码否
userRole角色否
deptId所在部门 修改部门时, 必须带上部门名称否
deptName部门名称 修改部门时, 必须带上部门ID否
queues技能组Ids否
userCaller{//坐席外呼
"type": 1, //0 默认 1自定义
"auto": false,//是否自动
"phones": ["123","23"],//中继号
"groups": ["123","23"],//号码组id
"xtels": ["123","23"]//x号
}		否
userDisplay"userDisplay": {//来显
"type": 1,
"phones": [],
"groups": []
},		否
{
    "id": 1019737,
    "agName": "哈哈哈4",
    "agNickname": "哈哈哈4",
    "agNum": "1320",
    "agPassword": "1q2w3e4r",
    "agStatus": 0,
    "deptId": 1,
    "deptName": "1",
    "queues": [
        "12"
    ],
    "smsPhone": "18271836397",
    "userCaller": {
        "type": 1, // 0 默认 1 自定义
        "auto": false,
        "phones": [],
        "groups": [],
        "xTels": []
    },
    "userDisplay": {
         "type": 1, // 0 默认 1 自定义
        "phones": [],
        "groups": []
    },
    "userEmail": "22228@163.com",
    "userRole": 10
}

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
  "code": "200",
  "result": true,
  "success": true
}
{
  "code": "400",
  "errorMsg": "技能组不存在",
  "success": false
}

坐席详情

坐席详情

接口地址

GET https://m.icsoc.net/v3/api/agent/info?id=1024830

接口参数

参数说明必填
idid是

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
  "code": "200",
  "result": {
    "id": 1024483,
    "agNum": "1238888",
    "agName": "wwww",
    "agNickname": "",
    "agStatus": 1,
    "smsPhone": "",
    "userEmail": "",
    "userRole": 992,
    "deptId": 113105,
    "deptName": "通信组",
    "queues": [],
    "userCaller": {
      "type": 2,
      "auto": false,
      "phones": [],
      "groups": [],
      "groupNames": [],
      "xtels": []
    },
    "userDisplay": {
      "type": 2,
      "phones": [],
      "groups": [],
      "groupNames": []
    }
  },
  "success": true
}

坐席删除

坐席删除

接口地址

POST https://m.icsoc.net/v3/api/agent/delete

接口参数

参数说明必填
idid是

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
  "code": "400",
  "errorMsg": "坐席[2323232]在登录状态",
  "success": false
}
{"code":"200","success":true}

坐席编辑号码下拉框

接口地址

GET https://m.icsoc.net/v3/api/agent/getPhoneSelect

结果编码说明

code说明
200ok
400业务异常
401token认证失败
500系统异常

结果示例

{
  "code": "200",
  "result": {
    "phones": [
      {
        "id": "15525429848",
        "name": "123 15525429848"
      }
    ],
    "groups": [
      {
        "id": "166",
        "name": "测试1"
      }
    ],
    "xTels": [
      {
        "id": "13161181859",
        "name": "13161181859"
      }
    ]
  },
  "success": true
}

查询部门树

接口地址

GET https://m.icsoc.net/v3/api/agent/department/all

结果编码说明

code说明
200ok
400业务异常
401token认证失败
500系统异常

结果示例

{
  "code": "200",
  "result": [
    {
      "children": [
        {
          "children": [],
          "dept_id": 113104,
          "dept_name": "研发部门",
          "dept_pid": 1
        }
      ],
      "dept_id": 1,
      "dept_name": "中通天鸿",
      "dept_pid": 0
    }
  ],
  "success": true
}

查询角色列表

查询角色列表

接口地址

POST https://m.icsoc.net/v3/api/agent/role/lists

接口参数

结果编码说明

code说明
200ok
400业务异常
401token认证失败
500系统异常

结果示例

{
  "code": "200",
  "result": [
    {
      "roleId": 936,
      "vccId": 782,
      "name": "guanliyuanwerwerwerwerwerwerwe",
      "roleGrade": 1,
      "roleGradeString": "主管"
    },
    {
      "roleId": 992,
      "vccId": 782,
      "name": "员工角色",
      "roleGrade": 3,
      "roleGradeString": "员工"
    }
  ],
  "success": true
}

查询技能组列表

查询技能组列表

接口地址

POST https://m.icsoc.net/v3/api/agent/queue/lists

接口参数

结果编码说明

code说明
200ok
400业务异常
401token认证失败
500系统异常

结果示例

{
  "code": "200",
  "result": [
    {
      "id": 206,
      "vccId": 782,
      "groupId": 0,
      "queNum": "10086",
      "quePriority": 100,
      "queName": "余浩技能组",
      "queTag": "0",
      "queType": 0,
      "brecord": 0,
      "queStrategy": 2,
      "overflowStrategy": 0,
      "queLength": 1,
      "queTime": 20,
      "ringTime": 3600,
      "nextWait": 30,
      "noansTimes": 1,
      "noansWait": 10,
      "noansAction": 0,
      "waitAudio": "1110",
      "tellevel": 224,
      "isDel": 0,
      "synchronousQueue": 1,
      "syncQue": 1,
      "groupBelong": "",
      "queTimeConfig": "",
      "bannounce": 1
    }],
  "success": true
}

部门列表接口

部门列表接口查询

接口地址

GET http://m.icsoc.net/v3/api/dept/list
GET https://m.icsoc.net/v3/api/dept/list?deptId=113104
GET https://m.icsoc.net/v3/api/dept/list?deptName=研发

接口参数

参数说明必填
deptId部门id否
deptName部门名称,支持模糊匹配否

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

传deptId或deptName查询结果

{
    "code": "200",
    "result": [
        {
            "deptName": "研发部门",
            "deptPid": 1,
            "deptDeep": 2,
            "vccId": 782,
            "deptId": 113104
        }
    ],
    "success": true
}

不带参数则查询整个部门树

{
    "code": "200",
    "result": [
        {
            "children": [
                {
                    "children": [
                        {
                            "dept_id": 113087,
                            "dept_name": "中通天鸿通信科技股份有限公司武汉通信股份",
                            "dept_pid": 113076
                        }
                    ],
                    "dept_id": 113076,
                    "dept_name": "2222222222222aaaaaaa",
                    "dept_pid": 1
                },
                {
                    "dept_id": 113351,
                    "dept_name": "232",
                    "dept_pid": 1
                }
            ],
            "dept_id": 1,
            "dept_name": "中通天鸿",
            "dept_pid": 0
        }
    ],
    "success": true
}

部门新增

部门新增接口

接口地址

POST https://m.icsoc.net/v3/api/dept/add

接口参数

参数说明必填
deptPid父部门ID是
deptName部门名称是
maxLoginNum最大登陆坐席数否
isEnableOutCaller是否开启外呼主叫 0停用 1启用否
isEnableDisplay来显号码开关 0默认 1自定义否
isAssignOutCaller是否开始自动分配 0停用 1启用否
isGroup号码组是否选中 0否 1是否
outCallerGroupIds外呼号码组 空为全部否
isPhone中继号是否选中 0否 1是否
outCallerPhones外呼中继号 空为全部否
isXPhoneX号码是否选中 0否 1是否
outCallerXPhones外呼X号码 空为全部否
isDisplayGroup来显号码号码组是否选中 0否 1是否
displayGroupIds来显号码号码组否
isDisplayPhone来显号码中继号是否选中 0否 1是否
displayPhones来显号码中继号否
{
  "isEnableOutCaller": 1,
  "isEnableDisplay": 1,
  "deptPid": 1,
  "deptName": "测试新增部门",
  "maxLoginNum": 100,
  "isAssignOutCaller": 0,
  "isGroup": 1,
  "outCallerGroupIds": "166",
  "isPhone": 0,
  "outCallerPhones": "",
  "isXPhone": 0,
  "outCallerXPhones": "",
  "isDisplayGroup": 1,
  "displayGroupIds": "167",
  "isDisplayPhone": 0,
  "displayPhones": "",
  "deptId": 0,
  "version": 0
}

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
    "code": "200",
    "result": {
        "deptName": "11115",
        "deptPid": 113104,
        "deptDeep": 3,
        "vccId": 782,
        "deptId": 113368
    },
    "success": true
}

编辑部门

部门编辑

接口地址

POST https://m.icsoc.net/v3/api/dept/edit

接口参数

参数说明必填
deptId修改的部门ID是
deptPid父部门ID是
deptName部门名称是
maxLoginNum最大登陆坐席数否
isEnableOutCaller是否开启外呼主叫 0停用 1启用否
isEnableDisplay来显号码开关 0默认 1自定义否
isAssignOutCaller是否开始自动分配 0停用 1启用否
isGroup号码组是否选中 0否 1是否
outCallerGroupIds外呼号码组 空为全部否
isPhone中继号是否选中 0否 1是否
outCallerPhones外呼中继号 空为全部否
isXPhoneX号码是否选中 0否 1是否
outCallerXPhones外呼X号码 空为全部否
isDisplayGroup来显号码号码组是否选中 0否 1是否
displayGroupIds来显号码号码组否
isDisplayPhone来显号码中继号是否选中 0否 1是否
displayPhones来显号码中继号否
{
  "isEnableOutCaller": 1,
  "isEnableDisplay": 1,
  "deptPid": 1,
  "deptName": "测试新增部门",
  "maxLoginNum": 100,
  "isAssignOutCaller": 0,
  "isGroup": 1,
  "outCallerGroupIds": "166",
  "isPhone": 0,
  "outCallerPhones": "",
  "isXPhone": 0,
  "outCallerXPhones": "",
  "isDisplayGroup": 1,
  "displayGroupIds": "167",
  "isDisplayPhone": 0,
  "displayPhones": "",
  "deptId": 0,
  "version": 0
}

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
    "code": "200",
    "result": {
        "deptName": "11116",
        "deptPid": 113104,
        "deptDeep": 3,
        "vccId": 782,
        "deptId": 113368
    },
    "success": true
}

部门详情

部门详情

接口地址

GET https://m.icsoc.net/v3/api/dept/info?deptId=113368

接口参数

参数说明必填
deptId部门id是

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
    "code": "200",
    "result": {
        "deptName": "11116",
        "deptPid": 113104,
        "deptDeep": 3,
        "vccId": 782,
        "deptId": 113368
    },
    "success": true
}

部门删除

部门删除

接口地址

POST https://m.icsoc.net/v3/api/dept/delete?deptId=113365

接口参数

参数说明必填
deptId部门id是

结果编码说明

code说明
200ok
400业务异常
401token认证失败
402输入参数事务
403限流请求过快
500系统异常

结果示例

{
    "code": "200",
    "result": 113365,
    "success": true
}

修改坐席所在部门

接口地址

POST https://m.icsoc.net/v3/api/dept/agentEditDept?agentId=1024480&deptId=113362

接口参数

参数说明必填
agentId坐席id是
deptId部门id是

结果编码说明

code说明
200ok
400业务异常
401token认证失败
500系统异常

结果示例

{
    "code": "200",
    "result": true,
    "success": true
}