Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

分页查询公告列表

分页查询公告列表

请求说明

请求地址https://openapi.wps.cn/v7/announce/announces
请求方法GET
签名方式KSO-1
权限要求查询公告(应用授权) kso.announce.read
查询公告(用户授权)kso.announce.read

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

查询参数(Query)

名称类型是否必填说明
is_topbool置顶标识:true-返回置顶公告,false返回普通公告;查询置顶公告时不需要传分页参数
page_sizeint640 <= page <= 100, 分页大小
page_tokenstring<= 1024 characters,分页token(第一次请求不传)
with_totalbool是否返回总数

请求地址示例

[GET] https://openapi.wps.cn/v7/announce/announces?page_size=10&page_token=0

响应体(Response)

名称类型说明
codeintegercode
moreobject更多的错误信息
msgstringmsg
dataobject信息返回
itemsobject[]公告列表
∟∟ app_idstring应用ID
∟∟ coverstring封面图store_key
∟∟ created_byobject创建者信息
∟∟∟ idstring创建者wps_uid
∟∟∟ namestring创建者名称
∟∟ expire_timeint64过期时间戳
∟∟ idstring公告ID
∟∟ is_topboolean是否置顶
∟∟ publish_timeint64发布时间戳
∟∟ titlestring公告标题
next_page_tokenstring分页游标(用于下一页查询)
totalint64总数

响应体示例

json
{
  "data": {
    "items": [
      {
        "app_id": "AK20211123JLJNIE",
        "cover": "5A51FBBANDAwMDMyNTA1MTpkb1ZKNVUyWkIxTXJ4dmVnakNROHJ4R0Nnb0dhRVRVS3U=",
        "created_by": {
          "id": "pzveBn5",
          "name": "超管"
        },
        "expire_time": 0,
        "id": "23367",
        "is_top": false,
        "publish_time": 1742547315,
        "title": "title-公告-1742547315145"
      },
      {
        "app_id": "AK20211123JLJNIE",
        "cover": "5A51FBBANDAwMDMyNTA1MTpkb1ZKNVUyWkIxTXJ4dmVnakNROHJ4R0Nnb0dhRVRVS3U=",
        "created_by": {
          "id": "pzveBn5",
          "name": "超管"
        },
        "expire_time": 0,
        "id": "23323",
        "is_top": false,
        "publish_time": 1742542899,
        "title": "title-公告-1742542898775"
      },
      {
        "app_id": "AK20211123JLJNIE",
        "cover": "5A51FBBANDAwMDMyNTA1MTpkb1ZKNVUyWkIxTXJ4dmVnakNROHJ4R0Nnb0dhRVRVS3U=",
        "created_by": {
          "id": "pzveBn5",
          "name": "超管"
        },
        "expire_time": 0,
        "id": "23324",
        "is_top": false,
        "publish_time": 1742542899,
        "title": "title-公告-1742542898930"
      },
      {
        "app_id": "AK20211123JLJNIE",
        "cover": "5A51FBBANDAwMDMyNTA1MTpkb1ZKNVUyWkIxTXJ4dmVnakNROHJ4R0Nnb0dhRVRVS3U=",
        "created_by": {
          "id": "pzveBn5",
          "name": "超管"
        },
        "expire_time": 0,
        "id": "23322",
        "is_top": false,
        "publish_time": 1742541080,
        "title": "title-公告-1742541079804"
      },
      {
        "app_id": "AK20211123JLJNIE",
        "cover": "5A51FBBANDAwMDMyNTA1MTpkb1ZKNVUyWkIxTXJ4dmVnakNROHJ4R0Nnb0dhRVRVS3U=",
        "created_by": {
          "id": "pzveBn5",
          "name": "超管"
        },
        "expire_time": 0,
        "id": "23321",
        "is_top": false,
        "publish_time": 1742541079,
        "title": "title-公告-1742541079461"
      }
    ],
    "next_page_token": "6",
    "total": 10
  },
  "code": 0,
  "more": {},
  "msg": "string"
}
回到旧版