华为云用户手册

响应示例 状态码： 200 OK [ { "id" : 100000000000, "account_id" : "04eexxxxxxxxxx", "sim_card_id" : 100000000000, "price_plan_id" : "10001", "price_plan_name" : "中国联通消费级每月30M联接服务（1年）", "iccid" : "898606xxxxxxxxxxxx", "flow_total" : 30, "flow_used" : 0, "flow_left" : 30 }, { "id" : 100000000001, "account_id" : "04eexxxxxxxxxx", "sim_card_id" : 100000000001, "price_plan_id" : "10001", "price_plan_name" : "中国联通消费级每月30M联接服务（1年）", "iccid" : "898607xxxxxxxxxxxx", "flow_total" : 30, "flow_used" : 0, "flow_left" : 30 } ] 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 403 Forbidden { "error_code" : "GSL.00010001", "error_msg" : "请求携带的token无效。" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 - Boolean OK 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 403 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 policy_name 否 String 策略名称 preferred_carrier 否 Integer 仅对SDK版本生效。最优选运营商,1:移动、2:电信、3:联通、4:上次使用的运营商 least_preferred_carrier 否 Integer 仅对SDK版本生效。最不优选运营商,1:移动、2:电信、3:联通 optimal_signal 否 Boolean 仅对SDK版本生效。最优信号选取策略是否开启,true:开启,false:不开启 auto_switch 否 Boolean 仅对SDK版本生效。自动切卡是否开启,true:开启,false:不开启 weak_signal_switch 否 Boolean 仅对SDK版本生效。弱信号切换策略是否开启,true:开启,false:不开启 connect_ip 否 String 仅对SDK版本生效。连接延时切换策略，连接延时时需要ping的ip地址 version 是 Integer 版本枚举,1:SDK版，2:无SDK版 switch_order 否 String 仅对无SDK版本生效。切卡顺序，运营商以英文逗号分隔，1:移动，2:电信，3:联通 blacklist 否 Integer 仅对无SDK版本生效。黑名单，只支持单个运营商，1:移动，2:电信，3:联通

请求示例 新增无SDK版本三网卡策略 POST https://{endpoint}/v1/network-switch-policies { "policy_name" : "testaa", "version" : 2, "blacklist" : 1, "switch_order" : "3,1,2" } 新增SDK版本三网卡策略 POST https://{endpoint}/v1/network-switch-policies { "policy_name" : "test_sdk", "version" : 1, "preferred_carrier" : 3, "least_preferred_carrier" : 2, "blacklist" : 0, "optimal_signal" : true, "auto_switch" : true, "weak_signal_switch" : true, "connect_ip" : "www.example.com" }

响应示例 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010001", "error_msg" : "参数异常" } 状态码： 403 Forbidden { "error_code" : "GSL.00010002", "error_msg" : "请求的内容不存在" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010004", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 limit Long 每页的记录数 offset Long 页码，最小值是1，最大值为1000000。默认值是1. count Long 记录总数 network_switch_policy_list Array of NetworkSwitchPolicyVO objects 网络切换策略实例列表 表3 NetworkSwitchPolicyVO 参数 参数类型 描述 id Long 策略主键id policy_name String 策略名称 preferred_carrier Integer SDK版本特有字段。最优选运营商,1:移动、2:电信、3:联通、4:上次使用的运营商 least_preferred_carrier Integer SDK版本特有字段。最不优选运营商,1:移动、2:电信、3:联通 optimal_signal Boolean SDK版本特有字段。最优信号选取策略是否开启,true:开启,false:不开启 auto_switch Boolean SDK版本特有字段。自动切卡是否开启,true:开启,false:不开启 weak_signal_switch Boolean SDK版本特有字段。弱信号切换策略是否开启,true:开启,false:不开启 connect_ip String SDK版本特有字段。连接延时切换策略，连接延时时需要ping的ip地址 create_time String 创建时间 modify_time String 修改时间 status Integer 状态,1:启用、0:禁用 type Integer 策略类型,0:系统策略,1:私有策略 used Boolean 策略是否已被使用过，即是否已被执行过策略切换，false：未被使用过，true：已被使用过 version Integer 版本枚举，1:SDK版 2:无SDK版 switch_order String 无SDK版本特有字段。切卡顺序，运营商以英文逗号分隔，1:移动，2:电信，3:联通 blacklist Integer 无SDK版本特有字段。黑名单，只支持单个运营商，1:移动，2:电信，3:联通 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/network-switch-policies 表1 Query参数 参数 是否必选 参数类型 描述 policy_name 否 String 策略名称 version 否 Integer 三网卡版本信息，1:SDK版，2:无SDK版 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数

响应示例 状态码： 200 OK 示例 1 { "limit" : 10, "offset" : 1, "count" : 1, "network_switch_policy_list" : [ { "id" : 1111111111111111, "policy_name" : "默认策略无SDK版", "preferred_carrier" : null, "least_preferred_carrier" : null, "optimal_signal" : false, "auto_switch" : false, "weak_signal_switch" : null, "connect_ip" : null, "create_time" : "2023-11-01T08:00:00.000+00:00", "modify_time" : "2023-11-01T08:00:00.000+00:00", "status" : 1, "type" : 0, "used" : true, "version" : 2, "switch_order" : "3,1,2", "blacklist" : 0 } ] } 示例 2 { "limit" : 10, "offset" : 1, "count" : 1, "network_switch_policy_list" : [ { "id" : 1000000000000000, "policy_name" : "默认策略", "preferred_carrier" : 3, "least_preferred_carrier" : 2, "optimal_signal" : false, "auto_switch" : true, "weak_signal_switch" : true, "connect_ip" : null, "create_time" : "2023-11-01T08:00:00.000+00:00", "modify_time" : "2023-11-01T08:00:00.000+00:00", "status" : 1, "type" : 0, "used" : true, "version" : 1, "switch_order" : null, "blacklist" : 0 } ] } 状态码： 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常" } 状态码： 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙，请稍后重试。" }

请求示例 查询SIM卡的历史月用量，卡ID为“4710226018477568”，账期为“2022-07”。 POST https://{endpoint}/v1/sim-cards/month-usages { "sim_card_ids" : [ 4710226018477568 ], "billing_cycles" : [ "2022-07" ] } 查询SIM卡的历史月用量。当参数sim_card_ids不传或长度为0时，根据iccids，查询卡标识为“8695xxxxxxxx”的历史月用量，账期为“2022-07”。 POST https://{endpoint}/v1/sim-cards/month-usages { "iccids" : [ "8695xxxxxxxx" ], "billing_cycles" : [ "2022-07" ] }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 sim_card_ids 否 Array of longs sim卡id列表，最多支持传入500个SIM卡id。sim_card_ids与iccids不能同时为空，sim_card_ids参数为空则根据iccids参数处理 iccids 否 Array of strings iccid列表，最多支持传入500个iccid。sim_card_ids与iccids不能同时为空，sim_card_ids参数为空则根据iccids参数处理 billing_cycles 是 Array of strings 账期，最多支持传入本月在内的6个月账期，例如[2022-07, 2022-06]，不支持传入未来账期。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 month_usages Array of MonthUsageVo objects 月用量列表 表3 MonthUsageVo 参数 参数类型 描述 sim_card_id Long SIM卡ID iccid String iccid flow_usages Array of FlowUsageVo objects 月用量 表4 FlowUsageVo 参数 参数类型 描述 billing_cycle String 账期 flow_used Double 已用流量（MB） 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "month_usages" : [ { "sim_card_id" : 4710226018477568, "iccid" : "8695xxxxxxxx", "flow_usages" : [ { "billing_cycle" : "202207", "flow_used" : 85.27 } ] } ] } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

URI GET /v1/back-pools/{back_pool_id}/members 表1 路径参数 参数 是否必选 参数类型 描述 back_pool_id 是 Long 流量池标识 表2 Query参数 参数 是否必选 参数类型 描述 cid 否 String 容器ID limit 否 Long 每页记录数 offset 否 Long 页码 billing_cycle 是 String 账期，例如：2021-04

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "pool_members" : [ { "id" : 100000001, "cid" : "89860XXXXXXXXXXXXXX", "sim_price_plan_id" : 455000000000, "flow_used" : 0, "sim_status" : 20 } ] } 状态码： 400 Bad Request { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 403 Forbidden { "error_code" : "GSL.00011004", "error_msg" : "账期不合法，请检查！" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 当前流量池的成员总数 pool_members Array of BackPoolMemVO objects 查询出来的流量池成员记录列表 表5 BackPoolMemVO 参数 参数类型 描述 id Long 流量池标识 cid String 容器ID sim_price_plan_id Long 套餐订购实例ID flow_used Double 已用流量(查询账期所在月份), 单位MB sim_status Integer 卡当前状态：11-未激活，13-可激活，14-已停用，20-在用，30-已拆机 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 id Long 自定义属性标识 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "id" : 1000001 } 状态码： 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常" } 示例 2 { "error_code" : "GSL.00027001", "error_msg" : "自定义属性名称不合法，请检查！" } 示例 3 { "error_code" : "GSL.00027002", "error_msg" : "自定义属性名称已存在，请重新输入！" } 示例 4 { "error_code" : "GSL.00027003", "error_msg" : "自定义属性名称和SIM卡管理列字段重复，请重新输入！" } 示例 5 { "error_code" : "GSL.00027004", "error_msg" : "登录用户最多可以创建6个自定义属性。" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00020003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 记录总数 tags Array of CmTagVO objects 标签记录 表3 CmTagVO 参数 参数类型 描述 id Long 标签标识 tag_name String 标签名称 status Integer 标签状态，0未使用，1使用中。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "work_order_id" : 1000001 } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作类型(ADD：断网，DEL:取消断网) iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理

请求示例 创建SIM卡断网/恢复在用的申请，将sim_card_id对应的SIM卡操作断网。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/cut-net { "action" : "ADD" } 创建SIM卡断网/恢复在用的申请。当参数sim_card_id为最小值时，将卡标识iccid为“898600xxxxxxxxxx”的SIM卡操作断网。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/cut-net { "action" : "ADD", "iccid" : "898600xxxxxxxxxx" }

URI GET /v1/sms-send-infos/details 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 cid 否 String 容器ID start_time 否 String 开始时间 end_time 否 String 结束时间

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "sms_details" : [ { "cid" : "11669563150033768257", "msisdn" : "861400190692085", "sent_time" : "2022-03-22T00:00:00.000+00:00", "received_time" : "2022-03-22T00:00:00.000+00:00", "sms_status" : 2, "sms_content" : "testadd321" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 limit Long 每页的记录数 offset Long 页码，最小值是1，最大值为1000000。默认值是1. count Long 记录总数 sms_details Array of SmsSendDetailQueryVo objects 短信发送详情列表 表4 SmsSendDetailQueryVo 参数 参数类型 描述 cid String 容器ID msisdn String MSISDN sent_time String 发送时间 received_time String 接收时间 sms_status Integer 短信状态:1发送中 2.已送达 3.失败 sms_content String 短信内容

SIM卡管理 API 说明 查询SIM卡列表 查询公有云租户下的SIM卡列表。 SIM卡单卡停机 创建停机申请，返回业务受理单号。1~2个工作日完成停机操作。 SIM卡单卡复机 创建复机申请，返回业务受理单号。1~2个工作日完成复机操作。 月用量统计 查看历史月流量，可以查看最多6个月的月用量。 查询SIM卡详情 查询SIM卡的详情信息。 激活实体卡 创建激活实体卡申请，返回业务受理单号。1~2个工作日完成激活操作。 查询SIM卡实名认证信息 实时查询SIM卡实名认证信息，接口仅支持查询中国大陆运营商卡片的实名认证信息。 SIM卡申请断网恢复在用 SIM卡申请断网/恢复在用，仅支持电信卡调用接口。 SIM卡达量断网/取消达量断网 SIM卡达量断网/取消达量断网，仅支持中国电信的卡和中国联通、中国移动的组池卡调用接口。 SIM卡机卡重绑 支持固定机卡重绑（需要上传IMEI，将SIM卡绑定到指定IMEI的设备）和普通机卡重绑（会清除之前绑定的设备，将SIM卡绑定到正在使用的设备），接口仅支持中国电信卡和中国移动卡调用，中国电信卡单卡每月只允许重绑 2 次, 中国移动卡仅支持普通机卡重绑。 清除实名认证信息 清除实名认证信息，接口仅支持中国电信卡调用。 实体卡限速 实体卡限速接口，仅支持中国电信和中国联通实体卡调用接口。中国联通卡需要个人实名认证后才能使用限速功能。 批量查询SIM卡日用量 批量查询SIM卡日用量接口，支持按天或按月查询。SIM卡标识和容器ID只能选一个参数，天和月也只能选一个参数。

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 limit Long 每页的记录数 offset Long 页码，最小值是1，最大值为1000000。默认值是1. count Long 记录总数 work_orders Array of WorkOrderVo objects 业务受理单列表 表3 WorkOrderVo 参数 参数类型 描述 id Long 业务受理ID sim_type Integer SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 work_order_type Integer 业务受理类型：1.批量激活实体卡 2.批量转移实体卡 3.创建流量池 4.实体卡复机 5.实体卡停机 6.批量启用或复机 7.批量停用或停机 8.批量订购 9.批量退订 10.实体卡激活 11.申请断网 12.达量断网 13.机卡重绑 14.实名制信息清除 15.实体卡限速 16.批量补卡 17.批量机卡重绑 18.重启已废弃后向流量池 19.批量达量断网 20断网恢复 21取消达量断网 22批量取消达量断网 23批量拆机 req_detail String 请求详情 total_count Integer 业务受理明细总数 success_count Integer 业务受理明细成功数 fail_count Integer 业务受理明细失败数 process_count Integer 业务受理明细处理中数 status Integer 业务受理状态：1审核中、2已审核、3处理中、4已完成、5已取消、6失败、7 审核不通过 create_time String 创建时间 finish_time String 完成时间 fail_reason String 失败原因 response String 响应内容 work_order_source Integer 业务受理单来源,1:运营人员生成,2:用户操作生成(console),3:自动化规则生成,4:后向流量池超阈值停用次月自动复机任务,5:单卡没流量停机定时任务,6:SIM卡到期自动停机定时任务,7:流量池停机定时任务,8:用户操作生成(api) work_order_source_desc String 业务受理单来源描述 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "work_orders" : [ { "id" : 5388214536425984, "sim_type" : 3, "work_order_type" : 4, "req_detail" : "容器ID:89860484192070060448", "total_count" : 1, "success_count" : 1, "fail_count" : 0, "process_count" : 0, "status" : 4, "create_time" : "2023-07-29T09:50:58.000+00:00", "finish_time" : "2023-07-29T09:55:00.000+00:00", "fail_reason" : null, "response" : null, "work_order_source" : 8, "work_order_source_desc" : "用户操作生成(api)" } ] } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

URI GET /v1/work-orders 表1 Query参数 参数 是否必选 参数类型 描述 main_search_key 否 String 业务受理ID limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 sim_type 否 Integer SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 work_order_type 否 Integer 业务受理类型：1.批量激活实体卡 2.批量转移实体卡 3.创建流量池 4.实体卡复机 5.实体卡停机 6.批量启用或复机 7.批量停用或停机 8.批量订购 9.批量退订 10.实体卡激活 11.申请断网 12.达量断网 13.机卡重绑 14.实名制信息清除 15.实体卡限速 16.批量补卡 17.批量机卡重绑 18.重启已废弃后向流量池 19.批量达量断网 20断网恢复 21取消达量断网 22批量取消达量断网 23批量拆机 status 否 Integer 业务受理状态:：1审核中、2已审核、3处理中、4已完成、5已取消、6失败、7 审核不通过

URI GET /v1/sim-cards-multiply 表1 Query参数 参数 是否必选 参数类型 描述 cid 否 String cid online_carrier 否 Integer 在线运营商标识 sim_card_id 否 Long SIM卡标识 version 否 Integer 三网卡版本信息，1:SDK版，2:无SDK版 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数