查询主页列表

功能介绍

根据用户提供的过滤条件查找用户管理的主页列表。

URI

GET /v1/aim-sa/portals

表1 Query参数
参数	是否必选	参数类型	描述
pub_name	否	String	服务号名称。最小长度：0 最大长度：15
begin_time	否	String	起始上线时间。格式为：yyyy-MM-ddTHH:mm:ssZ。最小长度：10 最大长度：50
end_time	否	String	截止上线时间。格式为：yyyy-MM-ddTHH:mm:ssZ。最小长度：10 最大长度：50
state	否	Integer	主页状态。 1：未生效 2：已生效 3：已失效 4：服务号已冻结
limit	否	Integer	每页显示的条目数量。最小值：1 最大值：100 缺省值：10
offset	否	Integer	偏移量，表示从此偏移量开始查询，offset大于等于0。最小值：0 最大值：2147483647 缺省值：0

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
data	ListPortalsRsp object	查询主页列表响应体。

表4 ListPortalsRsp
参数	参数类型	描述
portals	Array of PortalModel objects	主页列表。数组长度：0 - 1000
page_info	PageOffSet object	分页信息。

表5 PortalModel
参数	参数类型	描述
portal_id	String	主页ID。
company_id	String	企业ID。
company_name	String	企业名称。
pub_id	String	服务号ID。
pub_name	String	服务号名称。
background_img	String	主页背景图片资源ID。
background_img_url	String	背景图片URL。
summary	String	简介。
tels	String	热线号列表。说明：以JSON列表返回，格式： {"tel": "400-800-8800", "usage": "官方服务电话"}。
fastapps	String	快应用列表。说明：以JSON列表返回，格式： {"name": "快应用名称","logo_img": "快应用LOGO图片资源ID", "logo_img_url": "快应用LOGO图片资源URL", "description": "快应用描述","deeplink": "hap://app/fastapp","depend_engine_version": "1040"}。
state	Integer	主页状态。 1：未生效 2：已生效 3：已失效 4：服务号已冻结
approve_state	Integer	审核状态。 1：待审核 2：通过 3：驳回
online_time	String	上线时间。
creator	String	创建人。
create_time	String	创建时间。
change_reason	String	修改原因。

表6 PageOffSet
参数	参数类型	描述
offset	Integer	偏移量，表示从此偏移量开始查询，offset大于等于0。
limit	Integer	每页显示的条目数量。
total	Integer	总量。

状态码： 400

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	结果详情。

状态码： 500

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	结果详情。

请求示例

查询主页

https://koomessage.myhuaweicloud.cn/v1/aim-sa/portals

响应示例

状态码： 200

返回信息。

{
  "data" : {
    "portals" : [ {
      "portal_id" : "71233b4208194db991e0ec091f232d5c",
      "state" : 2,
      "approve_state" : 2,
      "company_id" : "cf2d298c555e44bf9fafdf5ada0cfc6f",
      "approve_time" : null,
      "online_time" : "2022-06-02T16:26:25Z",
      "company_name" : "轰趴馆",
      "creator" : "69c4daf2ad9d4792bc40211a1d540fa1",
      "create_time" : "2022-06-02T16:16:41Z",
      "change_reason" : null,
      "pub_id" : "7c6df57455a6483884736d6bbec0d6e2",
      "pub_name" : "林记小铺",
      "background_img" : "1498ae10657d46d596697e00c72707dc",
      "background_img_url" : "AimSauploadService/4e90259caa274a3db90441d01b1c88c9456789.jpg",
      "summary" : "通过华为云主页创建",
      "tels" : "[{\"usage\":\"usage1华为\",\"tel\":\"4000-955-988\"}]",
      "fastapps" : "[{\"name\":\"fastapp11012345\",\"logo_img\":\"10318b626df24a2ab02cfdcd659a18ec\",\"logo_img_url\":\"AimSauploadService/9d649d75258e43008ba054bdc1e80c0e20220520-175621(WeLinkPC).jpg\",\"description\":\"一二三四五六七八九零一二三四五六七八九\",\"deeplink\":\"hap://app/fastapp110\",\"depend_engine_version\":\"1040\"}]"
    } ],
    "page_info" : {
      "offset" : 0,
      "limit" : 1,
      "total" : 6
    }
  }
}