华为云用户手册

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

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

请求参数 表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" }

响应参数 状态码： 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

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

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 supported_mobiles Array of strings 支持智能信息手机号码列表。 unsupported_mobiles Array of strings 不支持智能信息手机号码列表。 tpl_id String 智能信息模板ID，由9位数字组成。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 结果状态码。 error_msg String 结果详情。 error_message Object 结果详情。 说明： 该字段在以后可能会废弃，建议使用error_msg字段对接。 状态码： 500 表5 响应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参数 参数 是否必选 参数类型 描述 mobiles 是 Array of strings 待查询的手机号码，一次最多请求100个。 说明： 不加密时，参数可传入纯手机号或国家码加手机号，国家码不带“+”号，例如国内手机号“1310000”，参数可传入“1310000”、“861310000”、“00861310000”。使用SHA1加密，mobiles传入号码国家码与手机号码的SHA1算法后的摘要，国家码格式为纯数字，不带“+”，去掉前面的0，例如国内手机号“1310000”，使用“861310000”进行SHA1加密。 最小长度：1 最大长度：40 数组长度：1 - 100 tpl_id 否 String 智能信息模板ID，由9位数字组成。 说明： 填写时，根据该模板所支持的厂商返回手机终端展示智能信息的能力状态 不填则返回手机终端在所有厂商展示智能信息的能力状态 最小长度：0 最大长度：32 encryption_alg 否 String 加密类型。 NONE：不加密 SHA1：使用SHA1加密算法加密 说明： 默认为NONE。

请求示例 查询模板报表。模板ID为"600000001"，查询时间范围从"2022-06-01 07:20:50" 到 "2022-07-01 07:20:50"。 https://koomessage.myhuaweicloud.cn/v1/aim/template-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的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表2 请求Body参数 参数 是否必选 参数类型 描述 tpl_ids 是 Array of strings 智能信息模板ID列表，一次最多请求100个。 数组长度：1 - 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 factory_type 否 Array of strings 厂商类型。不填时默认全厂商。列举值："huawei", "vivo", "oppo", "xiaomi", "meizu", "samsung"。

响应参数 状态码： 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字段对接。

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

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data UpdatePubResponse object 更新服务号信息响应体。 表5 UpdatePubResponse 参数 参数类型 描述 data data object 请求成功返回的数据，为JSON格式。 表6 data 参数 参数类型 描述 pub_update_log_id String 可使用该ID查询当前记录审核情况。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码。 error_msg String 结果详情。

请求示例 根据服务号ID更新服务号信息。设置修改原因为"修改名称"，修改服务号名称为"尊享酷玩"。 https://koomessage.myhuaweicloud.cn/v1/aim-sa/pubs/29333b06990f4a5ca3b13ffb0c67cccc { "pub_name" : "尊享酷玩", "pub_remark" : "仅测试使用", "pub_abstract" : "尊享酷玩的摘要", "logo_img" : "6245269fa0214a81b55f12ec3c81cccc", "auto_get_port" : 1, "authorization_files" : [ "f3335e54b86145409cacfac4bf17cccc" ], "industry" : 2, "signs_for_auto_get_port" : [ "华为云KooMessage" ], "change_reason" : "修改名称" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 Content-Type 是 String 请求体参数类型，该字段必须设置为：application/json。 表3 请求Body参数 参数 是否必选 参数类型 描述 change_reason 是 String 更新原因。 最小长度：1 最大长度：200 logo_img 否 String 服务号 LOG O图片资源ID。 说明： 通过上传智能信息服务号图片资源接口上传LOGO图片后获得的图片resource_id。图片要求大于等于240*240且比例相同。 最小长度：32 最大长度：32 authorization_files 否 Array of strings 授权证明图片资源ID，最多支持6张。 数组长度：0 - 6 pub_name 否 String 服务号名称。 最小长度：1 最大长度：15 pub_abstract 否 String 服务号简介。 最小长度：1 最大长度：75 pub_remark 否 String 服务号备注。 最小长度：1 最大长度：15 auto_get_port 否 Integer 自动获取端口。 最小值：0 最大值：1 signs_for_auto_get_port 否 Array of strings 自动收集端口使用的签名列表。 说明： auto_get_port为1时，该字段为必填，每个签名长度须为2-18个字符，每个服务号签名不可以重复。 数组长度：0 - 5 industry 否 Integer 从事行业，默认取服务号所属商家的行业分类。 1：金融理财 2：社交通讯 3：影音娱乐 4：旅游出行 5：购物 6：本地生活 7：运动健康 8：教育培训 9：新闻阅读 10：运营商 11：其他 最小值：1 最大值：11 areas_for_auto_get_port 否 Array of strings 自动收集端口生效的地区列表。地区取值见《地区名称列表》。 说明： auto_get_port为1时，该字段有效。不填则默认全国，不允许传入重叠地区。

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

响应参数 状态码： 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 获取短信签名详情返回体。 { "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" }

响应参数 状态码： 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

请求示例 查询智能信息发送报表-日报。模板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 } } }

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

响应参数 状态码： 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 绑定的地区，不允许传入重叠地区。地区取值见《地区名称列表》。 最小长度：0 最大长度：500 sign 是 Array of strings 绑定签名，必须是该端口号签名的子集。单个签名长度为2-18。 数组长度：0 - 5 ext_port_id 是 String 关联通道号ID，取通道号列表返回的ID。 最小长度：32 最大长度：32

请求示例 通道号绑定服务号。通道号为"8822053111111"，服务号ID为"961b0f7d32314b5cb287fc06fe09cccc"。 https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports/associate { "pub_id" : "961b0f7d32314b5cb287fc06fe09cccc", "ext_port_id" : "a67928a301364aa38d8cf6f08242cccc", "port" : "8822053111111", "province" : "佛山市", "sign" : [ "华为云KooMessage" ] }

响应参数 状态码： 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