文档首页/ 全球SIM联接 GSL/ API参考/ API列表/ 套餐管理/ 查询套餐列表信息
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

查询套餐列表信息

功能介绍

查询套餐列表信息

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/price-plans

表1 Query参数

参数

是否必选

参数类型

描述

limit

否

Long

分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数

最小值：10

最大值：500

缺省值：10

offset

否

Long

分页查询时的页码数，默认值为1，取值范围为1-1000000的整数

最小值：1

最大值：1000000

缺省值：1

main_search_key

否

String

查询关键标识类型：套餐名称 例如中国移动消费级每月30M联接服务（1年）

最大长度：256

flow_total

否

Long

流量总量(MB)

最小值：0

network_type

否

Long

网络制式 1.2g,3g,4g 2.NB

最小值：0

location_type

否

Long

覆盖区域:1. 中国 2. 欧洲 3. 大洋洲 4. 非洲 5. 亚太

最小值：0

carrier_type

否

Integer

运营商 1中国移动（实体卡） 2中国电信（实体卡） 3中国联通（实体卡） 4海外运营商（实体卡）

esim/vsim: 101.中国移动 102.中国电信 201.欧洲 501.中国香港 502.中国澳门 503.泰国 504.日本 505.柬埔寨 506.印度尼西亚 507.马来西亚 508.新加坡 509.斯里兰卡 510.中国台湾 511.孟加拉

最小值：0

country_type

否

Long

国家/地区 1中国香港，2中国澳门，3泰国，4日本，5，柬埔寨，6印尼，7马来西亚，8新加坡，9斯里兰卡，10中国台湾，11孟加拉

最小值：0

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

limit

Long

每页的记录数

最小值：10

最大值：500

offset

Long

页码，最小值是1，最大值为1000000。默认值是1.

最小值：1

最大值：1000000

count

Long

记录总数

最小值：0

price_plans

Array of ProPricePlanVo objects

套餐列表
表4 ProPricePlanVo

参数

参数类型

描述

price_plan_id

String

套餐ID

price_plan_name

String

套餐名称

description

String

描述

flow_total

Long

流量总量(MB)

package_type

Integer

套餐类型 1基础套餐;2叠加包套餐;如果是国际漫游不区分基础套餐包和叠加包

period

Integer

套餐周期

period_type

Integer

套餐周期类型 10:日;20:月;30:季;40:半年;50:年

effect_type

Integer

套餐生效类型 1.订购后激活使用时生效 2.订购即时生效 3.订购下个月开始生效

silent_period_day

Integer

沉默期

silent_period_unit

Integer

沉默期单位 1.年 2.月 3.日

auto_renew

Boolean

是否自动续订

location_desc

String

套餐适用区域

location_type

Integer

区域 1.中国 2.欧洲 3.大洋洲 4.非洲 5.亚太

sim_type

Integer

SIM卡类型 1.vSIM 2.eSIM 3.实体卡

carrier_type

Integer

运营商 1中国移动（实体卡） 2中国电信（实体卡） 3中国联通（实体卡） 4海外运营商（实体卡）

esim/vsim: 101.中国移动 102.中国电信 201.欧洲 501.中国香港 502.中国澳门 503.泰国 504.日本 505.柬埔寨 506.印度尼西亚 507.马来西亚 508.新加坡 509.斯里兰卡 510.中国台湾 511.孟加拉

price

Integer

价格(分)

状态码： 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

状态码： 500

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

查询全球SIM联接服务定义的套餐列表，每页返回10条数据，从第1页开始

GET https://{endpoint}/v1/price-plans?offset=1&limit=10

响应示例

状态码： 200

OK

{
  "limit" : 10,
  "offset" : 1,
  "count" : 1,
  "price_plans" : [ {
    "price_plan_id" : "100000",
    "price_plan_name" : "中国电信消费级每月30M联接服务（1年）",
    "description" : "中国电信消费级每月30M联接服务（1年）",
    "flow_total" : 10,
    "package_type" : 1,
    "period" : 1,
    "period_type" : 20,
    "effect_type" : 1,
    "silent_period_day" : 6,
    "silent_period_unit" : 2,
    "auto_renew" : false,
    "location_desc" : "中国",
    "location_type" : 1,
    "sim_type" : 3,
    "carrier_type" : 2,
    "price" : 1
  } ]
}

状态码： 400

Parameter Invalid

{
  "error_code" : "GSL.00010004",
  "error_msg" : "参数异常"
}

状态码： 500

Internal Server Error

{
  "error_code" : "GSL.00010003",
  "error_msg" : "系统繁忙，请稍后重试。"
}

状态码

状态码

描述

200

OK

400

Parameter Invalid

500

Internal Server Error

错误码

请参见错误码。

父主题： 套餐管理

相关文档