座席信息管理接口

请求方式：POST

请求地址

'/openapi/platform/v1/agent/list'

请求参数

字段名称	字段类型	是否必填	字段描述
agentNumber	string	否	坐席工号
agentName	string	否	座席名称
mobile	string	否	手机号
crmId	string	否	第三方关联用户的id
page	number	否	页数
pageSize	number	否	每页条数，默认100
groupId	string	否	服务组id

请求示例

{
    "agentNumber": "8010",
    "page": 1,
    "pageSize": 6
}

返回参数

字段名称	字段类型	字段描述
_id	string	坐席Id
accountId	String	账户编号
agentNumber	string	坐席工号
agentName	string	座席名称
password	string	座席密码
mobile	string	手机号
email	string	邮件地址
crmId	String	客户ID
status	Integer	座席状态 1 启用，0 停用
lockStatus	Integer	冻结状态 0 未冻结，1 冻结
groups	List<String>	服务组列表
restTime	Integer	整理时长
disNumbers	List<String>	专属外显号码列表
numberGroup	string	专属外显号码组id
sipNumber	string	坐席关联sip号
displayStrategy	List<String>	外显策略 enterprise 高级策略（坐席外呼时选择外显号），enterpriseGroup: 高级策略（坐席外呼时选择外显号码组）其他没有值
createTime	datetime	创建时间
updateTime	datetime	修改时间

返回示例


{
    "success": true,
    "message": "200 ok!",
    "code": "200",
    "data": {
        "list": [
            {
                "_id": "663578842498871236",
                "accountId": "1090",
                "agentNumber": "8010",
                "agentName": "cs",
                "mobile": "12345678901",
                "email": "",
                "crmId": "",
                "status": 1,
                "lockStatus": null,
                "groups": [
                    "10000210"
                ],
                "restTime": 30,
                "disNumbers": [
                    "021207711111"
                ],
                "numberGroup": "",
                "sipNumber": "1090000000262",
                "displayStrategy": [
                    "enterprise"
                ]
            }
        ],
        "page": {
            "pageSize": 100,
            "pageNumber": 1,
            "totalPage": 1,
            "total": 1
        }
    }
}

请求方式：POST

请求地址：/openapi/platform/v1/agent/create

请求参数

key	type	必填	备注
agentNumber	String	true	座席工号，座席工号长度为3-7位，必须是非0开头的数字
agentName	String	true	座席名称
mobile	String	false	手机号
crmId	String	false
email	String	false	邮箱
groups	Array(String)	false	服务组列表
status	int	false	座席是否启用，1为启用，0为停用，不传则默认启用
crmId	String	false	用来关联三方系统对应座席id
roles	Array(String)	true	角色列表, 请联系管理员获取字段信息
versionId	String	true	licence，请联系管理员获取字段信息
password	String	true	密码不能为空（不能使用特殊字符）
callConfigLoginType	Array(String)	false	座席允许的接听方式列表, 软电话 WEBRTC，话机 SIP, 手机模式 PSTN)
callConfigRestTime	number	false	整理时长，默认0s
imConfigAgentNickName	String	false	在线模块设置-座席昵称
imConfigMinLimit	number	false	在线模块设置-最小会话上限
imConfigMaxLimit	number	false	在线模块设置-最大会话上线
callerStrategy	String	false	外呼号码策略 1为无、2为指定外显号码、3为指定外显号码组
callerNumbers	List<String>	callerStrategy为1时必填	外显号码列表
callerGroup	String	callerStrategy为2时必填	外显号码组id
callInAnswerType	String	false	座席固定接听方式。CURRENT：当前登录方式。 PSTN：手机模式

请求参数示例：

{
  "agentNumber": "",
  "agentName": "",
  "mobile": "",
  "crmId": "",
  "email": "",
  "groups": [
    ""
  ],
  "roles": [
    ""
  ],
  "versionId": "",
  "password": "123456Aa",
  "callConfigLoginType": [
    ""
  ],
  "callConfigRestTime": 0,
  "imConfigAgentNickName": "",
  "imConfigMinLimit": 1,
  "imConfigMaxLimit": 5,
  "callerStrategy":"0"
}

请求方式：POST

访问路径

/openapi/platform/v1/agent/update

请求参数

字段名称	字段类型	是否必传	字段描述
agentNumber	string	是	坐席工号
agentName	string	否	坐席名称
email	string	否	坐席邮箱
password	string	否	坐席密码(可由字母、数字组成，长度为8-18个字不能使用特殊字符)
crmId	string	否	用来关联三方系统id
restTime	string	否	坐席整理时长，默认30s
mobile	string	否	换绑的手机号
groups	List<String>	否	所属服务组列表
status	Integer	否	座席是否启用，1为启用，0为停用
roles	Array(String)	否	角色列表, 请联系管理员获取字段信息
versionId	String	否	licence版本id，请联系管理员获取字段信息
callerStrategy	String	否	外呼号码策略 1为无、2为指定外显号码、3为指定外显号码组
callerNumbers	List<String>	callerStrategy为2时必填	外显号码列表
callerGroup	String	callerStrategy为3时必填	外显号码组id
callInAnswerType	String	false	座席固定接听方式。CURRENT：当前登录方式。 PSTN：手机模式

请求示例

{
    "agentName":"test",
    "email":"123121231@163.com"
    "password":"1231231qsa"
    "restTime":"20",
    "mobile":"15035041093",
    "agentNumber":"8124",
    "groups": ["id1","id2"]
}

返回参数

字段名称	字段类型	字段描述
success	boolean	请求是否成功
message	String	响应结果
code	String	响应码
data	String	响应文本

返回示例

{
    "success": true,
    "message": "200 ok!",
    "code": "200",
    "data": {
        "accountId": "1000",
        "agentNumber": "xxxx",
        "agentName": "xxx",
        "mobile": "xxxxxxx",
        "email": "",
        "password": "xxxxxxxxxxxx",
        "restTime": null
    } 
}

2025-10-15

座席信息管理接口

一、查询座席信息接口

二、新增座席接口

三、座席修改接口

本页目录