华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 template_reports Array of AIMTemplateReport objects 查询模板报表结果集。 page_info Page object 分页信息。 表4 AIMTemplateReport 参数 参数类型 描述 tpl_id String 智能信息模板ID。 start_time String 统计开始时间。样例为：1970-01-01T00:00:00Z。 resolving_times Integer 实际已解析数。 end_time String 统计结束时间。样例为：1970-01-01T00:00:00Z。 expose_uv Long 消息曝光数。 expose_pv Long 消息曝光次数。 click_uv Long 消息点击数。 click_pv Long 消息点击次数。 表5 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 app_id String 应用ID，用于获取、修改应用的唯一标识。 最小长度：1 最大长度：50 app_name String 应用名称。 最小长度：1 最大长度：30 status String 状态。 最小长度：1 最大长度：20 枚举值： CREATED：待上线。应用暂未创建成功，请稍候 SUSPENDED：暂停。无法发起业务请求。当客户所发短信内容触发业务违规，或客户申请退订短信业务时，运营经理会将客户短信应用暂停 LAUNCHED：正常。应用添加成功，可以正常使用 region String 地域。 最小长度：1 最大长度：20 create_time String 创建时间，格式：yyyy-MM-dd'T'HH:mm:ss。 最小长度：1 最大长度：20 up_link_addr String 上行短信地址。 最小长度：1 最大长度：255 状态码： 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 表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 结果详情。

响应示例 状态码： 200 获取短信应用详情返回体。 { "status" : "LAUNCHED", "region" : "cn", "app_id" : "2353cb25-c169-4e20-adcf-3517****0f9e", "app_name" : "应用1", "up_link_addr" : "https://www.huaweicloud.com/sms/receive", "create_time" : "2023-08-07T02:21:26"}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 material_ids 是 Array of strings 模板素材ID数组。

请求示例 查询智能信息发送报表-日报。模板ID为"600000005"，查询时间从"2022-07-15 00:00:00 到 2022-07-16 00:00:00"。 https://koomessage.myhuaweicloud.com/v1/aim/send-reports{ "begin_time" : "2022-07-15T00:00:00Z", "end_time" : "2022-07-16T00:00:00Z", "report_type" : "1", "tpl_id" : "600000005", "offset" : 0, "limit" : 2} 查询智能信息发送报表-月报。模板ID为"600000006"，查询时间从"2022-05-01 00:00:00 到 2022-07-01 00:00:00"。 https://koomessage.myhuaweicloud.com/v1/aim/send-reports{ "begin_time" : "2022-05-01T00:00:00Z", "end_time" : "2022-07-01T00:00:00", "report_type" : "2", "tpl_id" : "600000006", "offset" : 0, "limit" : 2}

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : { "data_list" : [ { "report_time" : "2022-07-15", "tpl_id" : "600000005", "tpl_name" : "【惠游重庆】入境欢迎-测试", "submission_count" : 4, "support_resolve_count" : 3, "send_count" : 0, "send_success_count" : 0, "resolve_success_count" : 0 } ], "page_info" : { "offset" : 1, "limit" : 2, "total" : 1 } }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 响应码。 message String 响应信息。 data QueryReportResponse object 响应数据体。 表4 QueryReportResponse 参数 参数类型 描述 data_list Array of ReportDetail objects 数据列表。 数组长度：0 - 100 page_info Page object 分页信息。 表5 ReportDetail 参数 参数类型 描述 report_time String 报表日期时间。 tpl_id String 智能信息模板ID。 tpl_name String 智能信息模板名称。 submission_count Integer 提交号码总数量。 support_resolve_count Integer 支持解析数量。 说明： 此数据不包括通过API发送的智能信息任务。 send_count Integer 发送数量。 send_success_count Integer 成功发送数量。 resolve_success_count Integer 成功解析数量。 表6 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 report_type 否 String 报表类型。 1：日报表 2：月报表 说明： 若不填，默认是1，即查询日报表。 最小长度：0 最大长度：8 tpl_id 否 String 智能信息模板ID。 最小长度：0 最大长度：9 tpl_name 否 String 智能信息模板名称。 最小长度：0 最大长度：100 begin_time 否 String 开始时间。格式为：2022-05-01T00:00:00Z。 最小长度：0 最大长度：30 end_time 否 String 结束时间。格式为：2022-05-01T00:00:00Z。 最小长度：0 最大长度：30 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 说明： 为提高查询效率，offset+limit须小于等于10000，超出范围查询为空。 最小值：0 最大值：2147483647 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：20

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 signature_name String 签名名称。 最小长度：1 最大长度：30 signature_id String 签名ID。 最小长度：1 最大长度：50 signature_type String 签名类型。 最小长度：1 最大长度：20 app_name String 应用名称。 最小长度：1 最大长度：30 app_id String 应用ID。 最小长度：1 最大长度：50 apply_desc String 申请说明。 最小长度：0 最大长度：100 channel_num String 国内短信通道号，仅当签名审核成功，运营人员配置完成后返回。 最小长度：1 最大长度：21 file_id String 营业执照文件ID。 最小长度：1 最大长度：50 status String 状态。 枚举值： PENDING_REVIEW：待审核 PRO CES SING： 内容审核 通过签名在处理中 REVIEW_PASSED：处理完毕 REVIEW_NOT_PASS：审核不通过 TO_BE_ACTIVATED：待激活 PENDING_ACTIVATE：激活审核中 signature_source Integer 签名来源。 最小值：0 最大值：20 is_involved_third String 是否涉及第三方权益。 power_attorney_file_id String 授权委托书文件ID。 最小长度：1 最大长度：50 urge_status String 催审状态。 最小长度：1 最大长度：20 urge_time String 催审时间。 最小长度：1 最大长度：20 urge_desc String 催审描述。 最小长度：0 最大长度：64 review_desc String 审核意见。 最小长度：0 最大长度：500 source_title_content String 标题内容。 最小长度：1 最大长度：180 create_time String 创建时间。 最小长度：1 最大长度：20 状态码： 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 获取短信签名详情返回体。 { "signature_name" : "签名创建测试5555", "signature_id" : "6a7aba12-ad82-4c53-986e-9b******0c87", "signature_type" : "PROMOTION_TYPE", "app_name" : "Huawei_12688", "app_id" : "2353cb25-c169-4e20-adcf-3****b4e0f9e", "apply_desc" : "203测试", "channel_num" : "882308042****", "file_id" : "c2d3613c-2864-48ce-8de6-db****23ad32", "status" : "PENDING_REVIEW", "signature_source" : 0, "is_involved_third" : "no", "power_attorney_file_id" : null, "source_title_content" : "", "urge_status" : null, "urge_time" : null, "urge_desc" : null, "review_desc" : null, "create_time" : "2023-08-07T02:28:45"}

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 最小长度：0 最大长度：32 error_msg String 结果详情。 最小长度：0 最大长度：32

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 change_reason 是 String 冻结原因。 最小长度：1 最大长度：200

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data data object 请求成功返回的数据，为JSON格式。 数组长度：0 - 2147483647 表5 data 参数 参数类型 描述 pub_id String 服务号ID。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

响应示例 状态码： 200 返回信息。 { "templates" : [ { "tpl_id" : "600000001", "tpl_name" : "测试-中行签到", "scene" : "测试模板", "tpl_state" : 1, "disable_desc" : "", "disable_time" : "1970-01-01T00:00:00Z", "audit_state" : 2, "audit_desc" : "审核通过", "description" : "您有一条新消息，测试。", "creation_time" : "2022-05-23T17:49:00Z", "update_time" : "2022-05-23T19:29:14Z", "pages" : "[{\"typeIndex\":0,\"cardId\":\"com.hbm.redpacket\",\"style\":{\"width\":\"342px\",\"opacity\":1,\"height\":\"456px\"},\"label\":\"主页1\",\"tag\":\"page1\",\"content\":[{\"visible\":true,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg.png\",\"h\":456,\"isBgimg\":true,\"type\":\"image\",\"skipReplaceSrc\":true,\"size\":0,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":0,\"notValid\":true,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.34403423289983026\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"\",\"longitude\":\"\"}},{\"serviceType\":0,\"visible\":false,\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/defaultImg/defaultImg2.jpg\",\"h\":23,\"type\":\"serviceNumber\",\"serviceName\":\"请选择服务号\",\"skipReplaceSrc\":true,\"borderRadius\":0,\"w\":342,\"x\":0,\"y\":348,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":0,\"color\":\"#fff\",\"textAlign\":\"center\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.6574206986442455\",\"locked\":true,\"serviceID\":\"\"},{\"visible\":true,\"proportion\":[1,1],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/603264561/20220523174859881fILNZn.jpg\",\"bg\":{\"proportion\":[9,5],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/tpl_file/Montnets/E01/S01/Template/610579108/20220523174900022c8XeYT.jpg\",\"w\":342,\"h\":190},\"h\":70,\"type\":\"image\",\"oppobg\":{\"proportion\":[3,4],\"src\":\"https://aim6.oss-cn-beijing.aliyuncs.com/editor_file/redpacketBg-oppo.jpg\",\"w\":342,\"h\":456},\"passItem\":false,\"size\":91289,\"borderRadius\":0,\"w\":70,\"x\":136,\"width\":1024,\"y\":44,\"angle\":0,\"style\":{\"padding\":0,\"borderRadius\":\"70px\",\"borderWidth\":0,\"borderStyle\":\"none\"},\"z\":0,\"tag\":\"tg0.45509392249988934\",\"srcParam\":\"\",\"locked\":true,\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"latitude\":\"\",\"navType\":2,\"floorType\":0,\"description\":\"\",\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"browserFloorUrl\":\"\",\"merchantName\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"isBg\":0,\"height\":1024},{\"visible\":true,\"h\":23,\"title\":\"true\",\"type\":\"text\",\"textMaxlength\":36,\"passItem\":false,\"textOPPOLength\":24,\"w\":342,\"x\":0,\"y\":128,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"tag\":\"tg0.42763825585357296\",\"text\":\"中行送您最高20元话费券\",\"placeholder\":\"编辑名称，最多显示18个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":40,\"type\":\"text\",\"textMaxlength\":22,\"passItem\":false,\"w\":342,\"x\":0,\"y\":196,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"24px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaTitle\":\"true\",\"tag\":\"tg0.04688490460114725\",\"text\":\"话费+签到双重福利红包\",\"placeholder\":\"编辑文本，最多11个字\",\"locked\":true,\"event\":{}},{\"visible\":true,\"h\":69,\"type\":\"text\",\"textMaxlength\":108,\"passItem\":false,\"textOPPOLength\":76,\"w\":280,\"x\":31,\"y\":236,\"angle\":0,\"z\":2,\"style\":{\"backgroundColor\":\"transparent\",\"fontFamily\":\"微软雅黑\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"fontSize\":\"14px\",\"textDecoration\":\"none\",\"lineHeight\":1.5,\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"opacity\":1,\"fontWeight\":\"700\"},\"divTextAreaContent\":\"true\",\"tag\":\"tg0.7916708792687688\",\"text\":\"登录手机银行首页-搜索-热门活动参加签到活动赢最高20元话费券！-测试\",\"placeholder\":\"编辑文本，最多显示54个字。编辑文本，最多显示54个字。编辑文本，最多显示54个字。\",\"locked\":true,\"event\":{}},{\"visible\":true,\"pageTitle\":\"\",\"h\":40,\"type\":\"button\",\"target\":\"\",\"passItem\":false,\"w\":202,\"x\":70,\"y\":381,\"angle\":0,\"action\":\"OPEN_APP\",\"z\":3,\"style\":{\"padding\":0,\"backgroundColor\":\"#ff9800\",\"color\":\"#ffffff\",\"textAlign\":\"center\",\"letterSpacing\":0,\"textDecoration\":\"none\",\"boxSizing\":\"border-box\",\"fontStyle\":\"normal\",\"fontFamily\":\"微软雅黑\",\"borderRadius\":\"32px\",\"borderWidth\":0,\"fontSize\":\"16px\",\"opacity\":1,\"borderStyle\":\"none\",\"fontWeight\":\"normal\"},\"tag\":\"tg0.6309152129863151\",\"text\":\"立即领取\",\"locked\":true,\"thirdService\":\"\",\"event\":{\"packageNames\":\"\",\"subject\":\"\",\"navType\":2,\"latitude\":\"\",\"description\":\"\",\"floorType\":0,\"txtButton\":\"\",\"body\":\"\",\"content\":\"\",\"target\":\"https://mbs.boc.cn/v/JzEZb\",\"merchantName\":\"\",\"browserFloorUrl\":\"\",\"mode\":0,\"floorUrl\":\"\",\"copyType\":1,\"action\":\"OPEN_BROWSER\",\"longitude\":\"\"},\"maxLength\":9}]}]", "params" : [ ], "factory_info" : [ { "factory_type" : "HuaWei", "state" : 1, "version" : null }, { "factory_type" : "XiaoMi", "state" : 1, "version" : null }, { "factory_type" : "OPPO", "state" : 1, "version" : null } ] } ], "page_info" : { "offset" : 0, "limit" : 1, "total" : 10 }}

URI GET /v1/aim/templates 表1 Query参数 参数 是否必选 参数类型 描述 tpl_id 否 String 智能信息模板ID。 最小长度：0 最大长度：36 tpl_name 否 String 智能信息模板名称。 最小长度：0 最大长度：100 tpl_type 否 String 模板分类。 public：查公共模板 private：查个人模板 说明： 不传查全部模板。 factory_type 否 Array of strings 厂商类型。 HUAWEI：华为 XI AOM I：小米 OPPO：OPPO MEIZU：魅族 VIVO：VIVO SAMSUNG：三星 数组长度：0 - 6 has_param 否 Boolean 模板是否携带参数。 true：是 false：否 begin_time 否 String 模板创建开始时间。样例：2019-10-12T07:20:50Z。 说明： begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 最小长度：0 最大长度：30 end_time 否 String 模板创建结束时间。样例：2019-10-12T07:20:50Z。 说明： begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 最小长度：0 最大长度：30 is_only_status 否 Boolean 响应里只返回状态信息，不返回pages和params。 false：默认值，返回全量信息 true：只返回状态信息 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：20

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 templates Array of AIMTemplate objects 模板列表。 page_info Page object 分页信息。 表4 AIMTemplate 参数 参数类型 描述 tpl_id String 智能信息模板ID。 说明： 智能信息平台生成的模板ID，由9位数字组成。 tpl_name String 智能信息模板名称。 scene String 场景类型。 tpl_state Integer 模板状态。 0：禁用 1：启用 disable_desc String 禁用原因。 disable_time String 禁用时间。样例：1970-01-01T00:00 :00Z。 audit_state Integer 审核状态。 0：未提交 1：审核中 2：审核通过 3：审核失败 audit_desc String 审批信息。 description String 短信示例。 说明： 对应创建个人模板API中的入参sms_example。 creation_time String 创建时间。样例为：1970-01-01T00:00:00Z。 update_time String 更新时间。样例为：1970-01-01T00:00:00Z。 pages String 模板页面HTML，JSON格式。 params Array of AIMTemplateParams objects 模板动态参数列表。 factory_info Array of FactoryInfo objects 支持厂商列表。 match_type Integer 模板类型。 1：短链解析模板 2：文本识别模板 4：一体化模板 card_id String 布局类型。 sub_type Integer 版式子类型。 preview_url String 模板二维码预览地址。 表5 AIMTemplateParams 参数 参数类型 描述 type String 参数类型。 string：文本 integer：数字 name String 参数名称。 has_length Boolean 动态参数是否长度限制。 false：不可设置 true：可设置 fix_length Integer 固定长度。 length_restrict Boolean 长度限制。 min_length Integer 最小长度。 max_length Integer 最大长度。 表6 FactoryInfo 参数 参数类型 描述 factory_type String 厂商名称。 state Integer 厂商状态。 0：禁用 1：启用 2：未启用 version String 厂商版本。 tpl_id String 智能信息模板ID。 表7 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message AnyType 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

响应示例 状态码： 200 查询短信模板响应体。 { "result" : [ { "status" : "Normal", "template_name" : "营销类07模板", "template_type" : "PROMOTION_TYPE", "template_content" : "华为云内部测试使用。${1} 回T取关", "template_id" : "1512***6", "signature_id" : "65ba0c56-aa84-4e68-86a7-****62c50707", "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af", "app_name" : "APP1", "create_time" : "2023-08-04 07:53:40", "has_variable" : "Yes", "flow_status" : "Adopted", "universal_template" : null, "template_desc" : "", "urge_status" : "NO", "urge_time" : null, "urge_desc" : null, "review_desc" : "请审批" }, { "status" : "Normal", "template_name" : "营销类06模板", "template_type" : "PROMOTION_TYPE", "template_content" : "测试一体化营销套餐006号${1} 回T取关", "template_id" : "1512***5", "signature_id" : "af98bc62-cc8b-407e-a37a-****726c19d6", "app_id" : "707b236a-b58b-41fc-b552-****eaaa19af", "app_name" : "APP1", "create_time" : "2023-08-04 07:45:08", "has_variable" : "Yes", "flow_status" : "Adopted", "universal_template" : null, "template_desc" : "", "urge_status" : "NO", "urge_time" : null, "urge_desc" : null, "review_desc" : "请审批" } ], "page_info" : { "offset" : 1, "limit" : 2, "total" : 148 }}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Array of SmsTemplateInfo objects 查询结果。 page_info Page object 分页信息。 表4 SmsTemplateInfo 参数 参数类型 描述 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 表5 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 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

URI GET /v1/sms/templates 表1 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量。表示从偏移量开始查询，offset大于等于0。 缺省值：1 limit 否 Integer 每页显示的条目数量。 缺省值：10 app_name 否 String 应用名称。 start_time 否 String 开始时间。 end_time 否 String 结束时间。 flow_status 否 String 流程状态。 枚举值： Adopted：通过 Reviewing：审核中 Reject：拒绝 template_id 否 String 模板ID。 template_name 否 String 模板名称。 template_type 否 String 模板类型。 枚举值： PROMOTION_TYPE：营销类 NOTIFY_TYPE：通知类

响应示例 状态码： 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( WeLink PC).jpg\",\"description\":\"一二三四五六七八九零一二三四五六七八九\",\"deeplink\":\"hap://app/fastapp110\",\"depend_engine_version\":\"1040\"}]" } ], "page_info" : { "offset" : 0, "limit" : 1, "total" : 6 } }}

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

响应参数 状态码： 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 结果详情。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 KM.00001075 短信签名为空 短信签名为空 请检查并在更改错误参数后重试 400 KM.00001076 短信签名的长度范围在1-18个字符之间 短信签名的长度范围在1-18个字符之间 请检查并在更改错误参数后重试 400 KM.00001080 模板ID不存在 模板ID不存在 请检查并在更改错误参数后重试 400 KM.00001081 模板ID为空 模板ID为空 请检查并在更改错误参数后重试 400 KM.00001082 模板ID不存在 模板ID不存在 请检查并在更改错误参数后重试 400 KM.00001083 手机号列表为空 手机号列表为空 请检查并在更改错误参数后重试 400 KM.00001098 短信通道号的字符长度范围必须在1-21之间 短信通道号的字符长度范围必须在1-21之间 请检查并在更改错误参数后重试 400 KM.00001124 短信应用名称不能为空 短信应用名称不能为空 请检查并在更改错误参数后重试 400 KM.00001125 短信应用名称不匹配 短信应用名称不匹配 请检查并在更改错误参数后重试 400 KM.00001126 短信发送通道参数不能为空 短信发送通道参数不能为空 请检查并在更改错误参数后重试 400 KM.00001127 短信签名不能为空 短信签名不能为空 请检查并在更改错误参数后重试 400 KM.00001128 短信签名不匹配 短信签名不匹配 请检查并在更改错误参数后重试 400 KM.00001129 短信模板ID不能为空 短信模板ID不能为空 请检查并在更改错误参数后重试 400 KM.00001134 短信模板ID必须为数字 短信模板ID必须为数字 请检查并在更改错误参数后重试 400 KM.00001135 短信模板不存在 短信模板不存在 请检查并在更改错误参数后重试 400 KM.00001138 该短信模板不属于当前用户，无权限使用该短信模板 该短信模板不属于当前用户，无权限使用该短信模板 请检查并在更改错误参数后重试 400 KM.00001189 signature_id不可为空 signature_id不可为空 请检查参数填写是否正确 400 KM.00001375 短信模板参数校验失败，PHONE类型1-15个字符，CHARDIGIT|DATETIME|MONEY|TEXT类型1-20个字符 短信模板参数校验失败，PHONE类型1-15个字符，CHARDIGIT|DATETIME|MONEY|TEXT类型1-20个字符 请检查并在更改错误参数后重试 400 KM.00001376 短信模板参数和发送输入的参数个数不匹配 短信模板参数和发送输入的参数个数不匹配 请检查参数sms_params，更改后重试 400 KM.00001377 创建的短信模板缺少解析标识类型参数 创建的短信模板缺少解析标识类型参数 请添加解析标识类型参数 400 KM.00001378 短信模板中出现连续参数 短信模板中出现连续参数 短信模板的参数不能连续插入 400 KM.00001402 短信模板参数校验失败，电话类型变量规则不匹配 短信模板参数校验失败，电话类型变量规则不匹配 请参考接口文档修改后重试 400 KM.00001403 短信模板参数校验失败，时间类型变量规则不匹配 短信模板参数校验失败，时间类型变量规则不匹配 请参考接口文档修改后重试 400 KM.00001404 短信模板参数校验失败，其他号码类型变量规则不匹配 短信模板参数校验失败，其他号码类型变量规则不匹配 请参考接口文档修改后重试 400 KM.00001448 短信模板不存在 短信模板不存在 请输入正确的短信模板ID 400 KM.00001452 应用名称重复 应用名称重复 请修改后重试 400 KM.00001453 签名已存在 签名已存在 请修改后重试 400 KM.00001459 应用名称不能超过30个字符 应用名称不能超过30个字符 请修改 400 KM.00001460 上行短信接收地址不能超过255个字符 上行短信接收地址不能超过255个字符 请修改 400 KM.00001461 应用不存在 应用不存在 请检查应用ID 400 KM.00001462 签名长度不能超过30个字符 签名长度不能超过30个字符 请修改 400 KM.00001463 申请说明字段长度不能超过100个字符 申请说明字段长度不能超过100个字符 请修改 400 KM.00001467 APP应用下载地址不能为空 APP应用下载地址不能为空 请输入 400 KM.00001468 电商平台店铺地址不能为空 电商平台店铺地址不能为空 请输入 400 KM.00001469 营业执照不能为空 营业执照不能为空 请上传营业执照 400 KM.00001470 授权委托书不能为空 授权委托书不能为空 请上传授权委托书 400 KM.00001471 签名来源不能为空 签名来源不能为空 请填写签名来源 400 KM.00001472 不支持的签名来源 不支持的签名来源 请修改后重试 400 KM.00001473 签名不存在 签名不存在 请检查签名ID 400 KM.00001475 待激活的签名才可以激活 待激活的签名才可以激活 请检查签名状态 400 KM.00001476 模板名称不能超过30个字符 模板名称不能超过30个字符 请修改模板名称 400 KM.00001477 不支持的模板类型 不支持的模板类型 请修改 400 KM.00001478 模板不存在 模板不存在 请检查模板ID 400 KM.00001482 “是否涉及第三方权益”输入有误 “是否涉及第三方权益”输入有误 请输入yes或no 400 KM.00001483 短信签名审核通过后才可以创建模板 短信签名审核通过后才可以创建模板 请检查签名状态 400 KM.00001484 审核不通过的模板才可以修改 审核不通过的模板才可以修改 请检查模板状态 400 KM.00001485 签名名称长度设置错误 签名名称长度设置错误 请控制签名名称的长度在2-16之间 400 KM.00001486 签名已存在 签名已存在 请更换签名名称或签名类型 400 KM.00001492 接收方号码不能为空 接收方号码不能为空 请输入接收方号码 400 KM.00001493 短链不存在 短链不存在 请检查并更改错误参数后重试 400 KM.00001494 不支持的签名类型 不支持的签名类型 请检查并更改签名类型后重试 400 KM.00001495 应用不存在 应用不存在 请检查应用ID 400 KM.00001496 文件名称不能为空 文件名称不能为空 请修改后重新上传 400 KM.00001497 文件名称不能包含空格 文件名称不能包含空格 请修改后重新上传 400 KM.00001498 文件名称不能包含特殊字符 文件名称不能包含特殊字符 请修改后重新上传 400 KM.00001499 文件名称不能超过64个字符 文件名称不能超过64个字符 请修改后重新上传 400 KM.00001500 接收方号码数超过最大值 接收方号码数超过最大值 请修改后重试 400 KM.00001501 扩展参数超过最大长度限制 扩展参数超过最大长度限制 请修改后重试 400 KM.00001502 接收方号码格式错误 接收方号码格式错误 请修改后重试 400 KM.00001503 短信模板参数校验失败 短信模板参数校验失败 请修改后重试 400 KM.00001504 短信签名校验失败 短信签名校验失败 请修改后重试 400 KM.00001505 短信模板校验失败 短信模板校验失败 请修改后重试 400 KM.00001506 通道号不存在 通道号不存在 请检查通道号输入是否正确 400 KM.00001511 扩展参数校验失败 扩展参数校验失败 请修改后重试 400 KM.00001518 模板名称已被使用 模板名称已被使用 请修改后重试 400 KM.00002024 创建的短信应用已达到上限 创建的短信应用已达到上限 请联系运营技术支持 400 KM.00002194 创建短信模板失败 创建短信模板失败 请检查参数后重试 400 KM.80000001 操作失败 操作失败 请联系技术支持 400 KM.80000002 参数无效 参数无效 请联系技术支持 400 KM.80000003 读取配置失败 读取配置失败 请联系技术支持 400 KM.80020000 未经授权的操作 未经授权的操作 请联系技术支持 400 KM.80020001 操作失败 操作失败 请联系技术支持 400 KM.80020002 查询模板素材失败 查询模板素材失败 请联系技术支持 400 KM.80020003 删除模板素材失败 删除模板素材失败 请联系技术支持 400 KM.80020004 文件类型无效，可接受的格式 文件类型无效，可接受的格式 请联系技术支持 400 KM.80020005 资源类型无效，可接受的格式 资源类型无效，可接受的格式 请联系技术支持 400 KM.80020006 找不到文件 找不到文件 请联系技术支持 400 KM.80020007 文件上传失败 文件上传失败 请联系技术支持 400 KM.80020008 文件下载失败 文件下载失败 请联系技术支持 400 KM.80020009 此素材不是视频素材 此素材不是视频素材 请联系技术支持 400 KM.80020010 读取文件失败 读取文件失败 请联系技术支持 400 KM.80020011 素材ID无效 素材ID无效 请联系技术支持 400 KM.80020012 文件流无效 文件流无效 请联系技术支持 400 KM.80020013 找不到文件URL 找不到文件URL 请联系技术支持 400 KM.80020014 文件名不能超过100个字符 文件名不能超过100个字符 请联系技术支持 400 KM.80020015 图片速率无效 图片速率无效 请联系技术支持 400 KM.80020016 文件描述不能超过50个字符 文件描述不能超过50个字符 请联系技术支持 400 KM.80020017 文件URL不能超过1000个字符 文件URL不能超过1000个字符 请联系技术支持 400 KM.80020018 文件无效，文件URL应以http或https开头 文件无效，文件URL应以http或https开头 请联系技术支持 400 KM.80020019 图片大小不能超过100KB 图片大小不能超过100KB 请联系技术支持 400 KM.80020020 视频大小不能超过10MB 视频大小不能超过10MB 请联系技术支持 400 KM.80020021 图片格式应为png、jpg、jpeg其中之一 图片格式应为png、jpg、jpeg其中之一 请联系技术支持 400 KM.80020022 视频格式应为mp4 视频格式应为mp4 请联系技术支持 400 KM.80020023 素材ID长度不能超过36个字符 素材ID长度不能超过36个字符 请联系技术支持 400 KM.80020025 创建封面素材失败 创建封面素材失败 请联系技术支持 400 KM.80030000 未经授权的操作 未经授权的操作 请联系技术支持 400 KM.80030001 操作失败 操作失败 请联系技术支持 400 KM.80030010 查询智能信息模板失败 查询智能信息模板失败 请联系技术支持 400 KM.80030020 由于类型是其中之一[文本，按钮]，页面内容无效 由于类型是其中之一[文本，按钮]，页面内容无效 请联系技术支持 400 KM.80030021 由于类型是其中之一[文本，按钮]，页面内容无效 由于类型是其中之一[文本，按钮]，页面内容无效 请联系技术支持 400 KM.80030022 找不到智能信息模板 找不到智能信息模板 请联系技术支持 400 KM.80030023 请求无效 请求无效 请联系技术支持 400 KM.80040001 操作失败 操作失败 请联系技术支持 400 KM.80040002 解析响应失败 解析响应失败 请联系技术支持 400 KM.80040003 上传素材失败 上传素材失败 请联系技术支持 400 KM.80040004 创建智能信息模板失败 创建智能信息模板失败 请联系技术支持 400 KM.80040005 更新智能信息模板失败 更新智能信息模板失败 请联系技术支持 400 KM.80040006 删除智能信息模板失败 删除智能信息模板失败 请联系技术支持 400 KM.80040007 创建智能信息模板失败，无法识别的JSON 创建智能信息模板失败，无法识别的JSON 请联系技术支持 400 KM.80050001 操作失败 操作失败 请联系技术支持 400 KM.80050002 文件未上传 文件未上传 请联系技术支持 400 KM.80050003 文件下载失败 文件下载失败 请联系技术支持 400 KM.80050004 文件删除失败 文件删除失败 请联系技术支持 400 KM.80050005 无法生成链接 无法生成链接 请联系技术支持 400 KM.90022042 回调地址连通性测试失败 回调地址连通性测试失败 检查上报URL是否已发布，或重试 400 KM.00000400 参数校验失败 参数校验失败 请参考返回的Error Message检查请求参数并修改 400 KM.90014016 更新模板状态失败 更新模板状态失败 请参考返回的Error Message检查请求参数并修改 400 KM.90014017 查询模板列表失败 查询模板列表失败 请参考返回的Error Message检查请求参数并修改 400 KM.90014020 查询模板审核状态失败 查询模板审核状态失败 请参考返回的Error Message检查请求参数并修改 400 KM.90014023 智能短信模板素材上传失败 智能短信模板素材上传失败 请参考返回的Error Message检查请求参数并修改 400 KM.90014105 无法下载资源文件 无法下载资源文件 请参考返回的Error Message，或者请联系技术支持 400 KM.90014106 文件名称过长，请修改后重新上传 文件名称过长，请修改后重新上传 请修改文件名称长度 400 KM.90014107 上传素材失败，非法的文件类型 上传素材失败，非法的文件类型 请修改文件类型 400 KM.90014108 上传素材失败，文件大小超出限制 上传素材失败，文件大小超出限制 请修改文件大小 400 KM.90015015 认证失败，用户所属企业为空 认证失败，用户所属企业为空 请完善用户企业信息 400 KM.90016009 上传素材失败 上传素材失败 请参考返回的Error Message检查素材类型及大小 400 KM.90016101 模板审核中，删除模板失败 模板审核中，删除模板失败 请等待模板审核后再删除 400 KM.90016102 企业用户无法删除公共模板，删除模板失败 企业用户无法删除公共模板，删除模板失败 请勿删除公共模板 400 KM.90016103 删除模板失败 删除模板失败 请检查模板类型是否为非审核状态下的个人模板 400 KM.90016104 模板已删除，无法再次删除，删除模板失败 模板已删除，无法再次删除，删除模板失败 请检查模板是否已删除 400 KM.90016105 模板不存在，删除模板失败 模板不存在，删除模板失败 请检查请求模板信息是否有误 400 KM.90016106 启用/禁用模板失败，未提交或审核中的模板不可修改状态 启用/禁用模板失败，未提交或审核中的模板不可修改状态 请提交并审核通过之后修改模板 400 KM.90016107 企业用户无法修改公共模板状态 企业用户无法修改公共模板状态 请勿修改公共模板状态 400 KM.90016108 设置模板状态异常 设置模板状态异常 请参考返回的Error Message，或者请联系技术支持 400 KM.90016112 禁用原因不能为空 禁用原因不能为空 请填写禁用原因 400 KM.90016113 启用/禁用的模板不存在 启用/禁用的模板不存在 请启用/禁用存在的模板 400 KM.90016209 查询模板列表失败 查询模板列表失败 请参考返回的Error Message，或者请联系技术支持 400 KM.90016301 手机号码数超过最大值 手机号码数超过最大值 请修改单次请求手机号码数量并分批次请求 400 KM.90016403 请求短链数量超过限制 请求短链数量超过限制 请修改单次短链请求数量并分批次请求 400 KM.90016405 模板不存在，不能生成短链 模板不存在，不能生成短链 请选择存在的模板 400 KM.90016406 模板未生效，生成短链失败 模板未生效，生成短链失败 请选择已生效的模板 400 KM.90016407 生成短链失败 生成短链失败 请参考返回的Error Message，或者请联系技术支持 400 KM.90016408 非法模板，不能生成短链 非法模板，不能生成短链 请选择合法模板 400 KM.90016410 当前timestamp已过期 当前timestamp已过期 请检查timestamp并修改 400 KM.90016411 当前账号已被禁用 当前账号已被禁用 请参考返回的Error Message，或者请联系技术支持 400 KM.90016412 当前账号已失效 当前账号已失效 请参考返回的Error Message，或者请联系技术支持 400 KM.90016413 扣费失败 扣费失败 请参考返回的Error Message，或者请联系技术支持 400 KM.90016414 入参为空 入参为空 请传入参数 400 KM.90016415 参数对象集合为空 参数对象集合为空 请设置非空参数集合 400 KM.90016416 请求短码数量超过限制 请求短码数量超过限制 请修改单次短码请求数量并分批次请求 400 KM.90016417 签名个数不合法 签名个数不合法 请填写合法签名个数 400 KM.90016418 智能短信编码类型不合法 智能短信编码类型不合法 请检查短信编码类型并修改 400 KM.90016419 展示次数不合法 展示次数不合法 请检查展示次数并修改 400 KM.90016420 签名长度不合法 签名长度不合法 请检查签名长度并修改 400 KM.90016421 客户标志不合法 客户标志不合法 请检查客户标志并修改 400 KM.90016422 自定义消息ID过长 自定义消息ID过长 请检查自定义消息ID并修改 400 KM.90016423 自定义跳转链接过长 自定义跳转链接过长 请检查自定义跳转链接长度并修改 400 KM.90016424 自定义参数过长 自定义参数过长 请修改自定义参数长度 400 KM.90016425 变参个数不合法 变参个数不合法 请检查变参个数并修改 400 KM.90016426 变参名或变参序号不合法 变参名或变参序号不合法 请参考返回的Error Message，或者请联系技术支持 400 KM.90016427 非法企业模板，无法生成短链 非法企业模板，无法生成短链 请选择合法企业模板 400 KM.90016428 非法代理商模板，无法生成短链 非法代理商模板，无法生成短链 请选择合法代理商模板 400 KM.90016435 批量查询账号余额的个数不符 批量查询账号余额的个数不符 请参考返回的Error Message，或者请联系技术支持 400 KM.90016436 产品类型非法 产品类型非法 请填写合法产品类型 400 KM.90016437 查询余额失败 查询余额失败 请参考返回的Error Message，或者请联系技术支持 400 KM.90016439 查询的发送账号所属公司不符 查询的发送账号所属公司不符 请检查发送账号所属公司 400 KM.90016440 失效时间不合法 失效时间不合法 请修改失效时间 400 KM.90016441 发送账号不存在 发送账号不存在 请联系技术支持 400 KM.90016442 OPPO每次申请短链不能超过10个 OPPO每次申请短链不能超过10个 请减少申请短链数在10个以内 400 KM.90016455 查询开始时间或结束时间参数为空 查询开始时间或结束时间参数为空 请同时传入开始时间和结束时间 400 KM.90016456 分页信息为空 分页信息为空 请添加分页信息 400 KM.90016457 分页信息不合法 分页信息不合法 请修改分页信息 400 KM.90016458 查询开始时间或结束时间参数不合法 查询开始时间或结束时间参数不合法 请检查时间格式是否与接口要求一致 400 KM.90016459 查询开始时间和结束时间间隔过大 查询开始时间和结束时间间隔过大 请缩短查询时间段 400 KM.90016462 参数内容包含敏感词 参数内容包含敏感词 请检查参数内容中是否包含敏感词 400 KM.90016463 OPPO模板一次只允许申请一个群发短链 OPPO模板一次只允许申请一个群发短链 请更换为非OPPO模板或单次只申请一个群发短链 400 KM.90016464 模板不属于该企业 模板不属于该企业 请检查模板是否属于该企业 400 KM.90016482 存在重复的自定义短链 存在重复的自定义短链 请检查自定义短链是否重复，修改后重试 400 KM.90016801 包含敏感词 包含敏感词 请检查请求参数中的敏感词，删除敏感词并重试 400 KM.90016802 卡片动参数据与协议动参数据不一致 卡片动参数据与协议动参数据不一致 请修改卡片动参与协议动参一致 400 KM.90016803 请求参数错误 请求参数错误 请参考返回的Error Message检查请求参数并修改 400 KM.90016804 提交模板失败 提交模板失败 请参考返回的Error Message检查请求参数并修改 400 KM.90016805 模板协议错误，请检查协议格式 模板协议错误，请检查协议格式 请检查协议格式并修改 400 KM.90018111 资源文本中存在http链接，无法转换 资源文本中存在http链接，无法转换 请去除资源文本中的http链接 400 KM.90019000 请求参数不合法 请求参数不合法 请参考返回的Error Message检查请求参数 400 KM.90019001 鉴权失败 鉴权失败 请前往控制台完成账号授权 400 KM.90020000 未识别错误码 未识别错误码 请联系技术支持 400 KM.90022015 待发送短信数量太大 待发送短信数量太大 请修改单次发送数量并分批次发送 400 KM.90022028 模板变量校验失败 模板变量校验失败 请修改模板变量 400 KM.90022029 模板类型校验失败 模板类型校验失败 请修改模板类型 400 KM.90022030 模板未激活 模板未激活 请激活模板 400 KM.90022031 协议校验失败 协议校验失败 请检查协议并修改 400 KM.90022033 模板类型不正确 模板类型不正确 请检查模板类型并修改 400 KM.90022041 同一短信内容接收号码重复 同一短信内容接收号码重复 请去除重复接收号码 400 KM.90022042 回调地址为空 回调地址为空 检查是否存上报回调地址 403 KM.00000403 鉴权失败 鉴权失败 前往控制台完成账号授权 403 KM.90019004 API Token校验失败 API Token校验失败 重新 获取Token 500 KM.00000001 内部错误 内部错误 请联系技术支持 500 KM.90010000 未识别错误码 未识别错误码 请联系技术支持 500 KM.90011001 请求外部系统获取解析短链失败 请求外部系统获取解析短链失败 请联系技术支持 500 KM.90019003 服务异常 服务异常 请联系技术支持 父主题： 附录

修订记录 发布日期 修订记录 2025-01-06 第三十四次正式发布。 修改： 查询通道号列表，新增Query参数is_bind，绑定状态，同步更新代码示例。 生成解析任务，修改请求Body参数params参数说明，删除“OPPO模板一次最多申请10个短链”。 2024-10-10 第三十三次正式发布。 修改： 创建个人模板，修改factory_type请求参数描述，增加VIVO厂商支持“单卡券（CardVoucher）”，同步修改单卡券涉及的请求示例。 2024-08-02 第三十二次正式发布。 修改： 一站式服务号创建，新增请求参数areas_for_auto_get_port，同步更新请求示例；修改authorization_files请求参数描述，增加“支持jpg、bmp、png和jpeg格式，全部图片总大小不超过4M”；修改请求参数description的可选性，由“否”改为“是”。 上传智能信息服务号图片资源，修改file_type请求参数，BG_IMAGE和FASTAPP_LOGO增加图片规格。 查询通道号列表，修改type请参数描述，增加“缺省值：0”。 注册通道号，修改authorization_files请求参数描述，增加“支持jpg、bmp、png和jpeg格式，全部图片总大小不超过4M”。 通道号绑定服务号，修改province请求参数描述，删除省份信息，增加新的省市地区列表，同步更新请求示例。 修改主页信息，修改请求参数name、logo_img、description、deeplink、depend_engine_version的可选性，由“否”改为“是”。 更新服务号信息，新增请求参数areas_for_auto_get_port；修改请求参数pub_abstract的可选性，由“是”改为“否”；修改pub_remark请求参数描述，服务号备注。 查询服务号列表，新增响应参数approve_state、areas_for_auto_get_port，同步更新响应示例。 查询智能信息服务号菜单，新增响应参数company_id、company_name，同步更新响应示例。 查询模板，新增响应参数match_type、card_id、sub_type、preview_url、tpl_id。 上传智能信息模板素材，修改image_rate请求参数描述，增加“threeToFour：指3:4比例”。 查询智能消息模板素材列表，新增响应参数obs_bucket_name、domain_id、size、obs_file_url、size；修改image_rate请求参数描述，增加“threeToFour：指3:4比例”。 查询视频模板封面图，新增响应参数obs_file_url、size；修改image_rate请求参数描述，增加“threeToFour：指3:4比例”。 2024-07-09 第三十一次正式发布。 修改： 创建个人模板，修改请求参数floor_type参数说明，删除OPPO和VIVO不支持打开H5页面相关描述；修改请求参数factory_type参数描述，OPPO支持单卡券（CardVoucher）布局类型，VIVO支持个性化红包类（RedPacketPersonal）布局类型，同步更新相应的请求示例。 删除短信签名，更新API的URI，同时更新请求示例。 2024-05-22 第三十次正式发布。 修改： 查询模板报表，更新API的URI，同时更新请求示例。 生成解析任务，修改请求Body参数resolving_time参数说明，增加“群发短链设置解析次数需要大于等于2”。 发送智能信息，修改aim_code_type、expiration_time、params参数描述，删除群发（group）短链相关信息。 2024-04-01 第二十九次正式发布。 修改： 创建个人模板，修改sub_type请求参数描述，增加card_id为CarouselVerticalImage、CardVoucher和ShortVideoImage时的sub_type参数规格，刷新card_id为RedPacket和RedPacketPersonal、ECImageAndText时的sub_type参数规格。 2024-01-31 第二十八次正式发布。 修改： 查询模板报表，修改tpl_ids请求参数数组长度，由“0-100”改为“1-100”；增加请求参数factory_type，厂商类型。 创建个人模板，修改功能介绍说明，模板内容需加“拒收请回复R”；请求示例中，content值末尾增加“拒收请回复R”。 上传智能信息模板素材，修改resource_type请求参数说明，视频大小由不超过“10M”改为“7M”。 生成解析任务，修改sms_signs请求参数描述，最多传入签名个数由“10”改为“5”，数组长度由“0-10”改为“1-5”；修改params请求参数说明，增加“群发短链每次调用最多申请一条”；修改custom_url请求参数描述，长度要求由不超过“2048”改为“256”。 新建智能信息基础版模板，增加请求参数is_draft，以草稿状态提交模板，同时更新请求示例。 查询智能信息基础版模板状态，修改Query参数offset、limit的必选性，由“是”改为“否”。 2024-01-16 第二十七次正式发布。 修改： 一站式服务号创建、查询智能信息服务号菜单、修改智能信息服务号菜单，修改third_service_name请求参数说明，增加“action_type=OPEN_APP”。 查询解析任务，修改Query参数begin_time参数说明，增加“仅支持查询最近1年内创建的解析任务”。 查询解析明细，修改Query参数begin_time参数说明，增加“仅支持查询最近1年内创建的短链”。 查询智能信息发送任务，修改Query参数begin_time参数说明，增加“仅支持查询最近1年内创建的智能信息发送任务”。 查询智能信息发送明细，修改Query参数begin_time参数说明，增加“仅支持查询最近1年内的发送明细”。 2023-12-13 第二十六次正式发布。 修改： 创建个人模板，修改card_id请求参数描述，增加“EcommerceCouponHorizontal：电商领券类横版”布局类型；修改sub_type请求参数说明，当card_id为EcommerceCouponHorizontal时，sub_type用于设置卡券区是否隐藏；修改请求参数button_type描述，当模板为电商领券类横版时，用于指定按钮类型；修改factory_type请求参数描述，HUAWEI厂商增加“电商领券类横版（EcommerceCouponHorizontal）”布局类型；增加“创建电商领券类横版模板(EcommerceCouponHorizontal)”请求示例。 2023-11-16 第二十五次正式发布。 修改： 创建个人模板，修改card_id请求参数描述，增加“EcommerceCouponVertical：电商领券类竖版”布局类型；修改sub_type请求参数说明，当card_id为EcommerceCouponVertical时，sub_type用于设置卡券区是否隐藏；增加请求参数button_type，当模板为电商领券类竖版时，用于指定按钮类型；修改factory_type请求参数描述，HUAWEI厂商增加“电商领券类竖版（EcommerceCouponVertical）”布局类型；增加“创建电商领券类竖版模板(EcommerceCouponVertical)”请求示例。 2023-10-18 第二十四次正式发布。 修改： 上传智能信息服务号图片资源，修改file_type请求参数描述，PUB_LOGO的大小由“不超过4M”改为“不超过100k”。 查询模板，修改Query参数factory_type，增加三星厂商类型，同时数组长度由“0-5”改为“0-6”。 创建个人模板，修改action_type请求参数说明，增加“三星厂商点击事件类型不支持新建日程、打开大图”；修改floor_type请求参数说明，增加三星厂商不支持的兜底类型说明；修改factory_type请求参数描述，增加三星厂商类型，同时增加三星厂商支持的布局类型。 发送智能信息，修改expiration_time请求参数描述，aim_code_type为group时，expiration_time取值范围从“1~100”修改为“1~180”。 定义模板状态回执，修改factory_type请求参数描述，增加三星厂商类型。 2023-09-27 第二十三次正式发布。 修改： 生成解析任务，修改expiration_time请求参数描述，aim_code_type为group时，expiration_time取值范围从“1~100”修改为“1~180”。 2023-08-29 第二十二次正式发布。 新增： 设置视频模板封面图 查询视频模板封面图 修改： 创建个人模板，修改功能介绍说明，增加“&”；修改src_type请求参数描述，增加说明“src_type为2，即资源地址时，src或cover内容必须是存储在客户侧服务器上的资源地址”；修改cover请求参数说明，增加“通过设置视频模板封面图接口设置视频封面”；修改创建电商类多商品模板(Ecommerce)(显示货币符号)请求示例，当type为text、content为按钮时，visible由“0”改为“1”。 2023-08-21 第二十一次正式发布。 新增： 短信应用，包含短信应用的创建、查询、修改等接口。 短信签名，包含短信签名的创建、查询、修改等接口。 短信模板，包含短信模板的创建、查询、修改等接口。 短信发送，包含短信发送的分批发送等接口。 修改： 一站式服务号创建、修改主页信息，修改logo_img请求参数说明，删除“比例+-0.15”，将“大小不超过5M”改为“大小不超过4M”。 上传智能信息服务号图片资源，修改file_type请求参数描述，PUB_LOGO、BG_IMAGE和FASTAPP_LOGO增加图片规格。 查询解析任务、查询解析明细，增加Query参数和响应参数，该参数为task_name，任务名称，并同步修改响应示例。 注册智能信息回执URL，修改url_type参数描述，修改“0：智能信息发送回调”为“0：智能信息单条发送回调”，增加“2：智能信息批量发送回调”；修改请求示例描述，修改“注册回执-智能信息发送回执”为“注册回执-智能信息单条发送回执”；增加“注册回执-智能信息批量发送回执”请求示例。 定义智能信息发送回执，修改body请求参数描述，增加参数约束“回调类型为智能信息单条发送/短链回调”和“回调类型为智能信息批量发送/短链回调”；增加请求参数total、sequence和extend；增加“定义短信批量回执”和“定义短链批量回执”请求示例。 错误码，新增短信接口相关的错误码。 2023-08-03 第二十次正式发布。 创建个人模板，修改card_id请求参数描述，增加“ShortVideoImage：短剧图片类”布局类型；修改factory_type请求参数描述，厂商“HUAWEI”支持的布局类型增加“短剧图片类（ShortVideoImage）”；增加“创建短剧图片模板(ShortVideoImage)”请求示例。 2023-07-27 第十九次正式发布。 修改： 创建个人模板，修改请求示例，包括示例描述和示例代码。 2023-07-20 第十八次正式发布。 修改： 查询模板，修改factory_type参数描述，“Xiaomi：小米”改为“XIAOMI：小米”；删除tpl_state响应参数说明，删除“智能信息模板启动、禁用暂为运营管理功能，Console页面与API暂未开放此功能”。 定义智能信息基础版发送回执，修改请求示例描述，将“手机用户下行消息接受成功”改为“手机用户下行消息接收成功”。 2023-07-14 第十七次正式发布。 修改： 解冻服务号，增加响应示例。 冻结服务号，修改响应参数结构体，并同步修改响应示例。 查询解析明细，修改resolved_status响应参数类型，“Object”改为“String”。 查询智能信息基础版模板状态，修改tpl_size和status响应参数类型，“String”改为“Integer”。 API，根据统一的要求，优化接口请求示例描述。 2023-06-16 第十六次正式发布。 修改： 创建个人模板，修改oppo_background请求参数描述，增加参数描述“OPPO红包背景图要求宽高比为3:4，建议尺寸为342px*456px”。 生成解析任务，修改aim_code_type请求参数描述，删除参数说明“使用动态参数模板时，该字段只能为individual”。 2023-05-30 第十五次正式发布。 新增： 启用或禁用模板实例 修改： 创建个人模板，修改sub_type请求参数描述，当card_id为ECImageAndText时，sub_type用于设置左右按钮组合颜色；增加请求参数ratio，短视频模板视频和封面的宽高比；增加创建电商类模板（ECImageAndText）（设置按钮颜色）请求示例。 发送智能信息基础版任务，修改mobiles请求参数描述和可选性，非必选，mobiles和individual_params字段只能二选一；修改dync_params请求参数描述，群发动态参数数组；增加请求参数individual_params，个性化手机号码及动态参数数组；增加发送智能信息基础版任务-个性化动态参数请求示例。 2023-05-26 第十四次正式发布。 修改： 创建个人模板，修改card_id请求参数描述，增加海报类（SimplePoster）、超文本普通类（NativePureText）、超文本增强类（NativeImageAndText）和短视频类（ShortVideo）模板类型；修改factory_type请求参数描述，HUAWEI厂商增加海报类（SimplePoster）、超文本普通类（NativePureText）、超文本增强（NativeImageAndText）和短视频类（ShortVideo）布局类型；增加创建海报类模板（SimplePoster）、创建超文本普通类模板（NativePureText）、创建超文本增强类模板（NativeImageAndText）和创建短视频模板（ShortVideo）请求示例。 查询智能信息基础版发送任务，修改请求示例名称，“查询视频短信发送任务”改为“查询智能信息基础版发送任务”。 发送智能信息基础版任务，修改请求示例名称，“发送视频短信任务-动态参数”改为“发送智能信息基础版任务-动态参数”。 2023-05-17 第十三次正式发布。 修改： 定义智能信息基础版模板状态回执，修改type请求参数描述，动参变量类型删除图片、音频和视频。 新建智能信息基础版模板，修改type请求参数描述，增加mp4视频资源类型；修改content请求参数说明，图片不支持使用#p_n#参数变量，故删除“图片”描述字样。 2023-05-10 第十二次正式发布。 修改： 生成解析任务、查询智能信息发送任务、发送智能信息，修改custom_url参数描述，长度要求不超过2048。 2023-04-23 第十一次正式发布。 修改： 查询模板，增加Query参数is_only_status，响应里只返回状态信息，不返回pages和params。 创建个人模板，增加visible请求参数说明，目前仅针对电商多商品（Ecommerce）、多卡券（CardVouchers）、增强机票类（PlaneTrip）这三种版式起效。 定义模板状态回执，修改audit_state请求参数说明，模板审核状态补充说明；修改state请求参数约束，厂商审核状态。 2023-03-31 第十次正式发布。 修改： 创建个人模板，增加请求参数sub_type，版式子类型；增加个性化红包类模板请求示例，创建个性化红包类模板（RedPacketPersonal）（样式2）。 定义模板状态回执，修改factory_type请求参数描述，同时修改对应的请求示例，华为厂商改为“HuaWei”、小米厂商改为“XiaoMi”。 2023-03-13 第九次正式发布。 修改： 创建个人模板，增加card_id请求参数说明，当送审厂商包含vivo时，各布局类型上传的图片最小像素。 新建智能信息基础版模板，修改index请求参数说明，最大帧数为8帧，2个元素的帧最多2个，index只能全部填或全为空。 2023-03-03 第八次正式发布。 修改： 发送智能信息，修改sms_params参数描述，增加短信模板参数的变量格式和限制信息。 新建智能信息基础版模板，修改title请求参数描述，智能信息基础版模板主题最大不超过20个字。 查询智能信息基础版模板状态，修改tpl_size响应参数说明，删除“audit_status非0时tpl_size为0”。 2023-02-24 第七次正式发布。 修改： 发送智能信息基础版任务，修改tpl_id请求参数约束，智能信息基础版模板ID最大长度是10；增加mobiles请求参数说明，长度指的是单个号码的长度。 2023-02-17 第六次正式发布。 修改： 查询模板报表，修改expose_uv、expose_pv、click_uv、click_pv响应参数描述，删除“暂时不提供”。 创建个人模板，修改card_id请求参数描述，增加Ecommerce（电商多商品类）、Trip1（机票类）、Trip2（火车票类）、Trip3（汽车票类）和PlaneTrip（增强机票类）五种布局类型，同时增加各类型对应的请求示例；增加请求参数content_child；修改factory_type请求参数说明，增加华为厂商（HUAWEI）支持的布局类型。 发送智能信息，修改dync_params参数描述，智能信息模板动态参数；增加参数sms_params，短信模板参数。 2023-02-07 第五次正式发布。 修改： 查询通道号列表，增加响应参数is_bind、pub_list、pub_name和pub_reference。 创建个人模板，修改sms_template请求参数说明，历史遗留字段，建议不再使用。 查询智能信息发送报表，修改report_type请求参数说明与必选性，非必选，默认查询日报表。 2023-01-13 第四次正式发布。 修改： 创建个人模板，增加type请求参数说明，图片轮播类模板最多可以放5张图片。 查询解析任务、生成解析任务、查询智能信息发送任务、发送智能信息，修改domain参数样例，带路径的短链 域名 结尾不能带“/”。 2023-01-11 第三次正式发布。 修改： 创建个人模板，删除创建横滑类1模板（Carousel）、创建横滑类2模板（CarouselTitle）请求示例中的参数src_type。 上传智能信息模板素材，修改功能介绍说明，增加删除资源的条件和逻辑。 生成解析任务，修改params请求参数说明，OPPO模板一次最多申请10个短链。 新建智能信息基础版模板，修改index请求参数说明，补充说明最大帧数。 查询智能信息基础版模板状态，增加Query参数begin_time与end_time。 2022-11-28 第二次正式发布。 新增： 注册智能信息基础版回执URL 查询用户已注册智能信息基础版回执接口 定义智能信息基础版发送回执 定义智能信息基础版上行消息回执 修改： API，修改接口参数与示例，两者一一对应。 查询模板，增加begin_time、end_time参数约束说明；修改factory_type请求参数描述。 创建个人模板，增加功能介绍说明；新增请求参数sms_signs、sms_template和vivo_background；修改action_type、factory_type请求参数描述。 上传智能信息模板素材，增加功能介绍说明。 查询解析任务，修改domain参数描述。 生成解析任务，修改custom_url参数说明；修改custom_short_code参数描述；修改domain、params参数描述。 查询手机号智能信息解析能力，增加tpl_id参数描述。 查询解析明细，修改aim_url参数约束描述。 查询智能信息发送任务，修改task_name参数描述；新增failed_short_chains、 success_number响应参数；修改domain参数描述。 发送智能信息，修改task_name、expiration_time参数描述；增加请求参数task_name描述说明；修改custom_url参数说明；新增failed_short_chains响应参数；修改custom_short_code参数描述；修改domain、params参数描述。 注册智能信息回执URL，修改callback_url参数说明。 新建智能信息基础版模板，删除请求参数reminders。 错误码 2022-11-04 第一次正式发布。

支持的授权项 细粒度策略支持的操作与API相对应，授权项列表说明如下： 权限：自定义策略中授权项定义的内容即为权限。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 授权范围：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM项目和企业项目的区别。 云消息 服务管理控制操作相关的授权项，明细如下表所示。用户调用如下API时，需要获取对应的权限。权限获取请参考 统一身份认证 服务（IAM）的帮助指导。 “√”表示支持，“x”表示暂不支持。 表1 云消息服务权限明细 权限描述 授权项 对应的API IAM项目（Project） 企业项目（Enterprise Project） 查询智能信息模板 kooMessage:devTemplate:list GET /v1/aim/templates √ × 查询智能信息模板报表 kooMessage:devTemplateReport:list POST /v1/aim/tempalte-reports/query √ × 生成智能信息解析任务 kooMessage:devResolveTask:create POST /v1/aim/resolve-tasks √ × 查询智能信息解析任务 kooMessage:devResolveTask:list GET /v1/aim/resolve-tasks √ × 查询手机号码智能信息解析能力 kooMessage:devMobileCapability:check POST /v1/aim/mobile-capabilities/check √ × 发送智能信息 kooMessage:devSendTask:create POST /v1/aim/send-tasks POST /v1/aim/sms/messages POST /v1/aim/sms/diff-messages √ × 查询智能信息发送任务 kooMessage:devSendTask:list GET /v1/aim/send-tasks √ × 查询短信应用 kooMessage:aimMsgApp:list GET /v1/sms/apps GET /v1/sms/apps/{app_id} √ × 创建短信应用 kooMessage:aimMsgApp:create POST /v1/sms/apps √ × 修改短信应用 kooMessage:aimMsgApp:update PUT /v1/sms/apps/{app_id} √ × 查询短信签名 kooMessage:aimMsgSignature:list GET /v1/sms/signatures GET /v1/sms/signatures/{signature_id} GET /v1/sms/signatures/files √ × 创建短信签名 kooMessage:aimMsgSignature:create POST /v1/sms/signatures POST /v1/sms/signatures/files √ × 删除短信签名 kooMessage:aimMsgSignature:delete DELETE /v1/sms/signatures/{signature_id} √ × 修改短信签名 kooMessage:aimMsgSignature:update PUT /v1/sms/signatures/{signature_id} √ × 创建短信模板 kooMessage:aimMsgTemplate:create POST /v1/sms/templates √ × 查询短信模板 kooMessage:aimMsgTemplate:list GET /v1/sms/templates GET /v1/sms/templates/{template_id} √ × 删除短信模板 kooMessage:aimMsgTemplate:delete DELETE /v1/sms/templates/{template_id} √ × 修改短信模板 kooMessage:aimMsgTemplate:update PUT /v1/sms/templates/{template_id} √ × 创建企业基本信息 kooMessage:aimSaCompany:create POST /v1/aim-sa/companies √ × 查询企业基本信息 kooMessage:aimSaCompany:list GET /v1/aim-sa/companies √ × 下载企业资料模板 kooMessage:aimSaCompany:upload GET /v1/aim-sa/companies/download √ × 上传企业资料 kooMessage:aimSaCompany:upload POST /v1/aim-sa/companies/upload √ × 更新企业资料 kooMessage:aimSaCompany:update PUT /v1/aim-sa/companies/{company_id} √ × 上传智能信息服务号的资源 kooMessage:aimSaMedia:upload POST /v1/aim-sa/media/upload √ × 查询智能信息服务号的资源 kooMessage:aimSaMedia:list GET /v1/aim-sa/media/upload √ × 创建智能信息服务号的菜单 kooMessage:aimSaMenu:create POST /v1/aim-sa/menu √ × 更新智能信息服务号的菜单 kooMessage:aimSaMenu:update PUT /v1/aim-sa/menus/{menu_id} √ × 查询智能信息服务号的菜单 kooMessage:aimSaMenu:list GET /v1/aim-sa/menus √ × 创建智能信息服务号的商家 kooMessage:aimSaMerchant:create POST /v1/aim-sa/merchants √ × 更新智能信息服务号的商家 kooMessage:aimSaMerchant:update PUT /v1/aim-sa/merchants/{merchant_id} √ × 查询智能信息服务号的商家 kooMessage:aimSaMerchant:list GET /v1/aim-sa/merchants √ × 创建智能信息服务号的主页 kooMessage:aimSaPortal:create POST /v1/aim-sa/portals √ × 更新智能信息服务号的主页 kooMessage:aimSaPortal:update PUT /v1/aim-sa/portals/{portal_id} √ × 查询智能信息服务号的主页 kooMessage:aimSaPortal:list GET /v1/aim-sa/portals √ × 创建智能信息服务号的端口号 kooMessage:aimSaPort:create POST /v1/aim-sa/ports √ × 查询智能信息服务号的端口号 kooMessage:aimSaPort:list GET /v1/aim-sa/ports √ × 通道号绑定服务号 kooMessage:aimSaPortAssociate:create POST /v1/aim-sa/ports/associate √ × 通道号解绑服务号 kooMessage:aimSaPortAssociate:delete POST /v1/aim-sa/ports/disassociate √ × 删除通道号 kooMessage:aimSaPort:delete DELETE /v1/aim-sa/ports/{port_id} √ × 创建服务号 kooMessage:aimSaPub:create POST /v1/aim-sa/pubs √ × 更新服务号 kooMessage:aimSaPub:update POST /v1/aim-sa/pubs/{pub_id} √ × 冻结服务号 kooMessage:aimSaPub:freeze POST /v1/aim-sa/pubs/{pub_id}/freeze √ × 查询服务号 kooMessage:aimSaPub:list GET /v1/aim-sa/pubs √ × 创建智能信息基础版模板 kooMessage:devAimBasicTemplate:create POST /v1/aim-basic/templates √ × 查询智能信息基础版模板 kooMessage:devAimBasicTemplate:list GET /v1/aim-basic/templates √ × 创建智能信息基础版发送任务 kooMessage:devAimBasicMsgTask:create POST /v1/aim-basic/send-tasks √ × 查询智能信息基础版发送任务 kooMessage:devAimBasicMsgTask:list GET /v1/aim-basic/send-tasks √ ×

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 tplid String 智能信息基础版模板ID。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

请求示例 新建智能信息基础版模板。模板名称为"测试-路由器推广"，有效期为1天。 https://koomessage.myhuaweicloud.cn/v1/aim-basic/templates{ "tpl_name" : "测试-路由器推广", "title" : "测试主题", "reslist" : [ { "type" : "txt", "name" : "广告文本", "source" : "txt", "content" : "【华为云】测试-尊敬的#p_1#你好，最新路由器出来啦" }, { "type" : "jpg", "name" : "one.jpg", "source" : "file", "content" : "iVBORw0KGgoAAAANSUhEUgAAAKoAAABOCAYAAACwo40WAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2Fy..." }, { "type" : "jpg", "name" : "two.jpg", "source" : "file", "content" : "iVBORw0KGgoAAAANSUhEUgAAAKoAAABOCAYAAACwo40WAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAAEXRFWHRTb2Z0d2FyZQBTbmlwYXN0ZV0Xzt0AACAASURB..." }, { "type" : "png", "name" : "three.png", "source" : "url", "content" : "https://dss0.bdstatic.com/5aV1bjqh_Q23odCf/static/superman/img/topnav/tupian@2x-482fc011fc.png" } ], "remarks" : "请将此模板类型设置为绑定通道类型是三网合一通道", "expiration_time" : 1, "is_draft" : 0}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 expiration_time 是 String 智能信息基础版模板有效期。单位：天，必须取整，最长9999天。 tpl_name 是 String 智能信息基础版模板名称。模板的别名，用来帮助记忆。最大不超过100个字，若使用中文需经过UTF-8编码。 title 是 String 智能信息基础版模板主题，最大不超过20个字，若使用中文需经过UTF-8 编码，主题不能包含“【】”，否则审核会不通过。 reslist 是 Array of ResourceInfo objects 模板资源列表，由按顺序排列的资源组成，资源类型支持文本、图片、音频、视频。 说明： 资源在JSON数组中的顺序将决定其在手机上的显示顺序，数组大小不能超过10。 数组长度：1 - 10 remarks 否 String 智能信息基础版模板备注信息，用于填写对模板审核的期望或要求，最大不超过200个字。例如：希望这个模板绑定的通道类型是三网合一通道，默认优先绑定三网合一通道。 callbackurl 否 String 客户系统回调URL，可用于通知对端模板审核状态信息。 说明： 接口规格需参照定义智能信息基础版模板状态回执完成实现。 is_draft 否 Integer 以草稿状态提交模板。 0：非草稿模板 1：草稿模板 缺省值：0 表3 ResourceInfo 参数 是否必选 参数类型 描述 index 否 String 智能信息基础版序号。 从1开始，例如: 1-1，表示第1帧第1个元素；1-2：表示第1帧第2个元素；2-1：表示第2帧第1个元素。 说明： 每帧支持最多2个元素，2个元素中必须包含有文本 如果未填该字段，则每个元素独占一帧并按数组顺序排序 最多支持8帧 最多2帧同时包含2个元素 index必须全部指定，或者全为空，不能重复 type 是 String 智能信息基础版资源类型。 类型为文字填：txt 类型为图片填：jpg/jpeg/png/gif 类型为音频填：mp3/wav 类型为视频填：mp4/3gp name 是 String 智能信息基础版资源名称。 source 是 String 智能信息基础版资源来源。 txt：表示资源内容是纯文字 file：表示资源内容来源于文件流 url：表示资源内容来源于URL外链 说明： 资源来自于文字/文件流/URL外链。 content 是 String 智能信息基础版资源信息内容。 当source=txt时，填写经过UTF-8编码的文字 当source=file时，填写经过Base64编码的文件流，不须带文件格式前缀，样例："iVBORw0KGgoAAAANSUhEUgA..."，样例过长，未显示全部 当source=url时，填写资源URL地址，URL长度不能超过1024个字节 说明： 文字中可以使用#p_n#参数变量占位，n为1~100内的数字，相同类型的资源同一参数占位符可复用。如：#p_1#已表示是文本参数占位符时，其它位置的文本类型资源可以包含该文本参数占位符。不能包含除模板签名外的“【】” 第一个文本帧，内容必须以：【签名】开始，“签名” 标识客户信息

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Array of SmsSignatureInfo objects 查询结果。 page_info Page object 分页信息。 表4 SmsSignatureInfo 参数 参数类型 描述 signature_name String 签名名称。 最小长度：1 最大长度：30 signature_id String 签名ID。 最小长度：1 最大长度：50 signature_type String 签名类型。 最小长度：1 最大长度：20 app_name String 应用名称。 最小长度：1 最大长度：30 app_id String 应用ID。 最小长度：1 最大长度：50 apply_desc String 申请说明。 最小长度：0 最大长度：100 channel_num String 国内短信通道号，仅当签名审核成功，运营人员配置完成后返回。 最小长度：1 最大长度：21 file_id String 营业执照文件ID。 最小长度：1 最大长度：50 status String 状态。 枚举值： PENDING_REVIEW：待审核 PROCESSING：内容审核通过签名在处理中 REVIEW_PASSED：处理完毕 REVIEW_NOT_PASS：审核不通过 TO_BE_ACTIVATED：待激活 PENDING_ACTIVATE：激活审核中 signature_source Integer 签名来源。 最小值：0 最大值：20 is_involved_third String 是否涉及第三方权益。 power_attorney_file_id String 授权委托书文件ID。 最小长度：1 最大长度：50 urge_status String 催审状态。 最小长度：1 最大长度：20 urge_time String 催审时间。 最小长度：1 最大长度：20 urge_desc String 催审描述。 最小长度：0 最大长度：64 review_desc String 审核意见。 最小长度：0 最大长度：500 source_title_content String 标题内容。 最小长度：1 最大长度：180 create_time String 创建时间。 最小长度：1 最大长度：20 表5 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 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