# 能力平台用户管理相关API

# 获取权限列表

  • 云平台可以调用此接口选择用户可以添加的权限。

# 请求路径

【POST】https://nice.zebra-c.com/api/user/getServicePermission

# 请求参数

# 请求 CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/user/getServicePermission' \ 
--header 'Content-Type: application/json' \

# 成功返回参数( body )

参数 类型 必须 说明
name string 能力平台名称
id string 能力平台ID
children.name string 能力平台下功能权限名称
children.id string 功能权限ID

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": [
        { 
            "id": "1628150d342740", 
            "name": "复核平台", 
            "children": [ 
                { 
                    "id": "16281fd5742251", 
                    "name": "NLP复核员" 
                }
            ] 
        }, 
        { 
            "id": "16281de5e43318", 
            "name": "小海星", 
            "children": [
                { 
                    "id": "16281de5e43318", 
                    "name": "录音用户" 
                }
            ] 
        } 
    ] 
}

# 新增或修改能力平台用户

  • 云平台可以调用此接口创建或修改能力平台用户。
  • 如需使用NICE能力平台,可通过该接口创建;如不需使用能力平台,无需调用该接口。

# 请求路径

【POST】https://nice.zebra-c.com/api/user/syncUser

# 请求参数

参数 类型 必须 说明
name string 用户名
phone string 手机号
email string 邮箱
user_code string 用户唯一标识。(该值需要保证唯一)
account string 登录密码。(需要经过双层md5加密,新增用户时必须传该字段)
projects array 用户项目权限。(数组元素是项目的 project_key 字段值 )
permissions array 用户功能权限。(数组元素是权限列表接口返回中 children.id 字段值 )
status int 用户状态值。(1.待激活 2.启用 3.停用 )

# 请求示例

{ 
    "name":"apitest001", 
    "phone":"18700000001", 
    "status":"2", 
    "permissions":[
        "31816281de5e43", 
        "225116281fd574"
    ], 
    "projects":["cc93de03e9ab3b305391a9cec68ca330f10c3073"], 
    "account":"50d3b1bc578bf182975a807da73b61b7", 
    "user_code":"25cb162f80a8fc69" 
}

# 请求 CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/user/syncUser'; \
 --header 'Content-Type: application/json' \ 
 --data-raw '{ "name":"apitest001", "phone":"18700000001", "status":"2", "permissions":["31816281de5e43", "225116281fd574"], "projects":["cc93de03e9ab3b305391a9cec68ca330f10c3073"], "account":"50d3b1bc578bf182975a807da73b61b7", "user_code":"25cb162f80a8fc69" }'

# 成功返回参数( body )

参数 类型 必须 说明

# 成功返回示例

{ 
    "errcode": 0, 
    "message": "成功", 
    "data": { } 
}

# 获取能力平台用户列表

云平台可以调用此接口获取能力平台用户列表。

# 请求路径

【POST】https://nice.zebra-c.com/api/user/getList

# 请求参数

# 请求 CURL 命令

curl --location --request POST 'https://nice.zebra-c.com/api/user/getList'; \
 --header 'Content-Type: application/json' \ 

# 成功返回参数( body )

参数 类型 必须 说明
account_name string 账号名
phone string 用户手机号
email string 用户邮箱
user_code string 用户ID
project string 用户管理项目
permissions string 用户能力平台权限
status string 用户状态

# 成功返回示例

{
    "errcode": 0,
    "message": "成功",
    "data": [
        {
            "account_name": "test001",
            "phone": 15211260001,
            "email": null,
            "user_code": "a4d8d16dc1ba55ccea38",
            "project": "汽车体验云demo,XJM复核测试-场景1,XJM复核测试-1014提测1",
            "permissions": "小海星:录音用户-蓝牙",
            "status": "启用"
        },
        {
            "account_name": "test002",
            "phone": 18700000001,
            "email": null,
            "user_code": "4bc21nlcfc20551ba55",
            "project": "汽车体验云demo,XJM复核测试-场景1,XJM复核测试-1014提测1",
            "permissions": "小海星:录音用户-蓝牙",
            "status": "启用"
        }
    ]
}