get_red_packet_info
查询群消息中 red_packet 消息段对应的 QQ 红包详细信息。
此接口在已认证的服务连接中调用,账号须属于当前框架且处于在线状态。self_id 与 protocol_id 共同选择账号。
此接口是预领取查询,不执行领取。retcode、retmsg 表示预领取结果;state 是上游状态值,不承诺未验证的枚举。send_object 仅在上游提供可解析详情时出现,claim_token 可用于后续领取。
适用协议
Android(手机 / 平板);Linux QQ 支持情况待核验。
调用方式
Free 不可调用。Plus 每次调用核对当前 QQ 最新等级,至少需要 32 级;Pro 不设这项 QQ 等级门槛。本接口虽不执行领取,但会返回领取材料,因此同样受此限制。
向已认证的 WebSocket 连接发送:
json
{
"type": "action",
"id": "example-1",
"action": "get_red_packet_info",
"params": {
"self_id": 123456789,
"protocol_id": 0,
"group_id": 987654321,
"sender_id": 1,
"red_packet": {
"title": "example",
"listid": "example",
"authkey": "example",
"channel": 1,
"pay_flag": 1,
"hb_from": 1,
"msg_random": 1,
"client_seq": 1,
"grab_uin_list": []
}
}
}响应通过相同 id 对应请求。连接、HTTP 调用与错误处理见通信协议。
参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
self_id | integer | 是 | 当前框架内的账号 QQ 号 |
protocol_id | integer | 是 | 账号协议配置 ID;从 get_protocol_list 获取,必须显式传入,0 也是有效 ID |
group_id | integer | 是 | 目标群号 |
sender_id | integer | 是 | 发送红包或转发资源的 QQ 号 |
red_packet | object | 是 | 红包参数对象,详见下方结构 |
red_packet.title | string | 见说明 | 收到的红包标题,沿用消息事件中的值 |
red_packet.listid | string | 见说明 | 消息事件中的红包编号 |
red_packet.authkey | string | 见说明 | 消息事件中的红包认证键 |
red_packet.channel | integer | 见说明 | 上游红包通道值 |
red_packet.pay_flag | integer | 见说明 | 消息事件中的红包支付标识 |
red_packet.hb_from | integer | 见说明 | 消息事件中的红包来源标识 |
red_packet.msg_random | integer | 见说明 | 上游消息随机数 |
red_packet.client_seq | integer | 见说明 | 客户端序列号 |
red_packet.grab_uin_list | integer[] | 见说明 | 红包消息中的领取目标 QQ 列表 |
claim_token | string | 否 | 预领取查询返回的令牌 |
返回值
以下为成功响应的 data,错误通过 ok: false 与 error 返回。
| 字段 | 类型 | 说明 |
|---|---|---|
retcode | string | 业务返回码字符串 |
retmsg | string | 业务返回说明 |
state | integer | 上游状态值 |
claim_token | string | 预领取查询返回的令牌 |
send_object | object | 可选的红包详情对象 |
send_object.sender_id | integer | 发送者 QQ 号 |
send_object.channel | integer | 上游红包通道值 |
send_object.recv_amount | integer | 已领取金额 |
send_object.recv_num | integer | 已领取份数 |
send_object.send_listid | string | 红包编号 |
send_object.send_name | string | 红包发送者名称 |
send_object.total_amount | integer | 红包总金额,单位分 |
send_object.total_num | integer | 红包总份数 |
send_object.wishing | string | 祝福语 |
