查询所有座席的软电话信息 (不包含业务账号) (querySysInfo)
场景描述
查询座席登录服务地址等系统信息。
接口方法
GET
接口URI
https://域名/apiaccess/CC-Mangemant/v1/querySysInfo,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
X-APP-Key |
string |
False |
app标识。 |
2 |
Authorization |
string |
True |
鉴权字段,内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
响应说明
- 响应状态码: 200
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1.1 |
serviceIp |
string |
False |
座席登录服务实例地址,Nginx地址,或SLB地址 长度限制:string(50) |
1.2 |
sipServicePort |
string |
False |
软电话注册端口,1~65535 长度限制:string(5) |
1.3 |
sipServiceIp |
string |
False |
软电话注册地址 长度限制:string(50) |
1.4 |
servicePort |
string |
False |
座席登录服务端口 长度限制:string(5) |
1.5 |
agents |
array[object] |
False |
座席集合 |
1.5.1 |
workNo |
integer |
True |
座席工号,范围从101到59999 |
1.5.2 |
sipAccount |
string |
False |
SIP软电话号码 长度限制:string(24) |
1.5.3 |
sipPwd |
string |
False |
SIP软电话加密前密码 长度限制:string(24) |
1.5.4 |
password |
string |
False |
座席签入登录平台的加密前密码 长度限制:string(8) |
1.5.6 |
id |
string |
False |
座席配置id |
1.5.7 |
ccRoleId |
string |
False |
平台角色Id |
1.5.8 |
accountId |
string |
False |
关联的Service Cloud账号ID |
1.5.9 |
accountCode |
string |
False |
关联的Service Cloud账号Code |
1.5.10 |
accountName |
string |
False |
关联的Service Cloud账号姓名 |
1.5.11 |
agentType |
integer |
False |
座席类型 |
1.5.12 |
selfPhone |
string |
False |
座席固话或手机 |
1.5.13 |
createInCtiFlag |
integer |
False |
在CTI平台创建过座席的标记,0:未创建,1:创建过 |
1.5.14 |
guId |
string |
False |
座席签入登录平台的的GUID |
1.5.15 |
singlePhoneFlag |
string |
False |
单电话座席开关 |
1.5.16 |
agentpara |
string |
False |
座席可选参数 |
1.5.17 |
partdbId |
string |
False |
分区Id |
1.5.18 |
tenantId |
string |
False |
租户ID |
1.5.19 |
agentStatus |
string |
False |
座席停用标志 0:可用(默认) |
1.5.20 |
timeRemaining |
integer |
False |
密码剩余过期时间 |
1.5.21 |
omsAgentType |
string |
False |
OMS座席类型 |
1.5.22 |
dualChannelRecFlag |
integer |
False |
双轨道录音,0:关闭(默认),1:开启 |
1.5.23 |
transparentDisplayFlag |
integer |
False |
座席透显开关,0:关闭(默认),1:开启 |
1.5.24 |
authFlag |
string |
False |
认证方式,0或null:UAP认证,1:统一认证 |
1.5.25 |
validTime |
integer |
False |
密码有效期天数,范围从0到180,默认值90 |
1.5.26 |
socialChatNum |
integer |
False |
座席并发处理多媒体呼叫数,范围从0到60 |
1.5.27 |
ccAgentAndSkillList |
array[object] |
False |
座席技能队列 |
1.5.28 |
AIRecognition |
integer |
False |
智能识别开关 |
- 响应状态码: 400
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
schema |
string |
True |
错误的请求:请检查请求路径及参数。 |
- 响应状态码: 401
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
schema |
string |
True |
未授权:1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。 |
- 响应状态码: 404
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
schema |
string |
True |
请求的内容未找到:请检查请求的路径。 |
- 响应状态码: 500
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
schema |
string |
True |
业务失败:请依次确认您请求中各参数的取值。 |
错误码
无。
报文样例
{ "x-app-key": "f******************************f" "Authorization": "Bearer 0******************************8" }
响应参数:
{ "servicePort": 448, "serviceIp": "127.0.0.0", "sipServiceIp": "127.0.0.0", "sipServicePort": 5060, "agents": [{ "workNo": 1522, "password": "7****tt", "sipAccount": "88881619", "sipPwd": "1****tt" }, { "workNo": 1523, "password": "f*****xL", "sipAccount": "88881620", "sipPwd": "1*****xL" }] }