云消息服务 KooMessage-查询主页列表:响应参数

时间:2025-02-12 15:01:31

响应参数

状态码: 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": "快应用 LOG O图片资源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

结果详情。

support.huaweicloud.com/api-koomessage/ListPortals.html