diff --git a/docs/message/private_msg.md b/docs/message/private_msg.md index ada10e9..1a5beff 100644 --- a/docs/message/private_msg.md +++ b/docs/message/private_msg.md @@ -26,7 +26,7 @@ | new_face_version | num | 表情包版本 | 为 `0` 或无此项表示旧版表情包,此时 B 站会自动转换成新版表情包,例如 `[doge]` -> `[tv_doge]`;`1` 为新版 | | msg_source | num | 消息来源 | 见[消息来源列表](#消息来源列表) | -`at_uids`数组: +`私信主体对象`中的`at_uids`数组: | 项 | 类型 | 内容 | 备注 | | ---- | ---- | --------- | ------- | @@ -167,7 +167,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \ | max_seqno | num | 所有消息中最大的序列号(最晚) | 若无私信则为 `0` | | e_infos | array | 聊天表情列表 | 若私信列表中无表情则无此项 | -`messages`数组: +`data`对象中的`messages`数组: | 项 | 类型 | 内容 | 备注 | | ---- | ---- | --------- | --------------------------------- | @@ -175,7 +175,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \ | n | obj | 私信(n+1) | | | …… | obj | …… | …… | -`e_infos`数组: +`data`对象中的`e_infos`数组: | 项 | 类型 | 内容 | 备注 | | ---- | ---- | --------- | ---- | @@ -183,7 +183,7 @@ curl 'https://api.vc.bilibili.com/session_svr/v1/session_svr/single_unread' \ | n | obj | 表情(n+1) | | | …… | obj | …… | …… | -`e_infos`数组中的对象: +`data`对象中的`e_infos`数组中的对象: | 字段 | 类型 | 内容 | 备注 | | ------- | ---- | ----------- | ----------------------------------- | @@ -352,20 +352,38 @@ public class Main { | 字段 | 类型 | 内容 | 备注 | | ------- | ---- | -------- | ------------------------------------------------- | -| code | num | 返回值 | 0:成功
-101:账号未登录
-400:请求错误
21047:你最多发送1条消息,对方回复或者关注你后可以继续发消息~ | -| message | str | 错误信息 | 默认为0 | +| code | num | 返回值 | 0:成功
-101:账号未登录
-400:请求错误
10005:msgkey不存在
21007:消息过长,无法发送
21026:不能给自己发送消息哦~
21035:该类消息暂时无法发送
21037:图片格式不合法,不要调戏接口啦
21041:消息已超期,不能撤回了哦
21042:消息已经撤回了哦
21046:你发消息的频率太高了,请在24小时后再发吧~
21047:你最多发送1条消息,对方回复或者关注你后可以继续发消息~ | +| message | str | 错误信息 | 成功时为0 | | ttl | num | | 默认为1 | -| data | obj | 信息本体 | 出错时无此项 | +| data | 有效时:obj
无效时:null | 信息本体 | | `data`对象: -| 字段 | 类型 | 内容 | 备注 | -| ------------- | ---- | ---------- | --------------------------------------------------------------------- | -| msg_key | num | 消息唯一id | | -| msg_content | str | 发送的消息 | 仅当请求参数中`msg[msg_type]`为`1`且`msg[receiver_type]`为`1`时有此项 | -| key_hit_infos | obj | 触发的提示 | 仅当请求参数中`msg[msg_type]`为`1`且`msg[receiver_type]`为`1`时有此项 | +| 字段 | 类型 | 内容 | 备注 | +| ------------- | ----- | ---------- | --------------------------------------------------------------------- | +| msg_key | num | 消息唯一id | | +| e_infos | array | 表情列表 | 若私信中无表情则无此项 | +| msg_content | str | 发送的消息 | 仅当请求参数中`msg[msg_type]`为`1`且`msg[receiver_type]`为`1`时有此项 | +| key_hit_infos | obj | 触发的提示 | 仅当请求参数中`msg[msg_type]`为`1`且`msg[receiver_type]`为`1`时有此项 | -`data`对象中的`key_hit_infos`: +`data`对象中的`e_infos`数组: + +| 项 | 类型 | 内容 | 备注 | +| ---- | ---- | --------- | ---- | +| 0 | obj | 表情1 | | +| n | obj | 表情(n+1) | | +| …… | obj | …… | …… | + +`data`对象中的`e_infos`数组中的对象: + +| 字段 | 类型 | 内容 | 备注 | +| ------- | ---- | ----------- | ----------------------------------- | +| text | str | 表情名称 | 包括左右两侧的中括号,如`[tv_doge]` | +| uri | str | 表情链接 | | +| size | num | 表情尺寸 | 1:小
2:大 | +| gif_url | str | 表情GIF链接 | 仅部分表情存在此项 | + +`data`对象中的`key_hit_infos`对象: | 字段 | 类型 | 内容 | 备注 | | --------- | ----- | ------------ | -------------------------------------- | @@ -373,8 +391,7 @@ public class Main { | rule_id | num | 触发的规则id | 当触发了提示时有此项,详细信息有待补充 | | high_text | array | 高亮的文本 | 当触发了提示时有此项 | - -`data`对象中的`key_hit_infos`中的`high_text`数组: +`data`对象中的`key_hit_infos`对象中的`high_text`数组: | 项 | 类型 | 内容 | 备注 | | ---- | ---- | ------------- | ---------------- | diff --git a/docs/message/private_msg_content.md b/docs/message/private_msg_content.md index 5c04d9c..9345c2f 100644 --- a/docs/message/private_msg_content.md +++ b/docs/message/private_msg_content.md @@ -2,7 +2,7 @@ ## 文字消息(`msg_type=1`) -在发送私信时,请确保下面的对象合法且 `content` 项的值为非 0 长度的文本,否则会提示 `请求错误` +在发送私信时,请确保下面的对象合法且 `content` 项的值为非空文本,否则会提示 `请求错误` 根对象: @@ -54,7 +54,7 @@ 内容为目标私信的 `msg_key` -请确保目标私信存在,且发送的私信与目标私信在同一会话内;发送此私信后,目标私信的 `msg_status` 会变成 `1` +请确保目标私信存在、在撤回有效期里,且与发送的私信在同一会话内;成功发送此私信后,目标私信的 `msg_status` 会变成 `1` **示例:** @@ -64,11 +64,11 @@ 7345551441311046575 ``` -这时,私信 A 就会被撤回,并且其 `msg_status` 也会变成 `1` +若发送成功,则私信 A 会被撤回,并且其 `msg_status` 也会变成 `1` ## 自定义表情消息(`msg_type=6`) -对象结构基本同 [图片消息](#图片消息(`msg_type=6`)) +对象结构基本同 [图片消息](#图片消息msg_type2) ## 分享消息(`msg_type=7`) @@ -78,26 +78,26 @@ ## 通知消息(`msg_type=10`) -本类型消息仅可接收,不能直接发送 +此类型消息仅可接收,不可直接发送 ## 视频推送消息(`msg_type=11`) -本类型消息仅可接收,不能直接发送 +此类型消息仅可接收,不可直接发送 ## 专栏推送消息(`msg_type=12`) -本类型消息仅可接收,不能直接发送 +此类型消息仅可接收,不可直接发送 ## 图片卡片消息(`msg_type=13`) -本类型消息仅可接收,不能直接发送 +此类型消息仅可接收,不可直接发送 ## 被关注时的自动推送消息(`msg_type=16`) ## 系统提示消息(`msg_type=18`) -本类型消息仅可接收,不能直接发送 +此类型消息仅可接收,不可直接发送