Skip to content

团队系统

1. 团队相关

1.1 场景列表

  • 接口地址
POST /v1/team/sceneList
  • 说明

此接口用于团队设置场景时使用。

  • 请求参数

  • 返回结果
名称类型示例描述
idint2ID
namestring"公司"名称
isManualint1是否常用:1是 2否
sortint2排序

备注

团队系统功能暂未完成,teamList暂时只返回空数组

  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": [
        {
            "id": 3,
            "name": "公司/企业",
            "isManual": 1,
            "sort": 1
        },
        {
            "id": 500,
            "name": "其他",
            "isManual": 1,
            "sort": 500
        }
    ]
}

1.2 所有团队列表

  • 接口地址
POST /v1/team/teamListAll
  • 请求参数

  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "myTeam": [
            {
                "id": 1,
                "teamNo": "TD20661036",
                "teamName": "biaobiao1",
                "teamCode": "KPQOVTHP",
                "scene": 0,
                "sceneCustomName": "",
                "personNo": "CY29810012",
                "personName": "biaobiao",
                "isOwner": true
            }
        ],
        "pendTeam": [
            {
                "id": 2,
                "teamNo": "TD54318535",
                "teamName": "88184160的互联",
                "teamCode": "AWECKTFR",
                "scene": 0,
                "sceneCustomName": "",
                "personNo": "CY97313909",
                "isOwner": false
            }
        ]
    }
}

1.3 确定/拒绝加入团队

  • 接口地址
POST /v1/team/teamPersonPendChange
  • 请求参数
名称类型是否必需示例描述
pendStatusintY1确认状态,1 确定加入,2 拒绝加入
personNostringY"CY97313909"操作人员编号
  • 返回结果

1.4 切换当前团队

  • 接口地址
POST /v1/team/changeTeam
  • 请求参数
名称类型是否必需示例描述
teamNostringY"TD54318535"切换到哪个团队
  • 返回结果

1.5 团队详情

  • 接口地址
POST /v1/team/detail
  • 说明

必须有当前团队,如没有,可通过(1.4 切换当前团队)接口切换选择团队;以下所有接口都如此。

  • 请求参数

  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "teamNo": "TD20661036",
        "teamName": "biaobiao1",
        "scene": 0,
        "sceneCustomName": "",
        "teamCode": "KPQOVTHP",
        "isOwner": true,
        "owner": "YH208389499689214",
        "isVip": false,
        "personName": "biaobiao",
        "personNo": "CY29810012",
        "personPhone": "13410577084",
        "personCount": 5,
        "isPersonal": 0,
        "isUpgrade": 0,
        "isBindEzviz": 0,
        "state": 1,
        "authStatus": 0
    }
}

1.6 修改团队信息

  • 接口地址
POST /v1/team/updateTeam
  • 请求参数
名称类型是否必需示例描述
teamNamestringY"biaobiao1"团队名称
  • 返回结果

1.7 解散团队

未完成

此接口功能尚未完成

  • 接口地址
POST /v1/team/disbandTeam
  • 请求参数
名称类型是否必需示例描述
teamNostringY"TD54318535"团队编号
  • 返回结果

1.8 退出团队

未完成

此接口功能尚未完成

  • 接口地址
POST /v1/team/exitTeam
  • 请求参数
名称类型是否必需示例描述
teamNostringY"TD54318535"团队编号
  • 返回结果

1.9 创建团队

  • 接口地址
POST /v1/team/createTeam
  • 说明

好像只有APP才有此功能。

  • 请求参数
名称类型是否必需示例描述
teamNamestringY"测试新团队"团队名称
sceneintY1选择场景
sceneCustomNamestringY/N"新场景"场景选择"其他"时必填:自定义场景名称
  • 返回结果

1.10 团队人员参数配置

  • 接口地址
POST /v1/team/teamPersonConfig
  • 请求参数

  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "teamNo": "TD20661036",
        "isOpenUser": 1,
        "isInputFace": 2,
        "isInputCard": 2,
        "roleIds": []
    }
}

1.11 团队人员参数配置修改

  • 接口地址
POST /v1/team/teamPersonConfigUpdate
  • 请求参数
名称类型是否必需示例描述
isOpenUserintY1添加人员时,是否默认勾选【开通账号】,1是2否
isInputFaceintY2是否允许用户自助录入自己的人脸信息
isInputCardintY2是否允许用户自助录入和挂失自己的卡片
roleIdsarrayY[2]【开通账号】时,给用户设置的默认角色;角色ID数组
  • 返回结果

1.12 邀请参数配置

  • 接口地址
POST /v1/team/teamApplyConfig
  • 请求参数

  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "teamNo": "TD20661036",
        "applyJoinTeamAudit": 1,
        "joinTeamInputFace": 2,
        "teamInviteUserValidFalse": 2
    }
}

1.13 邀请参数配置修改

  • 接口地址
POST /v1/team/teamApplyConfigUpdate
  • 请求参数
名称类型是否必需示例描述
applyJoinTeamAuditintY1邀请用户-申请后需管理员审核 1是2否
joinTeamInputFaceintY2邀请用户-申请加入时可录入人脸 1是2否
  • 返回结果

1.14 邀请信息重置

  • 接口地址
POST /v1/team/resetInviteInfo
  • 请求参数
名称类型是否必需示例描述
teamInviteUserValidFalseintY1邀请用户-邀请信息30天后自动失效 1是2否
  • 返回结果

1.15 邀请信息

  • 接口地址
POST /v1/team/getInviteInfo
  • 请求参数
名称类型是否必需示例描述
departNostringY"BM89184369"邀请用户的所属组织
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "teamName": "biaobiao1",
        "teamNo": "TD20661036",
        "teamCode": "MUOMIPAV",
        "inviteId": 1,
        "inviteInfo": "http://local.work.star-lock.cn/test?teamName=biaobiao1&teamCode=MUOMIPAV&inviteId=1&departNo=BM89184369",
        "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAIAAAAiOjnJAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAIo0lEQVR4nO2dyY7rWg4Euxrv/3/59k5vQRRNMjPli0bE0jqTbIIUJ+vnz58//wFw899vHwD+P0GwIAKCBREQLIiAYEEEBAsiIFgQ4Z/fLvz8/Cjr1vDYs6AYObsdbHKe5pNmneaEk5VXC66Y3IX9V35AY0EEBAsi/GoKH1aWa6VaG3PQrLOyL88nE9NTL00O1ixYB0+OMbFcLltWt5gw2RSNBREQLIjw2RQ+TMzTZNbN+ZqMEV22ye4uI3u7nckW9WArbr9yBY0FERAsiLAwhSIrS9GMWdmyZszEulVcIdOVI7yKpr7gQk5AY0EEBAsivGcKV3G/hpVndBuzYmLmmlnNwSbm+2aIXwCNBREQLIiwMIU5RSrW2Nwik+LKYqKzfiL6m5MtJrh+ZTQWRECwIMJnU2gvzBCLSW5lM7eVv3LCVSx35eTezPcNNBZEQLAgwq+m8IVgWqOZJ96Ty5pMuCXpJrvfvmfXXrlfGY0FERAsiPDzmzK02w4xV3g7jz3COWFVTyvOqtPtg+usCWgsiIBgQYSFV3jrCFiZMNHe5do0xBDlrU2yGdMc1VW0I/ZUorEgAoIFES59hfaOgFs7g6tr4OY5Ntzc1VWFj+tRoe412X0CGgsiIFgQ4XOAtOJymsTay8pKe7tqbCasVn74broWUwh/IwgWRPjVFP47YmMyVg6aq4/gZl/EXKHLdqyeGeyPHK4EZQWNBREQLIjw2RT+O9TtRol28xYObRZcXZpgLzS6HaOSS6o+oLEgAoIFETz/NtMoycaEiZ6jGNy7TXf5ZQ32YiRxrxtoLIiAYEGEhVfYrZIv3RR5IeK6GuwyxM2m9p6OFWgsiIBgQYTP7yt06Wqx0Vus9p8o/5ujt3JpxZVXPuAtydt8UiFACm+DYEGExR+vTQKbudqPyayVeaorT+6iobELt03FFGrda5XkFZOzaCyIgGBBhHhf4Zt1JituHXl1uli6WR3GyQldfYWi69eAxoIICBZEWLzFfhLlE/0pl/uzmi52VdQtmumiCVttevMBK7cmETQWRECwIMLnP15baUKXhq+DJ5uKJal1wckxXA8GXwls3p4QJqCxIAKCBREWLfaVF8oyxbZEl2K/BT8nl8S9KmLhqHinD2gsiIBgQYTLv804BjfTG25hTNEzmixot8hiW8QNl3OKxoIICBZE+NxMsbok5u8m64huy03V3z6pWzS4+lDsmdy68gQ0FkRAsCCC599mHm7BvUllTrPg5Dy3Foxb4ehk8KQc98FVPyOujCmE74NgQYTFq3vrpYqr2OaWK3Sd0BWnXYVMJ5eaY9jzrWJNKRoLIiBYEGHxkiaxmPNWhDnBVQZ5S3SucoWTvewpwhfKiipoLIiAYEGEhVeYazEQfcAJKx/Q3mLgsvXNys2sXK0OXiG8DYIFEcwB0oZcX0Pdog6+uWwuxMeJ1cpibcxki3qpgsaCCAgWRJCaKVzBz1s+8Tb9hR691cFuK0+2EO8LrxD+RhAsiLB4M4VLSa72elhVbNZZYtXNrZ3hhQjw5JZXNa6rvRrQWBABwYIIi2aKiba8jVm13bku3Qo1RVZm13UMV7Z3dQw0FkRAsCDC4tW9rmyUveFiNWa1hYsXMnr2vcSvF40FERAsiGBuplhNdxXAuIpCm8HNwSbcrFKu1NbeAllBY0EEBAsiXMpm3nQuckakGby61JxZ3KLZ6xb4tZ+5AY0FERAsiLDwCh9uhTR1+mTMqhtxtUVFdEUne7k6+yabig8PzZgJaCyIgGBBhEuL/Zu5QjGVdvM3RS9M9EldnSmrJwRXuvYBjQURECyI4MkV3tJ2q+liwafoGb3gFdot12qLm03EFMLbIFgQ4fNb7Cv2PrVGITfrTBr6JrPq9Dp4dcv2hr7JUSs3z9FV0YrGgggIFkSQ/nhNjJ3eptvjqzdvVxwjxpYbxFSjq3oWjQURECyIIFWQutJSLrtgL22dDL61PFTEClLX84CrfwSNBREQLIiQejNFXaeZ5Ur/2YtJJucRm/5cFZvNFpPBzaY0U8BfBIIFEaSyGVeHwmTTm8dnr7FxndnVKigievoNaCyIgGBBhEvZTMNNaTd6+OZziY2Kk6qSuvvNiLj8RNejy2SvCWgsiIBgQYRFrrDi6n1oVnb1m7vIdR/k4s+TWRUxUorGgggIFkT4/JKmB9FtcTXiuYKozfSbEyfee+MRT9ZZ+aRiFJRcIXwNBAsiXN5MsULMxN3OY28etB/shaokMU7bXKLFHr4GggURFq/utdfbN9NFbyXXPnDzAUUzZ+8QXK1TwSuEr4FgQYTFq3td/ebNrIrYHyHaBbEXcvIUUQc3W9i7PCZVQM3ueIXwNggWRLiUzaz6I5oFXUm6FbcQpetLWMUh66WKWCQjPrFgCuFtECyIkMoVuuoYbwuuOi9u3mVdZ4KrIMceAbYHvdFYEAHBggiLCtIHe0PBKjYoumN101X675ZYXHHrdJhMF/OtK+OIxoIICBZEuLy690GMlDazXrBu9t5D0RW95TddY5pZDwRI4fsgWBAh9W8zD66g5c1lWzXZNceorPxW13TRtjbrNAe7gcaCCAgWRLgESCc0xZMrVe9K5Im5SzG62wyeHEO808mjwsoHnMgGGgsiIFgQ4XMzhVhk6MrEiSWXYsPF6kuYmIzb1+JyaZvp4qUHNBZEQLAgwqWvsHKLpordB65M5Sq+OsFVttqc0OXk3qbXg1XQWBABwYIIC1Mockvb1emuVjixVfC5VMe4LODt8LlGidWDARoLIiBYEOE9U/hmcYurDbCy8qca83TL3zXTbxVHddNmC3KF8H0QLIiweIv9aDlTp2EdUxH7EW5tCK5QsBh+dO11az8hVwhfA8GCCFJfYYOrS86VEKzTG0SH6GajRatdBz/c+lkmu5MrhLdBsCDC4o/XAOagsSACggURECyIgGBBBAQLIiBYEAHBgggIFkT4H+it7al+pLZ9AAAAAElFTkSuQmCC"
    }
}

1.16 邀请页面信息验证

  • 接口地址
POST /v1/open/teamInviteInfo
  • 请求参数
名称类型是否必需示例描述
inviteIdintY3邀请ID
teamCodestringY"PDDZBTVF"邀请码
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "teamName": "biaobiao1"
    }
}

1.17 提交邀请用户申请

  • 接口地址
POST /v1/open/resetInviteInfo
  • 说明

此接口需要验证码,codeType=11,参见验证码接口文档。

  • 请求参数
名称类型是否必需示例描述
inviteIdintY3邀请ID
teamCodestringY"PDDZBTVF"邀请码
personNamestringY"邀请人1"用户姓名
phonestringY"13410577036"用户手机号
verificationCodestringY"123445"验证码
departNostringY"BM12121222"部门编号
  • 返回结果

2. 组织

2.1 组织列表

  • 接口地址
POST /v1/team/departList
  • 请求参数
名称类型是否必需示例描述
departNostringN""父级组织;未传值时默认顶级组织
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "departList": [
            {
                "id": 1,
                "teamNo": "TD20661036",
                "departNo": "BM66547152",
                "departName": "biaobiao1",
                "parentId": -1,
                "leader": "",
                "level": 1,
                "sort": 1,
                "hasLeaf": false,
                "personNum": 1
            }
        ]
    }
}

2.2 组织添加

  • 接口地址
POST /v1/team/departCreate
  • 请求参数
名称类型是否必需示例描述
departNamestringY"研发二部"组织名称
parentDepartNostringY"BM89184369"上一级组织编号
leaderarrayN["CY53595123"]负责人编号集合
  • 返回结果

2.3 组织修改

  • 接口地址
POST /v1/team/departUpdate
  • 请求参数
名称类型是否必需示例描述
departNamestringY"研发二部"组织名称
departNostringY"BM89184369"要修改的组织编号
leaderarrayN["CY53595123"]负责人编号集合
  • 返回结果

2.4 组织删除

  • 接口地址
POST /v1/team/departDelete
  • 请求参数
名称类型是否必需示例描述
departNostringY"BM89184369"要操作的组织编号
  • 返回结果

2.5 组织排序

  • 接口地址
POST /v1/team/departSort
  • 请求参数
名称类型是否必需示例描述
departNostringY"BM79211238"要交换排序的组织编号1
sortChangeDepartNostringY"BM27383619"要交换排序的组织编号2
  • 返回结果

3. 人员

3.1 人员列表

  • 接口地址
POST /v1/team/personList
  • 请求参数
名称类型是否必需示例描述
pageNointN1第几页, 默认1
pageSizeintN10每页数量,默认10
departNostringN"BM66547152"部门编号;默认团队的顶级部门
personNamestringN"aa"名称模糊查询
phonestringN"13411111111"手机号
stateintN1人员状态1正常2已过期
jobNumberstringN"10002"工号
cardNostringN"659874"卡号
hasLeafDepartbooleanNtrue是否包含下级组织
userStateintN2用户状态1开通2未开通3停用
passPortsarrayN[1,2]通行凭证
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "pageNo": 1,
        "pageSize": 1,
        "total": 1,
        "pages": 1,
        "list": [
            {
                "id": 1,
                "teamNo": "TD20661036",
                "departNo": "BM66547152",
                "departName": "34572686的互联",
                "personNo": "CY29810012",
                "personName": "biaobiao",
                "jobNumber": 10001,
                "phone": "13410577084",
                "sex": 0,
                "sexName": "",
                "pathName": "",
                "state": "",
                "userState": 1,
                "faceCount": 0,
                "fingerprintCount": 0,
                "cardCount": 0,
                "isSuper": false,
                "isOperationUser": false
            }
        ]
    }
}

3.2 人员添加

  • 接口地址
POST /v1/team/personCreate
  • 请求参数
名称类型是否必需示例描述
departNostringY"BM43619692"所属组织编号
personNamestringY"xixi"人员姓名
createUserbooleanNfalse是否开通账号
phonestringY/N"13410577084"手机号;选择开通账号时必填
sexintN1性别1男2女0未知
positionstringN"班长"职务
remarkstringN"dafdaf"备注
associateUsersarrayN["CY66517494"]关联人员
limitTypeintN1生效类型;1永久;2有效期
limitStartTimestringN"2025-11-07"生效日期
limitEndTimestringN"2025-08-07"失效日期
idCardstringN"121212"身份证号
isConfirmbooleanNtrue姓名重复确认;(对应报错:446)
roleIdsarrayN[1212, 3213213]分配角色ID集合
jobNumberstringN""工号
  • 返回结果

  • 异常结果

姓名重复提示

json
{
    "errorCode": 446,
    "errorMsg": "该姓名在团队中已存在,是否确定添加?",
    "description": "",
    "data": {}
}

3.3 人员修改

  • 接口地址
POST /v1/team/personUpdate
  • 请求参数
名称类型是否必需示例描述
personNostringY"CY94260799"要修改的人员编号
personNamestringY"xixi"人员姓名
createUserbooleanNfalse是否开通账号
phonestringY/N"13410577084"手机号;选择开通账号时必填
sexintN1性别1男2女0未知
positionstringN"班长"职务
remarkstringN"dafdaf"备注
associateUsersarrayN["CY66517494"]关联人员
limitTypeintN1生效类型;1永久;2有效期
limitStartTimestringN"2025-11-07"生效日期
limitEndTimestringN"2025-08-07"失效日期
idCardstringN"121212"身份证号
roleIdsarrayN[1212, 3213213]分配角色ID集合
isSendSmsbooleanNfalse是否发送短信通知
isConfirmbooleanNtrue姓名重复确认;(对应报错:446)
jobNumberstringN""工号
  • 返回结果

  • 异常结果

姓名重复提示

json
{
    "errorCode": 446,
    "errorMsg": "该姓名在团队中已存在,是否确定添加?",
    "description": "",
    "data": {}
}

3.4 人员删除

  • 接口地址
POST /v1/team/personDelete
  • 请求参数
名称类型是否必需示例描述
personNostringY"CY53595123"要操作的人员编号
  • 返回结果

3.5 人员详情

  • 接口地址
POST /v1/team/personDetail
  • 请求参数
名称类型是否必需示例描述
personNostringY"CY53595123"要操作的人员编号
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "id": 6,
        "teamNo": "TD20661036",
        "departNo": "BM84077761",
        "departName": "研发一部",
        "personNo": "CY94260799",
        "personName": "xixi5",
        "jobNumber": 10005,
        "phone": "13410577085",
        "sex": 0,
        "sexName": "--",
        "pathName": "",
        "state": "",
        "userState": 2,
        "isSuper": false,
        "isOperationUser": false,
        "position": "",
        "remark": "",
        "idCard": "",
        "associateUsers": [
            {
                "personNo": "CY66517494",
                "personName": "xixi3",
                "avatarUrl": "http://local.work.star-lock.cn/storage/https://ui-avatars.com/api/?name=xixi&color=7F9CF5&background=EBF4FF"
            }
        ],
        "roleList": [2, 4]
    }
}

3.6 人员下拉数据

  • 接口地址
POST /v1/team/personMap
  • 说明

用在组织、商户设置负责人,或者其他有下拉选择人员的地方。

  • 请求参数
名称类型是否必需示例描述
userStateintN1是否开通账号的人员;不传或者不等于1,默认为否
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": [
        {
            "personNo": "CY29810012",
            "personName": "biaobiao"
        },
        {
            "personNo": "CY53595123",
            "personName": "xixi1"
        }
    ]
}

3.7 已删除人员列表

  • 接口地址
POST /v1/team/DelPersonList
  • 请求参数
名称类型是否必需示例描述
pageNointN1第几页, 默认1
pageSizeintN10每页数量,默认10
personNamestringN"aa"名称模糊查询
phonestringN"13411111111"手机号
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "pageNo": 1,
        "pageSize": 1,
        "total": 1,
        "pages": 1,
        "list": [
            {
                "id": 1,
                "departName": "34572686的互联",
                "personNo": "CY29810012",
                "personName": "biaobiao",
                "jobNumber": 10001,
                "phone": "13410577084",
                "deleteDay": 1,
                "deletedAt": ""
            }
        ]
    }
}

3.8 人员恢复

  • 接口地址
POST /v1/team/personRestore
  • 请求参数
名称类型是否必需示例描述
personNostringY"CY53595123"要操作的人员编号
phoneConfirmbooleanNtrue手机号重复时,强制恢复,手机号置空(对应报错:444)
departConfirmbooleanNtrue组织已不存在时,强制恢复,默认分配到根组织(对应报错:445)
  • 返回结果

  • 异常结果

手机号已重复

json
{
    "errorCode": 444,
    "errorMsg": "该手机号在团队中已存在,是否继续恢复此人员,但恢复后手机号将为空?",
    "description": "",
    "data": {}
}

组织已不存在

json
{
    "errorCode": 445,
    "errorMsg": "该人员删除前所属组织已不存在,是否继续恢复到根组织?",
    "description": "",
    "data": {}
}

3.9 人员开通账号

  • 接口地址
POST /v1/team/personOpenUser
  • 请求参数
名称类型是否必需示例描述
personNostringY"CY53595123"要操作的人员编号
phonestringY/N"121212"手机号,如人员没有手机号,则必填
roleIdsarrayN[1212, 3213213]分配角色ID集合
isSendSmsbooleanNfalse是否发送短信通知
  • 返回结果

3.10 人员删除账号

  • 接口地址
POST /v1/team/personCloseUser
  • 请求参数
名称类型是否必需示例描述
personNostringY"CY53595123"要操作的人员编号
  • 返回结果

3.11 人员更换组织

  • 接口地址
POST /v1/team/personChangeDepart
  • 请求参数
名称类型是否必需示例描述
departNostringY"BM20668167"要更换的新组织编号
personNoListarrayY["CY94260799"]选中的人员编号集合
  • 返回结果

4. 人员标签

4.1 人员标签列表

  • 接口地址
POST /v1/team/groupList
  • 请求参数
名称类型是否必需示例描述
groupNamestringN"aa"名称模糊查询
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": [
        {
            "groupId": 2,
            "teamNo": "TD20661036",
            "groupNo": "FZ20499153",
            "groupName": "标签2",
            "personNums": 0
        },
        {
            "groupId": 3,
            "teamNo": "TD20661036",
            "groupNo": "FZ37384610",
            "groupName": "标签33",
            "personNums": 0
        }
    ]
}

4.2 人员标签添加

  • 接口地址
POST /v1/team/groupCreate
  • 请求参数
名称类型是否必需示例描述
groupNamestringY"标签34"标签名称
  • 返回结果

4.3 人员标签修改

  • 接口地址
POST /v1/team/groupUpdate
  • 请求参数
名称类型是否必需示例描述
groupNostringY"FZ5006020"要操作的标签编号
groupNamestringY"xxxx"标签名称
  • 返回结果

4.4 人员标签删除

  • 接口地址
POST /v1/team/groupDelete
  • 请求参数
名称类型是否必需示例描述
groupNostringY"FZ20499153"要操作的编号
  • 返回结果

4.5 人员标签排序

  • 接口地址
POST /v1/team/groupSort
  • 请求参数
名称类型是否必需示例描述
groupNostringY"FZ20499153"要交换排序的标签编号1
sortChangeGroupNostringY"FZ37384610"要交换排序的标签编号2
  • 返回结果

4.6 标签的人员

  • 接口地址
POST /v1/team/groupPersonList
  • 请求参数
名称类型是否必需示例描述
groupNostringY"FZ20499153"要查询的标签
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "pageNo": 1,
        "pageSize": 10,
        "total": 3,
        "pages": 1,
        "list": [
            {
                "personNo": "CY70080598",
                "personName": "xixi2",
                "departNo": "BM84077761",
                "departName": "研发一部",
                "jobNumber": 10002,
                "phone": "13410577089",
                "sex": 0,
                "sexName": ""
            }
        ]
    }
}

4.7 标签添加人员

  • 接口地址
POST /v1/team/groupAddPerson
  • 请求参数
名称类型是否必需示例描述
groupNostringY"FZ20499153"要添加人员的标签
personNosarrayY["CY70080598"]要添加的人员
  • 返回结果

4.8 标签移除人员

  • 接口地址
POST /v1/team/groupDelPerson
  • 请求参数
名称类型是否必需示例描述
groupNostringY"FZ20499153"要移除人员的标签
personNosarrayY["CY70080598"]要移除的人员
  • 返回结果

5. 商户

5.1 商户列表

  • 接口地址
POST /v1/team/merchantList
  • 请求参数
名称类型是否必需示例描述
merchantNamestringN""名称模糊查询
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": {
        "pageNo": 1,
        "pageSize": 10,
        "total": 2,
        "pages": 1,
        "list": [
            {
                "id": 2,
                "teamNo": "TD20661036",
                "merchantNo": "191006713151190",
                "merchantName": "商户222",
                "createdAt": "2025-01-09 20:11:05",
                "updatedAt": "2025-01-09 20:11:05",
                "operator": "biaobiao",
                "merchantLeaderNos": ["CY66517494", "CY46007406"],
                "merchantLeaderNames": ["xixi3", "xixi4"]
            }
        ]
    }
}

5.2 商户添加

  • 接口地址
POST /v1/team/merchantCreate
  • 请求参数
名称类型是否必需示例描述
merchantNamestringY"商户332"商户名称
merchantLeaderNosarrayY["CY46007406"]商户负责人
  • 返回结果

5.3 商户修改

  • 接口地址
POST /v1/team/merchantUpdate
  • 请求参数
名称类型是否必需示例描述
merchantNostringY"191006725582571"要操作的商户编号
merchantNamestringY"商户332"商户名称
merchantLeaderNosarrayY["CY46007406"]商户负责人
  • 返回结果

5.4 商户删除

  • 接口地址
POST /v1/team/merchantDelete
  • 请求参数
名称类型是否必需示例描述
merchantNostringY"191006725582571"要操作的商户编号
verificationCodestringY"123456"商户需要验证码验证,验证码类型参考验证码接口说明
  • 返回结果

6. 角色

6.1 角色列表

  • 接口地址
POST /v1/team/roleList
  • 请求参数
名称类型是否必需示例描述
roleNamestringN"员"角色名称;模糊查询
roleDescstringN"角色"角色描述;模糊查询
roleStatusintN2角色状态;1冻结,2正常
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": [
        {
            "id": 1,
            "teamNo": "TD20661036",
            "roleName": "管理员",
            "roleDesc": "该角色拥有全部权限。该角色不可修改。",
            "roleStatus": 2,
            "roleStatusName": "正常",
            "isDefault": 2,
            "isSuper": 1,
            "isOperationRole": 0
        }
    ]
}

6.2 角色添加

  • 接口地址
POST /v1/team/roleCreate
  • 请求参数
名称类型是否必需示例描述
roleNamestringY"角色112"角色名称
roleDescstringN"角色的描述"描述
personNosarrayN["CY66517494"]人员
  • 返回结果

6.3 角色修改

  • 接口地址
POST /v1/team/roleUpdate
  • 请求参数
名称类型是否必需示例描述
roleIdintY3要修改的角色ID
roleNamestringY"角色1123"名称
roleDescstringN"角色的描述11"描述
personNosarrayN["CY66517494"]人员
  • 返回结果

6.4 角色删除

  • 接口地址
POST /v1/team/roleDelete
  • 请求参数
名称类型是否必需示例描述
roleIdintY3要删除的角色ID
  • 返回结果

6.5 角色详情

  • 接口地址
POST /v1/team/roleDetail
  • 请求参数
名称类型是否必需示例描述
roleIdintY2要查询的角色ID
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": [
        {
            "id": 1,
            "teamNo": "TD20661036",
            "roleName": "管理员",
            "roleDesc": "该角色拥有全部权限。该角色不可修改。",
            "roleStatus": 2,
            "roleStatusName": "正常",
            "isDefault": 2,
            "isSuper": 1,
            "isOperationRole": 0,
            "manageRoleIds": [],
            "personList": ["CY66517494"],
            "functionPermission": [],
            "dataPermission": {
                "dataPermissionType": 1,
                "dataPermissionDepart": []
            },
            "areaResource": []
        }
    ]
}

7. 新用户审核

7.1 新用户列表

  • 接口地址
POST /v1/team/inviteAuditList
  • 请求参数
名称类型是否必需示例描述
namestringN"2"姓名模糊查询
phonestringN"13410577036"手机号
departNostringN"BM12121222"部门编号
statusintN1状态查询;1审核记录列表;0待审核列表
  • 返回示例
json
{
    "errorCode": 0,
    "description": "success",
    "errorMsg": "success",
    "data": [
        {
            "id": 3,
            "teamNo": "TD20661036",
            "name": "夕夕33",
            "phone": "13410577038",
            "departNo": "BM12121222",
            "departName": "biaobiao1",
            "identificationInfo": null,
            "roleIds": [],
            "createdAt": "2025-01-16 10:57:11",
            "applyStatus": 0,
            "applyStatusName": "待审核",
            "operatorName": "",
            "rejectReason": "",
            "auditTime": null
        }
    ]
}

7.2 新用户审核

  • 接口地址
POST /v1/team/inviteAudit
  • 请求参数
名称类型是否必需示例描述
idintY1要审核的新用户ID
auditStatusintY1审核状态:1同意 2拒绝
rejectReasonstringY/N"111111111111111111111"auditStatus=2时必填;拒绝原因
  • 返回结果

鑫泓佳智能硬件通信协议文档