调用GetLoginDetails获取坐席的登录信息，包括坐席基本信息、服务器地址信息、鉴权信息等，该接口只允许自己调用，管理员无权替他人调用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
ccc-test |
| UserId |
string |
否 |
坐席 ID，非必填，不填则默认使用当前 RAM 账户映射的坐席。 |
agent@ccc-test |
| ChatDeviceId |
string |
否 |
Chat 设备 ID。 |
4c51c9116c36537cb850dc1081d745df |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| Code |
string |
响应码。 |
OK |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Message |
string |
响应信息。 |
无 |
| RequestId |
string |
请求 ID。 |
F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4 |
| Params |
array |
响应参数 |
|
|
string |
响应参数。 |
无 |
|
| Data |
object |
登录信息数据。 |
|
| DisplayName |
string |
坐席展示名。 |
坐席小王 |
| Extension |
string |
坐席分机号。 |
8001**** |
| Signature |
string |
签名信息，使用非对称加密算法生成，注册 SIP 服务器时需要使用该信息进行鉴权。 |
zi31STIMtIfa/UN2l+6lww**** |
| SipServerUrl |
string |
SIP 注册服务器地址，坐席需要以 SIP 用户的身份注册到服务器上才能进行话务操作。 |
sh-sip-ccc.aliyuncs.com:443 |
| DeviceId |
string |
如果座席注册了 SIP 话机，则此参数是 SIP 话机设备的设备 ID，否则为空。 |
Yealink SIP-T23G 44.84.XX.XX |
| AgentServerUrl |
string |
坐席数据推送服务器地址，连接成功后，服务器会推送坐席状态数据到坐席工作台。 |
sh-wss-ccc.aliyuncs.com |
| UserId |
string |
坐席 ID。 |
agent@ccc-test |
| UserKey |
string |
签名数据，用于生成签名信息，由于该签名机制不支持中文，所以目前都使用 UserKey2 进行签名。 |
坐席@aliyun:802001:1656406628862 |
| WorkMode |
string |
工作模式。 枚举值：
|
ON_SITE |
| UserKey2 |
string |
签名数据，用于生成签名信息，由于 UserKey 不支持中文签名，因此新增了 UserKey2。 |
802001:1656406628862" |
| Signature2 |
string |
签名信息，使用非对称加密算法生成，注册 SIP 服务器时需要使用该信息进行鉴权。 |
zi31STIMtIfa/UN2l+6lww**** |
| DeviceExt |
string |
SIP 设备分机号，使用 SIP 话机时需要用到该字段。 |
8033**** |
| DeviceState |
string |
SIP 设备状态。 枚举值：
|
OFFLINE |
| ChatUserId |
string |
Chat 会话设备 ID。 |
A-8000100x |
| ChatDeviceId |
string |
Chat 设备 ID。 |
4c51c9116c36537cb850dc1081d745df |
| ChatLoginToken |
string |
Chat 会话登录令牌。 |
{"accessToken":"oauth_cloud_key:4xxx0=","accessTokenExpiredTime":864xxxx,"refreshToken":"oauth_cloud_key:Paxxxx=="} |
| ChatAppId |
string |
Chat 会话应用 ID。 |
7pjxxx |
| ChatAppKey |
string |
Chat 会话应用密钥。 |
955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0 |
| ChatServerUrl |
string |
Chat 会话服务器地址。 |
wss://wss.im.dingtalk.cn |
| Nickname |
string |
坐席昵称 |
老王 |
| AvatarUrl |
string |
坐席头像地址。 |
http://abc.com/sam.jpb |
示例
正常返回示例
JSON格式
{
"Code": "OK",
"HttpStatusCode": 200,
"Message": "无",
"RequestId": "F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4",
"Params": [
"无"
],
"Data": {
"DisplayName": "坐席小王",
"Extension": "8001****",
"Signature": "zi31STIMtIfa/UN2l+6lww****",
"SipServerUrl": "sh-sip-ccc.aliyuncs.com:443",
"DeviceId": "Yealink SIP-T23G 44.84.XX.XX",
"AgentServerUrl": "sh-wss-ccc.aliyuncs.com",
"UserId": "agent@ccc-test",
"UserKey": "坐席@aliyun:802001:1656406628862",
"WorkMode": "ON_SITE",
"UserKey2": "802001:1656406628862\"",
"Signature2": "zi31STIMtIfa/UN2l+6lww****",
"DeviceExt": "8033****",
"DeviceState": "OFFLINE",
"ChatUserId": "A-8000100x",
"ChatDeviceId": "4c51c9116c36537cb850dc1081d745df",
"ChatLoginToken": "{\"accessToken\":\"oauth_cloud_key:4xxx0=\",\"accessTokenExpiredTime\":864xxxx,\"refreshToken\":\"oauth_cloud_key:Paxxxx==\"}",
"ChatAppId": "7pjxxx",
"ChatAppKey": "955e4bd7xxxxxxxxxxxxxd7898ba9fa0d0",
"ChatServerUrl": "wss://wss.im.dingtalk.cn",
"Nickname": "老王",
"AvatarUrl": "http://abc.com/sam.jpb"
}
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
| 404 | NotExists.UserId | The user %s does not exist in instance %s. | 云联络中心实例中不存在指定的用户。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。