短信量包查询
更新时间:2025-12-12
描述
实现外部客户通过api查询短信流量包。
URL
/sms/v3/prepay/{userid}
注意userid是用户在v3系统里面的账户id即accountid
HTTP Method
GET
请求Query参数
| 参数名称 | 类型 | 是否必须 | 描述 | 取值示例 |
|---|---|---|---|---|
| pageNo | String | 否 | 查询页所在位置 默认:1 |
1 |
| pageSize | String | 否 | 查询页量包数量 默认:10 |
10 |
| countryType | String | 否 | 不填默认查询所有类型 签名适用的国家类型 domestic:国内 international:国际/港澳台 global:全球均适用 |
domestic |
| packageStatus | String | 否 | 不填默认查询所有类型 量包可用状态 RUNNING:使用中 EXPIRED:已过期 USED_UP:已用完 DESTROYED:已销毁 |
RUNNING |
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| prepaidPackages | List | PrepaidPackage数组,一个PrepaidPackage对应一个量包 |
| totalCount | int | 用户查询到量包总数 |
StatisticsResult定义
| 参数名称 | 类型 | 描述 |
|---|---|---|
| packageId | String | 量包ID |
| name | String | 量包名称 |
| countryType | String | 量包适用国家类型 DOMESTIC:国内 INTERNATIONAL:国际/港澳台 GLOBAL:全球 |
| capacity | BigDecimal | 量包短信总量条数 |
| remainingCapacity | BigDecimal | 量包短信剩余用量条数 |
| packageStatus | String | 量包可用状态 RUNNING:使用中 EXPIRED:已过期 USED_UP:已用完 DESTROYED:已销毁 |
| purchaseDate | Date | 量包购买时间 |
| expiryDate | Date | 量包过期时间 |
HTTP请求示例
JSON
1GET /sms/v3/prepay/cdf5755983a346108e212762b9a462c0?pageNo=1&pageSize=10&countryType=domestic&packageStatus=EXPIRED HTTP/1.1
2Host: smsv3.bj.baidubce.com
3Authorization: bce-auth-v1/d9e2e7cf6aad47999a6f7015b0222c73/2025-11-26T06:54:46Z/36000/host/d8632b9f879eccbfd61d2b889129d3e7ffd95d50a1886d7d581216e7c89e454b
4Content-Type: application/json
响应成功示例
JSON
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 26 Nov 2025 06:59:48 GMT
4Server: BWS
5X-Bce-Request-Id: 3c73286f-35ed-455c-8b34-546d0b74284f
6{
7 "prepaidPackages": [
8 {
9 "packageId": "cdaf598458394cc983db8fdc1853fc78",
10 "name": "国内普通短信包",
11 "countryType": "DOMESTIC",
12 "capacity": 5000.00,
13 "remainingCapacity": 0.00,
14 "packageStatus": "EXPIRED",
15 "purchaseDate": "2022-01-07T08:53:52.000+00:00",
16 "expiryDate": "2022-01-07T09:05:52.000+00:00"
17 },
18 {
19 "packageId": "794e0e34dcad4edc96c566bcb26a3dc0",
20 "name": "国内普通短信包",
21 "countryType": "DOMESTIC",
22 "capacity": 5000.00,
23 "remainingCapacity": 0.00,
24 "packageStatus": "EXPIRED",
25 "purchaseDate": "2022-01-07T08:42:52.000+00:00",
26 "expiryDate": "2022-01-07T08:54:52.000+00:00"
27 }
28 ],
29 "totalCount": 2
30}
