LoginApi
modules.login.LoginApi
Bases: ApiModule
登录相关的 API.
Source code in qqmusic_api/modules/_base.py
check_expired
async
check_expired(credential: Credential | None = None) -> bool
检查登录凭证是否已过期.
| PARAMETER | DESCRIPTION |
|---|---|
credential
|
待检查的凭证. 若为 None 则检查当前客户端已存储的凭证.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
bool
|
是否已过期.
TYPE:
|
Source code in qqmusic_api/modules/login.py
refresh_credential
async
尝试刷新登录凭证.
| PARAMETER | DESCRIPTION |
|---|---|
credential
|
待刷新的凭证. 若为 None 则刷新当前客户端已存储的凭证.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Credential
|
刷新后的新凭证对象.
TYPE:
|
Source code in qqmusic_api/modules/login.py
get_qrcode
async
获取指定类型的登录二维码.
| PARAMETER | DESCRIPTION |
|---|---|
login_type
|
登录类型 (QQ/微信/手机客户端).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QR
|
包含二维码二进制数据及标识符的对象.
TYPE:
|
Source code in qqmusic_api/modules/login.py
check_qrcode
async
检查二维码登录状态.
| PARAMETER | DESCRIPTION |
|---|---|
qrcode
|
待检查的二维码对象.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
QRLoginResult
|
包含当前状态和凭证 (仅在 DONE 时包含) 的结果对象.
TYPE:
|
Source code in qqmusic_api/modules/login.py
checking_mobile_qrcode
async
checking_mobile_qrcode(
qrcode: QR, deadline: float | None = None
) -> QRLoginStream
检查手机登录二维码状态 (单次 MQTT 连接生命周期).
建立 MQTT 订阅并持续产出服务端推送的登录状态事件.
当收到终端事件 (DONE/REFUSE/TIMEOUT/OTHER) 时会主动结束迭代.
| PARAMETER | DESCRIPTION |
|---|---|
qrcode
|
待检查的二维码对象.
TYPE:
|
deadline
|
基于
TYPE:
|
| YIELDS | DESCRIPTION |
|---|---|
QRLoginResult
|
包含当前状态和凭证的结果对象.
TYPE::
|
| RAISES | DESCRIPTION |
|---|---|
NetworkError
|
MQTT 建连、订阅或消息监听过程中发生网络错误. |
Source code in qqmusic_api/modules/login.py
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | |
send_authcode
async
发送手机验证码.
| PARAMETER | DESCRIPTION |
|---|---|
phone
|
手机号.
TYPE:
|
country_code
|
国家代码, 默认为 86 (中国).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
PhoneAuthCodeResult
|
包含发送状态及附加信息的结果对象.
TYPE:
|
Source code in qqmusic_api/modules/login.py
phone_authorize
async
使用手机验证码鉴权.
| PARAMETER | DESCRIPTION |
|---|---|
phone
|
手机号.
TYPE:
|
auth_code
|
验证码.
TYPE:
|
country_code
|
国家代码, 默认为 86.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Credential
|
登录成功后的凭证对象.
TYPE:
|