华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 url_type 是 Integer 回调类型。 0：发送状态回执 1：上行消息回执 callback_url 是 String 回调地址，必须是http或https开头的字符串，不能为空。 说明： 建议使用https。 最小长度：1 最大长度：1000 remark 否 String 备注。 最小长度：0 最大长度：1000

请求示例 创建一个名称为"模板测试AA"，类型为通知类的短信模板。 https://koomessage.myhuaweicloud.cn/v1/sms/templates{ "signature_id" : "65ba0c56-aa84-4e68-86a7-38af62c50707", "template_content" : "尊敬的华为云会员，详情请咨询4000-955**** ${1} ", "template_desc" : "模板测试", "template_name" : "模板测试AA", "template_type" : "NOTIFY_TYPE", "universal_template" : 0, "variable_attributes" : [ { "variable_index" : 1, "variable_type" : "NEWTEXT", "variable_desc" : "直发" } ]}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 app_id 否 String 应用ID，默认取签名所属的应用ID。 最小长度：1 最大长度：50 signature_id 是 String 签名ID。 最小长度：1 最大长度：50 template_content 是 String 模板内容。 最小长度：1 最大长度：500 template_desc 否 String 模板描述。 最小长度：1 最大长度：100 template_name 是 String 模板名称。 最小长度：1 最大长度：30 template_type 否 String 模板类型。默认取所属签名的签名类型。 最小长度：1 最大长度：20 枚举值： PROMOTION_TYPE：营销类 NOTIFY_TYPE：通知类 universal_template 否 String 是否为通用模板(暂不支持通用模板)。 缺省值：0 最小长度：1 最大长度：10 枚举值： 0：非通用模板 1：通用模板 variable_attributes 是 Array of VariableAttributes objects 模板参数。 数组长度：1 - 20 表3 VariableAttributes 参数 是否必选 参数类型 描述 variable_index 是 Integer 参数索引。 variable_type 是 String 参数类型。 最小长度：1 最大长度：20 枚举值： PHONE：电话号码 NEWTEXT：解析标识 CHARDIGIT：其他号码(如验证码、订单号、密码等) DATETIME：日期时间 MONEY：金额 TEXT：其他 variable_desc 否 String 参数描述。变量类型为TEXT（其他）时必填。 最小长度：0 最大长度：100

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 template_id String 模板ID。 最小长度：1 最大长度：50 template_name String 模板名称。 最小长度：1 最大长度：30 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 callback_url 是 String 回调地址。 说明： 必须http或https开头，建议使用https 支持 域名 或公网IP回调地址，不支持私网IP回调地址 最小长度：1 最大长度：1000 url_type 否 Integer 回调类型。 0：智能信息单条发送回调 1：模板状态回调 2：智能信息批量发送回调 缺省值：0

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data Callback object 注册详情。 status String 请求状态，固定200。 message String 状态描述。 表4 Callback 参数 参数类型 描述 callback_url String 回调地址。 id String 注册回调的唯一标识ID。 url_type Integer 回调类型。 0：智能信息单条发送回调 1：模板状态回调 2：智能信息批量发送回调 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

请求示例 注册回执-智能信息单条发送回执 https://koomessage.myhuaweicloud.cn/v1/aim/callbacks{ "callback_url" : "https://www.example.com/v1/send-resolve-status", "url_type" : 0} 注册回执-智能信息模板状态回执 https://koomessage.myhuaweicloud.cn/v1/aim/callbacks{ "callback_url" : "https://www.example.com/v1/template-status", "url_type" : 1} 注册回执-智能信息批量发送回执 https://koomessage.myhuaweicloud.cn/v1/aim/callbacks{ "callback_url" : "https://www.example.com/v1/send-resolve-status", "url_type" : 2}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 mobiles 是 Array of strings 待查询的手机号码，一次最多请求100个。 说明： 不加密时，参数可传入纯手机号或国家码加手机号，国家码不带“+”号，例如国内手机号“1310000”，参数可传入“1310000”、“861310000”、“00861310000”。使用SHA1加密，mobiles传入号码国家码与手机号码的SHA1算法后的摘要，国家码格式为纯数字，不带“+”，去掉前面的0，例如国内手机号“1310000”，使用“861310000”进行SHA1加密。 最小长度：1 最大长度：40 数组长度：1 - 100 tpl_id 否 String 智能信息模板ID，由9位数字组成。 说明： 填写时，根据该模板所支持的厂商返回手机终端展示智能信息的能力状态 不填则返回手机终端在所有厂商展示智能信息的能力状态 最小长度：0 最大长度：32 encryption_alg 否 String 加密类型。 NONE：不加密 SHA1：使用SHA1加密算法加密 说明： 默认为NONE。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 supported_mobiles Array of strings 支持智能信息手机号码列表。 unsupported_mobiles Array of strings 不支持智能信息手机号码列表。 tpl_id String 智能信息模板ID，由9位数字组成。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

请求示例 检查手机号智能信息解析能力-原始手机号。模板ID为"600000001"，手机号码不加密。 https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check{ "mobiles" : [ "131****0000", "131****0001" ], "encryption_alg" : "NONE", "tpl_id" : "600000001"} 检查手机号智能信息解析能力-SHA1加密。模板ID为"600000001"，加密方式为"SHA1"。 https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check{ "mobiles" : [ "de005a80a77f52080d7c67c65ba8663e5b0f0be1", "1837ec7308eb38494fda35da8a34038ab7533e6a" ], "encryption_alg" : "SHA1", "tpl_id" : "600000001"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 data Object 固定为null。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

请求示例 生成解析任务-个性化。模板ID为"600000001"，短链最大解析次数为1次，过期时间为7天。 https://koomessage.myhuaweicloud.cn/v1/aim/resolve-tasks{ "tpl_id" : "600000001", "sms_signs" : [ "华为云 KooMessage " ], "aim_code_type" : "individual", "resolving_times" : 1, "domain" : null, "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0000", "dync_params" : { "param1" : "参数1", "param2" : "参数2", "param3" : "参数3", "param4" : "参数4" }, "custom_url" : "https://www.example.com" }, { "cust_flag" : "131****0001", "dync_params" : { "param1" : "参数1", "param2" : "参数2", "param3" : "参数3", "param4" : "参数4" }, "custom_url" : "https://www.example.com" } ]} 生成解析任务-群发。模板ID为"600000002"，短链最大解析次数为5次，过期时间为7天，域名为"km2g.cn"。 https://koomessage.myhuaweicloud.cn/v1/aim/resolve-tasks{ "tpl_id" : "600000002", "sms_signs" : [ "华为云KooMessage" ], "aim_code_type" : "group", "resolving_times" : 5, "domain" : "km2g.cn", "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0000", "custom_url" : "https://www.example.com" } ]} 生成解析任务-自定义短码。模板ID为"600000002"，短链最大解析次数为5次，过期时间为7天，自定义短码为"abc123"。 https://koomessage.myhuaweicloud.cn/v1/aim/resolve-tasks{ "tpl_id" : "600000002", "sms_signs" : [ "华为云KooMessage" ], "aim_code_type" : "group", "resolving_times" : 5, "domain" : "km3g.cn", "expiration_time" : 7, "generation_type" : "2", "params" : [ { "cust_flag" : "131****0000", "custom_short_code" : "abc123" } ]}

响应示例 状态码： 200 返回信息。 { "task_id" : "80959fd0-dc23-42e3-9595-59a49ee6cccc", "tpl_id" : "600000002", "sms_signs" : [ "华为云KooMessage" ], "resolving_times" : 5, "aim_code_type" : "group", "domain" : "km2g.cn", "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0000", "cust_id" : "231724915a62455ca356e10a085c9a23", "dync_params" : null, "custom_url" : "https://www.example.com", "aim_url" : "km2g.cn/PDARc6", "aim_code" : "PDARc6", "result_code" : "0", "error_message" : null, "generate_date" : "2022-07-18T21:02:44Z", "expire_date" : "2022-07-25T21:02:44Z", "custom_short_code" : null } ]}

请求示例 向不同用户发送不同内容的短信。 https://koomessage.myhuaweicloud.cn/v1/aim/sms/diff-messages{ "channel_num" : "882306284****", "task_name" : "多模板API", "sms_content" : [ { "to" : [ "1552785****" ], "template_id" : "151**334", "template_params" : [ "fnafc.cc/kXfvIwzs" ] }, { "to" : [ "1392740****" ], "template_id" : "151**335", "template_params" : [ "(KM:F49C3EGz)" ] } ]}

响应示例 状态码： 200 发送短信响应体。 { "status" : "Success", "result" : [ { "to" : "+86139274****8", "channel_num" : "8823060****9", "msg_id" : "b24f1f03-556e-468e-9fe1-23729b9414d7_72****6", "create_time" : "2023-07-20 09:22:59", "send_status" : "000000" }, { "to" : "+861552785****", "channel_num" : "8823060806439", "msg_id" : "b24f1f03-556e-468e-9fe1-23729b9414d7_****407", "create_time" : "2023-07-20 09:22:59", "send_status" : "000000" } ], "task_id" : "a914ca57-09cf-4899-af62-f9a****06c3c"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 task_id String 任务ID。 最小长度：1 最大长度：50 status String 任务状态。 Success：发送成功 Failed：发送失败 说明： 此状态仅代表任务提交状态，不代表智能信息发送结果。用户手机接收智能信息结果请以收到的回执结果为准，也可通过查询智能信息发送明细API获取或登录KooMessage控制台查看。 最小长度：1 最大长度：20 result Array of SmsDetailResponse objects 短信ID列表，当目标号码存在多个时，每个号码都会返回一个SmsID。 当返回异常响应时不携带此字段。 表5 SmsDetailResponse 参数 参数类型 描述 to String 短信接收方的号码。 最小长度：1 最大长度：21 channel_num String 短信发送方的号码。 最小长度：1 最大长度：21 msg_id String 短信的唯一标识。 最小长度：1 最大长度：50 send_status String 短信状态码。 以下举例状态码及其说明，具体处理建议请参考API错误码。 000000：短信平台处理请求成功 E200015：待发送短信数量太大 E200028：模板变量校验失败 E200029：模板类型校验失败 E200030：模板未激活 E200031：协议校验失败 E200033：模板类型不正确 E200041：同一短信内容接收号码重复 最小长度：1 最大长度：7 create_time String 短信资源的创建时间。 即短信平台接收到用户发送短信请求的时间，为UTC时间。 格式为：yyyy-MM-dd'T'HH:mm:ss'Z'。 最小长度：1 最大长度：20 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 id 是 String 主键ID，取查询通道号绑定信息列表返回的ID字段。 最小长度：32 最大长度：32

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data BindPortResponseBody object 通道号解绑服务号响应体。 表4 BindPortResponseBody 参数 参数类型 描述 message String 信息。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 template_id String 模板ID。 最小长度：1 最大长度：50 template_name String 模板名称。 最小长度：1 最大长度：30 create_time String 创建时间。 最小长度：1 最大长度：20 template_type String 模板类型。 最小长度：1 最大长度：20 app_id String 应用ID。 最小长度：1 最大长度：50 app_name String 应用名称。 最小长度：1 最大长度：30 signature_id String 签名ID。 最小长度：1 最大长度：50 template_content String 模板内容。 最小长度：1 最大长度：500 template_desc String 申请描述。 最小长度：1 最大长度：100 has_variable String 是否有变量。 最小长度：1 最大长度：10 flow_status String 流程状态。 最小长度：1 最大长度：20 status String 模板状态。 最小长度：1 最大长度：20 universal_template Integer 是否是通用模板。 最小值：0 最大值：1 urge_status String 催审状态。 最小长度：0 最大长度：20 urge_time String 催审时间。 最小长度：1 最大长度：20 urge_desc String 催审描述。 最小长度：0 最大长度：64 review_desc String 审批描述。 最小长度：0 最大长度：500 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

响应示例 状态码： 200 获取短信模板详情响应体。 { "status" : "Normal", "template_name" : "模板测试AAB", "template_type" : "PROMOTION_TYPE", "template_content" : "尊敬的华为云会员，详情请咨询4000-955**** ${1} ", "template_id" : "1512***3", "signature_id" : "65ba0c56-aa84-4e68-86a7-****62c50707", "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af", "app_name" : "NewOPACCOUNT082", "create_time" : "2023-08-08 06:14:56", "has_variable" : "Yes", "flow_status" : "Reviewing", "universal_template" : null, "template_desc" : "模板测试", "urge_status" : "NO", "urge_time" : null, "urge_desc" : null, "review_desc" : null}

响应示例 状态码： 200 返回信息。 { "data" : { "data" : [ { "id" : "a67928a301364aa38d8cf6f08242cccc", "create_time" : "2022-08-05T01:45:05Z", "pub_name" : null, "pub_id" : null, "port_type" : 1, "sign_check" : 0, "port" : "8822053111111", "province" : null, "sign" : [ "华为云KooMessage" ], "authorization_files" : { "3d214a61672846f88ad77597f935cccc" : "AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png" }, "is_bind" : 1, "pub_list" : [ { "pub_name" : "服务号名称1", "pub_reference" : "服务号备注1" } ] }, { "id" : "fce3da488355458f80ba5407e3c1cccc", "create_time" : "2022-08-04T09:27:29Z", "pub_name" : null, "pub_id" : null, "port_type" : 1, "sign_check" : 1, "port" : "8822053112222", "province" : null, "sign" : [ "0804测试测试" ], "authorization_files" : { "37fd9a91d5bb4457aae5dd431676cccc" : "AimSauploadService/62dcfe64c95b4635bef2ef76a72bcccc测试3.PNG" }, "is_bind" : 1, "pub_list" : [ { "pub_name" : "服务号名称2", "pub_reference" : "服务号备注2" } ] } ], "page_info" : { "offset" : 0, "limit" : 2, "total" : 8 } }}

URI GET /v1/aim-sa/ports 表1 Query参数 参数 是否必选 参数类型 描述 type 否 Integer 操作类型。 0：查询通道号列表 1：查询绑定关系列表 缺省值：0 最小长度：0 最大长度：1 port 否 String 通道号。 最小长度：0 最大长度：21 port_type 否 Integer 通道号类型。 1：普通 3：前缀号段 5：后缀号段 最小值：1 最大值：5 sign_search 否 String 单个通道号签名。 说明： 不支持多个签名查询，支持模糊搜索。长度要求0-18。 最小长度：0 最大长度：18 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：2147483647 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：10 start_time 否 String 开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ。 end_time 否 String 结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ。 pub_name 否 String 服务号名称。 说明： type=1时，此字段作为过滤条件 type=0时，不作为过滤条件 最小长度：0 最大长度：64 is_bind 否 Integer 绑定状态。 0：未绑定 1：已绑定 说明： type=0时，此字段作为过滤条件 type=1时，不作为过滤条件 最小长度：0 最大长度：1

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：multipart/form-data。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 FormData参数 参数 是否必选 参数类型 描述 file 是 File 营业执照/授权委托书文件。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 file_id String 文件ID。 最小长度：1 最大长度：50 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

响应示例 状态码： 200 返回信息。 { "page_info" : { "offset" : 0, "limit" : 1, "total" : 143 }, "data" : [ { "pub_id" : "9405df1846a348e0b997d855bf80acc7", "company_id" : "6b3dd34b00e94326908720fa97f2b132", "pub_remark" : "K歌", "oper_time" : "2022-06-01T15:03:36Z", "state" : 1, "approve_state" : 3, "online_time" : "2022-06-07T14:08:09Z", "company_name" : null, "pub_name" : "轰趴馆-K歌", "logo_img" : "ab44b435b7a442a59e199735a9e3ce26", "logo_url" : "AimSauploadService/1dc408cff6b147a690f19732a42731273.png", "authorization_files" : { "63e2a3d465744bf69cf0321bd3e9bfb2" : "AimSauploadService/75356fb37c5b4067ba691ea2026ec69e3.png" }, "auto_get_port" : 1, "industry" : 1, "pub_abstract" : "我来一首天籁吧", "signs_for_auto_get_port" : [ "轰趴馆" ], "areas_for_auto_get_port" : [ "陕西省", "佛山市" ] } ]}

URI GET /v1/aim-sa/pubs 表1 Query参数 参数 是否必选 参数类型 描述 pub_name 否 String 服务号名称。 最小长度：1 最大长度：15 state 否 Integer 服务号状态。 1：未生效 2：已生效 3：已失效 4：已冻结 最小值：1 最大值：4 start_time 否 String 开始上线时间，格式为：yyyy-MM-ddTHH:mm:ssZ。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：214748364 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：10 end_time 否 String 结束上线时间，格式为：yyyy-MM-ddTHH:mm:ssZ。 industry 否 String 服务号所属行业。 1：金融理财 2：社交通讯 3：影音娱乐 4：旅游出行 5：购物 6：本地生活 7：运动健康 8：教育培训 9：新闻阅读 10：运营商 11：其他 最小值：1 最大值：11 approve_state 否 Integer 审核状态。 1：审核中 2：审核通过 3：驳回

请求示例 根据主页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" } ]}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 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 表4 TelModel 参数 是否必选 参数类型 描述 tel 是 String 电话号码（只能包含数字和“-”，且开头和结尾必须为数字）。 最小长度：1 最大长度：20 usage 是 String 号码用途。 说明： 号码用途长度范围为1-30个字符，中文占2个字符，英文占1个字符。 表5 UpdatePortalFastappModel 参数 是否必选 参数类型 描述 name 是 String 快应用名。 说明： 长度范围为1-30个字符，中文占2个字符，英文占1个字符。 logo_img 是 String 快应用 LOG O图片资源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 表6 响应Body参数 参数 参数类型 描述 data UpdatePortalRsp object 修改主页信息响应体。 表7 UpdatePortalRsp 参数 参数类型 描述 portal PortalModel object 主页信息。 表8 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 修改原因。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。