修改主页信息
功能介绍
用户对已创建的主页进行信息的修改。
URI
PUT /v1/aim-sa/portals/{portal_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
portal_id |
是 |
String |
主页ID。 最小长度：32 最大长度：32 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
change_reason |
是 |
String |
修改原因。 最小长度：5 最大长度：50 |
|
background_img |
是 |
String |
主页背景图片资源ID。 分辨率大于等于1440*810，支持jpg、jpeg、bmp、png。参数值为上传智能信息服务号图片资源API返回的resource_id。 最小长度：32 最大长度：32 |
|
summary |
是 |
String |
简介。 最小长度：1 最大长度：75 |
|
tels |
否 |
Array of TelModel objects |
热线号列表。 数组长度：0 - 5 |
|
fastapps |
否 |
Array of UpdatePortalFastappModel objects |
快应用列表。 数组长度：0 - 10 |
|
hw_pubs |
否 |
Array of strings |
华为服务号列表。
说明：
预留，暂未使用。 数组长度：0 - 10 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
tel |
是 |
String |
电话号码（只能包含数字和“-”，且开头和结尾必须为数字）。 最小长度：1 最大长度：20 |
|
usage |
是 |
String |
号码用途。
说明：
号码用途长度范围为1-30个字符，中文占2个字符，英文占1个字符。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
快应用名。
说明：
长度范围为1-30个字符，中文占2个字符，英文占1个字符。 |
|
logo_img |
是 |
String |
快应用LOGO图片资源ID。
说明：
图片格式为jpg、bmp、jpeg，分辨率大于等于192*192，大小不超过4M。参数值为上传智能信息服务号图片资源API返回的resource_id。 最小长度：32 最大长度：32 |
|
description |
是 |
String |
快应用描述。
说明：
长度范围为1-38个字符，中文占2个字符，英文占1个字符。 |
|
deeplink |
是 |
String |
快应用跳转链接。 最小长度：1 最大长度：1000 |
|
depend_engine_version |
是 |
String |
快应用依赖引擎版本。
说明：
长度范围为1-50个字符，中文占2个字符，英文占1个字符。 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
UpdatePortalRsp object |
修改主页信息响应体。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
主页状态。
|
|
approve_state |
Integer |
审核状态。
|
|
online_time |
String |
上线时间。 |
|
creator |
String |
创建人。 |
|
create_time |
String |
创建时间。 |
|
change_reason |
String |
修改原因。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
结果详情。 |
状态码： 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
结果详情。 |
请求示例
根据主页ID修改主页信息。设置修改原因为"我想修改主页"，修改主页背景图片资源ID为"1d191b06da9a485895e10e48cbc5cccc"，快应用跳转地址为"hap://app/122"。
https://koomessage.myhuaweicloud.com/v1/aim-sa/portals/bcce7e60df6445a592c09ca95dfdcccc
{
"change_reason" : "我想修改主页",
"background_img" : "1d191b06da9a485895e10e48cbc5cccc",
"summary" : "测试-欢迎来到酷玩影视",
"tels" : [ {
"tel" : "131****0000",
"usage" : "加入我们"
}, {
"tel" : "131****0001",
"usage" : "联系我们"
} ],
"fastapps" : [ {
"name" : "酷玩",
"description" : "这是一个快应用的描述",
"deeplink" : "hap://app/122",
"depend_engine_version" : "1",
"logo_img" : "d2fe995119584f88be9e9ef53d2ccccc"
} ]
}
响应示例
状态码： 200
返回信息。
{
"data" : {
"portal" : {
"portal_id" : "bcce7e60df6445a592c09ca95dfdcccc",
"state" : 1,
"approve_state" : 1,
"company_id" : "cf2d298c555e44bf9fafdf5ada0ccccc",
"company_name" : "南派餐饮",
"creator" : "7139bc07d53240dca88722930485cccc",
"create_time" : "2022-08-08T01:49:29Z",
"change_reason" : "我想修改主页",
"pub_id" : "961b0f7d32314b5cb287fc06fe09cccc",
"pub_name" : "服务号名称",
"background_img" : "1d191b06da9a485895e10e48cbc5cccc",
"background_img_url" : "AimSauploadService/ad63cdaa3a044a589bbde7f6a4551111.png",
"summary" : "测试-欢迎来到酷玩影视",
"tels" : "[{\"usage\":\"加入我们\",\"tel\":\"131****0000\"},{\"usage\":\"联系我们\",\"tel\":\"131****0001\"}]",
"fastapps" : "[{\"name\":\"酷玩\",\"logo_img\":\"d2fe995119584f88be9e9ef53d2ccccc\",\"logo_img_url\":\"AimSauploadService/ccccd328eba84b27ab215122aada398ftest22_192x192 (1).jpg\",\"description\":\"这是一个快应用的描述\",\"deeplink\":\"hap://app/122\",\"depend_engine_version\":\"1\"}]",
"approve_time" : null,
"online_time" : null
}
}
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
返回信息。 |
|
400 |
非法参数。 |
|
500 |
内部错误。 |
错误码
请参见错误码。
