有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

Action

自动智能联动动作 被如下接口引用:AppCreateAutomation、AppCreateScene、AppDescribeAutomation、AppGetSceneList、AppModifyAutomation、AppModifyScene。
名称
类型
必选
描述
ActionType
Int
动作类型。
0:设备动作。
1:延时。
2:场景。
3:通知。
ProductId
String
产品 ID。
DeviceName
String
设备名称。
Data
String
ActionType=0:设备动作参数。
ActionType=1:延时时间单位秒。
ActionType=2:执行场景 Id。
ActionType=3:通知内容。
AliasName
String
设备别名或者场景名称。
IconUrl
String
产品或者场景的图标 URL。

ActionHistories

设备动作历史 被如下接口引用:AppGetDeviceActionHistories。
名称
类型
描述
DeviceName
String
设备名称。
ActionId
String
动作 Id。
ActionName
String
动作名称。
ReqTime
int64
请求时间。
RspTime
int64
响应时间。
InputParams
string
输入参数。
OutputParams
string
输出参数。
Calling
string
调用方式。
ClientToken
string
调用 Id。
Status
string
调用状态。

ActionPushData

监听之后的服务器回包 被如下接口引用:DeviceRegistrationMonitor。
名称
类型
描述
deviceIds
[String]
返回成功注册监听的设备列表。
如果入参的设备 ID 无返回,表示该用户未绑定要注册监听的设备。

ActionPushParam

注册设备的时候传入的参数 被如下接口引用:DeviceRegistrationMonitor。
名称
类型
必选
描述
AccessToken
String
AccessToken 为调用登录接口之后获取的 Token。
DeviceIds
[String]
需要注册监听的设备列表,必须是已经绑定到该用户名下的设备。

AlarmDetailItem

预警详细信息 被如下接口引用:AppGetInsuranceAlarmDetailList。
名称
类型
必选
描述
Name
String
预警名称。
Reason
String
隐患分析。
Detail
String
预警细节。
Suggestion
String
处置建议。
AlarmTimestamp
Int64
预警时间。

AlarmSummaryItem

预警摘要信息 被如下接口引用:AppGetInsuranceAlarmSummaryList。
名称
类型
必选
描述
Name
String
预警名称。
Reason
String
隐患分析。
Suggestion
String
处置建议。
AlarmTimestamp
Int64
预警时间。
AlarmCount
Int64
总预警数。

AppDeviceInfo

App 设备信息 被如下接口引用:AppBindSubDeviceInFamily、AppSecureAddDeviceInFamily、AppSigBindDeviceInFamily。
名称
类型
描述
DeviceId
String
设备 ID。
ProductId
String
产品 ID。
DeviceName
String
设备名。
AliasName
String
设备别名。
CreateTime
String
创建 unix 时间戳(秒级)。
UpdateTime
String
最后更新时间,unix 时间戳(秒级)。
FamilyId
String
家庭 ID。
RoomId
String
房间 ID。
IconUrl
String
图标 Url。

AppInsuranceDeviceInfo

设备信息 被如下接口引用:AppGetUnBindDeviceList。
名称
类型
必选
描述
DeviceId
String
设备 ID。
DeviceNo
String
设备 SN 或车架号。

AppServiceInsuranceInfo

保单信息 被如下接口引用:AppGetInsuranceList。
名称
类型
必选
描述
ItemId
String
保单类别。
ItemType
Int64
保单类型。
0:测试保单。
1:正式保单。
InsuranceNo
String
保单号。
Address
String
地址。
BeginTime
Int64
保单生效时间。
EndTime
Int64
保单结束时间。
Score
Int64
评分。
AlarmNum
Int64
预警条数。
Status
Int64
保单状态。
1:失效。
2:保障中。
3:待生效。
ServiceName
String
服务名称。
BindDeviceId
String
绑定设备 ID。

Automation

自动智能联动实体 被如下接口引用:AppDescribeAutomation。
名称
类型
必选
描述
AutomationId
String
自动智能联动 ID。
Icon
String
自动智能联动的背景图片地址。
Name
String
自动智能联动的名称。
Status
int
自动智能联动开关状态。
0:关闭。
1:启用。
MatchType
int
条件匹配类型。
0:全部条件满足。
1:其中一个条件满足。
EffectiveBeginTime
String
生效开始时间。
EffectiveEndTime
String
生效结束时间。
EffectiveDays
String
生效日期 由0和1组成的7位数字,0表示不执行,1表示执行,第1位为周日,依次表示周一至周六。
Conditions
Array of Condition
自动智能联动触发条件。
Actions
Array of Action
自动智能联动动作列表。

AutomationListItem

自动智能联动信息 被如下接口引用:AppGetAutomationList。
名称
类型
必选
描述
AutomationId
String
自动智能联动 ID。
Icon
String
自动智能联动的背景图片地址。
Name
String
自动智能联动的名称。
Status
int
自动智能联动开关状态。
0:关闭。
1:启用。

Condition

App 设备信息 被如下接口引用:AppCreateAutomation、AppDescribeAutomation、AppModifyAutomation。
名称
类型
必选
描述
CondId
String
条件 ID。
CondType
Int32
条件类型。
0:设备属性条件。
1:定时条件。
Property
Property
条件属性。
Timer
Timer
条件触发时间。

Data

返回数据 被如下接口引用:device_activation。
名称
类型
描述
activation_date
string
设备激活日期。

DataHistoryItem

历史数据记录 被如下接口引用:AppGetDeviceDataHistory。
名称
类型
描述
Time
String
毫秒时间戳。
Value
String
数据取值。

Data_accompany_awesome_personal

返回数据 被如下接口引用:accompany_awesome_personal。
名称
类型
必选
描述
accompany
Array Of Object of accompany_awesome_personal
伴奏个性推荐。

Data_accompany_awesome_top

返回数据 被如下接口引用:accompany_awesome_top。
名称
类型
必选
描述
accompany
Array Of Object of accompany_awesome_top
伴奏推荐列表。

Data_accompany_category_info

返回数据 被如下接口引用:accompany_category_info。
名称
类型
必选
描述
category_id
String
分类 id。
category_name
String
分类名。
category_img
String
分类图片。

Data_accompany_category_list

返回数据 被如下接口引用:accompany_category_list。
名称
类型
必选
描述
groups
Array Of groups_accompany_category_list of groups_accompany_category_list
伴奏分组。
recommends
Array Of recommends_accompany_category_list of recommends_accompany_category_list
推荐分类。

Data_accompany_category_song

返回数据 被如下接口引用:accompany_category_song。
名称
类型
必选
描述
accompany
Array Of Object of accompany_category_song
伴奏列表。

Data_accompany_favorite_list

被如下接口引用:accompany_favorite_list。
名称
类型
必选
描述
playlist_id
String
歌单 id。
total
Integer
总数。
accompany
Array Of Object of accompany_favorite_list
伴奏列表。

Data_accompany_free_info

返回数据 被如下接口引用:accompany_free_info。
名称
类型
必选
描述
accompany
Array Of accompany_accompany_free_info of accompany_accompany_free_info
体验信息。

Data_accompany_free_song_url

返回数据 被如下接口引用:accompany_free_song_url。
名称
类型
必选
描述
accompany_size
String
伴奏大小单位字节。
has_original
Integer
音频是否有原唱音轨 。
0:无。
1:有。
singer_name
String
歌手名。
playable_code
Integer
是否可以播放 枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:音乐方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)
9:未知原因,无权播放。
accompany_id
String
伴奏 ID。
accompany_url
String
伴奏下载链接。
duration
Integer
伴奏时长单位毫秒。
singer_id
String
歌手 ID。
song_name
String
歌曲名。

Data_accompany_free_top_list

返回数据 被如下接口引用:accompany_free_top_list。
名称
类型
必选
描述
groups
Array Of groups_accompany_free_top_list of groups_accompany_free_top_list
分组列表。

Data_accompany_free_top_song

返回数据 被如下接口引用:accompany_free_top_song。
名称
类型
必选
描述
accompany
Array Of Object of accompany_free_top_song
伴奏列表。

Data_accompany_free_url

返回数据 被如下接口引用:accompany_free_url.
名称
类型
必选
描述
playable_code
Integer
是否可以播放 枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
accompany_id
String
伴奏 ID。
accompany_size
String
伴奏大小单位字节。
accompany_url
String
伴奏下载链接。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
duration
Integer
伴奏时长单位毫秒。
singer_name
String
歌手名。
song_name
String
歌曲名。

Data_accompany_hq_url

返回数据 被如下接口引用:accompany_hq_url。
名称
类型
必选
描述
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
duration
Integer
伴奏时长单位毫秒。
song_name
String
歌曲名。
playable_code
Integer
是否可以播放 枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
accompany_id
String
伴奏 ID。
accompany_size
String
伴奏大小单位字节。
singer_name
String
歌手名。
accompany_url
String
伴奏下载链接。
singer_id
String
歌手 ID。

Data_accompany_info

返回数据 被如下接口引用:accompany_info。
名称
类型
必选
描述
accompany
Array Of Object of accompany_accompany_info
伴奏列表。

Data_accompany_lyric

返回数据 被如下接口引用:accompany_lyric。
名称
类型
必选
描述
lyric
String
base64编码的歌词内容。
offset
Integer
歌词偏移量。
format
String
歌词格式。

Data_accompany_mv

返回数据 被如下接口引用:accompany_mv。
名称
类型
必选
描述
mv_id
String
MV id。
mv_name
String
MV 名。
duration
Integer
MV 时长,单位毫秒。
offset
Integer
MV 与伴奏对齐时间偏移量。

Data_accompany_newsearch_song

返回数据 被如下接口引用:accompany_newsearch_song。
名称
类型
必选
描述
accompany
Array Of Object of accompany_newsearch_song
伴奏列表。
author
Array Of Object of author_newsearch_song
歌手列表。

Data_accompany_opus_del

返回数据 被如下接口引用:accompany_opus_del。
名称
类型
描述
data
object
objects

Data_accompany_opus_list

返回数据 被如下接口引用:accompany_opus_list。
名称
类型
必选
描述
total
Integer
总数
opuses
Array Of opuses_accompany_opus_list of opuses_accompany_opus_list
opuses

Data_accompany_opus_upload

返回数据 被如下接口引用:accompany_opus_upload。
名称
类型
必选
描述
opus_id
String
作品 id。

Data_accompany_opus_url

返回数据 被如下接口引用:accompany_opus_url。
名称
类型
必选
描述
url
String
作品下载链接。
duration
Integer
时长单位秒。
size
Integer
伴奏大小单位字节。

Data_accompany_search_song

返回数据 被如下接口引用:accompany_search_song。
名称
类型
必选
描述
accompany
Array Of Object of accompany_search_song
伴奏搜索。
total
Integer
总数。

Data_accompany_search_tips

被如下接口引用:accompany_search_tips。
名称
类型
必选
描述
tips
Array Of String
提示。

Data_accompany_singer_list

歌手列表 被如下接口引用:accompany_singer_list。
名称
类型
必选
描述
singers
Array Of singers_accompany_singer_list of singers_accompany_singer_list
热门歌手。
letters
Array Of letters_accompany_singer_list of letters_accompany_singer_list
letters

Data_accompany_singer_song

返回数据 被如下接口引用:accompany_singer_song。
名称
类型
必选
描述
total
Integer
总数。
accompany
Array Of Object of accompany_singer_song
伴奏列表。

Data_accompany_songpitch

返回数据 被如下接口引用:accompany_songpitch。
名称
类型
必选
描述
pitch
String
音高。
offset
Integer
音高偏移量。
type
Integer
来源。
0为默认值。
1为算法制作。
2为人工导入。
md5sum
String
md5 签名,用于完整性校验。

Data_accompany_theme_list

返回数据 被如下接口引用:accompany_theme_list。
名称
类型
必选
描述
themes
Array Of themes_accompany_theme_list of themes_accompany_theme_list
主题列表。

Data_accompany_theme_song

被如下接口引用:accompany_theme_song。
名称
类型
必选
描述
accompany
Array Of Object of accompany_theme_song
伴奏列表。

Data_accompany_top_list

被如下接口引用:accompany_top_list
名称
类型
必选
描述
groups
Array Of groups_accompany_top_list of groups_accompany_top_list
分组列表。

Data_accompany_top_song

返回数据 被如下接口引用:accompany_top_song。
名称
类型
必选
描述
accompany
Array Of Object of accompany_top_song
伴奏列表。

Data_accompany_url

返回数据 被如下接口引用:accompany_url。
名称
类型
必选
描述
accompany_id
String
伴奏 ID
duration
Integer
伴奏时长单位毫秒
singer_id
String
歌手 ID
song_name
String
歌曲名
playable_code
Integer
是否可以播放 枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
status
Integer
0:成功获取到伴奏下载信息。
1:当日免费体验次数已经用完。
accompany_size
String
伴奏大小单位字节。
accompany_url
String
伴奏下载链接。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
singer_name
String
歌手名。

Data_album_info

返回数据 被如下接口引用:album_info。
名称
类型
描述
album_id
Integer
专辑 id。
album_name
String
专辑名。
album_translate_name
String
专辑译名。
album_img
String
专辑封面。
intro
String
专辑简介。
company
String
唱片公司。
singer_id
String
歌手 id。
singer_name
String
歌手名。
total
Integer
歌曲总数。
publish_time
String
发布时间。
songs
歌曲列表。

Data_asset_purchased_albums

返回数据 被如下接口引用:asset_purchased_albums。
名称
类型
描述
total
Integer
总数。
albums
专辑信息。

Data_asset_purchased_songs

返回数据 被如下接口引用:asset_purchased_songs。
名称
类型
描述
total
Integer
总数。
songs
歌曲列表。

Data_awesome_everyday

返回数据 被如下接口引用:awesome_everyday。
名称
类型
描述
songs
歌曲列表。

Data_awesome_newsong

返回数据 被如下接口引用:awesome_newsong。
名称
类型
描述
total
Integer
总数。
songs
歌曲列表。

Data_awesome_recommend

返回数据 被如下接口引用:awesome_recommend。
名称
类型
描述
songs
歌曲列表。

Data_child_home

返回数据 被如下接口引用:child_home。
名称
类型
必选
描述
groups
Array Of groups_child_home of groups_child_home
资源分组。

Data_child_resource

返回数据 被如下接口引用:child_resource。
名称
类型
必选
描述
type
Integer
大分类。
3-歌单。
4-专辑。
7-小分类。
total
Integer
总数。
lists
Array Of lists_child_resource of lists_child_resource
资源分组。

Data_favorite_oper_playlist

返回数据 被如下接口引用:favorite_oper_playlist。
名称
类型
描述
playlist_extra_id
String
歌单附加 id,移除收藏时使用。
playlist_id
String
操作的歌单 id。

Data_favorite_oper_song

返回数据 被如下接口引用:favorite_oper_song。
名称
类型
描述
song_extra_id
String
歌曲附加 id,移除收藏时使用。
song_id
String
操作的歌曲 id。

Data_favorite_other_list

返回数据 被如下接口引用:favorite_other_list。
名称
类型
描述
playlists
歌单。

Data_favorite_self_list

返回数据 被如下接口引用:favorite_self_list。
名称
类型
描述
playlists
歌单。

Data_favorite_song

返回数据 被如下接口引用:favorite_song。
名称
类型
描述
total
Integer
总数。
songs
歌曲列表。

Data_give_common_record

返回数据 被如下接口引用:give_common_record。
名称
类型
描述
status
Integer
-
times
Integer
剩余领取次数。
collection_time
String
上一次领取时间。

Data_give_common_scancodelogin

返回数据 被如下接口引用:give_common_scancodelogin。
名称
类型
描述
status
Integer
-
order_no
String
订单号(同 sp 内唯一)。
partner_no
String
厂商订单号(同 sp 内唯一)。
create_time
String
订单创建时间。
vip_end_time
String
vip 有效期终止时间。
collection_time
String
上一次领取时间。

Data_live_program_list

返回数据 被如下接口引用:live_program_list。
名称
类型
必选
描述
programs
Array Of programs_live_program_list of programs_live_program_list
节目分组。

Data_live_room_status

返回数据 被如下接口引用:live_room_status。
名称
类型
必选
描述
status
Integer
房间内节目状态。
0:停播。
1:开播。
horizontal
Integer
横屏流状态。
0:停播。
1:开播。
vertical
Integer
竖屏流状态。
0:停播。
1:开播。

Data_live_room_url

返回数据 被如下接口引用:live_room_url。
名称
类型
必选
描述
vertical
Array Of vertical_live_room_url of vertical_live_room_url
竖屏流信息。
status
String
房间内节目状态。
0:停播。
1:开播。
room_id
Integer
房间 id。
expire
Integer
链接过期时间。
horizontal
Array Of horizontal_live_room_url of horizontal_live_room_url
横屏流信息。

Data_longaudio_free_home

返回数据 被如下接口引用:longaudio_free_home。
名称
类型
必选
描述
groups
Array Of groups_longaudio_free_home of groups_longaudio_free_home
资源分组。

Data_longaudio_resource

返回数据 被如下接口引用:longaudio_resource。
名称
类型
必选
描述
is_end
String
是否存在下一页。
特别提醒:返回结果个数可能少于请求的size,建议以瀑布流的方式设计 UI 交互。
lists
Array Of lists_longaudio_resource of lists_longaudio_resource
资源列表。

Data_minipauth

返回数据 被如下接口引用:wechat_minipauth。
名称
类型
描述
token
string
用户令牌。
expire
integer
令牌有效期 unix 时间戳,单位秒。
userid
string
用户 id。

Data_monitor_delay

返回值为空。 被如下接口引用:monitor_delay。

Data_monitor_listen

返回值为空。 被如下接口引用:monitor_listen。

Data_mv_category_list

返回数据 被如下接口引用:mv_category_list。
名称
类型
必选
描述
categories
Array Of categories_mv_category_list of categories_mv_category_list
分类列表。

Data_mv_category_mv

返回数据 被如下接口引用:mv_category_mv
名称
类型
必选
描述
mvs
Array Of mvs_mv_category_mv of mvs_mv_category_mv
MV 列表。

Data_mv_info

返回数据 被如下接口引用:mv_info。
名称
类型
必选
描述
song_id
String
歌曲 ID。
singer_id
String
歌手 ID。
singer_name
String
歌手名称。
author_name
String
MV 制作人名称.
intro
String
简介。
tags
MV 信息。
mv_id
String
MV ID。
mv_img
String
MV 图片。
mv_name
String
MV 名称。
accompany_id
String
伴奏 ID。

Data_mv_infos

返回数据 被如下接口引用:mv_infos。
名称
类型
必选
描述
mvInfos
Array Of mvInfos_mv_infos of mvInfos_mv_infos
MV 信息。

Data_mv_live_tme

返回数据 被如下接口引用:mv_live_tme。
名称
类型
必选
描述
mvs
Array Of mvs_mv_live_tme of mvs_mv_live_tme
MV 列表。
返回数据 被如下接口引用:mv_search。
名称
类型
必选
描述
mvs
Array Of mvs_mv_search of mvs_mv_search
MV 列表。
total
Integer
总数。

Data_mv_trial

返回数据 被如下接口引用:mv_trial。
名称
类型
必选
描述
mv_size_ld
Integer
流畅版 MV 大小。
mv_url_ld
String
流畅版 MV 下载链接。
mv_size_sd
Integer
标清版 MV 大小。
mv_url_sd
String
标清版 MV 下载链接。
mv_size_qhd
Integer
高清版 MV 大小。
mv_url_qhd
String
高清版 MV 下载链接。
mv_size_hd
Integer
超清版 MV 大小。
mv_url_hd
String
超清版 MV 下载链接。
mv_size_fhd
Integer
蓝光版 MV大小。
mv_url_fhd
String
蓝光版MV 下载链接。
duration
Integer
MV 时长单位毫秒。
mv_id
String
MV ID。
mv_name
String
MV 名。
singer_name
String
歌手名。

Data_mv_url

返回数据 被如下接口引用:mv_url
名称
类型
必选
描述
mv_size_hd
Integer
超清版 MV 大小。
mv_url_hd
String
超清版 MV 下载链接。
mv_size_fhd
Integer
蓝光版 MV 大小。
mv_url_fhd
String
蓝光版 MV 下载链接。
mv_size_qhd
Integer
高清版 MV 大小。
mv_url_qhd
String
高清版 MV 下载链接。
mv_size_sd
Integer
标清版 MV 大小。
mv_url_sd
String
标清版 MV 下载链接。
mv_size_ld
Integer
流畅版 MV 大小。
mv_url_ld
String
流畅版 MV 下载链接。
duration
Integer
MV 时长单位毫秒。
mv_id
String
MV ID。
mv_name
String
MV 名。
singer_name
String
歌手名。

Data_playlist_awesome

返回数据 被如下接口引用:playlist_awesome
名称
类型
描述
playlists
歌单。

Data_playlist_song

返回数据 被如下接口引用:playlist_song。
名称
类型
描述
total
Integer
总数。
songs
歌曲列表。

Data_playlist_top

返回数据 被如下接口引用:playlist_top
名称
类型
描述
groups
分组列表。

Data_radio_list

返回数据 被如下接口引用:radio_list。
名称
类型
描述
groups
分组列表。

Data_radio_song

返回数据 被如下接口引用:radio_song。
名称
类型
描述
total
Integer
总数。
songs
歌曲列表。

Data_rigion_home

返回数据 被如下接口引用:rigion_home。
名称
类型
必选
描述
groups
Array Of groups_rigion_home of groups_rigion_home
资源分组。

Data_rigion_oldman_index

返回数据 被如下接口引用:rigion_oldman_index。
名称
类型
必选
描述
groups
Array Of groups_rigion_oldman_index of groups_rigion_oldman_index
资源分组。

Data_search_song

返回数据 被如下接口引用:search_song。
名称
类型
必选
描述
total
Integer
总数。
keyword
String
关键词。
songs
Array Of songs_search_song of songs_search_song
歌曲列表。

Data_search_tips

返回数据 被如下接口引用:search_tips。
名称
类型
必选
描述
tips
Array Of String
tips

Data_search_voice

返回数据 被如下接口引用:search_voice。
名称
类型
必选
描述
tts_text
String
用于语音提示的文本。
songs
语音搜索歌曲列表。

Data_singer_album

返回数据 被如下接口引用:singer_album。
名称
类型
描述
total
Integer
歌曲总数。
albums
专辑列表。

Data_singer_info

返回数据 被如下接口引用:singer_info。
名称
类型
描述
singer_id
String
歌手 id。
singer_name
String
歌手名。
area
String
歌手地区。
translate_name
String
歌手译名。
song_count
Integer
歌手歌曲数。
singer_img
String
歌手相片。

Data_singer_list

返回数据 被如下接口引用:singer_list。
名称
类型
描述
singers
歌手

Data_singer_song

返回数据 被如下接口引用:singer_song。
名称
类型
描述
total
Integer
歌曲总数。
songs
歌曲列表。

Data_song_accompany

返回数据 被如下接口引用:song_accompany。
名称
类型
描述
accompany
伴奏。

Data_song_infos

返回数据 被如下接口引用:song_infos。
名称
类型
描述
songs
歌曲列表。

Data_song_lyric

返回数据 被如下接口引用:song_lyric。
名称
类型
描述
lyric
string
歌词。

Data_song_tolisten

返回数据 被如下接口引用:song_tolisten。
名称
类型
描述
songs
歌曲列表。

Data_song_url

返回数据 被如下接口引用:song_url。
名称
类型
描述
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_name
String
歌手名。
song_url
String
歌曲下载链接。
song_size
String
歌曲大小。
song_url_hq
String
歌曲(hq)下载链接。
song_size_hq
String
歌曲(hq)大小。
song_url_sq
String
歌曲(sq)下载链接。
song_size_sq
String
歌曲(sq)大小。
duration
Integer
歌曲时长,单位毫秒。
playable_code
Integer
是否可以播放 枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP有权但设备端无权的情况)。
9:未知原因,无权播放。
try_url
String
歌曲试听链接。
try_size
Integer
歌曲试听大小,单位字节。
try_begin
Integer
歌曲试听开始,单位毫秒。
try_end
Integer
歌曲试听结束,单位毫秒。

Data_top_list

返回数据 被如下接口引用:top_list。
名称
类型
描述
groups
分组。

Data_top_song

返回数据 被如下接口引用:top_song。
名称
类型
描述
total
Integer
总数。
songs
歌曲列表。

Data_user_info

返回数据 被如下接口引用:user_info。
名称
类型
描述
userid
String
用户 id。
nick_name
String
用户昵称。
img
String
用户头像。
is_vip
Integer
是否vip。
0:否。
1:是。
vip_end_time
String
vip 有效期终止时间。
car_vip_end_time
String
车机会员有效期终止时间。
svip_end_time
String
豪 V 有效期终止时间。

Data_user_logout

返回数据为空。 被如下接口引用:user_logout。

Data_user_qrcode_auth

返回数据 被如下接口引用:user_qrcode_auth。
名称
类型
描述
userid
String
用户 ID。
token
String
用户令牌。
expire
Integer
令牌有效期 unix 时间戳,单位秒。

Data_user_qrcode_get

返回数据 被如下接口引用:user_qrcode_get。
名称
类型
描述
qrcode
String
登录二维码 url,自行渲染。
ticket
String
获取二维码授权信息的凭证。

Data_vip_activity_partner_give

返回数据 被如下接口引用:vip_activity_partner_give
名称
类型
必选
描述
create_time
String
TME 订单创建时间。
vip_end_time
String
vip 有效期终止时间。
status
Integer
-
order_no
String
TME 订单号(同 sp 内唯一)。
partner_no
String
厂商订单号(同 sp 内唯一)。

Data_vip_ksing_info

返回数据 被如下接口引用:vip_ksing_info。
名称
类型
必选
描述
userid
String
用户 ID。
nick_name
String
用户昵称。
img
String
用户头像。
is_vip
Integer
是否vip。
0:否。
1:是。
vip_end_time
String
vip 有效期终止时间。

Data_vip_ksing_partner_give

返回数据 被如下接口引用:vip_ksing_partner_give
名称
类型
必选
描述
order_no
String
TME 订单号(同 sp 内唯一)。
partner_no
String
厂商订单号(同 sp 内唯一)。
create_time
String
TME 订单创建时间。
vip_end_time
String
vip 有效期终止时间。

Data_vip_svip_common_give

返回数据 被如下接口引用:vip_svip_common_give
名称
类型
必选
描述
order_no
String
TME 订单号(同 sp 内唯一)。
partner_no
String
厂商订单号(同 sp 内唯一)。
create_time
String
TME 订单创建时间。

Data_vip_tme_partner_give

返回数据 被如下接口引用:vip_tme_partner_give
名称
类型
必选
描述
order_no
String
TME 订单号(同 sp 内唯一)。
partner_no
String
厂商订单号(同 sp 内唯一)。
create_time
String
TME 订单创建时间。
vip_end_time
String
vip 有效期终止时间。

Data_wechat_appinfocode

返回数据 被如下接口引用:wechat_appinfocode
名称
类型
描述
ticket
String
获取第三方 App 信息凭证。
req_name
String
拉起的小程序的请求名。
req_path
String
拉起的小程序的请求路径。
返回数据 被如下接口引用:wechat_openlink
名称
类型
描述
ticket
String
获取扫码授权结果的凭证。
openlink
String
微信小程序 openlink。
expire
Integer
令牌有效期 unix 时间戳,单位秒。

Data_wechat_qrcodeauth

返回数据 被如下接口引用:wechat_qrcodeauth
名称
类型
描述
token
String
用户令牌。
userid
String
用户 id。
expire
Integer
令牌有效期 unix 时间戳,单位秒。

Data_wechat_qrcodeget

返回数据 被如下接口引用:wechat_qrcodeget
名称
类型
描述
ticket
String
获取扫码授权结果的凭证。
qrcode
String
微信小程序二维码图像二进制数据 base64 编码。

Device

设备信息 被如下接口引用:AppGetDeviceStatuses
名称
类型
描述
DeviceName
String
设备名。
Online
Int
在线状态。
LoginTime
Int64
登录时间。
LastDataTime
Int64
最近登录时间。

DeviceFenceEvent

设备地理围栏告警事件 被如下接口引用:AppGetFenceEventList
名称
类型
必选
描述
EventType
String
设备地理围栏名称。
CreateTime
String
创建 unix 时间戳(秒级)。

DeviceItem

设备状态 被如下接口引用:AppGetInsuranceDeviceStatus
名称
类型
必选
描述
ProductName
String
设备展示名称。
OnlineStatus
Int
设备状态:
0:离线。
1:在线。
2:未知。

DeviceList

设备列表 被如下接口引用:AppGetFamilyDeviceList、AppGetFamilySubDeviceList、AppGetGatewayBindDeviceList
名称
类型
描述
ProductId
String
设备 ID。
DeviceName
String
设备名称。
DeviceId
String
设备 Id。
AliasName
String
设备别名。
UserId
String
用户 Id。
RoomId
String
房间 ID。
FamilyId
String
家庭 ID。
IconUrl
String
图标 Url。
DeviceType
Int32
设备类型:
0:普通。
1:网关设备。
2:子设备。
CreateTime
Int64
创建 unix 时间戳(秒级)。
UpdateTime
Int64
最后更新的 unix 时间戳(秒级)。

ErrorMessage

错误信息
名称
类型
描述
Code
String
错误码。
Message
String
错误信息。

EventHistory

搜集结果集
名称
类型
描述
TimeStamp
Int64
事件的时间戳。
ProductId
String
事件的产品 ID。
DeviceName
String
事件的设备名称。
EventId
String
事件的标识符 ID。
Type
String
事件的类型。
Data
string
事件的数据。

FamilyList

被如下接口引用:AppGetFamilyList
名称
类型
描述
FamilyId
String
家庭 ID。
Name
String
名称。
Role
Int
角色。
CreateTime
Int
创建时间。
UpdateTime
Int
最后更新时间。

Fence

设备地理围栏信息 被如下接口引用:AppGetFenceList
名称
类型
必选
描述
FenceId
Int64
设备地理围栏 ID。
FenceName
String
设备地理围栏名称。
FenceArea
String
设备地理围栏区域范围。
FenceDesc
String
设备地理围栏描述。
AlertCondition
String
触发条件。
FenceEnable
Boolean
启用状态。
Method
String
通知方式。
CreateTime
String
创建 unix 时间戳(秒级)。
UpdateTime
String
最后更新时间,unix 时间戳(秒级)。

HeartBeatData

心跳接口的服务器回包 被如下接口引用:HeartBeat
名称
类型
描述
RequestId
String
公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。

HeartBeatParam

设备心跳接口入参 被如下接口引用:HeartBeat
名称
类型
描述
DeviceIds
[String]
设备列表。

IotUser

用户信息 被如下接口引用:AppFindUser
名称
类型
描述
UserId
String
用户 Id。
NickName
String
昵称。
Avatar
String
头像。
CountryCode
String
手机号国家码。
PhoneNumber
String
手机号码。
Email
String
邮箱。

IotUserDetail

用户信息 被如下接口引用:AppGetUser
名称
类型
描述
UserId
String
用户 Id。
NickName
String
昵称。
Avatar
String
头像。
CountryCode
String
手机号国家码。
PhoneNumber
String
手机号码。
Email
String
邮箱。
HasPassword
Int
是否已设置密码。
0:未设置。
1:已设置。
HasWxOpenID
Int
是否已绑定微信。
0:未绑定。
1:已绑定。

KugouParams

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:device_activation。

KugouParams_accompany_awesome_personal

请求参数 被如下接口引用:accompany_awesome_personal
名称
类型
必选
描述
size
Integer
每页?项。
page
Integer
第?页。

KugouParams_accompany_awesome_top

请求参数 被如下接口引用:accompany_awesome_top。
名称
类型
必选
描述
size
Integer
每页?项。
page
Integer
第?页。
type
Integer
排行榜类型。
1:热门榜。
2:飙升榜。

KugouParams_accompany_category_info

请求参数 被如下接口引用:accompany_category_info。
名称
类型
必选
描述
category_id
String
伴奏分类 id。

KugouParams_accompany_category_list

[object Object] 被如下接口引用:accompany_category_list。

KugouParams_accompany_category_song

请求参数 被如下接口引用:accompany_category_song。
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
category_id
String
伴奏分类 id。

KugouParams_accompany_favorite_list

请求参数 被如下接口引用:accompany_favorite_list。
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_accompany_free_info

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:accompany_free_info。

KugouParams_accompany_free_song_url

请求参数 被如下接口引用:accompany_free_song_url
名称
类型
必选
描述
accompany_id
String
伴奏 id。

KugouParams_accompany_free_top_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:accompany_free_top_list。

KugouParams_accompany_free_top_song

请求参数 被如下接口引用:accompany_free_top_song
名称
类型
必选
描述
group_id
String
分组 id。
top_id
String
榜单、电台 id。

KugouParams_accompany_free_url

请求参数 被如下接口引用:accompany_free_url。
名称
类型
必选
描述
accompany_id
String
伴奏 id。
free_token
String
免费令牌。

KugouParams_accompany_hq_url

请求参数 被如下接口引用:accompany_hq_url。
名称
类型
必选
描述
accompany_id
String
伴奏 id。

KugouParams_accompany_info

请求参数 被如下接口引用:accompany_info。
名称
类型
必选
描述
accompany_id
String
伴奏 id。

KugouParams_accompany_lyric

请求参数 被如下接口引用:accompany_lyric。
名称
类型
必选
描述
accompany_id
String
伴奏 id。

KugouParams_accompany_mv

请求参数 被如下接口引用:accompany_mv。
名称
类型
必选
描述
accompany_id
String
伴奏 id。

KugouParams_accompany_newsearch_song

请求参数 被如下接口引用:accompany_newsearch_song
名称
类型
必选
描述
keyword
String
关键词。

KugouParams_accompany_opus_del

请求参数 被如下接口引用:accompany_opus_del
名称
类型
必选
描述
opus_id
String
作品 id。

KugouParams_accompany_opus_list

请求参数 被如下接口引用:accompany_opus_list
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_accompany_opus_upload

请求参数 被如下接口引用:accompany_opus_upload
名称
类型
必选
描述
opus_hash
String
作品 hash。
opus_desc
String
作品描述。
krc_id
String
歌词 id。
grade
String
等级。
opus_name
String
作品名。
accompany_id
String
伴奏 id。
duration
Integer
作品播放时长,单位秒。
score
String
总分。
average_score
String
平均分。

KugouParams_accompany_opus_url

请求参数 被如下接口引用:accompany_opus_url
名称
类型
必选
描述
opus_id
String
作品 id。

KugouParams_accompany_search_song

请求参数 被如下接口引用:accompany_search_song
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
keyword
String
关键词。

KugouParams_accompany_search_tips

请求参数 被如下接口引用:accompany_search_tips
名称
类型
必选
描述
keyword
String
关键词。

KugouParams_accompany_singer_list

请求参数 被如下接口引用:accompany_singer_list
名称
类型
必选
描述
type
Integer
歌手类型。
1:全部。
2:男歌手。
3:女歌手。
4:组合。
area
Integer
歌手区域。
1:华语。
2:欧美。
3:日韩。

KugouParams_accompany_singer_song

请求参数 被如下接口引用:accompany_singer_song
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
singer_id
String
歌手 id。

KugouParams_accompany_songpitch

请求参数 被如下接口引用:accompany_songpitch
名称
类型
必选
描述
accompany_id
String
伴奏 id。

KugouParams_accompany_theme_list

请求参数 被如下接口引用:accompany_theme_list
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_accompany_theme_song

请求参数 被如下接口引用:accompany_theme_song
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
theme_id
String
主题 id。

KugouParams_accompany_top_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:accompany_top_list。

KugouParams_accompany_top_song

请求参数 被如下接口引用:accompany_top_song
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
group_id
String
分组 id。
top_id
String
榜单 id。

KugouParams_accompany_url

请求参数 被如下接口引用:accompany_url
名称
类型
必选
描述
accompany_id
String
伴奏 id。

KugouParams_album_info

请求参数 被如下接口引用:album_info
名称
类型
描述
page
Integer
第?页。
size
Integer
每页?项。
album_id
String
专辑 id。

KugouParams_asset_purchased_albums

请求参数 被如下接口引用:asset_purchased_albums
名称
类型
描述
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_asset_purchased_songs

请求参数 被如下接口引用:asset_purchased_songs
名称
类型
描述
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_awesome_everyday

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:awesome_everyday。

KugouParams_awesome_newsong

请求参数 被如下接口引用:awesome_newsong
名称
类型
描述
page
Integer
第?页。
size
Integer
每页?项。
top_id
Int
榜单 id。
1:华语。
2:欧美。
3:韩语。
4:日语。

KugouParams_awesome_recommend

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:awesome_recommend。

KugouParams_child_home

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:child_home。

KugouParams_child_resource

请求参数 被如下接口引用:child_resource
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
resource_type
Integer
大分类 7-小分类
resource_id
String
资源 id。

KugouParams_favorite_oper_playlist

请求参数 被如下接口引用:favorite_oper_playlist
名称
类型
描述
cmd
Integer
1:收藏歌单。
2:取消收藏。
playlist_id
String
歌单 id。
playlist_extra_id
String
歌单附加 id。
收藏时传入歌单 id。
取消收藏时传入获取歌单列表(或收藏歌单)时返回的同名字段。

KugouParams_favorite_oper_song

请求参数 被如下接口引用:favorite_oper_song
名称
类型
描述
cmd
Integer
1:收藏歌单。
2:取消收藏。
playlist_id
String
歌单 id。
song_id
String
歌曲 id。
song_extra_id
String
歌曲附加 id。
收藏时传入歌曲 id 。
取消收藏时传入获取歌单歌曲列表时返回的同名字段。

KugouParams_favorite_other_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:favorite_other_list。

KugouParams_favorite_self_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:favorite_self_list。

KugouParams_favorite_song

请求参数 被如下接口引用:favorite_song
名称
类型
描述
playlist_id
String
歌单 id。
page
Integer
第?页。
size
Integer
每页?项。
type
String
默认:other。
self:自建歌单。
other:收藏的歌单。

KugouParams_give_common_record

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:give_common_record。

KugouParams_give_common_scancodelogin

请求参数 被如下接口引用:give_common_scancodelogin
名称
类型
描述
partner_no
String
厂商订单号(同 sp 内唯一)。

KugouParams_live_program_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:live_program_list。

KugouParams_live_room_status

请求参数 被如下接口引用:live_room_status
名称
类型
必选
描述
room_id
String
房间 id。

KugouParams_live_room_url

请求参数 被如下接口引用:live_room_url
名称
类型
必选
描述
room_id
String
房间 id。

KugouParams_longaudio_free_home

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:longaudio_free_home。

KugouParams_longaudio_resource

请求参数 被如下接口引用:longaudio_resource
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
tag_id
String
分类 tag_id。

KugouParams_monitor_delay

请求参数 被如下接口引用:monitor_delay
名称
类型
必选
描述
pid
String
牛方案 2.0 pid,产品接入时申请获得。
device_id
String
厂商设备唯一标示,由 ascii 可见字符组成。
client_ver
String
客户端版本号,厂商自行填写自家版本号,用于辅助监控统计。
platform
String
客户端平台版本信息,用于辅助监控统计。
timestamp
Integer
unix 时间戳,单位秒。
nonce
String
随机字串,由 ascii 可见字符组成。
data
Array Of data_monitor_delay of data_monitor_delay
数据。

KugouParams_monitor_listen

请求参数 被如下接口引用:monitor_listen
名称
类型
必选
描述
pid
String
牛方案 2.0 pid,产品接入时申请获得。
device_id
String
厂商设备唯一标示,由 ascii 可见字符组成。
timestamp
Integer
unix 时间戳,单位秒。
nonce
String
随机字串,由 ascii 可见字符组成。
data
Array Of data_monitor_listen of data_monitor_listen
数据。

KugouParams_mv_category_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:mv_category_list。

KugouParams_mv_category_mv

请求参数 被如下接口引用:mv_category_mv
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
category_id
String
分类 id。
sort
Integer
排序。
1:发布时间。
2:标签创建时间。
3:播放量(倒序)。
4:算法。
5:mv 飙升值。

KugouParams_mv_info

请求参数 被如下接口引用:mv_info
名称
类型
必选
描述
mv_id
String
mv_id

KugouParams_mv_infos

请求参数 被如下接口引用:mv_infos
名称
类型
必选
描述
mvs_id
Array Of String
mvid 列表。

KugouParams_mv_live_tme

请求参数 被如下接口引用:mv_live_tme
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
live_type
Integer
1-所有视频,2-完整演唱会视频。
请求参数 被如下接口引用:mv_search
名称
类型
必选
描述
userid
String
TME 用户 id。
page
Integer
第?页。
size
Integer
每页?项。
keyword
String
关键词。

KugouParams_mv_trial

请求参数 被如下接口引用:mv_trial
名称
类型
必选
描述
mv_id
String
mv_id

KugouParams_mv_url

请求参数 被如下接口引用:mv_url
名称
类型
必选
描述
mv_id
String
mv_id

KugouParams_playlist_awesome

请求参数 被如下接口引用:playlist_awesome
名称
类型
描述
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_playlist_song

请求参数 被如下接口引用:playlist_song
名称
类型
描述
playlist_id
String
歌单分类 id。
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_playlist_top

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:playlist_top。

KugouParams_radio_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:radio_list。

KugouParams_radio_song

请求参数 被如下接口引用:radio_song
名称
类型
描述
radio_id
String
电台 id。

KugouParams_rigion_home

请求参数 被如下接口引用:rigion_home
名称
类型
必选
描述
id
String
专区 id。

KugouParams_rigion_oldman_index

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:rigion_oldman_index。

KugouParams_search_song

请求参数 被如下接口引用:search_song
名称
类型
必选
描述
page
Integer
第?页。
size
Integer
每页?项。
keyword
String
关键词。

KugouParams_search_tips

请求参数 被如下接口引用:search_tips
名称
类型
必选
描述
keyword
String
关键词。

KugouParams_search_voice

请求参数 被如下接口引用:search_voice
名称
类型
必选
描述
query
String
用户语音在处理后的原始文本。
slots
Array Of slots_search_voice of slots_search_voice
语音搜索列表。

KugouParams_singer_album

请求参数 被如下接口引用:singer_album
名称
类型
描述
singer_id
String
歌手 id。
page
Integer
第?页。
size
Integer
每页?项。
sort
Integer
排序。
1:最热 。
2:最新。

KugouParams_singer_info

请求参数 被如下接口引用:singer_info
名称
类型
描述
singer_id
String
歌手 id。

KugouParams_singer_list

请求参数 被如下接口引用:singer_list
名称
类型
描述
page
Integer
第?页。
size
Integer
每页?项。
area
Integer
歌手地区。
0:全部。
1:内地。
2:欧美。
3:日本。
4:韩国。
5:港台。
6:其它。
type
Integer
歌手类型。
0:全部。
1:男。
2:女。
3:组合。

KugouParams_singer_song

请求参数 被如下接口引用:singer_song
名称
类型
描述
singer_id
String
歌手 id。
page
Integer
第?页。
size
Integer
每页?项。

KugouParams_song_accompany

请求参数 被如下接口引用:song_accompany
名称
类型
描述
song_id
String
歌曲 id。

KugouParams_song_infos

请求参数 被如下接口引用:song_infos
名称
类型
描述
songs_id
歌曲 id 列表。

KugouParams_song_lyric

请求参数 被如下接口引用:song_lyric
名称
类型
描述
song_id
String
歌曲 id。

KugouParams_song_tolisten

请求参数 被如下接口引用:song_tolisten
名称
类型
描述
song_id
String
歌曲 id。

KugouParams_song_url

请求参数 被如下接口引用:song_url
名称
类型
描述
song_id
String
歌曲 id。

KugouParams_top_list

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:top_list。

KugouParams_top_song

请求参数 被如下接口引用:top_song
名称
类型
描述
page
Integer
第?页。
size
Integer
每页?项。
top_id
String
榜单 id。

KugouParams_user_info

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:user_info。

KugouParams_user_logout

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:user_logout。

KugouParams_user_qrcode_auth

请求参数 被如下接口引用:user_qrcode_auth
名称
类型
描述
ticket
String
获取二维码授权信息的凭证。

KugouParams_user_qrcode_get

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:user_qrcode_get。

KugouParams_vip_activity_partner_give

请求参数 被如下接口引用:vip_activity_partner_give
名称
类型
必选
描述
partner_no
String
厂商订单号(同 sp 内唯一)。
month
Integer
购买月份数。
day
Integer
购买天数,天数和月数二选一,不可同时为0。

KugouParams_vip_ksing_info

请求参数这里为空,传递空对象 {} 即可。 被如下接口引用:vip_ksing_info。

KugouParams_vip_ksing_partner_give

请求参数 被如下接口引用:vip_ksing_partner_give
名称
类型
必选
描述
day
Integer
1. 购买天数,天数和月数二选一,不可同时为0。
2. 天数为1为酷狗线上测试充值渠道(请提前联系 TME 导入配额),酷我Q音目前暂时不支持。
month
Integer
购买月份数。
partner_no
String
厂商订单号(同 sp 内唯一)。

KugouParams_vip_svip_common_give

请求参数 被如下接口引用:vip_svip_common_give
名称
类型
必选
描述
partner_no
String
厂商订单号(同 sp 内唯一)。
pay_no
String
用户支付订单号。
day
Integer
1. 购买天数,天数和月数二选一,不可同时为0。
2. 天数为1为酷狗线上测试充值渠道(请提前联系 TME 导入配额),酷我Q音目前暂时不支持。
month
Integer
购买月份数。

KugouParams_vip_tme_partner_give

请求参数 被如下接口引用:vip_tme_partner_give
名称
类型
必选
描述
userid
String
TME 用户 id。
token
String
TME 用户 token,非首次充值支持免 token(KW 和 QM 传过期或有效 token,KG 传有效 token 或空)。
partner_no
String
厂商订单号(同 sp 内唯一)。
day
Integer
1. 购买天数,天数和月数二选一,不可同时为0。
2. 天数为1为酷狗线上测试充值渠道(请提前联系 TME 导入配额),酷我Q音目前暂时不支持。
month
Integer
购买月份数。

KugouParams_wechat_appinfocode

请求参数 被如下接口引用:wechat_appinfocode
名称
类型
描述
package
String
包名需事先向 TME 注册。

KugouParams_wechat_minipauth

请求参数 被如下接口引用:wechat_minipauth
名称
类型
描述
auth_code
string
获取用户信息凭证。
请求参数 被如下接口引用:wechat_openlink
名称
类型
描述
package
String
包名需事先向TME注册对应手机 APP 的包名(如没有对应手机 APP 可暂时预留一个)。

KugouParams_wechat_qrcodeauth

请求参数 被如下接口引用:wechat_qrcodeauth
名称
类型
描述
ticket
String
获取扫码授权结果的凭证。

KugouParams_wechat_qrcodeget

请求参数 被如下接口引用:wechat_qrcodeget
名称
类型
描述
package
String
包名需事先向 TME 注册。

Location

经纬度 被如下接口引用:AppGetDeviceLocation、AppGetDeviceLocationHistory
名称
类型
描述
Longitude
float32
经度
Latitude
float32
纬度

MemberList

被如下接口引用:AppGetFamilyMemberList
名称
类型
描述
UserId
String
用户 Id。
NickName
String
用户昵称。
Avatar
String
头像。
Role
Int
角色类型。
0是普通成员。
1是管理员。

MessageAttachment

消息加信息
名称
类型
描述
ShareToken
String
分享设备或邀请成员加入家庭时,用于绑定的凭证。

Msgs

消息体
名称
类型
描述
UserId
String
接受者用户 Id。
FromUserId
String
发送者用户 Id。
MsgId
String
消息 Id。
Category
Int
主类型(1:设备,2:家庭,3:通知)。
MsgType
Int64
类型。
101: 设备告警提醒。
200:成员添加结果通知。
201: 成员删除结果通知。
202:社区成员添加结果通知。
203: 社区成员删除结果通知。
204:邀请成员加入。
300: 设备分享结果通知。
301: 设备分享邀请。
MsgTitle
String
消息标题。
MsgContent
String
消息内容。
MsgTimestamp
Int64
消息时间戳。
ProductId
String
产品 ID。
DeviceName
String
设备名。
DeviceAlias
String
设备别名。
FamilyId
String
家庭 ID。
FamilyName
String
家庭名称。
RelateUserId
String
关联用户,在家庭消息中,一般指被添加或删除的用户。
CreateAt
String
创建时间,RFC3339 格式。
Attachments
Object of MessageAttachment
消息加信息。

Position

位置 被如下接口引用:AppGetDeviceLocation、AppGetDeviceLocationHistory
名称
类型
描述
Location
Location
经纬度。
CreateTime
int64
创建时间。

ProductList

关联产品列表
名称
类型
描述
ProductId
String
产品 ID。
Name
String
产品名称。
Description
String
产品描述。
UIConfig
String
交互配置信息 json 字符串,包括产品图片、配网引导等。

Products

产品列表
名称
类型
描述
ProductId
String
产品 ID。
Name
String
产品名称。
Description
String
产品描述。
DataTemplate
String
产品数据模板。
NetType
String
产品网络连接类型。
CategoryId
Int32
产品分类 ID。
ProductType
Int32
产品类型。
UpdateTime
Int64
最后更新的 unix 时间戳(秒级)。

ProductsConfigRsp

产品界面配置返回值 被如下接口引用:AppGetProductsConfig
名称
类型
描述
ProductId
String
产品ID
Config
String
产品配置

Property

条件属性被如下接口引用:AppCreateAutomation、AppDescribeAutomation、AppModifyAutomation
名称
类型
必选
描述
ProductId
String
产品 ID。
DeviceName
String
设备名称。
AliasName
String
设备别名。
IconUrl
String
产品图标 URL。
PropertyId
String
产品属性 ID。
Op
String
条件操作符。
eq:等于。
ne:不等于。
gt:大于。
lt:小于。
ge:大于等于。
le:小于等于。
Value
Any
比较的值。

RiskItem

扣分项结构体被如下接口引用:AppGetInsuranceEvaluation
名称
类型
必选
描述
Name
String
扣分项名称。
Reason
String
隐患分析。
Suggestion
String
处置建议。

Roomlist

房间列表信息被如下接口引用:AppGetRoomList
名称
类型
描述
RoomId
String
房间的所属 Id。
RoomName
String
房间名称。
DeviceNum
Int
房间拥有的设备数。
CreateTime
Int
创建时间,unix 时间戳(秒级)。
UpdateTime
Int
最后更新时间,unix 时间戳(秒级)。

Scene

场景实体被如下接口引用:AppGetSceneList
名称
类型
必选
描述
SceneId
String
手动智能联动 ID。
FamilyId
String
手动智能联动所属家庭 ID。
SceneName
String
手动智能联动的名称。
SceneIcon
String
手动智能联动的背景图片地址。
Actions
Array of Action
手动智能联动动作列表。
UserId
String
用户 ID。
CreateTime
int
创建时间戳。
UpdateTime
int
更新时间戳。
Flag
int
设备状态。
0:正常。
1:设备异常。
Status
int
运行状态。
0:未运行。
1:运行中。

ShareDeviceTokenInfo

响应结果被如下接口引用:AppDescribeShareDeviceToken
名称
类型
描述
FromUserId
String
分享用户 Id。
FromUserNick
String
分享用户昵称。
UserId
String
被分享用户 Id。
UserNick
String
被分享用户昵称。
ProductId
String
产品 ID。
DeviceName
String
设备名。
AliasName
String
设备别名。
IconUrl
String
图标 URL。
BindTime
Int64
绑定的 unix 时间戳(秒级)。
ExpireTime
Int64
有效期(秒级)。
CreateTime
Int64
创建的 unix 时间戳(秒级)。

ShareDevices

分享设备信息被如下接口引用:AppDescribeShareDevice、AppListUserShareDevices
名称
类型
描述
ProductId
String
产品 ID。
DeviceName
String
设备名称。
DeviceId
String
设备 ID,是产品 ID/设备名称拼接而来。
IconUrl
String
图标的 url。
AliasName
String
设备别名、备注。
CreateTime
String
设备创建时间,这里是 RFC3339 的格式。

ShareUserInfo

分享用户信息被如下接口引用:AppListShareDeviceUsers
名称
类型
描述
UserId
String
被分享用户 Id。
NickName
String
昵称。
CountryCode
String
国家码。
PhoneNumber
String
手机号。
BindTime
Int64
绑定时间,秒级 UNIX 时间戳。

Timer

条件触发时间被如下接口引用:AppCreateAutomation、AppDescribeAutomation、AppModifyAutomation
名称
类型
必选
描述
Days
String
定时器开启时间,每一位——0:关闭,1:开启,从左至右依次表示:周日、周一、周二、周三、周四、周五、周六。
TimePoint
String
定时器开启时间点。

TimerList

定时器列表信息被如下接口引用:AppGetTimerList
名称
类型
描述
TimerId
String
定时器 ID。
TimerName
String
定时器名称。
ProductId
String
定时器所属的产品 ID。
DeviceName
String
定时器对应的设备名称。
Days
String
定时器开启时间,每一位——0是关闭,1是开启,从左至右依次表示:周日、周一、周二、周三、周四、周五、周六。
TimePoint
String
定时器开启时间点。
Repeat
Int
是否循环。
0:不需要。
1:需要。
Data
String
定时器启动时下发的状态。
Status
String
开启状态。0表示关闭,1表示开启。
CreateTime
Int64
创建时间,unix 时间戳(秒级)。
UpdateTime
Int64
最后一次更新时间,unix 时间戳(秒级)。

TokenResultInfo

用户信息被如下接口引用:AppGetToken、AppGetTokenByWeiXin
名称
类型
描述
ExpireAt
Int64
截止时间,Unix 秒级时间戳。
Token
String
开发平台返回的 AccessToken,通过该 Token 进行登录后的接口请求。
CancelAccountTime
Int64
仅当用户提交注销申请(AppUserCancelAccount)后再次登录时返回(仅申请首次登录返回),此字段用来返回注销申请提交时间,提醒用户注销流程已取消,Unix 秒级时间戳。

UserSetting

用户设置被如下接口引用:AppGetUserSetting
名称
类型
必选
描述
EnableWechatPush
Int
微信推送。
EnableDeviceMessagePush
Int
设备信息推送。
EnableFamilyMessagePush
Int
家庭信息推送。
EnableNotifyMessagePush
Int
通知信息推送。
AllowEditions
Int
小程序白名单版本。0表示仅限家庭版,1表示家庭版和社区版都允许。
UsingEdition
Int
小程序当前使用版本。0表示家庭版,1表示社区版。
TemperatureUnit
String
温度单位:C 表示摄氏度, F 表示华氏度。
Region
String
时区设置,有效时区参见:AppGetGlobalConfig 中的 RegionListEN 或 RegionListCN。
NoDisturbTime
String
消息免打扰时段,为空则表示未开启免打扰,开启时则用:HH:MM-HH:MM 表示免打扰时段,例如:21:00-08:00。
NoDisturbDeviceList
Array of String
免打扰设备 ID 列表。
NoDisturbFamilyList
Array of String
免打扰家庭列表。

YunApiParam

设备心跳接口被如下接口引用:HeartBeat
名称
类型
必选
描述
AccessToken
String
AccessToken 为调用登录接口之后获取 Token。
ActionParams
Object of HeartBeatParam
设备心跳接口入参。
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。

accompany_accompany_free_info

体验信息被如下接口引用:accompany_free_info
名称
类型
必选
描述
accompany_id
String
已经体验的伴奏 id。

accompany_accompany_info

伴奏列表被如下接口引用:accompany_info
名称
类型
必选
描述
has_original
Integer
音频是否有原唱音轨。
0:无 。
1:有。
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
mv_id
String
MVID
hash_key
String
hashkey
song_id
String
歌曲 id。
accompany_id
String
伴奏 id。
song_name
String
伴奏名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
duration
Integer
伴奏时长单位毫秒。
album_img
String
专辑图片。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。
krc_id
String
歌词 ID。
original_mv_id
String
原版本 MV ID。

accompany_awesome_personal

伴奏个性推荐
被如下接口引用:accompany_awesome_personal
名称
类型
必选
描述
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
accompany_id
String
伴奏 id。
song_name
String
伴奏名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
duration
Integer
伴奏时长单位毫秒。
album_img
String
专辑图片。
has_original
Integer
音频是否有原唱音轨。
0:没有。
1:有。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_awesome_top

伴奏推荐列表被如下接口引用:accompany_awesome_top
名称
类型
必选
描述
weight
Integer
热度值/飙升值。
is_hq
Integer
是否显示HQ标识。
0:不显示。
1:显示。
accompany_id
String
伴奏 id。
song_name
String
伴奏名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
duration
Integer
伴奏时长单位毫秒。
album_img
String
专辑图片。
has_original
Integer
音频是否有原唱音轨。
0:没有。
1:有。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_category_song

伴奏列表被如下接口引用:accompany_category_song
名称
类型
必选
描述
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
accompany_id
String
伴奏 id。
song_name
String
伴奏名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
duration
Integer
伴奏时长单位毫秒。
album_img
String
专辑图片。
has_original
Integer
音频是否有原唱音轨。
0:没有。
1:有。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_favorite_list

伴奏列表被如下接口引用:accompany_favorite_list
名称
类型
必选
描述
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
has_original
Integer
音频是否有原唱音轨。
0:没有。
1:有。
singer_name
String
歌手名。
accompany_id
String
伴奏 id。
song_name
String
伴奏名字。
duration
Integer
伴奏时长单位毫秒。
singer_id
String
歌手 id。
album_img
String
专辑图片。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_free_top_song

伴奏列表被如下接口引用:accompany_free_top_song
名称
类型
必选
描述
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
has_original
Integer
音频是否有原唱音轨。
0:没有。
1:有。
singer_name
String
歌手名。
free_token
String
免费令牌。
accompany_id
String
伴奏 id。
song_name
String
伴奏名字。
duration
Integer
伴奏时长单位毫秒。
singer_id
String
歌手 id。
album_img
String
专辑图片。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_newsearch_song

伴奏列表被如下接口引用:accompany_newsearch_song
名称
类型
必选
描述
song_hot
Integer
热度。
accompany_id
String
伴奏 id。
song_name
String
伴奏名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
duration
Integer
伴奏时长单位毫秒。
album_img
String
专辑图片。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_search_song

伴奏搜索被如下接口引用:accompany_search_song
名称
类型
必选
描述
song_hot
Integer
热度。
accompany_id
String
伴奏 id。
song_name
String
伴奏名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
duration
Integer
伴奏时长单位毫秒。
album_img
String
专辑图片。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_singer_song

伴奏列表被如下接口引用:accompany_singer_song
名称
类型
必选
描述
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
singer_name
String
歌手名。
accompany_id
String
伴奏 id。
song_name
String
伴奏名字。
duration
Integer
伴奏时长单位毫秒。
singer_id
String
歌手 id。
album_img
String
专辑图片。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_song_accompany

伴奏 被如下接口引用:song_accompany
名称
类型
描述
accompany_id
String
伴奏 id。
song_name
String
伴奏名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
duration
Integer
伴奏时长单位毫秒。
album_img
String
专辑图片。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_theme_song

伴奏列表 被如下接口引用:accompany_theme_song
名称
类型
必选
描述
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
singer_name
String
歌手名。
accompany_id
String
伴奏 id。
song_name
String
伴奏名字。
duration
Integer
伴奏时长单位毫秒。
singer_id
String
歌手 id。
album_img
String
专辑图片。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

accompany_top_song

伴奏列表 被如下接口引用:accompany_top_song
名称
类型
必选
描述
is_hq
Integer
是否显示 HQ 标识。
0:不显示。
1:显示。
has_original
Integer
音频是否有原唱音轨。
0:无。
1:有。
singer_name
String
歌手名。
accompany_id
String
伴奏 id。
song_name
String
伴奏名字。
duration
Integer
伴奏时长单位毫秒。
singer_id
String
歌手 id。
album_img
String
专辑图片。
is_ktv
Integer
是否有 KTV。
0:没有。
1:有。
bit_rate
Integer
比特率。
has_pitch
Integer
是否有音高。
0:没有。
1:有。

albums_asset_purchased_albums

专辑信息 被如下接口引用:asset_purchased_albums
名称
类型
描述
album_id
String
专辑 id。
album_name
String
专辑名。
album_translate_name
String
专辑译名。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
intro
String
专辑简介。
company
String
唱片公司。
singer_id
String
歌手 id。
singer_name
String
歌手名。
publish_time
String
发布时间.

albums_singer_album

专辑信息 被如下接口引用:singer_album
名称
类型
描述
album_id
String
专辑 id。
album_name
String
专辑名。
album_translate_name
String
专辑译名。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
intro
String
专辑简介。
company
String
唱片公司。
singer_id
String
歌手 id。
singer_name
String
歌手名。
publish_time
String
发布时间。

appapiCommon

AppApi 公共参数
名称
类型
必选
描述
Action
String
公共参数,本接口取值:AppCreateEmailUser。
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。
AppKey
String
公共参数,应用 AppKey ,用于标识对应的 App。
Signature
String
公共参数,请求签名,需用户自行生成,用于校验请求的合法性。
Timestamp
Int64
公共参数,请求的 Unix 时间戳(秒级)。
Nonce
Int
公共参数,随机正整数,与 Timestamp 联合起来,防止重放攻击。

author_newsearch_song

歌手列表 被如下接口引用:accompany_newsearch_song
名称
类型
必选
描述
singer_id
String
歌手 id。
singer_name
String
歌手名。
singer_img
String
歌手图片。

categories_accompany_category_list

分类 被如下接口引用:accompany_category_list
名称
类型
必选
描述
category_name
String
分类名。
category_id
String
分类 id。

categories_mv_category_list

分类列表 被如下接口引用:mv_category_list
名称
类型
必选
描述
category_id
String
分类 id。
category_name
String
分类名。

data_monitor_delay

数据 被如下接口引用:monitor_delay
名称
类型
必选
描述
api
String
api path,必须与 api 实际 path 保持一致。
userid
String
TME 用户 id。
client_ip
String
接口使用者 ip,如设备直接调用 TME api 则上报设备 ip,反之则厂商服务器 ip。
server_ip
String
接口实际调用时的服务器 ip。
ecode
Integer
业务错误码(error_code)。
reqtime
Integer
请求时间时间戳单位秒。
rspsize
Integer
响应包大小,单位字节。
sp
String
服务提供商对应枚举值分别为酷狗,酷我,Q音。
apn
String
网络类型。
etype
Integer
错误类型。0:调用成功。1:网络错误。2:http 错误码。3:业务错误码。
reqsize
Integer
请求包大小,单位字节。
retry
Integer
重试次数(本次是第几次重试)。
delay
Integer
接口调用时延,单位 ms。

data_monitor_listen

数据 被如下接口引用:monitor_listen
名称
类型
必选
描述
play_quality
String
歌曲/长音频播放品质 d,取值:SQ、HQ、standard;视频播放品质:FHD、HD、LD、QHD、SD。
duration
Integer
歌曲时长(单位 ms)。
play_time
Integer
歌曲实际播放时长(单位 ms)。
play_type
Integer
1:在线。
2:缓存。
3:下载。
client_ip
String
接口实际使用者 ip,即硬件终端 ip。
media_type
Integer
1:听歌。
2:视频MV。
3:伴奏K歌业务。
4:有声音频。
5:直播。
lvt
String
用户播放时间 format: 2019-09-19 00:00:00。
try_play
Integer
0:可完整播放。1:vip 试听类型。2:免登录试听。
说明:可完整播放(该用户有完播权限),vip 试听类型(非 vip 用户试听 vip 歌曲片段),免登录试听(用户未登录,免费试听权限)。
sp
String
服务提供商对应枚举值分别为酷狗,酷我,Q音。
userid
String
TME 用户 id。
song_id
String
根据多媒体类型,赋值相应的 ID:歌曲 ID、伴奏 ID、MV 的 ID。
api
String
api path,必须与 api 实际 path 保持一致。
source_id
String
歌曲 id 来源, 歌曲来源为歌单上传歌单 id,歌曲来源为榜单,上传榜单 id。如果都不是,传空。

groups_accompany_category_list

伴奏分组 被如下接口引用:accompany_category_list
名称
类型
必选
描述
group_name
String
分组名。
categories
Array Of categories_accompany_category_list of categories_accompany_category_list
分类。

groups_accompany_free_top_list

分组列表 被如下接口引用:accompany_free_top_list
名称
类型
必选
描述
group_id
String
分组 id。
group_name
String
分组名。
tops
Array Of tops_accompany_free_top_list of tops_accompany_free_top_list
榜单列表。

groups_accompany_top_list

分组列表 被如下接口引用:accompany_top_list
名称
类型
必选
描述
group_id
String
分组 id。
group_name
String
分组名。
tops
Array Of tops_accompany_top_list of tops_accompany_top_list
tops

groups_child_home

资源分组 被如下接口引用:child_home
名称
类型
必选
描述
name
String
资源名称。
infos
Array Of infos_child_home of infos_child_home
资源列表。

groups_longaudio_free_home

资源分组 被如下接口引用:longaudio_free_home
名称
类型
必选
描述
name
String
资源名称。
tag_id
String
资源 tag_id,值为-1即没有更多的资源。
infos
Array Of infos_longaudio_free_home of infos_longaudio_free_home
资源列表。

groups_playlist_top

分组列表
被如下接口引用:playlist_top
名称
类型
描述
category_id
String
分类 id 推荐歌单传入同名字段获取相应歌单。
category_name
String
分类名。
category_icon
String
分类封面。

groups_radio_list

分组列表 被如下接口引用:radio_list
名称
类型
描述
group_id
String
分组 id。
group_name
String
分组名。
radios
Array of radios_radio_list
电台列表。

groups_rigion_home

资源分组 被如下接口引用:rigion_home
名称
类型
必选
描述
name
String
资源名称。
infos
Array Of infos_rigion_home of infos_rigion_home
资源列表。

groups_rigion_oldman_index

资源分组 被如下接口引用:rigion_oldman_index
名称
类型
必选
描述
id
Integer
专区 id。
name
String
专区名称。
pic
String
专区封面。
summary
String
描述。

groups_top_list

分组 被如下接口引用:top_list
名称
类型
描述
group_id
String
分组 id。
group_name
String
分组名。
tops
Array of tops_top_list
榜单。

horizontal_live_room_url

横屏流信息 被如下接口引用:live_room_url
名称
类型
必选
描述
rate
String
清晰度标识 (1:流畅。2:标清。 3:高清。 4:超清。 5:1080P。)
hls
Array Of String
hls 流信息。
httpflv
Array Of String
httpflv 流信息。
httpsflv
Array Of String
httpsflv 流信息。
rtmp
Array Of String
rtmp 流信息。
httpshls
Array Of String
httpshls 流信息。
streamName
String
流名称。

infos_child_home

资源列表 被如下接口引用:child_home
名称
类型
必选
描述
resource_type
String
大分类。
3:歌单。 4:专辑。 7:小分类。
resource_id
String
资源 id。
name
String
资源名称。
pic
String
资源图。

infos_longaudio_free_home

资源列表 被如下接口引用:longaudio_free_home
名称
类型
必选
描述
resource_id
Integer
资源 id。
name
String
资源名称。
pic
String
资源封面。

infos_rigion_home

资源列表 被如下接口引用:rigion_home
名称
类型
必选
描述
resource_type
String
大分类。
2:单曲。 3:歌单。 103:歌单合集。 4:专辑。 104:专辑合集。 5:歌手。 6:排行榜。 7:分类。 8:MV。 108:MV 合集。 9:电台。 109:电台合集。
resource_id
String
资源 id。
name
String
资源名称。
pic
String
资源封面。

letters_accompany_singer_list

letters 被如下接口引用:accompany_singer_list
名称
类型
必选
描述
letter
String
歌手首字母。
singers
Array Of singers_accompany_singer_list of singers_accompany_singer_list
歌手列表。

lists_child_resource

资源分组 被如下接口引用:child_resource
名称
类型
必选
描述
id
String
资源 id。
name
String
资源名称。
pic
String
资源图片。

lists_longaudio_resource

资源列表 被如下接口引用:longaudio_resource
名称
类型
必选
描述
resource_id
Integer
资源 id。
name
String
资源名称。
pic
String
资源封面。

mvInfos_mv_infos

mv 信息 被如下接口引用:mv_infos
名称
类型
必选
描述
author_name
String
MV 制作人名称。
tags
mv 信息。
mv_id
String
MV id
mv_name
String
MV 名称。
singer_id
String
歌手 id。
singer_name
String
歌手名称。
accompany_id
String
伴奏 id。
intro
String
简介。
song_id
String
歌曲 id。
mv_img
String
MV 图片。

mvs_mv_category_mv

MV 列表 被如下接口引用:mv_category_mv
名称
类型
必选
描述
mv_img
String
MV 图片。
mv_name
String
MV 名称。
singer_id
String
歌手 id。
singer_name
String
歌手名称。
song_id
String
歌曲 id。
mv_id
String
MV id

mvs_mv_live_tme

MV 列表 被如下接口引用:mv_live_tme
名称
类型
必选
描述
mv_id
String
MV id
mv_img
String
MV 图片。
mv_name
String
MV 名称。
singer_id
String
歌手 id。
singer_name
String
歌手名称。
song_id
String
歌曲 id。
mv 列表 被如下接口引用:mv_search
名称
类型
必选
描述
singer_name
String
歌手名称。
has_acc
Integer
是否有伴奏。
0:没有。
1:有。
mv_id
String
MV id
mv_img
String
MV 图片。
mv_name
String
MV 名称。
song_id
String
歌曲 id。

opuses_accompany_opus_list

opuses 被如下接口引用:accompany_opus_list
名称
类型
必选
描述
opus_name
String
作品名称。
score
Integer
总分数。
grade
String
等级。
listen_num
Integer
试听人数。
album_img
String
专辑封面。
accompany_id
String
伴奏 id。
opus_id
String
作品 id。
average_score
Integer
平均分。
is_private
Integer
是否公开。
0:公开作品。
1:私密作品。
duration
Integer
作品播放时间,单位秒。

playlists_favorite_other_list

歌单 被如下接口引用:favorite_other_list
名称
类型
描述
playlist_id
String
歌单 id。
playlist_name
String
歌单名称。
pic
String
歌单封面。
playlist_extra_id
String
歌单附加 id。

playlists_favorite_self_list

歌单 被如下接口引用:favorite_self_list
名称
类型
描述
playlist_id
String
歌单 id。
playlist_name
String
歌单名称。
pic
String
歌单封面。
update_time
String
歌单更新时间。
create_time
String
歌单创建时间。
total
Integer
歌单歌曲数量。

playlists_playlist_awesome

歌单 被如下接口引用:playlist_awesome
名称
类型
描述
playlist_id
String
歌单 id。
playlist_name
String
歌单名称。
pic
String
歌单封面。
update_time
String
歌单更新时间。
create_time
String
歌单创建时间。
intro
string
歌单简介。

programs_live_program_list

节目分组 被如下接口引用:live_program_list
名称
类型
必选
描述
room_id
Integer
房间 id。
status
String
节目状态。 0是未开播,1是开播。
price
String
价格。
name
String
节目名称。
startTime
String
开始时间。
endTime
String
结束时间。
intro
String
节目描述。
pic
String
封面图片。
pay_type
Integer
是否付费演出会。0:不是。1:是。

radios_radio_list

电台列表 被如下接口引用:radio_list
名称
类型
描述
radio_id
String
电台 id。
radio_name
String
电台名。
radio_img
String
电台封面。

recommends_accompany_category_list

推荐分类 被如下接口引用:accompany_category_list
名称
类型
必选
描述
category_id
String
分类 id。
category_name
String
分类名。
category_img
String
分类图片。

singers_accompany_singer_list

热门歌手 被如下接口引用:accompany_singer_list
名称
类型
必选
描述
singer_id
String
歌手 id。
singer_name
String
歌手名。
singer_img
String
歌手图片。

singers_accompany_singer_list_1

歌手列表
名称
类型
必选
描述
singer_name
String
歌手名。
singer_img
String
歌手图片。
singer_id
String
歌手 id。

singers_singer_list

歌手 被如下接口引用:singer_list
名称
类型
描述
singer_id
String
歌手 id。
singer_name
String
歌手名。
area
String
歌手地区。
translate_name
String
歌手译名。
singer_img
String
歌手相片。

slots_search_voice

语音搜索列表 被如下接口引用:search_voice
名称
类型
必选
描述
name
String
-
value
String
词槽参数值。

songs_album_info

歌曲列表 被如下接口引用:album_info
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否vip歌曲。0:否。1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。0:否。1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否。
1:有。
language
String
语言。

songs_asset_purchased_songs

歌曲列表 被如下接口引用:asset_purchased_songs
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否 。
1:是。
language
String
语言。

songs_awesome_everyday

歌曲列表 被如下接口引用:awesome_everyday
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否 。
1:有。
language
String
语言。

songs_awesome_newsong

歌曲列表 被如下接口引用:awesome_newsong
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否 。
1:有。
language
String
语言。

songs_awesome_recommend

歌曲列表 被如下接口引用:awesome_recommend
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否 。
1:有。
language
String
语言。

songs_favorite_song

歌曲列表 被如下接口引用:favorite_song
名称
类型
描述
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
song_extra_id
String
歌曲附加 id,仅获取自建歌单歌曲列表时返回(取消收藏时使用)。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。

songs_id_song_infos

歌曲id列表 被如下接口引用:song_infos
名称
类型
必选
描述
Values
Array of String
一个或者多个过滤值。

songs_playlist_song

歌曲列表 被如下接口引用:playlist_song
名称
类型
描述
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。

songs_radio_song

歌曲列表 被如下接口引用:radio_song
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
language
String
语言。

songs_search_song

歌曲列表 被如下接口引用:search_song
名称
类型
必选
描述
singer_name
String
歌手名。
album_id
String
歌曲所属专辑 id。
album_name
String
歌曲所属专辑名。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
singer_img
String
歌手头像。
album_img_mini
String
专辑封面100px左右。
language
String
语言。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
album_img
String
专辑封面。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
mv_id
String
mv id

songs_search_voice

语音搜索歌曲列表 被如下接口引用:search_voice
名称
类型
必选
描述
singer_name
String
歌手名。
duration
Integer
歌曲时长,单位 ms。
song_id
String
歌曲 id。
song_name
String
歌曲名。

songs_singer_song

歌曲列表 被如下接口引用:singer_song
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否 。
1:有。
language
String
语言。

songs_song_infos

歌曲列表 被如下接口引用:song_infos
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否 。
1:有。
topic_url
String
歌曲专题页面(购买链接)。
language
String
语言。

songs_song_tolisten

歌曲列表 被如下接口引用:song_tolisten
名称
类型
描述
singer_img
String
歌手头像。
album_img
String
专辑封面。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
album_img_medium
String
专辑封面500px左右。
is_vip_song
Integer
是否 vip 歌曲。0:否 。1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。0:否 。1:是。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
singer_name
String
歌手名。
album_id
String
专辑 id。
album_name
String
专辑名。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
try_playable
Integer
是否有试听片段。
0:否 。
1:有。
topic_url
String
歌曲专题页面(购买链接)。
language
String
语言。

songs_top_song

歌曲列表 被如下接口引用:top_song
名称
类型
描述
singer_name
String
歌手名。
album_id
String
歌曲所属专辑 id。
album_name
String
歌曲所属专辑名。
song_id
String
歌曲 id。
song_name
String
歌曲名。
singer_id
String
歌手 id。
playable_code
Integer
是否可以播放。枚举值依次对应:
0:可以。
1:海外地区不能播放。
2:歌曲无版权不能播放。
3:会员歌曲,非会员不能播放。
4:付费内容,须购买才可播放。
5:牛方案策略,非会员不能播放。
6:因定向版权下架不能播放(针对 APP 有权但设备端无权的情况)。
9:未知原因,无权播放。
is_vip_song
Integer
是否 vip 歌曲。
0:否 。
1:是。
mv_id
String
mv id
has_accompany
Integer
是否有伴奏。
0:否 。
1:是。
singer_img
String
歌手头像。
album_img_mini
String
专辑封面100px左右。
album_img_small
String
专辑封面300px左右。
language
String
语言。
album_img
String
专辑封面。
album_img_medium
String
专辑封面500px左右。

tags_mv_info

mv 信息 被如下接口引用:mv_info
名称
类型
必选
描述
tag_id
String
标签 id。
parent_id
String
标签 parentId。
tag_name
String
标签的名称。

tags_mv_infos

mv 信息 被如下接口引用:mv_infos
名称
类型
必选
描述
tag_id
String
标签 id。
parent_id
String
标签 parentId。
tag_name
String
标签的名称。

themes_accompany_theme_list

主题列表 被如下接口引用:accompany_theme_list
名称
类型
必选
描述
theme_thumbnail
String
主题缩略图。
theme_id
String
主题 id。
theme_name
String
主题名。
theme_img
String
主题图片。

tokenapiCommon

tokenApi的公共参数
名称
类型
必选
描述
Action
String
公共参数,本接口取值:AppLogoutUser。
AccessToken
String
公共参数,AccessToken 用于对一个已经登录的用户鉴权。
RequestId
String
公共参数,唯一请求 ID,可自行生成,推荐使用 uuId。定位问题时,需提供该次请求的 RequestId。

tops_accompany_free_top_list

榜单列表 被如下接口引用:accompany_free_top_list
名称
类型
必选
描述
top_id
String
榜单 id。
top_name
String
榜单名。
header_url
String
榜单图片。

tops_accompany_top_list

tops 被如下接口引用:accompany_top_list
名称
类型
必选
描述
top_id
String
榜单 id。
top_name
String
榜单名。

tops_top_list

榜单 被如下接口引用:top_list
名称
类型
描述
top_id
String
榜单 id。
top_name
String
榜单名。
header_url
String
榜单图片。

vertical_live_room_url

竖屏流信息 被如下接口引用:live_room_url
名称
类型
必选
描述
rtmp
Array Of String
rtmp 流信息。
httpshls
Array Of String
httpshls 流信息。
streamName
String
流名称。
rate
String
清晰度标识 (1:流畅。 2:标清。 3:高清。 4:超清。 5:1080P。)
hls
Array Of String
hls 流信息。
httpflv
Array Of String
httpflv 流信息。
httpsflv
Array Of String
httpsflv 流信息。

WechatTemplate

第三方微信模板 被如下接口引用:AppDescribeTemplateBinding
名称
类型
必选
描述
ModelId
String
产品型号ID。
TemplateId
String
微信模板ID
Title
String
微信模板标题
Status
Int
订阅状态:0未订阅;1已订阅;2不接收

WechatDeviceInfo

微信设备票据 被如下接口引用:APPGetWechatDeviceTicket
名称
类型
必选
描述
DeviceId
String
设备ID。
WXIoTDeviceInfo.SN
String
设备SN。
WXIoTDeviceInfo.SNTicket
String
设备票据。
WXIoTDeviceInfo.ModelId
String
产品型号ID。