feat: 更新包月充电、获取用户信息、用户关系相关说明 (#981)

* Update charge_list.md * Update charge_msg.md * Update relation.md * Update relation.md * update * Update monthly.md * Update monthly.md * update * Update charge_list.md * Update relation.md * Update monthly.md * Update README.md * Update charge_list.md * update * Update relation.md * Update relation.md * Update relation.md * Update info.md * update
SocialSisterYi · Mar 10, 2024 · f9ee5c3 · f9ee5c3
1 parent 4645c1e
commit f9ee5c3
Show file tree

Hide file tree

Showing 7 changed files with 451 additions and 368 deletions.
diff --git a/README.md b/README.md
@@ -187,9 +187,10 @@ B站 API 采用 C/S 结构，大多数接口为 REST API 和 gRPC，少部分接
 - [x] [实时广播（通讯协议）](docs/broadcast)
     - [x] [视频内广播](docs/broadcast/video_room.md)
 - [ ] [充电](docs/electric)
-    - [ ] [包月充电操作](docs/electric/monthly.md)
-    - [x] [自定义充电（B币方式）](docs/electric/Bcoin.md)
-    - [x] [自定义充电（微信 & 支付宝方式）](docs/electric/WeChat&Alipay.md)
+  - [ ] [包月充电](docs/electric/monthly.md)
+  - [ ] 自定义充电
+    - [x] [B币方式充电](docs/electric/Bcoin.md)
+    - [x] [微信 & 支付宝方式充电](docs/electric/WeChat&Alipay.md)
     - [x] [充电留言](docs/electric/charge_msg.md)
     - [x] [充电列表](docs/electric/charge_list.md)
 - [ ] [动态](docs/dynamic)

diff --git a/docs/electric/charge_list.md b/docs/electric/charge_list.md
@@ -25,13 +25,13 @@
 
 `data`对象：
 
-| 字段        | 类型  | 内容             | 备注         |
-| ----------- | ----- | ---------------- | ------------ |
-| count       | num   | 本月充电人数     |              |
-| list        | array | 本月充电用户列表 |              |
-| total_count | num   | 总计充电次数     |              |
-| total       | num   | 总计充电次数     | 同上         |
-| special_day | num   | 0                | 作用尚不明确 |
+| 字段        | 类型  | 内容             | 备注            |
+| ----------- | ----- | ---------------- | --------------- |
+| count       | num   | 本月充电人数     |                 |
+| list        | array | 本月充电用户列表 |                 |
+| total_count | num   | 总计充电次数     |                 |
+| total       | num   | 总计充电次数     | 同`total_count` |
+| special_day | num   | 0                | 作用尚不明确    |
 
 `data`中的`list`数组：
 
@@ -69,8 +69,8 @@
 查询用户`mid=53456`的充电公示列表
 
 ```shell
-curl -G 'https://api.bilibili.com/x/ugcpay-rank/elec/month/up?up_mid=53456' \
---data-urlencode 'mid=53456'
+curl -G 'https://api.bilibili.com/x/ugcpay-rank/elec/month/up' \
+--data-urlencode 'up_mid=53456'
 ```
 
 <details>
@@ -166,14 +166,14 @@ curl -G 'https://api.bilibili.com/x/ugcpay-rank/elec/month/up?up_mid=53456' \
 
 `data`对象：
 
-| 字段        | 类型   | 内容             | 备注         |
-| ----------- | ------ | ---------------- | ------------ |
-| show_info   | obj    | 展示选项         |              |
-| av_count    | num    | 目标视频充电人数 |              |
-| count       | num    | 本月充电人数     |              |
-| total_count | num    | 总计充电人数     |              |
-| special_day | num    | 0                | 作用尚不明确 |
-| display_num | num    | 0                | 作用尚不明确 |
+| 字段        | 类型  | 内容             | 备注         |
+| ----------- | ----- | ---------------- | ------------ |
+| show_info   | obj   | 展示选项         |              |
+| av_count    | num   | 目标视频充电人数 |              |
+| count       | num   | 本月充电人数     |              |
+| total_count | num   | 总计充电人数     |              |
+| special_day | num   | 0                | 作用尚不明确 |
+| display_num | num   | 0                | 作用尚不明确 |
 | list        | array | 本月充电用户列表 |              |
 
 `data`中的`show_info`对象：
@@ -231,7 +231,7 @@ bvid方式：
 ```shell
 curl -G 'https://api.bilibili.com/x/web-interface/elec/show' \
 --data-urlencode 'mid=53456' \
---data-urlencode 'bvid=BV1up4y1y77i '
+--data-urlencode 'bvid=BV1up4y1y77i'
 ```
 
 <details>
@@ -301,73 +301,76 @@ curl -G 'https://api.bilibili.com/x/web-interface/elec/show' \
 
 **url参数：**
 
-| 参数名   | 类型 | 内容     | 必要性 | 备注                             |
-| -------- | ---- | -------- | ------ | -------------------------------- |
-| currentPage | num  | 页数 | 必要   |  |
-| pageSize | num  | 分页大小 | 必要   | 取值范围[1,50] |
-| customerId | num  | (?) | 必要   | 目前为固定值：10026 |
-| beginTime | str  | 开始日期 |    | yyyy-MM-dd |
-| endTime | str  | 结束日期 |    | yyyy-MM-dd |
+| 参数名      | 类型 | 内容     | 必要性 | 备注                |
+| ----------- | ---- | -------- | ------ | ------------------- |
+| currentPage | num  | 页数     | 必要   |                     |
+| pageSize    | num  | 分页大小 | 必要   | 取值范围[1,50]      |
+| customerId  | num  | (?)      | 必要   | 目前为固定值：10026 |
+| beginTime   | str  | 开始日期 | 非必要 | yyyy-MM-dd          |
+| endTime     | str  | 结束日期 | 非必要 | yyyy-MM-dd          |
 
 **json回复：**
 
 根对象：
 
 | 字段    | 类型 | 内容     | 备注                        |
 | ------- | ---- | -------- | --------------------------- |
-| code    | num  | 返回值   | 0：成功<br />800501007：user not login<br />800501008：内部错误<br /> 800501011：请求参数有误|
-| errno | num  |  |                      |
-| msg     | str  |         |                             |
-| showMsg     | str  |        |                             |
-| success     | bool  |         |                             |
+| code    | num  | 返回值   | 0：成功<br />800501007：user not login<br />800501008：内部错误<br /> 800501011：请求参数有误 |
+| errno   | num  |          |                             |
+| msg     | str  |          |                             |
+| showMsg | str  |          |                             |
+| success | bool |          |                             |
 | data    | obj  | 信息本体 |                             |
 
 `data`对象：
 
-| 字段     | 类型  | 内容   | 备注 |
-| -------- | ----- | ------ | ---- |
-| page | obj | 分页信息 |      |
+| 字段   | 类型  | 内容         | 备注 |
+| ------ | ----- | ------------ | ---- |
+| page   | obj   | 分页信息     |      |
 | result | array | 充电信息本体 |      |
-| config | array | (?) |      |
+| config | array | (?)          |      |
 
 `page`对象：
 
-| 字段     | 类型  | 内容   | 备注 |
-| -------- | ----- | ------ | ---- |
-| currentPage | num | 当前页数 |      |
-| pageSize | num | 当前分页大小 |      |
-| totalCount | num | 记录总数 |      |
-| totalPage | num | 总页数 |      |
+| 字段        | 类型 | 内容         | 备注 |
+| ----------- | ---- | ------------ | ---- |
+| currentPage | num  | 当前页数     |      |
+| pageSize    | num  | 当前分页大小 |      |
+| totalCount  | num  | 记录总数     |      |
+| totalPage   | num  | 总页数       |      |
 
 `config`数组中的对象：
 
-| 字段     | 类型  | 内容   | 备注 |
-| -------- | ----- | ------ | ---- |
-| mid | num |  |   总是为null   |
-| name | str |  |    总是为null   |
-| avatar | str |  |    总是为null   |
-| originalThirdCoin | num |  |    总是为null   |
-| brokerage | num |  |   总是为null    |
-| remark | str |  |    总是为null   |
-| ctime | str |  |    总是为null   |
+| 字段              | 类型 | 内容 | 备注       |
+| ----------------- | ---- | ---- | ---------- |
+| mid               | null |      | 总是为null |
+| name              | null |      | 总是为null |
+| avatar            | null |      | 总是为null |
+| originalThirdCoin | null |      | 总是为null |
+| brokerage         | null |      | 总是为null |
+| remark            | null |      | 总是为null |
+| ctime             | null |      | 总是为null |
 
 `result`数组中的对象：
 
-| 字段     | 类型  | 内容   | 备注 |
-| -------- | ----- | ------ | ---- |
-| mid | num | 充电人mid |      |
-| name | str | 充电人昵称 |      |
-| avatar | str | 充电人头像 |      |
-| originalThirdCoin | num | 原始B币数 |      |
-| brokerage | num | 实际收到的贝壳数 |      |
-| remark | str | 充电渠道 |  Web/安卓/iOS    |
-| ctime | str | 充电时间 |   yyyy-MM-dd HH:mm:ss   |
+| 字段              | 类型 | 内容             | 备注                |
+| ----------------- | ---- | ---------------- | ------------------- |
+| mid               | num  | 充电人mid        |                     |
+| name              | str  | 充电人昵称       |                     |
+| avatar            | str  | 充电人头像       |                     |
+| originalThirdCoin | num  | 原始B币数        |                     |
+| brokerage         | num  | 实际收到的贝壳数 |                     |
+| remark            | str  | 充电渠道         | Web/安卓/iOS        |
+| ctime             | str  | 充电时间         | yyyy-MM-dd HH:mm:ss |
 
 **示例：**
 
 ```shell
-curl -L -X GET 'https://pay.bilibili.com/bk/brokerage/listForCustomerRechargeRecord?currentPage=1&pageSize=2&customerId=10026' \
--H 'Cookie: SESSDATA=xxx'
+curl -G 'https://pay.bilibili.com/bk/brokerage/listForCustomerRechargeRecord' \
+--data-urlencode 'currentPage=1' \
+--data-urlencode 'pageSize=2' \
+--data-urlencode 'customerId=10026' \
+-b 'SESSDATA=xxx'
 ```
 
 <details>
@@ -480,8 +483,8 @@ curl -L -X GET 'https://pay.bilibili.com/bk/brokerage/listForCustomerRechargeRec
 **示例：**
 
 ```shell
-curl -L -X GET 'https://member.bilibili.com/x/h5/elec/rank/recent' \
--H 'Cookie: SESSDATA=xxx'
+curl -G 'https://member.bilibili.com/x/h5/elec/rank/recent' \
+-b 'SESSDATA=xxx'
 ```
 
 <details>