华为云用户手册

请求示例 请求示例 POST https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/sessions/{session_id}Request Header:Content-Type: application/jsonX-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...Request Body:{ "question": "桌面云打不开了"} Java语言请求代码示例 import java.io.BufferedReader;import java.io.InputStream;import java.io.InputStreamReader;import java.io.OutputStreamWriter;import java.net.HttpURLConnection;import java.net.URL;public class CBSDemo { public void cbsDemo() { try { //endpoint、projectId、qabot_id等需要替换成实际信息。 URL url = new URL("https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/sessions/{session_id}"); String token = "用户获取得到的实际token值"; HttpURLConnection connection = (HttpURLConnection) url.openConnection(); connection.setRequestMethod("POST"); connection.setDoInput(true); connection.setDoOutput(true); connection.addRequestProperty("Content-Type", "application/json"); connection.addRequestProperty("X-Auth-Token", token); //输入参数 String body = "{\"question\": \"桌面云打不开了\"}"; OutputStreamWriter osw = new OutputStreamWriter(connection.getOutputStream(), "UTF-8"); osw.append(body); osw.flush(); InputStream is = connection.getInputStream(); BufferedReader br = new BufferedReader(new InputStreamReader(is, "UTF-8")); while (br.ready()) { System.out.println(br.readLine()); } } catch (Exception e) { e.printStackTrace(); } } public static void main(String[] args) { CBSDemo CBSDemo = new CBSDemo(); CBSDemo.cbsDemo(); }}

响应示例 状态码：200 成功响应示例 { { "answers": [ { "score": 0.949, "answer": "重启电脑", "domain": "桌面云", "qa_pair_id": "888899999", "st_question": "桌面云打不开", "top_score_question": "桌面云打不开" } ], "recommend_answers": [] }, "session_id": "73e84311-32a0-43ff-9735-bb2be1150624"} 状态码：400 失败响应示例 { "error_code":"CBS.0011", "error_msg":"auth failed"}

响应参数 状态码： 200 表5 QaBotAnswers 参数 参数类型 描述 answers Array of QaBotAnswer objects 问答机器人 回复。 表6 QaBotAnswer 参数 参数类型 描述 qa_pair_id String 问答对ID，UUID格式，如：305cd440-ab4f-4704-9b30-ffa4e82a5606。 st_question String 标准问题，如：桌面云打不开。 answer String 知识库中的语料答案，包含该字段时，为直接回答；不包含时，为推荐答案。 score Double 相似度得分，精确到小数点后3位。 domain String 问题类别。 top_score_question String 最高评分的扩展问或标准问。 表7 ChatAnswers 参数 参数类型 描述 answer String 答案，如：美好的一天祝您一切顺利。 score Float 闲聊的置信度，范围：[0.0,1.0 ]。0.0表示兜底回复。 表8 TaskBotAnswers 参数 参数类型 描述 answer String 答案， 如：请问您需要查询哪里的天气？ skill_id String 技能标识符，UUID格式。如：9eece064-bdb5-43cb-8e0f-8c19a929e25c。 skill_responses Array of SkillResponse objects 技能信息。 表9 SkillResponse 参数 参数类型 描述 skill_id String 输入问题，不能为空，UUID格式，如：9eece064-bdb5-43cb-8e0f-8c19a929e25c。 skill_version String skill的版本。 frame Frame object 命中意图。 candidate object 候选意图，具体参见表15。 locked Boolean 技能是否被锁定，默认是false related_intenions Array of RelatedIntention objects 相关意图信息。 表10 Frame 参数 参数类型 描述 intention String 意图。 confidence Double 命中意图置信度。 current_slots Array of CurrentSlot objects 当前槽位列表。 history_slots Array of HistorySlot objects 历史槽位列表。 reply String 机器人回复。 task_complete Boolean 任务是否完成。 flow_complete Boolean 对话流程是否结束 candidate_words Array of Strings 候选词。 intention_alias String 意图名称。 表11 CurrentSlot 参数 参数类型 描述 slot_id String 槽位ID，UUID格式，如：9eece064-bdb5-43cb-8e0f-8c19a929e25c。 slot_identification String 用户设置的槽位标识 slot_name String 槽位名称。 slot_values Array of SlotValue objects 槽位值。 表12 SlotValue 参数 参数类型 描述 word String 词。 norm_word String 归一化后的标准词。 begin_position Integer 词的起始位置。 end_position Integer 词的结束位置。 表13 HistorySlot 参数 参数类型 描述 slot_identification String 用户设置的槽位标识 slot_name String 槽位名称。 slot_values Array of HistorySlotWord objects 槽信息。 表14 HistorySlotWord 参数 参数类型 描述 word String 词。 norm_word String 归一化后的词。 表15 CandidateIntention 参数 参数类型 描述 candidate_intention String 候选意图。 candidate_confidence Double 候选意图置信度。 表16 RelatedIntention 参数 参数类型 描述 intention String 意图名称。 confidence Double 意图置信度。 状态码： 400 表17 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。

URI POST https://{endpoint}/v1/{project_id}/qabots/{qabot_id}/sessions/{session_id} 表1 路径参数 参数 是否必选 参数类型 描述 endpoint 是 String 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 project_id 是 String 项目ID，用于资源隔离。请参见获取项目ID。 qabot_id 是 String 机器人标识符，qabot编号，UUID格式。如：303a0a00-c88a-43e3-aa2f-d5b8b9832b02。 进入问答机器人的Console界面，在“机器人名称/ID”列显示对应的qabot_id。 session_id 是 String 会话标识符，UUID格式。如：c04e6f7b-61d7-4a2d-a0c8-f9ecd2f62359。 具体获取方式请参见开启会话章节。

URI GET https://{endpoint}/v1/{project_id}/digital-human/image-frames?image_id={image_id} 表1 路径参数 参数 是否必选 参数类型 描述 endpoint 是 String 终端节点，即调用API的请求地址。 不同服务不同区域的endpoint不同，您可以从终端节点中获取。 例如，CBS服务在“华北-北京四”区域的“endpoint”为“cbs-ext.cn-north-4.myhuaweicloud.com”。 project_id 是 String 项目ID，用于资源隔离。请参见获取项目ID。 image_id 是 String 图片ID。可以通过调用获取图片列表获取。 offset 否 Integer 偏移量。默认为0。 limit 否 Integer 分页限制数。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 total Integer 播报框总数。 offset Integer 起始位置。 count Integer 本次查询数量。 image_frames Array of ImageFrame objects 播报框。 表3 ImageFrame 参数 参数类型 描述 create_time String 创建时间。 update_time String 更新时间 frame_resolution_type Integer 框的长宽比。 0: 16/9 1: 4/3 2: 3/4 id String 框架。 image_frame_position LeftRightPosition object 框的默认地址。 image_position LeftRightPosition object 插图的默认地址。 resolution_type Integer 横竖屏模式。 0：横版 1：竖版 url String 框的存储地址。 表4 LeftRightPosition 参数 参数类型 描述 left Position object 框在左边的坐标。 right Position object 框在右边的坐标 表5 Position 参数 参数类型 描述 x Integer 像素坐标x。 y Integer 像素坐标x。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 CBS.XXXX。 error_msg String 错误详情。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 CBS.XXXX。 error_msg String 错误详情。

响应示例 状态码： 200 OK { "total" : 3, "offset" : 0, "count" : 3, "image_frames" : [ { "id" : "gov_16vs9", "url" : "https://cbs-digital-human-cn-north-4.obs.cn-north-4.myhuaweicloud.com", "image_frame_position" : { "left" : { "x" : 60, "y" : 135 }, "right" : { "x" : 638, "y" : 135 } }, "image_position" : { "left" : { "x" : 120, "y" : 202 }, "right" : { "x" : 698, "y" : 202 } }, "frame_resolution_type" : 0, "resolution_type" : 0 }, { "id" : "gov_3vs4", "url" : "https://cbs-digital-human-cn-north-4.obs.cn-north-4.myhuaweicloud.com", "image_frame_position" : { "left" : { "x" : 265, "y" : 0 }, "right" : { "x" : 745, "y" : 0 } }, "image_position" : { "left" : { "x" : 420, "y" : 84 }, "right" : { "x" : 900, "y" : 84 } }, "frame_resolution_type" : 2, "resolution_type" : 0 }, { "id" : "gov_4vs3", "url" : "https://cbs-digital-human-cn-north-4.obs.cn-north-4.myhuaweicloud.com", "image_frame_position" : { "left" : { "x" : 143, "y" : 135 }, "right" : { "x" : 638, "y" : 135 } }, "image_position" : { "left" : { "x" : 300, "y" : 202 }, "right" : { "x" : 795, "y" : 202 } }, "frame_resolution_type" : 1, "resolution_type" : 0 } ]} 状态码： 400 Bad Request { "error_code" : "CBS.0003", "error_msg" : "This resource Id:[33dbe0e2-bb9b-4efc-xxx] does not exist."} 状态码： 500 Internal Server Error { "error_code" : "CBS.0004", "error_msg" : "Internal Server Error"}

公共请求参数 表1 公共请求消息头 名称 描述 是否必选 示例 Content-type 发送的实体的MIME类型。 是 application/json Content-Length 请求body长度，单位为Byte。 POST/PUT请求为可选， GET不包含。 3495 X-Auth-Token 用户Token。 是 MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... X-Language 请求语言类型。 否，默认为zh-cn。 en-us 其它header属性，请遵照https协议。 父主题： 数据结构

响应示例 状态码： 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 主页列表。 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 结果详情。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。 Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 云服务存在两种部署方式：项目级服务和全局级服务。其中： 项目级服务需要获取项目级别的Token，此时请求body中“auth.scope”的取值为“project”。 全局级服务需要获取全局级别的Token，此时请求body中“auth.scope”的取值为“domain”。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "cn-north-4" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https:// koomessage.myhuaweicloud.com/v1/aim/mobile-capabilities/checkContent-Type: application/jsonX-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

响应参数 状态码： 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参数 参数 是否必选 参数类型 描述 material_ids 是 Array of strings 模板素材ID数组。

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

请求参数 表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 表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 Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 tpl_ids 是 Array of strings 智能信息模板ID列表，一次最多请求100个。 begin_time 是 String 模板报表查询开始时间。样例：2019-10-12T07:20:50.522Z。 说明： 开始时间和结束时间最多间隔90天，超出时间限制返回为空。 最小长度：1 最大长度：30 end_time 是 String 模板报表查询结束时间。样例：2019-10-12T07:20:50.522Z。 说明： 开始时间和结束时间最多间隔90天，超出时间限制返回为空。 最小长度：1 最大长度：30 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：2147483647 缺省值：0 limit 否 Integer 每页显示的条目数量。 最小值：1 最大值：100 缺省值：20

请求示例 查询模板报表 https://koomessage.myhuaweicloud.cn/v1/aim/tempalte-reports/query{ "tpl_ids" : [ "600000001" ], "begin_time" : "2022-06-01T07:20:50.522Z", "end_time" : "2022-07-01T07:20:50.522Z", "offset" : 0, "limit" : 10}

响应示例 状态码： 200 返回信息。 { "template_reports" : [ { "tpl_id" : "600000001", "start_time" : "2022-06-30T00:00:00Z", "resolving_times" : 0, "end_time" : "2022-07-18T17:56:08Z", "expose_uv" : 3, "expose_pv" : 33, "click_uv" : 3, "click_pv" : 6 } ], "page_info" : { "offset" : 0, "limit" : 10, "total" : 1 }}

请求参数 表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参数 参数 参数类型 描述 status String 响应码。 message String 响应信息。 data QueryReportResponse object 响应数据体。 表4 QueryReportResponse 参数 参数类型 描述 data_list Array of ReportDetail objects 数据列表。 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 Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

请求示例 查询智能信息发送报表-日报 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} 查询智能信息发送报表-月报 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 表2 响应Body参数 参数 参数类型 描述 data MenuPushResponseBody object 菜单催审返回体。 表3 MenuPushResponseBody 参数 参数类型 描述 data data object 消息体。 表4 data 参数 参数类型 描述 log_id String 菜单申请记录ID。 message String 返回信息。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

请求示例 绑定通道号 https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports/associate{ "pub_id" : "961b0f7d32314b5cb287fc06fe09cccc", "ext_port_id" : "a67928a301364aa38d8cf6f08242cccc", "port" : "8822053111111", "province" : "福建省", "sign" : [ "华为云 KooMessage " ]}

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

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 pub_id 是 String 服务号ID。 最小长度：0 最大长度：32 port 是 String 通道号。 port_type=5时，长度必须为5 port_type=1或3，长度在21位内 最小长度：0 最大长度：21 province 是 String 通道号绑定/解绑的province字段取值范围如下：全国、河北省、山西省、辽宁省、吉林省、黑龙江省、江苏省、浙江省、安徽省、福建省、江西省、山东省、河南省、湖北省、湖南省、广东省、海南省、四川省、贵州省、云南省、陕西省、甘肃省、青海省、台湾省、内蒙古自治区、广西壮族自治区、西藏自治区、宁夏回族自治区、新疆维吾尔自治区、北京市、天津市、上海市、重庆市、香港特别行政区、澳门特别行政区。 最小长度：0 最大长度：500 sign 是 Array of strings 绑定签名，必须是该端口号签名的子集。单个签名长度为2-18。 ext_port_id 是 String 关联通道号ID，取通道号列表返回的ID。 最小长度：32 最大长度：32

响应参数 状态码： 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：启用 说明： 智能信息模板启动、禁用暂为运营管理功能，Console页面与API暂未开放此功能。 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 支持厂商列表。 表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 厂商版本。 表7 Page 参数 参数类型 描述 offset Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 limit Integer 每页显示的条目数量。 total Integer 总条数。 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表9 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。

响应示例 状态码： 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 }}