获取公共账号列表
使用场景: 调用本接口,获取公共账号列表。用于拉取机构内的公共账号。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://oapi.epaas.qq.com/public_account/list
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
page_index | int32 | 否 | 分页页码, 从1开始 |
page_size | int32 | 否 | 每页大小,传入-1时全量获取 |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
total | uint32 | 公共账号数量, 用于分页控制 |
accounts | 公共账号列表 | |
accounts.userid | string | 公共账号的用户id |
accounts.nickname | string | 公共账号昵称,仅限于展示 |
accounts.account | string | 公共账号,可用于登录 |
accounts.departments | 公共账号所属部门列表 | |
accounts.departments.department_id | uint32 | 公共账号所属部门id |
accounts.departments.department_name | string | 公共账号所属部门名称 |
请求示例:
GET https://oapi.epaas.qq.com/public_account/list?access_token=ACCESS_TOKEN&page_index=PAGE_INDEX&page_size=PAGE_SIZE
返回示例:
{
"errmsg": "ok",
"errcode": 0,
"total": 10,
"accounts": [
{
"userid": "886",
"nickname": "李四",
"account": "外部访客账号",
"departments": [
{
"department_id": 123,
"department_name": "教务处"
}
]
}
]
}
获取公共账号
使用场景: 调用本接口,获取公共账号信息详情,用于单个指定公共账号的详情。
权限说明
权限项 | 说明 | 备注 |
---|---|---|
应用是否需要申请白名单 | 不需要 | |
用户凭证 | 未支持 | |
机构凭证 | 支持 | 获取不到用户凭证的后台管理场景使用 |
请求方式: GET(HTTPS)
请求地址: https://oapi.epaas.qq.com/public_account/get
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 接口调用凭证 |
userid | string | 是 | 公共账号的用户id |
返回参数:
参数 | 类型 | 说明 |
---|---|---|
errcode | int32 | 返回码,0为正常 |
errmsg | string | 对返回码的文本描述内容 |
请求示例:
GET https://oapi.epaas.qq.com/public_account/get?access_token=ACCESS_TOKEN&userid=USERID
返回示例:
{
"errcode": 0,
"errmsg": "ok",
"userid": "886",
"nickname": "李四",
"account": "外部访客账号",
"departments": [
{
"department_id": 123,
"department_name": "教务处"
}
]
}