song

models.song

Song API 返回模型定义.

QuerySongResponse `pydantic-model`

Bases: Response

批量歌曲查询响应.

ATTRIBUTE	DESCRIPTION
`tracks`	按请求条件返回的歌曲对象列表. TYPE: `list[Song]`

Fields:

tracks (list[Song])

UrlinfoItem `pydantic-model`

Bases: Response

表示 GetEVkey/GetVkey 返回的单个文件授权结果.

ATTRIBUTE	DESCRIPTION
`mid`	歌曲 mid. TYPE: `str`
`filename`	请求的目标文件名. TYPE: `str`
`purl`	相对下载路径,需要与 CDN 域名拼接后才能访问. TYPE: `str`
`vkey`	资源访问令牌,歌曲文件通常依赖该字段完成鉴权. TYPE: `str`
`ekey`	加密资源解密密钥. TYPE: `str`
`result`	单个文件的业务结果码.常见值为 `0`(成功)、`104003`(无权限)、 `104004`(VKey 获取失败)、`104013`(播放设备受限). TYPE: `int`

Fields:

mid (str)
filename (str)
purl (str)
vkey (str)
ekey (str)
result (int)

GetSongUrlsResponse `pydantic-model`

Bases: Response

歌曲播放地址响应.

同一次请求可能返回多个码率或文件名对应的授权结果,调用方需逐项判断是否可播放.

ATTRIBUTE	DESCRIPTION
`expiration`	链接过期时间 (秒). TYPE: `int`
`data`	每个目标文件对应的授权与路径信息. TYPE: `list[UrlinfoItem]`

Fields:

expiration (int)
data (list[UrlinfoItem])

ContentItem `pydantic-model`

Bases: Response

表示 GetSongDetail 返回的内容项.

ATTRIBUTE	DESCRIPTION
`id`	内容项 ID. TYPE: `int`
`value`	内容项值. TYPE: `str`
`show_type`	内容项展示类型. TYPE: `int`
`jumpurl`	内容项跳转链接. TYPE: `str`

Fields:

id (int)
value (str)
show_type (int)
jumpurl (str)

GetSongDetailResponse `pydantic-model`

Bases: Response

歌曲详情响应.

除歌曲基础信息外,还按内容分组返回发行公司、流派、语言、发布时间等补充资料.

ATTRIBUTE	DESCRIPTION
`company`	发行公司信息. TYPE: `list[ContentItem]`
`genre`	歌曲类型信息. TYPE: `list[ContentItem]`
`intro`	歌曲简介信息. TYPE: `list[ContentItem]`
`lan`	语言信息. TYPE: `list[ContentItem]`
`pub_time`	发布时间信息. TYPE: `list[ContentItem]`
`extras`	额外信息. TYPE: `dict[str, str]`
`track`	歌曲基本信息. TYPE: `Song`

Fields:

company (list[ContentItem])
genre (list[ContentItem])
intro (list[ContentItem])
lan (list[ContentItem])
pub_time (list[ContentItem])
extras (dict[str, str])
track (Song)

SimilarSongGroup `pydantic-model`

Bases: Response

一组相似歌曲推荐卡片.

一个分组对应一个推荐标题及其下挂载的歌曲列表.

ATTRIBUTE	DESCRIPTION
`title_template`	推荐分组的标题模板. TYPE: `str`
`title_content`	标题模板中的实际内容. TYPE: `str`
`song`	当前推荐分组下的歌曲列表. TYPE: `list[Song]`

Fields:

title_template (str)
title_content (str)
song (list[Song])

GetSimilarSongResponse `pydantic-model`

Bases: Response

相似歌曲推荐响应.

ATTRIBUTE	DESCRIPTION
`tag`	本次推荐附带的歌曲标签列表. TYPE: `list[dict]`
`song`	按卡片分组组织的相似歌曲结果. TYPE: `list[SimilarSongGroup]`

Fields:

tag (list[dict])
song (list[SimilarSongGroup])

SongLabel `pydantic-model`

Bases: Response

歌曲标签项.

ATTRIBUTE	DESCRIPTION
`id`	标签 ID. TYPE: `int`
`tag_txt`	标签文本. TYPE: `str`
`tag_icon`	标签图标地址. TYPE: `str`
`tag_url`	标签跳转链接. TYPE: `str`
`tag_type`	标签类型. TYPE: `int`
`species`	标签所属分类. TYPE: `int`

Fields:

id (int)
tag_txt (str)
tag_icon (str)
tag_url (str)
tag_type (int)
species (int)

GetSongLabelsResponse `pydantic-model`

Bases: Response

获取歌曲标签结果.

ATTRIBUTE	DESCRIPTION
`labels`	歌曲标签列表. TYPE: `list[SongLabel]`

Fields:

labels (list[SongLabel])

RelatedPlaylist `pydantic-model`

Bases: SongList

歌曲详情页关联歌单中的单个歌单摘要.

ATTRIBUTE	DESCRIPTION
`creator`	歌单创建者名称. TYPE: `str`

Fields:

id (int)
dirid (int)
title (str)
picurl (str)
desc (str)
songnum (int)
listennum (int | str)
creator (str)

GetRelatedSonglistResponse `pydantic-model`

Bases: Response

歌曲关联歌单响应.

ATTRIBUTE	DESCRIPTION
`has_more`	是否还有更多结果. TYPE: `int`
`songlist`	按推荐分组展开后的相关歌单列表. TYPE: `list[RelatedPlaylist]`

Fields:

has_more (int)
songlist (list[RelatedPlaylist])

RelatedMv `pydantic-model`

Bases: MV

歌曲详情页关联 MV 的摘要信息.

ATTRIBUTE	DESCRIPTION
`picurl`	MV 封面. TYPE: `str`
`playcnt`	MV 播放量. TYPE: `int`
`singers`	MV 关联歌手列表. TYPE: `list[MVSinger]`

Fields:

id (int)
vid (str)
type (int)
name (str)
title (str)
picurl (str)
playcnt (int)
singers (list[MVSinger])

MVSinger `pydantic-model`

Bases: Singer

关联 MV 中的歌手摘要信息.

ATTRIBUTE	DESCRIPTION
`picurl`	歌手头像地址. TYPE: `str`

Fields:

id (int)
mid (str)
name (str)
title (str)
type (int)
uin (int)
pmid (str)
picurl (str)

GetRelatedMvResponse `pydantic-model`

Bases: Response

歌曲关联 MV 响应.

ATTRIBUTE	DESCRIPTION
`has_more`	是否还有更多结果. TYPE: `int`
`mv`	当前返回的相关 MV 列表. TYPE: `list[RelatedMv]`

Fields:

has_more (int)
mv (list[RelatedMv])

GetOtherVersionResponse `pydantic-model`

Bases: Response

获取歌曲其他版本结果.

ATTRIBUTE	DESCRIPTION
`data`	其他版本歌曲列表. TYPE: `list[Song]`

Fields:

data (list[Song])

SongProducer `pydantic-model`

Bases: Response

歌曲制作人项.

ATTRIBUTE	DESCRIPTION
`type`	制作人类型. TYPE: `int`
`name`	制作人名称. TYPE: `str`
`icon`	制作人头像. TYPE: `str`
`scheme`	制作人跳转链接. TYPE: `str`
`singer_mid`	制作人 singer mid. TYPE: `str`
`follow`	关注状态. TYPE: `int`

Fields:

type (int)
name (str)
icon (str)
scheme (str)
singer_mid (str)
follow (int)

SongProducerGroup `pydantic-model`

Bases: Response

歌曲制作人信息分组.

ATTRIBUTE	DESCRIPTION
`title`	分组标题. TYPE: `str`
`producers`	该分组下的制作人列表. TYPE: `list[SongProducer]`
`type`	分组类型. TYPE: `int`

Fields:

title (str)
producers (list[SongProducer])
type (int)

GetProducerResponse `pydantic-model`

Bases: Response

歌曲制作人响应.

ATTRIBUTE	DESCRIPTION
`data`	按职责分组的制作人列表. TYPE: `list[SongProducerGroup]`
`reinforce_msg`	附带的摘要说明文案. TYPE: `str`

Fields:

data (list[SongProducerGroup])
reinforce_msg (str)

SheetMusic `pydantic-model`

Bases: Response

曲谱项.

ATTRIBUTE	DESCRIPTION
`score_mid`	曲谱 MID. TYPE: `str`
`score_name`	曲谱名称. TYPE: `str`
`pic_urls`	曲谱图片列表. TYPE: `list[str]`
`version`	曲谱版本说明. TYPE: `str`
`tonality`	调号. TYPE: `int`
`score_type`	曲谱类型. TYPE: `int`
`score_type_text`	曲谱类型文本. TYPE: `str`
`uploader`	上传者. TYPE: `str`
`view_frequency`	浏览量. TYPE: `int`
`tonality2`	第二调号值. TYPE: `int`
`author`	作者. TYPE: `str`
`composer`	作曲. TYPE: `str`
`lyricist`	作词. TYPE: `str`
`singer`	演唱者. TYPE: `str`
`performer`	演奏者. TYPE: `str`
`song_mid`	关联歌曲 MID. TYPE: `str`
`sub_name`	曲谱副标题. TYPE: `str`
`url`	曲谱详情链接. TYPE: `str`
`album_url`	专辑链接. TYPE: `str`
`ins_type`	乐器类型. TYPE: `int`
`ins_type_text`	乐器类型文本. TYPE: `str`
`cover_url`	乐器封面. TYPE: `str`
`difficulty`	难度. TYPE: `str`
`sheet_file`	曲谱文件地址. TYPE: `str`

Fields:

score_mid (str)
score_name (str)
pic_urls (list[str])
version (str)
tonality (int)
score_type (int)
score_type_text (str)
uploader (str)
view_frequency (int)
tonality2 (int)
author (str)
composer (str)
lyricist (str)
singer (str)
performer (str)
song_mid (str)
sub_name (str)
url (str)
album_url (str)
ins_type (int)
ins_type_text (str)
cover_url (str)
difficulty (str)
sheet_file (str)

GetSheetResponse `pydantic-model`

Bases: Response

歌曲相关曲谱响应.

ATTRIBUTE	DESCRIPTION
`result`	当前返回的曲谱列表. TYPE: `list[SheetMusic]`
`total_map`	各曲谱类型对应的数量聚合. TYPE: `dict[str, int]`

Fields:

result (list[SheetMusic])
total_map (dict[str, int])

GetFavNumResponse `pydantic-model`

Bases: Response

歌曲收藏人数响应.

ATTRIBUTE	DESCRIPTION
`numbers`	以歌曲标识为键的收藏人数原始值映射. TYPE: `dict[str, int]`
`show`	对应的收藏人数展示文案映射. TYPE: `dict[str, str]`

Fields:

numbers (dict[str, int])
show (dict[str, str])

CdnDispatchSipInfo `pydantic-model`

Bases: Response

CDN 调度中的单个节点信息.

ATTRIBUTE	DESCRIPTION
`cdn`	CDN 节点地址. TYPE: `str`
`quic`	是否支持 QUIC. TYPE: `int`
`ipstack`	IP 栈类型. TYPE: `int`
`quichost`	QUIC 主机名. TYPE: `str`
`plaintext_quic`	是否支持明文 QUIC. TYPE: `int`
`encrypt_quic`	是否支持加密 QUIC. TYPE: `int`

Fields:

cdn (str)
quic (int)
ipstack (int)
quichost (str)
plaintext_quic (int)
encrypt_quic (int)

GetCdnDispatchResponse `pydantic-model`

Bases: Response

获取音频 CDN 调度响应.

仅保留歌曲 URL 构建与缓存控制所需字段.

ATTRIBUTE	DESCRIPTION
`retcode`	接口返回码. TYPE: `int`
`sip`	可用 CDN 根地址列表. TYPE: `list[str]`
`sipinfo`	可用 CDN 节点明细列表. TYPE: `list[CdnDispatchSipInfo]`
`test_file`	用于测试 CDN 可用性的文件路径. TYPE: `str`
`expiration`	数据有效期 (秒). TYPE: `int`
`refresh_time`	建议刷新间隔 (秒). TYPE: `int`
`cache_time`	建议缓存时长 (秒). TYPE: `int`

Fields:

retcode (int)
sip (list[str])
sipinfo (list[CdnDispatchSipInfo])
test_file (str)
expiration (int)
refresh_time (int)
cache_time (int)

song

models.song

QuerySongResponse pydantic-model

UrlinfoItem pydantic-model

GetSongUrlsResponse pydantic-model

ContentItem pydantic-model

GetSongDetailResponse pydantic-model

SimilarSongGroup pydantic-model

GetSimilarSongResponse pydantic-model

SongLabel pydantic-model

GetSongLabelsResponse pydantic-model

RelatedPlaylist pydantic-model

GetRelatedSonglistResponse pydantic-model

RelatedMv pydantic-model

MVSinger pydantic-model

GetRelatedMvResponse pydantic-model

GetOtherVersionResponse pydantic-model

SongProducer pydantic-model

SongProducerGroup pydantic-model

GetProducerResponse pydantic-model

SheetMusic pydantic-model

GetSheetResponse pydantic-model

GetFavNumResponse pydantic-model

CdnDispatchSipInfo pydantic-model

GetCdnDispatchResponse pydantic-model

QuerySongResponse `pydantic-model`

UrlinfoItem `pydantic-model`

GetSongUrlsResponse `pydantic-model`

ContentItem `pydantic-model`

GetSongDetailResponse `pydantic-model`

SimilarSongGroup `pydantic-model`

GetSimilarSongResponse `pydantic-model`

SongLabel `pydantic-model`

GetSongLabelsResponse `pydantic-model`

RelatedPlaylist `pydantic-model`

GetRelatedSonglistResponse `pydantic-model`

RelatedMv `pydantic-model`

MVSinger `pydantic-model`

GetRelatedMvResponse `pydantic-model`

GetOtherVersionResponse `pydantic-model`

SongProducer `pydantic-model`

SongProducerGroup `pydantic-model`

GetProducerResponse `pydantic-model`

SheetMusic `pydantic-model`

GetSheetResponse `pydantic-model`

GetFavNumResponse `pydantic-model`

CdnDispatchSipInfo `pydantic-model`

GetCdnDispatchResponse `pydantic-model`