华为云用户手册

URI GET /v1/aim/send-details 表1 Query参数 参数 是否必选 参数类型 描述 task_id 否 String 任务ID。 最小长度：0 最大长度：36 tpl_id 否 String 智能信息模板ID。 最小长度：0 最大长度：9 sms_sign 否 String 签名。 最小长度：0 最大长度：18 cust_flag 否 String 创建解析任务时填写用户唯一标识。 说明： 手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。 最小长度：0 最大长度：64 begin_time 否 String 发送开始时间。格式为：2019-10-12T07:20:50Z。 说明： 需同时传入end_time才能生效，单独传begin_time不会作为过滤条件。 仅支持查询最近1年内的发送明细。 最小长度：0 最大长度：30 end_time 否 String 发送结束时间。格式为：2019-10-12T07:20:50Z。 说明： 需同时传入begin_time才能生效，单独传end_time不会作为过滤条件。 最小长度：0 最大长度：30 offset 是 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 说明： 为提高查询效率，offset+limit须小于等于10000，超出范围查询为空。 最小值：0 最大值：1000000 limit 是 Integer 每页显示的条目数量。 最小值：1 最大值：100

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 task_id String 任务ID。 最小长度：1 最大长度：50 status String 任务状态。 Success：发送成功 Failed：发送失败 说明： 此状态仅代表任务提交状态，不代表智能信息发送结果。用户手机接收智能信息结果请以收到的回执结果为准，也可通过查询智能信息发送明细API获取或登录 KooMessage 控制台查看。 最小长度：1 最大长度：20 result Array of SmsDetailResponse objects 短信ID列表，当目标号码存在多个时，每个号码都会返回一个SmsID。 当返回异常响应时不携带此字段。 表4 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 表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

请求示例 向用户发送短信，短信通道号为882306039，模板ID为1512。 https://koomessage.myhuaweicloud.cn/v1/aim/sms/messages{ "channel_num" : "8823060****39", "template_id" : "1512****", "signature" : "测试签名", "app_name" : "OPACCOUNT688", "task_name" : "测试发送", "to" : [ "139274****98", "15527****78" ], "template_params" : [ "kXfvIwzs" ]}

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：0 最大长度：2000 表3 请求Body参数 参数 是否必选 参数类型 描述 change_reason 是 String 解冻原因。 最小长度：1 最大长度：200

请求示例 根据菜单ID修改智能信息服务号菜单。设置修改原因为"业务调整"，修改或添加菜单。 https://koomessage.myhuaweicloud.cn/v1/aim-sa/menus/34cffce987e64757bb9b711895714692{ "change_reason" : "业务调整", "menu" : { "menu_items" : [ { "action_type" : "OPEN_APP", "name" : "通过申请", "content" : "hap://app/xxxx.deeplink.xxxxx", "ext_msg" : { "package_name" : "baoming", "app_id" : "", "browser_floor_url" : "https://www.example.com/" } }, { "action_type" : "OPEN_URL", "name" : "打开链接", "content" : "https://www.example.com/", "ext_msg" : { "web_title" : "搜索", "open_in_browser" : "1" } }, { "action_type" : "OPEN_SUBMENU", "name" : "通过菜单", "ext_msg" : { }, "sub_menu_items" : [ { "action_type" : "OPEN_URL", "name" : "搜索一下", "sub_menu_items" : [ ], "content" : "https://www.example.com/", "ext_msg" : { "web_title" : "url标题", "open_in_browser" : "1" } }, { "action_type" : "CALLING", "name" : "电一下", "sub_menu_items" : [ ], "content" : "131****0000" }, { "action_type" : "OPEN_APP", "name" : "手机软件", "sub_menu_items" : [ ], "content" : "hap://app/xxxx.deeplink.xxxxx", "ext_msg" : { "package_name" : "开心消消乐", "app_id" : "appid", "browser_floor_url" : "https://www.example.com/" } }, { "action_type" : "OPEN_QUICK", "name" : "快应用", "sub_menu_items" : [ ], "content" : "hap://app/11111111111", "ext_msg" : { "depend_engine_ver" : "快应用引擎", "third_service_name" : "服务名" } }, { "action_type" : "OPEN_QUICK", "name" : "快应用", "sub_menu_items" : [ ], "content" : "hap://app/dfs/dfdf", "ext_msg" : { "depend_engine_ver" : "v1.1.0", "third_service_name" : "测试" } } ] } ] }}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 menu 是 Menus object 菜单配置信息。 change_reason 是 String 修改原因。 最小长度：1 最大长度：1000 表4 Menus 参数 是否必选 参数类型 描述 menu_items 是 Array of MenuItem objects 各子菜单项配置。 数组长度：0 - 3 表5 MenuItem 参数 是否必选 参数类型 描述 name 是 String 子菜单名称。 一级菜单名长度和菜单数量有关，具体约束为： 当菜单数量为1个时，菜单名长度范围在1-24个字符。 当菜单数量为2个时，菜单名长度范围在1-12个字符。 当菜单数量为3个时，菜单名长度范围在1-8个字符。 二级菜单名长度范围恒为1-16个字符。 说明： 以上字符区分中英文，一个中文占2个字符，字母和数字占1个字符，且同时生效的一组菜单内名称不能重复。 action_type 是 String 菜单动作类型。 OPEN_SUBMENU：打开子菜单 OPEN_URL：打开URL CALLING：拨打电话 OPEN_APP：打开APP OPEN_QUICK：打开快应用 最小长度：0 最大长度：30 content 否 String 对应值类型。对应不同action_type值，content含义如下： action_type=OPEN_SUBMENU：不填 action_type=OPEN_URL：参数数值为跳转URL action_type=CALLING：参数数值为电话号码 action_type=OPEN_APP：参数数值为APP的跳转deeplink action_type=OPEN_QUICK：参数数值为快应用跳转的deeplink 最小长度：0 最大长度：1000 ext_msg 否 ExtMsg object 额外需要携带的信息。 action_type=OPEN_SUBMENU时，不填 action_type=CALLING时，不填 action_type=OPEN_URL时，必填 action_type=OPEN_APP时，必填 action_type=OPEN_QUICK时，必填 sub_menu_items 否 Array of MenuItem objects 子菜单配置项。 说明： 仅当action_type=OPEN_SUBMENU时生效，且该项内不允许再配置子菜单。 数组长度：0 - 5 表6 ExtMsg 参数 是否必选 参数类型 描述 open_in_browser 否 String 打开方式。 0：webView打开 1：浏览器打开 说明： action_type=OPEN_URL必填，其他不填。 web_title 否 String 标题，必填，长度范围为1-20个字符。 说明： action_type=OPEN_URL必填，其他不填。 package_name 否 String app包名，长度范围为1-50个字符。 说明： action_type=OPEN_APP必填，其他不填。 app_id 否 String 商家应用的appid，长度范围为0-60个字符。 说明： action_type=OPEN_APP必填，其他不填。 browser_floor_url 否 String 兜底url，长度范围为0-1000个字符，支持http/https。 说明： action_type=OPEN_APP选填，其他不填。 depend_engine_ver 否 String 依赖的快应用引擎版本号，长度范围为1-50个字符。 说明： action_type=OPEN_QUICK必填，其他不填。 third_service_name 否 String 第三方服务名，长度范围为1-50个字符。 说明： action_type=OPEN_QUICK或OPEN_APP必填，其他不填。

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 data UpdateMenuRsp object 修改智能信息服务号菜单响应体。 表8 UpdateMenuRsp 参数 参数类型 描述 menu_id String 菜单ID。 log_id String 操作记录ID。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

请求示例 发送智能信息基础版任务-动态参数。模板ID为"800000002"，任务名称为"测试-行程提醒"，失效时间为72小时。 https://koomessage.myhuaweicloud.cn/v1/aim-basic/send-tasks{ "tpl_id" : "800000002", "task_name" : "测试-行程提醒", "expiration_time" : "72", "dync_params" : [ { "param_name" : "p_1", "content_type" : "txt", "content_source" : "txt", "content_detail" : "会员" }, { "param_name" : "p_2", "content_type" : "txt", "content_source" : "txt", "content_detail" : "2022-02-03" } ], "mobiles" : [ "131****0000", "131****0001" ]} 发送智能信息基础版任务-个性化动态参数。模板ID为"800000002"，任务名称为"测试-行程提醒"，失效时间为72小时。 https://koomessage.myhuaweicloud.cn/v1/aim-basic/send-tasks{ "tpl_id" : "800000002", "task_name" : "测试-行程提醒", "expiration_time" : "72", "individual_params" : [ { "mobiles" : [ "131****0000", "131****0001" ], "dync_params" : [ { "param_name" : "p_1", "content_type" : "txt", "content_source" : "txt", "content_detail" : "会员" }, { "param_name" : "p_2", "content_type" : "txt", "content_source" : "txt", "content_detail" : "2022-02-03" } ] }, { "mobiles" : [ "131****0002", "131****0003" ], "dync_params" : [ { "param_name" : "p_1", "content_type" : "txt", "content_source" : "txt", "content_detail" : "会员2" }, { "param_name" : "p_2", "content_type" : "txt", "content_source" : "txt", "content_detail" : "2022-02-05" } ] } ]}

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 data VMSTaskResponse object 发送智能信息基础版发送任务响应。 表7 VMSTaskResponse 参数 参数类型 描述 ret_code String 智能信息基础版下发结果返回码。 task_id String 智能信息基础版下发任务批次ID。 desc String 智能信息基础版下发描述信息。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 task_name 是 String 任务名称。 最小长度：0 最大长度：32 tpl_id 是 String 智能信息基础版模板ID。 最小长度：0 最大长度：10 expiration_time 否 Integer 失效时间（小时，范围是1~72小时）。 最小值：1 最大值：72 缺省值：24 mobiles 否 Array of strings 群发手机号码列表，最多支持5000个号码。 说明： 长度指的是单个号码的长度。 mobiles和individual_params字段只能二选一。 最小长度：1 最大长度：20 数组长度：1 - 5000 dync_params 否 Array of ContentParam objects 群发动态参数数组。 参数顺序按照模板创建时参数占位符的顺序传入，例如创建模板时设置动参有#p_1#、#p_2#、#p_3#，则传入的参数数组顺序第一个元素为#p_1#，第二个元素是#p_2#，第三个元素为#p_3#。 mobiles不填时，此字段被忽略。 数组长度：1 - 100 individual_params 否 Array of IndividualParam objects 个性化手机号码及动态参数数组。 mobiles和individual_params字段只能二选一。 exdata 否 String 智能信息基础版扩展字段。 最小长度：0 最大长度：256 表3 ContentParam 参数 是否必选 参数类型 描述 param_name 是 String 智能信息基础版参数名称。 最小长度：0 最大长度：64 content_type 是 String 智能信息基础版参数类型。txt：纯文字动参。 最小长度：0 最大长度：256 content_source 是 String 智能信息基础版参数源。txt：内容源自纯文字。 最小长度：0 最大长度：256 content_detail 是 String 智能信息基础版参数内容，填写经过utf-8编码的文字。 最小长度：0 最大长度：256 表4 IndividualParam 参数 是否必选 参数类型 描述 mobiles 是 Array of strings 个性化动态参数号码列表，最多支持5000个号码。 说明： 长度指的是单个号码的长度。 最小长度：1 最大长度：20 dync_params 是 Array of IndividualContentParam objects 个性化动态参数数组。 参数顺序按照模板创建时参数占位符的顺序传入，例如创建模板时设置动参有#p_1#、#p_2#、#p_3#，则传入的参数数组顺序第一个元素为#p_1#，第二个元素是#p_2#，第三个元素为#p_3#。 表5 IndividualContentParam 参数 是否必选 参数类型 描述 param_name 是 String 智能信息基础版参数名称。 最小长度：0 最大长度：64 content_type 是 String 智能信息基础版参数类型。txt：纯文字动参。 最小长度：0 最大长度：256 content_source 是 String 智能信息基础版参数源。txt：内容源自纯文字。 最小长度：0 最大长度：256 content_detail 是 String 智能信息基础版参数内容，填写经过utf-8编码的文字。 最小长度：0 最大长度：256

响应示例 状态码： 200 返回200状态码仅代表接口请求成功，任务提交结果由task_state字段来区分，此结果仅代表任务提交结果，并非智能信息发送结果。用户手机接收智能信息结果请以收到的回执结果为准，也可通过查询智能信息发送明细API获取或登录KooMessage控制台查看。 { "task_name" : "智能信息发送", "sms_channel" : { "channel_number" : "8822053111111", "sms_tpl_id" : 15010661, "sms_sign" : "华为云KooMessage", "sms_app_name" : "KooMessage" }, "resolve_task" : { "tpl_id" : "600000001", "resolve_times" : 1, "aim_code_type" : "individual", "domain" : null, "expiration_time" : 7, "generation_type" : "1", "params" : [ { "cust_flag" : "131****0000", "dync_params" : null, "custom_url" : "https://www.example.com", "custom_short_code" : null, "sms_params" : [ ] } ] }, "task_id" : "c3d7659d-06b0-4fa0-9eed-9225389ecccc", "task_state" : "Success", "creation_time" : "2022-07-19T14:37:34.00Z", "submission_count" : 1, "send_count" : 1, "resolve_count" : 0, "failed_short_chains" : [ ]}

请求示例 发送智能信息。模板ID为"600000001"，短链最大解析次数为1次，过期时间为7天，发送手机号码如"131****0000"；通道号为"8822053111111"，短信模板ID为"15010661"。 https://koomessage.myhuaweicloud.cn/v1/aim/send-tasks{ "task_name" : "智能信息发送", "sms_channel" : { "channel_number" : "8822053111111", "sms_tpl_id" : 15010661, "sms_sign" : "华为云KooMessage", "sms_app_name" : "KooMessage" }, "resolve_task" : { "tpl_id" : "600000001", "resolve_times" : 1, "aim_code_type" : "individual", "domain" : null, "expiration_time" : 7, "params" : [ { "cust_flag" : "131****0000", "custom_url" : "https://www.example.com" } ] }} 发送智能信息-动态参数。模板ID为"600000002"，短链最大解析次数为1次，过期时间为7天，发送手机号码如"131****0000"，分别设置动态参数；通道号为"8822053111111"，短信模板ID为"15010661"。 https://koomessage.myhuaweicloud.cn/v1/aim/send-tasks{ "task_name" : "智能信息发送-动态参数", "sms_channel" : { "channel_number" : "8822053111111", "sms_tpl_id" : 15010661, "sms_sign" : "华为云KooMessage", "sms_app_name" : "KooMessage" }, "resolve_task" : { "tpl_id" : "600000002", "resolve_times" : 1, "aim_code_type" : "individual", "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", "sms_params" : [ "参数1", "参数2" ] }, { "cust_flag" : "131****0001", "dync_params" : { "param1" : "参数1", "param2" : "参数2", "param3" : "参数3", "param4" : "参数4" }, "custom_url" : "https://www.example.com", "sms_params" : [ "参数1", "参数2" ] } ] }}

请求示例 根据视频封面图资源ID和AIM视频资源ID设置视频模板的封面图。 https://koomessage.myhuaweicloud.com/v1/aim/template-material-thumbnails{ "aim_resource_id" : "688676247659655168", "thumbnail_id" : "d6699714-ab80-44f4-8ce7-57db944e06c8"}

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

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 aim_resource_id 是 String AIM资源ID。 最小长度：1 最大长度：36 thumbnail_id 是 String 视频封面图ID。 最小长度：1 最大长度：36

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 results Array of VariableAttributesResponse objects 返回结果列表。 total Integer 总数。 表4 VariableAttributesResponse 参数 参数类型 描述 id Integer ID。 variable_index Integer 变量索引。 variable_length Integer 变量长度。 variable_type String 变量类型。 最小长度：1 最大长度：20 variable_desc String 变量描述。 最小长度：0 最大长度：100 状态码： 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 表3 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 data GetTemplateStatusResult object 查询智能信息基础版模板状态响应。 表4 GetTemplateStatusResult 参数 参数类型 描述 templates Array of VmsTemplateStatus objects 智能信息基础版模板列表。 数组长度：0 - 200 page_info Page object 分页信息。 表5 VmsTemplateStatus 参数 参数类型 描述 tpl_id String 智能信息基础版模板ID。 audit_state Integer 智能信息基础版审核状态。 0：正常可用 1：审核中 2：审核不通过 3：模板已禁用 4：模板不存在 5：模板已过期 audit_desc String 智能信息基础版模板状态的描述，若状态是审核不通过或被禁用，描述表示的是不通过或禁用的原因。 说明： 长度不超过 1024 字。 tpl_size Integer 智能信息基础版模板的大小。 说明： 单位：字节。 valid_time String 模板截止有效日期，格式：yyyy-MM-ddTHH:mm:ssZ，0：表示永久有效。样例：2020-01-31T23:59:59Z。 status_detail Array of StatusDetail objects 运营商的模板状态详情。 preview_url String 智能信息基础版模板预览地址。 tpl_name String 智能信息基础版模板名称。 title String 智能信息基础版模板主题。 tpl_sign String 智能信息基础版模板签名。 create_time String 智能信息基础版模板创建时间，格式：yyyy-MM-ddTHH:mm:ssZ。 var_info Array of VarInfo objects 智能信息基础版模板动参信息，静态模板没有动参，该字段填空。 restags String 资源分配标签，取值如下： 三网一般 三网抗诉 单网一般 单网抗诉 表6 StatusDetail 参数 参数类型 描述 carrier String 运营商类型。 cmcc：中国移动 cucc：中国联通 ctcc：中国电信 oversea：港澳台及国外 unknown：未知 status Integer 模板状态： 0：正常可用 1：审核中 2：审核不通过 3：模板已禁用 4：模板不存在 5：模板已过期 desc String 对模板状态的描述。 说明： 若状态是审核不通过或被禁用，描述表示的是不通过或禁用的原因。 表7 VarInfo 参数 参数类型 描述 name String 动参变量占位符名称。 说明： 格式：#p_N#（N表示第几个参数，与模板文件占位名称保持一致），如：#p_1#。 type String 动参变量类型。 类型为文字：txt 类型为图片：jpg/jpeg/png/gif 类型为音频：mp3/wav 类型为视频：mp4/3gp 表8 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

响应示例 状态码： 200 查询智能信息基础版模板状态返回体。 { "status" : "200", "message" : "success", "data" : { "templates" : [ { "tpl_id" : "800000001", "tpl_name" : "测试-正能量", "title" : null, "tpl_sign" : "华为云", "tpl_size" : 0, "audit_state" : 3, "audit_desc" : "模板签名被禁用", "create_time" : "2022-07-01T14:58:06Z", "valid_time" : "2022-09-29T23:59:59Z", "preview_url" : "https://rcos.800ct.com:57156/preview/27Em/6592288c6f55da18296824f9d806ddab.html", "restags" : "三网一般", "var_info" : [ { "type" : "txt", "name" : "#p_1#" } ], "status_detail" : [ { "carrier" : "cmcc", "status" : 0, "desc" : "正常可用" }, { "carrier" : "ctcc", "status" : 3, "desc" : "模板已禁用" }, { "carrier" : "cucc", "status" : 0, "desc" : "正常可用" } ] } ], "page_info" : { "offset" : 0, "limit" : 20, "total" : 1 } }}

URI GET /v1/aim-basic/templates 表1 Query参数 参数 是否必选 参数类型 描述 tpl_id 否 String 智能信息基础版模板ID。 tpl_name 否 String 智能信息基础版模板名称。 tpl_type 否 String 智能信息基础版模板分类。 public：公共模板 private：个人模板 has_param 否 Boolean 智能信息基础版模板是否携带参数，不传查全部模板。 begin_time 否 String 智能信息基础版模板创建开始时间。 样例为：2019-10-12T07:20:50Z。 说明： begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 end_time 否 String 智能信息基础版模板创建结束时间。 样例为：2019-10-12T07:20:50Z。 说明： begin_time和end_time必须全部为空或全部不为空，并且begin_time不能大于end_time。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：1000000 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：20

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 status String 请求状态，固定200。 message String 状态描述。 data Array of ListThumbnail objects 视频封面图列表。 表4 ListThumbnail 参数 参数类型 描述 id String 视频封面图ID。 created_at String 创建时间。 is_primary Integer 是否作为视频素材封面。 0：否 1：是 file_name String 文件名称。 aim_resource_id String 资源ID。 obs_object_key String 从OBS返回的文件Key。 obs_file_url String 文件访问路径。 image_rate String 图像比例。 oneToOne：指1:1比例 sixteenToNine：指16:9比例 threeToOne：指3:1比例 fortyEightToSixtyFive：指48:65比例 twentyOneToNine：指21:9比例 threeToFour：指3:4比例 is_auto_gen Integer 视频封面图是否自动从系统生成。 0：系统自动生成 1：上传自定义 description String 视频封面图的详细描述。 size Integer 视频封面图所占空间大小。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。

响应示例 状态码： 200 返回信息。 { "status" : "200", "message" : "success", "data" : [ { "id" : "db910127-dc96-4751-a756-001f66c6eb6f", "created_at" : "2023-07-04 14:31:46.0", "is_primary" : 1, "file_name" : "1_cropped_bg.png", "aim_resource_id" : "HWR100046551", "obs_object_key" : "bhvdepxbjo-5355528098406562.jpg", "image_rate" : "oneToOne", "description" : null, "is_auto_gen" : 1 }, { "id" : "dbc604fe-c87d-4020-8791-267d9b526387", "created_at" : "2023-05-27 01:27:25.0", "is_primary" : 0, "file_name" : "1_cropped_kahve.jpg", "aim_resource_id" : "HWR100034106", "obs_object_key" : "ylvwpfuxtw-12013592016942369.jpg", "image_rate" : "oneToOne", "description" : null, "is_auto_gen" : 0 } ]}

请求示例 注册智能信息服务号通道号。设置通道号为"8822053111111"，普通类型，不校验签名。 https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports{ "port" : "8822053111111", "sign" : [ "华为云KooMessage" ], "port_type" : 1, "sign_check" : 0, "authorization_files" : [ "3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png" ]}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 port 是 String 通道号。 port_type=5时 ，长度必须为5 port_type=1或3，长度在21位内 最小长度：0 最大长度：21 port_type 是 Integer 通道号类型。 1：普通 3：前缀号段 5：后缀号段 最小值：1 最大值：5 sign 是 Array of strings 签名列表，最大长度为5。单个签名长度为2-18。 最小长度：2 最大长度：18 数组长度：0 - 5 sign_check 是 Integer 是否需要校验。 0：不校验 1：校验签名 说明： 当port_type为3或者5时，sign_check必须为1。 最小值：0 最大值：1 authorization_files 是 Array of strings 授权证明图片资源，支持jpg、bmp、png和jpeg格式，全部图片总大小不超过4M，最多支持5张。参数格式为：资源ID:资源URL，样例：3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png。 说明： 资源ID与资源URL对应上传智能信息服务号图片资源API返回的resource_id和resource_url。 数组长度：0 - 5

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data PortRegisterResponse object 注册通道号响应体。 表4 PortRegisterResponse 参数 参数类型 描述 data RegisterResult object 返回体。 表5 RegisterResult 参数 参数类型 描述 port String 通道号。 port_type Integer 通道号类型。 1：普通 3：前缀号段 5：后缀号段 sign Array of strings 签名列表，最大长度为5。 数组长度：0 - 5 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 app_name String 应用名称。 最小长度：1 最大长度：30 app_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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 app_name 是 String 应用名称。 最小长度：1 最大长度：30 up_link_addr 否 String 上行回调地址。支持通信协议HTTPS/HTTP。 最大长度：255

请求示例 修改ID为2353cb25-c169-4e20-adcf-3517****0f9e的短信应用。 https://koomessage.myhuaweicloud.cn/v1/sms/apps/2353cb25-c169-4e20-adcf-3517****0f9e{ "app_name" : "应用2", "up_link_addr" : "https://www.huaweicloud.cn"}

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 request_id 否 String 请求ID。 最小长度：0 最大长度：100 domain_id 否 String 租户ID。 最小长度：0 最大长度：100 callback_type 否 String 回调类型。 shortchain：短链 sms：短信 最小值：1 最大值：2 body 否 String 响应信息。 回调类型为智能信息单条发送/短链回调： callback_type为shortchain时，body为ShortChainCallback实体的json字符串。 callback_type为sms时，body为SmsCallback实体的json字符串。 回调类型为智能信息批量发送/短链回调： callback_type为shortchain时，body为ShortChainCallback实体数组的json字符串。 callback_type为sms时，body为SmsCallback实体数组的json字符串。 说明： 回执中的task_id可用于发送任务或解析任务关联，使用发送智能信息API发送智能短信，同一发送批次每一个手机号最多收到两次回执，一个发送结果回执，一个解析成功回执，两次回执可使用aim_url关联。 最小长度：0 最大长度：100 retry 否 Boolean 重试标识。 表3 ShortChainCallback 参数 是否必选 参数类型 描述 task_id 否 String 任务ID。 cust_flag 否 String 创建解析任务时填写用户唯一标识，手机号码或者任何的唯一标识，唯一标识不超过64个字符。发送智能信息时则必须填客户的手机号码。此处为手机号。样例为：130****0001。 tpl_id 否 String 智能信息模板ID，由9位数字组成。 aim_url 否 String 带URL地址的智能信息短链。 aim_code 否 String 不带URL地址前缀的智能信息编码。 status 否 Integer 生成状态。 0：成功 非0：失败，具体请参见错误码 describe 否 String 对应返回的回执错误码的描述内容。 表4 SmsCallback 参数 是否必选 参数类型 描述 task_id 否 String 任务ID。 cust_flag 否 String 客户ID。 msg_id 否 String 发送明细的唯一标识ID。 tpl_id 否 String 智能信息模板ID，由9位数字组成。 sms_sign 否 String 短信签名。 aim_code 否 String 不带URL地址前缀的智能信息编码。 aim_url 否 String 带URL地址的智能信息短链。 send_time 否 String 短信发送时间。 receive_time 否 String 短信接收时间。 send_status 否 String 发送状态码。 说明： “DELIVRD”代表短信发送成功，其余状态码请参考短信服务错误码表。 send_status_desc 否 String 发送状态描述。 total 否 String 长短信拆分后的短信条数。 当短信未拆分时该参数取值为1。 sequence 否 String 长短信拆分后的短信序号。 当total参数取值大于1时，该参数才有效。当短信未拆分时该参数取值为1。 extend 否 String 扩展字段。 用户可以在发送短信的请求中携带该参数，如果用户发送短信时未携带extend参数，状态报告就不会携带该参数。