首页 云呼叫中心 API参考 API目录 配置 GetLoginDetails - 获取登录信息

GetLoginDetails - 获取登录信息

调用GetLoginDetails获取坐席的登录信息,包括坐席基本信息、服务器地址信息、鉴权信息等。

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
UserIdstring

坐席ID,非必填,不填则默认使用当前RAM账户映射的坐席。

agent@ccc-test

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

F1A4774A-F28B-5C40-AEF6-D88D2DD6C7E4
Paramsarray
string

响应参数。

Dataobject

登录信息数据。

DisplayNamestring

坐席展示名。

坐席小王
Extensionstring

坐席分机号。

8001****
Signaturestring

签名信息,使用非对称加密算法生成,注册SIP服务器时需要使用该信息进行鉴权。

zi31STIMtIfa/UN2l+6lww****
SipServerUrlstring

SIP注册服务器地址,坐席需要以SIP用户的身份注册到服务器上才能进行话务操作。

sh-sip-ccc.aliyuncs.com:443
DeviceIdstring

如果座席注册了SIP话机,则此参数是SIP话机设备的设备ID,否则为空。

Yealink SIP-T23G 44.84.XX.XX
AgentServerUrlstring

坐席数据推送服务器地址,连接成功后,服务器会推送坐席状态数据到坐席工作台。

sh-wss-ccc.aliyuncs.com
UserIdstring

坐席ID。

agent@ccc-test
UserKeystring

签名数据,用于生成签名信息,由于该签名机制不支持中文,所以目前都使用UserKey2进行签名。

坐席@aliyun:802001:1656406628862
WorkModestring

工作模式。

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

签名数据,用于生成签名信息,由于UserKey不支持中文签名,因此新增了UserKey2。

802001:1656406628862"
Signature2string

签名信息,使用非对称加密算法生成,注册SIP服务器时需要使用该信息进行鉴权。

zi31STIMtIfa/UN2l+6lww****
DeviceExtstring

SIP设备分机号,使用SIP话机时需要用到该字段。

8033****
DeviceStatestring

SIP设备状态。

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

示例

正常返回示例

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

错误码

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

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

阿里云首页 云呼叫中心 相关技术圈