调用ListRamUsers获取RAM用户列表_云联络中心(Cloud Contact Center)-阿里云帮助中心

调用ListRamUsers获取未导入指定实例下的RAM用户列表。

接口说明

一个 RAM 用户可以作为坐席导入到多个实例下，但是一个坐席只能指向一个 RAM 账户，如果我们在实例下创建坐席，实际上是创建了一个 RAM 账户的，此时如果想创建一个新的实例又不想创建多余的 RAM 账户，就可以调用 ListRamUsers 接口获取未导入实例下的 RAM 用户列表，然后再调用导入 RAM 用户的接口将 RAM 用户导入到实例下。这样可以避免过多的创建 RAM 账户，造成资源浪费。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
SearchPattern	string	否	根据坐席登录名或坐席展示名进行模糊匹配，非必填，默认为空，为空表示不过滤。	agent
PageNumber	integer	是	分页序号，范围 1-1000。	1
PageSize	integer	是	分页大小，范围 1-100。	10

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	24753D71-C91D-1A38-A8AD-372BF12453F6
Data	object	数据。
PageNumber	integer	分页序号，范围 1-1000。	1
PageSize	integer	分页大小，范围 1-100。	10
TotalCount	integer	总数。	100
List	array<object>	RAM 用户列表。
RamUser	object	RAM 用户
DisplayName	string	RAM 账户姓名。	测试账号
Email	string	邮箱。	username@example.com
LoginName	string	RAM 用户名。	agent
Mobile	string	RAM 账户预留的个人电话号码。	1382114****
AliyunUid	long	RAM 账户所属的阿里云主账号 UID。	15772400000****
Primary	boolean	RAM 账号是否为主账号。	false
RamId	string	RAM 用户的 UID。	28036411123456****
Params	array
Param	string	响应参数。	无

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "24753D71-C91D-1A38-A8AD-372BF12453F6",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 100,
    "List": [
      {
        "DisplayName": "测试账号",
        "Email": "username@example.com",
        "LoginName": "agent",
        "Mobile": "1382114****",
        "AliyunUid": 0,
        "Primary": false,
        "RamId": "28036411123456****"
      }
    ]
  },
  "Params": [
    "无"
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	Parameter.Maximum	The parameter %s must be less than or equal to %s.	参数必须小于或等于系统规定的最大值。
400	Parameter.Minimum	The parameter %s must be greater than or equal to %s.	参数必须大于或等于系统规定的最小值。
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-11-06	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情