GetUser - 获取坐席

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

调试

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

调试

授权信息

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

请求参数

名称类型必填描述示例值
InstanceIdstring

实例ID。

ccc-test
UserIdstring

坐席ID,选填,UserId和Extension任选一个填写即可。

agent@ccc-test
Extensionstring

坐席分机号,选填,UserId和Extension任选一个填写即可。

8003****

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75
Dataobject

数据。

DisplayNamestring

坐席展示名。

坐席小王
DisplayIdstring

坐席的工号。

1001
Extensionstring

坐席分机号。

8003****
LoginNamestring

坐席登录名。

agent
Emailstring

邮箱。

username@example.com
WorkModestring

工作模式。

ON_SITE
枚举值:
- ON_SITE: 场内模式
- OFF_SITE: 场外模式
- OFFICE_PHONE: 办公电话模式
Mobilestring

坐席的个人电话号码。

1391234****
UserIdstring

坐席ID。

agent@ccc-test
RoleNamestring

角色名称。

Admin
枚举值:
- Mannager: 技能组组长
- Agent: 坐席
- Admin: 管理员
InstanceIdstring

实例ID。

ccc-test
RoleIdstring

角色ID,格式为:角色@实例ID。

Admin@ccc-test
DeviceIdstring

设备ID,浏览器WebRTC软电话或实体话机设备的标识ID,同一时间只允许一种设备注册。

ACC-YUNBS-1.0.10-****
DeviceExtstring

SIP话机分机号,如果座席注册了SIP话机,则此参数为SIP话机设备的分机号。

8033****
DeviceStatestring

SIP话机设备的状态,如果未注册SIP话机,则状态为UNREGISTERED(未注册),如过SIP话机注册过但是不在线,则状态为OFFLINE(离线),如果SIP话机注册过并且在线则为ONLINE(在线)。

OFFLINE
枚举值:
- UNREGISTERED: 未注册
- OFFLINE: 离线
- ONLINE: 在线

示例

正常返回示例

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"
  }
}

错误码

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

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

变更历史

变更时间变更内容概要操作
2022-01-19OpenAPI 错误码发生变更、 OpenAPI 返回结构发生变更
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更
阿里云首页 云呼叫中心 相关技术圈