Skip to content

分页查询公告列表

分页查询公告列表

标签公告管理

请求说明

字段
请求地址
https://openapi.wps.cn/v7/announce/announces
HTTP 方法
GET
接口描述
查询企业下的公告列表,支持置顶公告过滤和分页
签名方式
KSO-1
限频策略
权限要求
查询公告(应用授权) kso.announce.read
查询公告(用户授权) kso.announce.read

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Id-Type
string类型
* internal - 内部
* external - 外部
internal, external

查询参数 (Query)

属性名类型是否必填描述可选值
is_top
boolean置顶标识:true-返回置顶公告,false返回普通公告;查询置顶公告时不需要传分页参数-
page_size
integer分页大小,默认20-
page_token
string分页token(第一次请求不传)-
with_total
boolean是否返回总数-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "items": [
      {
        "app_id": "string",
        "cover": "string",
        "created_by": {
          "id": "string",
          "name": "string"
        },
        "expire_time": 0,
        "id": "string",
        "is_top": true,
        "publish_time": 0,
        "title": "string"
      }
    ],
    "next_page_token": "string",
    "total": 0
  },
  "code": 0,
  "msg": "string"
}