知识中心
所有文章
帮助中心
AI客户联络中心 升级日志
API文档
AI客户联络
API接口
【新】云节点列表
对话接口
白标接口及地址
【更新】用户列表
最后更新于 2023/04/28   阅读数 1072

用户列表

  • 允许已授权的用户通过此接口更新自己的信息。

    • URL/users?tenant_id={tenant_id}

    • MethodGET

    • 需要鉴权

    💡 注意:

    原接口GET /users 新增参数tenant_id,可筛选不同云节点上的用户

请求参数

参数

类型

必填

描述

tenant_id

String

N

云节点id

id

String

N

用户id

phone

String

N

手机号码

email

String

N

邮箱

name

String

N

用户名

请求示例

GET /users?tenant_id=f2d216a3-9ea5-4f1d-a170-ce9ebed41eaf

成功响应

条件:鉴权校验通过,且云节点id存在。

状态码:200 OK

响应示例:将返回该云节点下的用户列表:

{
    "code": 200,
    "status": "success",
    "message": "查看用户列表成功",
    "data": [
        {
            "id": "173d8501-b6a3-4869-a87e-71807bfd4fb8",
            "name": "测试33",
            "phone": "12311111111",
            "email": "test33@aicall.net",
          	"tenant_id": "f2d216a3-9ea5-4f1d-a170-ce9ebed41eaf",
            "created_at": "2022-06-09 13:44:54",
            "updated_at": "2022-06-09 13:44:54"
        }
    ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
plaintext

字段

类型

描述

备注

id

string

该用户的id

name

string

该用户的名称

phone

string

该用户的手机号

email

string

该用户的邮箱

tenant_id

string

云节点id

错误响应

条件:请求的云节点id不存在。

状态码200

响应示例: 将不返回任何用户。

{
    "code": 200,
    "status": "success",
    "message": "查看用户列表成功",
    "data": []
}
1
2
3
4
5
6
plaintext

注意事项

未能解决您的问题?请联系
本篇目录

请求参数

请求示例

成功响应

错误响应

注意事项