openplatform

角色权限与组织应用

服务端 API 更新于 2026-08-28 阅读 5

获取应用运营者列表

接口说明:获取对接组织里面某个角色的成员列表请求方式:GET (HTTPS)请求地址:https://apigw-example.domain/v1/org/:orgid/role/:roleid/members/fetch?app_token=APP_TOKENquery参数说明

参数 必须 说明
app_token 应用访问TOKEN
user_token 非必填字段, 人员TOKEN

param 参数说明

参数 必须 说明
orgid 组织ID
roleid 角色ID, 字符组常量,值:"role_app_admin" - 应用管理员(当前app_token对应的应用的管理员列表)

返回参数字段说明:|参数|类型|描述 | |-------------|----------|----------| | staffs | obj array | 应用运营者人员信息列表 | | staffs.id | string | 人员ID | | staffs.name | string | 人员姓名 |

返回数据示例:

业务正常返回:

{
    "errCode": 0,
    "errMsg": "ok",
    "data": {
        "staffs": [{
            "id": "id1",
            "name": "管理员1"
        }, {
            "id": "id2",
            "name": "管理员2"
        }]
    }
}

业务异常返回:

{
    "errCode": 错误码,
    "errMsg": 对应的统一错误码描述
}

对应可能的错误码说明:

接口错误码

获取组织详情

接口说明:获取组织详细信息请求方式:GET (HTTPS)请求地址:https://apigw-example.domain/v1/org/:orgid/fetch?app_token=APP_TOKENquery参数说明

参数 必须 说明
app_token 应用访问TOKEN
user_token 非必填字段,人员TOKEN

param 参数说明

参数 必须 说明
orgid 组织ID

返回参数字段说明:|参数|参数|描述 | |----------|----------|---------| | orgId | string | 组织id | | orgName | string | 组织名称 | | iconUrl | string | logo资源ID |

返回数据示例:

业务正常返回:

{
    "errCode": 0,
    "errMsg": "ok",
    "data": {
        "orgId":"5555",
        "orgName": "org name",
        "iconUrl": "xxxxxx"
    }
}

业务异常返回:

{
    "errCode": 错误码 ,
    "errMsg": 对应的统一错误码描述
}

对应可能的错误码说明:

接口错误码

获取应用已安装到的组织列表

接口说明:获取应用已安装到的组织列表,支持按时间增量和分页请求方式:GET (HTTPS)请求地址:https://apigw-example.domain/v1/app/roaming/orgs/fetch?app_token=APP_TOKEN&base_version=BASE_VERSION&page_size=PAGE_SIZEquery参数说明

参数 必须 说明
app_token
user_token
base_version 增量请求的起始时间版本号,时间戳字符串,单位:微秒,可生成该样式时间戳字符串增量获取数据,全量第一次请求时可以传 “0”。
page_size 分页返回最大数据量,最大限制1000条,大于1000按1000条返回。

返回参数字段说明:|参数|数据类型|说明 | |-------------------|---------------|----------------------| | latestVersion | string | 返回数据集所包含的数据中最新的版本号,是一个时间戳字符串,单位:微秒,请求下一页时可以此值作为base_version传入。调用者需要保存该版本号到本地,下次增量请求数据时作为base_version传递到服务端。 | | hasMore | bool | 是否还有下一页数据,有-true,没有-false。 | | orgList | obj array | 组织信息对象列表 | | orgList.orgId | string | 组织ID | | orgList.orgName | string | 组织名称 | | orgList.state | int | 应用对接组织状态,0-正常, 1- 已删除 |

返回数据示例:

业务正常返回:

{
    "errCode": 0,
    "errMsg": "ok",
    "data": {
        "latestVersion": "1657525409062619",
        "hasMore": true,
        "orgList": [
            {
                "orgId": "524288",
                "orgName": "xxx",
                "state": 1
            },
            {
                "orgId": "233456",
                "orgName": "xxx",
                "state": 0
            }
        ]
    }
}

业务异常返回:

{
    "errCode": 错误码 ,
    "errMsg": 对应的统一错误码描述
}

对应可能的错误码说明:

接口错误码