调用GetUser获取坐席_云联络中心(Cloud Contact Center)-阿里云帮助中心

调用GetUser获取指定实例下指定坐席ID对应的坐席信息。

调试

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

授权信息

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

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	ccc-test
UserId	string	否	坐席 ID，选填，UserId 和 Extension 任选一个填写即可。	agent@ccc-test
Extension	string	否	坐席分机号，选填，UserId 和 Extension 任选一个填写即可。	8003****

返回参数

名称	类型	描述	示例值
	object
Code	string	响应码。	OK
HttpStatusCode	integer	HTTP 状态码。	200
Message	string	响应信息。	无
RequestId	string	请求 ID。	EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Data	object	数据。
DisplayName	string	坐席展示名。	坐席小王
DisplayId	string	坐席的工号。	1001
Extension	string	坐席分机号。	8003****
LoginName	string	坐席登录名。	agent
Email	string	邮箱。	username@example.com
WorkMode	string	工作模式。枚举值： ON_SITE：场内模式。 OFF_SITE：场外模式。 OFFICE_PHONE：办公电话模式。	ON_SITE
Mobile	string	坐席的个人电话号码。	1391234****
UserId	string	坐席 ID。	agent@ccc-test
RoleName	string	角色名称。枚举值： Agent：坐席。 Admin：管理员。 Manager：技能组组长。	Admin
InstanceId	string	实例 ID。	ccc-test
RoleId	string	角色 ID，格式为：角色@实例 ID。	Admin@ccc-test
DeviceId	string	设备 ID，浏览器 WebRTC 软电话或实体话机设备的标识 ID，同一时间只允许一种设备注册。	ACC-YUNBS-1.0.10-****
DeviceExt	string	SIP 话机分机号，如果座席注册了 SIP 话机，则此参数为 SIP 话机设备的分机号。	8033****
DeviceState	string	SIP 话机设备的状态，如果未注册 SIP 话机，则状态为 UNREGISTERED（未注册），如果 SIP 话机注册过但是不在线，则状态为 OFFLINE（离线），如果 SIP 话机注册过并且在线则为 ONLINE（在线）。	OFFLINE
Nickname	string	坐席昵称	阿云
AvatarUrl	string	坐席头像地址。	http://xxx.com/xxx.jpg
Params	array	扩展参数
Param	string	响应参数。	无

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "DisplayName": "坐席小王",
    "DisplayId": "1001",
    "Extension": "8003****",
    "LoginName": "agent",
    "Email": "username@example.com",
    "WorkMode": "ON_SITE",
    "Mobile": "1391234****",
    "UserId": "agent@ccc-test",
    "RoleName": "Admin",
    "InstanceId": "ccc-test",
    "RoleId": "Admin@ccc-test",
    "DeviceId": "ACC-YUNBS-1.0.10-****",
    "DeviceExt": "8033****",
    "DeviceState": "OFFLINE",
    "Nickname": "阿云",
    "AvatarUrl": "http://xxx.com/xxx.jpg"
  },
  "Params": [
    "无"
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
404	NotExists.InstanceId	The specified instance %s does not exist.	指定的呼叫中心实例不存在。

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

变更历史

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