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
|
待刷新的凭证.
TYPE:
|
| RAISES | DESCRIPTION |
|---|---|
CredentialRefreshError
|
凭证刷新失败. |
| 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:
|
| RAISES | DESCRIPTION |
|---|---|
LoginAuthExpiredError
|
登录鉴权参数无效或已过期 (code=1000/104401/104400). |
LoginDeviceLimitError
|
登录设备数量超限 (code=20279). |
LoginAccountRestrictedError
|
账号受限或已被封禁 (code=20277/20278/20450). |
LoginRateLimitError
|
操作过于频繁 (code=104604). |
LoginError
|
其他登录业务异常. |
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
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 | |
send_authcode
async
发送手机验证码.
固定使用 Android 平台.
| PARAMETER | DESCRIPTION |
|---|---|
phone
|
手机号 (int) 或加密手机号 (str). |
country_code
|
国家代码, 默认为 86 (中国).
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
PhoneAuthCodeResult
|
包含发送状态及附加信息的结果对象.
TYPE:
|
Source code in qqmusic_api/modules/login.py
phone_authorize
async
使用手机验证码鉴权.
固定使用 Android 平台.
| PARAMETER | DESCRIPTION |
|---|---|
phone
|
手机号 (int) 或加密手机号 (str). |
auth_code
|
验证码.
TYPE:
|
| RETURNS | DESCRIPTION |
|---|---|
Credential
|
登录成功后的凭证对象.
TYPE:
|
| RAISES | DESCRIPTION |
|---|---|
LoginAuthExpiredError
|
登录鉴权参数无效或已过期 (code=1000/104401/104400). |
LoginDeviceLimitError
|
登录设备数量超限 (code=20279). |
LoginAccountRestrictedError
|
账号受限或已被封禁 (code=20277/20278/20450). |
LoginRateLimitError
|
操作过于频繁 (code=104604). |
LoginError
|
其他登录业务异常. |