调用FindUsers获取呼叫中心实例中的所有用户。

需要提供角色,技能组,技能级别,以及按需提供用户详细信息。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String FindUsers

系统规定参数。取值:FindUsers

Criteria String test

待查询名称,可以传登录名或者展示名称。

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

待获取用户的呼叫中心实例ID

PageNumber Integer 1

分页序号

PageSize Integer 2

分页大小

AccessKeyId String xxx

您的AccessKey ID

返回数据

名称 类型 示例值 描述
Code String OK

响应码

HttpStatusCode Integer 200

HTTP状态码

Message String

响应信息

RequestId String EAF3C248-E123-441B-A545-B6CD02E98EED

请求ID

Success Boolean true

是否成功

Users

获取到的呼叫中心实例中的用户列表

List

对象列表

User

对象列表

Detail

用户详细信息

Department String IT

用户的部门

DisplayName String test

用户的全名

Email String test@alibaba-inc.com

用户的电子邮件地址

LoginName String test123

用户登陆名

Phone String 13601763214

用户的电话号码

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

用户所归属的呼叫中心实例ID

PrivateOutboundNumberId String a08d255e-12a5-48f8-93e0-6b8e1b6dec5a

个人外呼号码的PhoneNumberId

RamId String 294911036201260519

用户所对应的RAM账户ID

Roles

用户的角色列表

Role

用户的角色列表

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

角色所归属的呼叫中心实例ID

RoleDescription String 管理员

角色描述

RoleId String 59a3d864-2f98-4f5e-84ec-c1ea13af93f3

角色ID,系统自动生成的唯一标示符。

RoleName String ADMIN

角色名称

SkillLevels

座席用户在一个技能组的等级,一个座席用户可以属于多个技能组。

SkillLevel

座席用户在一个技能组的等级,一个座席用户可以属于多个技能组。

Level Integer 4

技能级别

Skill

技能组

InstanceId String 9cfad875-6260-4a53-ab6e-b13e3fb31f7d

技能组所归属的呼叫中心实例

SkillGroupDescription String 描述

技能组简单描述

SkillGroupId String a053e6d5-16ee-4283-9c81-631b78ae08a2

技能组唯一ID,系统自动生成的唯一标示符。

SkillGroupName String 默认技能组

技能组名字,需要在所归属的呼叫中心实例中唯一。

SkillLevelId String 181792

技能级别唯一ID,系统自动生成的唯一标示符。

UserId String 674a5953-21d5-4ee9-9b42-eb8813d6d844

用户唯一标识。

注意这里是RAM子账号在呼叫中心实例的唯一标识并非RamId,即UUID。

PageNumber Integer 1

分页序号

PageSize Integer 10

分页大小

TotalCount Integer 1

对象总数

示例

请求示例


http(s)://ccc.cn-shanghai.aliyuncs.com/?Action=FindUsers
&Criteria=test
&InstanceId=9cfad875-6260-4a53-ab6e-b13e3fb31f7d
&PageNumber=1
&PageSize=2
&<公共请求参数>

正常返回示例

XML 格式

<FindUsersResponse>
      <code>OK</code>
      <httpStatusCode>200</httpStatusCode>
      <requestId>EAF3C248-E123-441B-A545-B6CD02E98EED</requestId>
      <success>true</success>
      <users>
            <list>
                  <detail>
                        <department></department>
                        <displayName>test</displayName>
                        <email>test@alibaba-inc.com</email>
                        <loginName>test123</loginName>
                        <phone>13601763214</phone>
                  </detail>
                  <instanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</instanceId>
                  <privateOutboundNumberId></privateOutboundNumberId>
                  <ramId>294911036201260519</ramId>
                  <roles>
                        <instanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</instanceId>
                        <roleDescription>管理员</roleDescription>
                        <roleId>59a3d864-2f98-4f5e-84ec-c1ea13af93f3</roleId>
                        <roleName>ADMIN</roleName>
                  </roles>
                  <skillLevels>
                        <level>5</level>
                        <skill>
                              <instanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</instanceId>
                              <skillGroupDescription></skillGroupDescription>
                              <skillGroupId>2e4714f8-9c36-426b-b50f-ee3e70d97119</skillGroupId>
                              <skillGroupName>王小二test</skillGroupName>
                        </skill>
                        <skillLevelId>141147</skillLevelId>
                  </skillLevels>
                  <skillLevels>
                        <level>5</level>
                        <skill>
                              <instanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</instanceId>
                              <skillGroupDescription>描述</skillGroupDescription>
                              <skillGroupId>a053e6d5-16ee-4283-9c81-631b78ae08a2</skillGroupId>
                              <skillGroupName>默认技能组</skillGroupName>
                        </skill>
                        <skillLevelId>181792</skillLevelId>
                  </skillLevels>
                  <skillLevels>
                        <level>5</level>
                        <skill>
                              <instanceId>9cfad875-6260-4a53-ab6e-b13e3fb31f7d</instanceId>
                              <skillGroupDescription></skillGroupDescription>
                              <skillGroupId>a53f9f4e-0a02-422e-bab5-df5e13cd9abd</skillGroupId>
                              <skillGroupName>孟珍测试技能组</skillGroupName>
                        </skill>
                        <skillLevelId>144870</skillLevelId>
                  </skillLevels>
                  <userId>674a5953-21d5-4ee9-9b42-eb8813d6d844</userId>
            </list>
            <pageNumber>1</pageNumber>
            <pageSize>10</pageSize>
            <totalCount>1</totalCount>
      </users>
</FindUsersResponse>

JSON 格式

{
	"users":{
		"totalCount":1,
		"pageSize":10,
		"pageNumber":1,
		"list":[
			{
				"detail":{
					"phone":"13601763214",
					"email":"test@alibaba-inc.com",
					"department":"",
					"displayName":"test",
					"loginName":"test123"
				},
				"userId":"674a5953-21d5-4ee9-9b42-eb8813d6d844",
				"roles":[
					{
						"roleDescription":"管理员",
						"instanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d",
						"roleName":"ADMIN",
						"roleId":"59a3d864-2f98-4f5e-84ec-c1ea13af93f3"
					}
				],
				"instanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d",
				"skillLevels":[
					{
						"level":5,
						"skill":{
							"skillGroupDescription":"",
							"skillGroupId":"2e4714f8-9c36-426b-b50f-ee3e70d97119",
							"instanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d",
							"skillGroupName":"王小二test"
						},
						"skillLevelId":"141147"
					},
					{
						"level":5,
						"skill":{
							"skillGroupDescription":"描述",
							"skillGroupId":"a053e6d5-16ee-4283-9c81-631b78ae08a2",
							"instanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d",
							"skillGroupName":"默认技能组"
						},
						"skillLevelId":"181792"
					},
					{
						"level":5,
						"skill":{
							"skillGroupDescription":"",
							"skillGroupId":"a53f9f4e-0a02-422e-bab5-df5e13cd9abd",
							"instanceId":"9cfad875-6260-4a53-ab6e-b13e3fb31f7d",
							"skillGroupName":"孟珍测试技能组"
						},
						"skillLevelId":"144870"
					}
				],
				"privateOutboundNumberId":"",
				"ramId":"294911036201260519"
			}
		]
	},
	"httpStatusCode":200,
	"requestId":"EAF3C248-E123-441B-A545-B6CD02E98EED",
	"code":"OK",
	"success":true
}

错误码

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