租户角色列表
服务描述
本接口可获取当前租户下所有的角色列表。
开发须知
调用本接口前,请先获取appId
服务地址
GET https://{您的专属域名}/basic/openapi/v1/staff/role
请求参数
参数 |
位置 |
类型 |
是否必填 |
说明 |
appId |
header |
String |
Y |
应用ID |
timestamp |
header |
String |
Y |
时间戳,毫秒 |
sign |
header |
String |
Y |
签名 |
Content-Type |
header |
String |
Y |
application/json |
roleName |
url地址栏 |
String |
N |
角色名称 |
请求数据示例:
GET https://{您的专属域名}/basic/openapi/v1/staff/role?roleName='呼入'
返回结果
参数 |
类型 |
说明 |
code |
String |
结果码 |
message |
String |
结果描述 |
data |
List<RoleInfo> |
全部角色数据 |
RoleInfo
参数 |
类型 |
说明 |
roleId |
long |
角色id |
roleName |
String |
角色名称 |
status |
Byte |
角色状态(0:禁止删除 1:可以删除) |
ssoStatus |
Byte |
是否被单点登录引用(0:未被引用 1:已被引用) |
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": [
{
"roleId": 776,
"roleName": "话务坐席",
"status": 1,
"ssoStatus": 0
},
{
"roleId": 777,
"roleName": "在线坐席",
"status": 1,
"ssoStatus": 0
}
]
}
结果码说明
结果码 |
说明 |
10000 |
请求成功 |
20001 |
请求失败 |
21002 |
认证失败,请重新登录 |
FAQ: