{
  "name": "ame",
  "display_name": "正版曲库直通车",
  "description": "介绍如何使用API对正版曲库直通车进行操作，包括素材获取、数据上报等。",
  "domain": "other",
  "api_version": "2019-09-16",
  "endpoint": "ame.tencentcloudapi.com",
  "actions": [
    {
      "name": "BatchDescribeKTVMusicDetails",
      "description": "根据 Id 列表查询歌曲的详细信息，包含基础信息及播放信息。",
      "status": "online",
      "parameters": [
        {
          "name": "MusicIds",
          "type": "array",
          "required": true,
          "description": "歌曲Id列表，注：列表最大长度为50",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": [
        "MusicIds"
      ]
    },
    {
      "name": "CreateKTVRobot",
      "description": "创建机器人，支持进入 RTC 房间，播放直播互动曲库歌曲。",
      "status": "online",
      "parameters": [
        {
          "name": "RTCSystem",
          "type": "string",
          "required": true,
          "description": "RTC厂商类型，取值有： TRTC",
          "example": "TRTC"
        },
        {
          "name": "JoinRoomInput",
          "type": "object",
          "required": true,
          "description": "进房参数。",
          "example": "无",
          "children": [
            {
              "name": "TRTCJoinRoomInput",
              "type": "object",
              "required": false,
              "description": "TRTC进房参数",
              "example": "无",
              "children": [
                {
                  "name": "Sign",
                  "type": "string",
                  "required": true,
                  "description": "签名。",
                  "example": "xxxxxxx"
                },
                {
                  "name": "RoomId",
                  "type": "string",
                  "required": true,
                  "description": "房间号。",
                  "example": "12345"
                },
                {
                  "name": "SdkAppId",
                  "type": "string",
                  "required": true,
                  "description": "推流应用ID。",
                  "example": "140000001"
                },
                {
                  "name": "UserId",
                  "type": "string",
                  "required": true,
                  "description": "用户唯一标识。",
                  "example": "tom"
                },
                {
                  "name": "PrivateMapKey",
                  "type": "string",
                  "required": false,
                  "description": "进房钥匙，若需要权限控制请携带该参数。 [privateMapKey 权限设置](/document/product/647/32240)",
                  "example": "xxxxxxx"
                },
                {
                  "name": "Role",
                  "type": "string",
                  "required": false,
                  "description": "用户角色，目前支持两种角色： anchor：主播 audience：观众",
                  "example": "anchor"
                },
                {
                  "name": "RoomIdType",
                  "type": "string",
                  "required": false,
                  "description": "TRTC房间号的类型： Integer：数字类型 String：字符串类型 默认为：Integer 。",
                  "example": "Integer"
                }
              ]
            }
          ]
        },
        {
          "name": "ApplicationLicenseInput",
          "type": "object",
          "required": false,
          "description": "license基础信息",
          "example": "无",
          "children": [
            {
              "name": "AppName",
              "type": "string",
              "required": true,
              "description": "应用名称，注：后面三个字段AndroidPackageName、IOSBundleId、PcIdentifier，三者选填一个",
              "example": "无"
            },
            {
              "name": "AndroidPackageName",
              "type": "string",
              "required": false,
              "description": "app的安卓包名",
              "example": "无"
            },
            {
              "name": "IOSBundleId",
              "type": "string",
              "required": false,
              "description": "app的IOS的BundleId名",
              "example": "无"
            },
            {
              "name": "PcIdentifier",
              "type": "string",
              "required": false,
              "description": "PC标识名",
              "example": "无"
            }
          ]
        },
        {
          "name": "SyncRobotCommands",
          "type": "array",
          "required": false,
          "description": "创建机器人时初始化参数。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Command",
              "type": "string",
              "required": true,
              "description": "可同时传入多个指令，顺序执行。取值有： Play：播放 Pause：暂停 SwitchPrevious：上一首 SwitchNext：下一首 SetPlayMode：设置播放模式 Seek：调整播放进度 SetPlaylist：歌单变更 SetAudioParam：音频参数变更 SendMessage：发送自定义消息 SetDestroyMode：设置销毁模式 SetVolume：设置音量（已废弃，请采用 SetRealVolume） SetRealVolume：设置真实音量",
              "example": "无"
            },
            {
              "name": "PlayCommandInput",
              "type": "object",
              "required": false,
              "description": "播放参数。",
              "example": "无",
              "children": [
                {
                  "name": "Index",
                  "type": "integer",
                  "required": true,
                  "description": "歌曲位置索引。",
                  "example": "2"
                }
              ]
            },
            {
              "name": "SetPlaylistCommandInput",
              "type": "object",
              "required": false,
              "description": "播放列表变更信息，当Command取SetPlaylist时，必填。",
              "example": "无",
              "children": [
                {
                  "name": "Type",
                  "type": "string",
                  "required": true,
                  "description": "变更类型，取值有： Add：添加 Delete：删除 ClearList：清空歌曲列表 Move：移动歌曲",
                  "example": "Add"
                },
                {
                  "name": "Index",
                  "type": "integer",
                  "required": false,
                  "description": "歌单索引位置， 当 Type 取 Add 时，-1表示添加在列表最后位置，大于-1表示要添加的位置； 当 Type 取 Delete 时，表示待删除歌曲的位置； 当 Type 取 Move 时，表示待调整歌曲的位置。",
                  "example": "1"
                },
                {
                  "name": "ChangedIndex",
                  "type": "integer",
                  "required": false,
                  "description": "当 Type 取 Move 时，必填，表示移动歌曲的目标位置。",
                  "example": "2"
                },
                {
                  "name": "MusicIds",
                  "type": "array",
                  "required": false,
                  "description": "歌曲 ID 列表，当 Type 取 Add 时，与MusicURLs必填其中一项。",
                  "example": "xxxxxx",
                  "item_type": "string"
                },
                {
                  "name": "MusicURLs",
                  "type": "array",
                  "required": false,
                  "description": "歌曲 URL 列表，当 Type 取 Add 时，与MusicIds必填其中一项。 注：URL必须以.mp3结尾且必须是mp3编码文件。",
                  "example": "http://demo.mp3",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "SeekCommandInput",
              "type": "object",
              "required": false,
              "description": "播放进度，当Command取Seek时，必填。",
              "example": "无",
              "children": [
                {
                  "name": "Position",
                  "type": "integer",
                  "required": true,
                  "description": "播放位置，单位：毫秒。",
                  "example": "120"
                }
              ]
            },
            {
              "name": "SetAudioParamCommandInput",
              "type": "object",
              "required": false,
              "description": "音频参数，当Command取SetAudioParam时，必填。",
              "example": "无",
              "children": [
                {
                  "name": "Definition",
                  "type": "string",
                  "required": false,
                  "description": "规格，取值有： audio/mi：低规格 audio/lo：中规格 audio/hi：高规格",
                  "example": "audio/hi"
                },
                {
                  "name": "Type",
                  "type": "string",
                  "required": false,
                  "description": "音频类型，取值有： Original：原唱 Accompaniment：伴奏",
                  "example": "Original"
                }
              ]
            },
            {
              "name": "SendMessageCommandInput",
              "type": "object",
              "required": false,
              "description": "自定义消息，当Command取SendMessage时，必填。",
              "example": "无",
              "children": [
                {
                  "name": "Message",
                  "type": "string",
                  "required": true,
                  "description": "自定义消息，json格式字符串。",
                  "example": "{\"field\":\"value\"}"
                },
                {
                  "name": "Repeat",
                  "type": "integer",
                  "required": false,
                  "description": "消息重复次数，默认为 1。",
                  "example": "2"
                }
              ]
            },
            {
              "name": "SetPlayModeCommandInput",
              "type": "object",
              "required": false,
              "description": "播放模式，当Command取SetPlayMode时，必填。",
              "example": "无",
              "children": [
                {
                  "name": "PlayMode",
                  "type": "string",
                  "required": true,
                  "description": "播放模式，取值有： RepeatPlaylist：列表循环 Order：顺序播放 RepeatSingle：单曲循环 Shuffle：随机播放",
                  "example": "RepeatPlaylist"
                }
              ]
            },
            {
              "name": "SetDestroyModeCommandInput",
              "type": "object",
              "required": false,
              "description": "销毁模式，当Command取SetDestroyMode时，必填。",
              "example": "无",
              "children": [
                {
                  "name": "DestroyMode",
                  "type": "string",
                  "required": true,
                  "description": "销毁模式，取值有： Auto：房间没人时自动销毁 Expire：房间没人时过期自动销毁 Never：不自动销毁，需手动销毁默认为：Auto。",
                  "example": "Auto"
                },
                {
                  "name": "DestroyExpireTime",
                  "type": "integer",
                  "required": false,
                  "description": "过期销毁时间，单位：秒，当DestroyMode取Expire时必填。",
                  "example": "120"
                }
              ]
            },
            {
              "name": "SetVolumeCommandInput",
              "type": "object",
              "required": false,
              "description": "音量，当Command取SetVolume时，必填。 （已废弃，请采用 SetRealVolumeCommandInput）",
              "example": "无",
              "children": [
                {
                  "name": "Volume",
                  "type": "integer",
                  "required": true,
                  "description": "音量大小，取值范围为 0~100，默认值为 50。",
                  "example": "50"
                }
              ]
            },
            {
              "name": "SetRealVolumeCommandInput",
              "type": "object",
              "required": false,
              "description": "真实音量，当Command取SetRealVolume时，必填。",
              "example": "无",
              "children": [
                {
                  "name": "RealVolume",
                  "type": "integer",
                  "required": true,
                  "description": "真实音量大小，取值范围为 0~100，默认值为 50。",
                  "example": "50"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "RTCSystem",
        "JoinRoomInput"
      ]
    },
    {
      "name": "DescribeAuthInfo",
      "description": "获取授权项目信息列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量：Offset=Offset+Limit"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "数据条数"
        },
        {
          "name": "Key",
          "type": "string",
          "required": false,
          "description": "搜索关键字"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeCloudMusic",
      "description": "获取云音乐播放信息接口",
      "status": "online",
      "parameters": [
        {
          "name": "MusicId",
          "type": "string",
          "required": true,
          "description": "歌曲Id",
          "example": "xxx"
        },
        {
          "name": "MusicType",
          "type": "string",
          "required": false,
          "description": "歌曲类型，可选值有： MP3-128K-FTW：含有水印的试听资源； MP3-320K-FTD-P：320kbps歌曲热门片段； MP3-320K-FTD：320kbps已核验歌曲完整资源。 默认为：MP3-128K-FTW",
          "example": "MP3-320K-FTD-P"
        }
      ],
      "required": [
        "MusicId"
      ]
    },
    {
      "name": "DescribeCloudMusicPurchased",
      "description": "获取授权项目下已购云音乐列表",
      "status": "online",
      "parameters": [
        {
          "name": "AuthInfoId",
          "type": "string",
          "required": true,
          "description": "授权项目Id",
          "example": "xx"
        }
      ],
      "required": [
        "AuthInfoId"
      ]
    },
    {
      "name": "DescribeItemById",
      "description": "根据歌曲ID查询歌曲信息",
      "status": "online",
      "parameters": [
        {
          "name": "ItemIDs",
          "type": "string",
          "required": true,
          "description": "歌曲ID，目前暂不支持批量查询"
        }
      ],
      "required": [
        "ItemIDs"
      ]
    },
    {
      "name": "DescribeItems",
      "description": "该服务后续会停用，不再建议使用",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "offset (Default = 0)，(当前页-1) * Limit"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "条数，必须大于0，最大值为30"
        },
        {
          "name": "CategoryId",
          "type": "string",
          "required": false,
          "description": "（电台/歌单）ID，CategoryId和CategoryCode两个必传1个，可以从获取分类内容（Station）列表接口中获取。"
        },
        {
          "name": "CategoryCode",
          "type": "string",
          "required": false,
          "description": "（电台/歌单）ID，CategoryId和CategoryCode两个必传1个，可以从获取分类内容（Station）列表接口中获取。"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "DescribeKTVMusicDetail",
      "description": "根据 Id 查询歌曲的详细信息，包含基础信息及播放信息。",
      "status": "online",
      "parameters": [
        {
          "name": "MusicId",
          "type": "string",
          "required": true,
          "description": "曲目 Id",
          "example": "\"\""
        }
      ],
      "required": [
        "MusicId"
      ]
    },
    {
      "name": "DescribeKTVMusicTags",
      "description": "获取直播互动曲库标签分组信息和标签信息",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeKTVPlaylistDetail",
      "description": "根据歌单 Id 获取歌单详情，包括歌单的基础信息以及歌曲列表。",
      "status": "online",
      "parameters": [
        {
          "name": "PlaylistId",
          "type": "string",
          "required": true,
          "description": "歌单Id",
          "example": "无"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "10"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "10"
        }
      ],
      "required": [
        "PlaylistId"
      ]
    },
    {
      "name": "DescribeKTVPlaylists",
      "description": "获取直播互动曲库推荐歌单列表。",
      "status": "online",
      "parameters": [
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "歌单类型，取值有： ·OfficialRec：官方推荐 ·Normal：自定义 当该字段未填时，默认为取OfficialRec",
          "example": "1"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。 取值范围：Offset + Limit 不超过5000",
          "example": "10"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。 取值范围：Offset + Limit 不超过5000",
          "example": "100"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeKTVRobots",
      "description": "获取机器人列表，支持 Id、状态等过滤条件。",
      "status": "online",
      "parameters": [
        {
          "name": "RobotIds",
          "type": "array",
          "required": false,
          "description": "机器人Id列表。",
          "example": "ame-xxxxx",
          "item_type": "string"
        },
        {
          "name": "Statuses",
          "type": "array",
          "required": false,
          "description": "机器人状态，取值有： Play：播放 Pause：暂停 Destroy：销毁",
          "example": "Play",
          "item_type": "string"
        },
        {
          "name": "CreateTime",
          "type": "object",
          "required": false,
          "description": "匹配创建时间在此时间段内的机器人。 包含所指定的头尾时间点。",
          "example": "无",
          "children": [
            {
              "name": "Before",
              "type": "string",
              "required": false,
              "description": "大于等于此时间（起始时间）。 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。",
              "example": "2020-12-10T07:25:52Z"
            },
            {
              "name": "After",
              "type": "string",
              "required": false,
              "description": "小于此时间（结束时间）。 格式按照 ISO 8601标准表示，详见 ISO 日期格式说明。",
              "example": "2020-12-10T07:25:52Z"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值：10。",
          "example": "10"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeKTVSingerCategories",
      "description": "获取直播互动曲库歌手分类信息",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeKTVSingerMusics",
      "description": "根据歌手id，返回该歌手下歌曲列表。",
      "status": "online",
      "parameters": [
        {
          "name": "SingerId",
          "type": "string",
          "required": true,
          "description": "歌手id",
          "example": "无"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量，默认值：0。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "10"
        }
      ],
      "required": [
        "SingerId"
      ]
    },
    {
      "name": "DescribeKTVSingers",
      "description": "根据过滤条件，返回匹配的歌手列表。",
      "status": "online",
      "parameters": [
        {
          "name": "SingerIds",
          "type": "array",
          "required": false,
          "description": "歌手id集合，精确匹配歌手id 数组长度限制10",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "Genders",
          "type": "array",
          "required": false,
          "description": "歌手性别集合，不传为全部，精确匹配歌手性别类型， 数组长度限制1 取值范围：直播互动曲库歌手分类信息接口，返回性别分类信息列表中，分类英文名",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "Areas",
          "type": "array",
          "required": false,
          "description": "歌手区域集合，不传为全部，精确匹配歌手区域 数组长度限制10 取值范围：直播互动曲库歌手分类信息接口，返回的区域分类信息列表中，分类英文名",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序方式。默认按照播放数倒序 Sort.Field 可选 PlayCount。",
          "example": "无",
          "children": [
            {
              "name": "Field",
              "type": "string",
              "required": true,
              "description": "排序字段",
              "example": "无"
            },
            {
              "name": "Order",
              "type": "string",
              "required": true,
              "description": "排序方式，可选值：Asc（升序）、Desc（降序）",
              "example": "Asc"
            }
          ]
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页偏移量，默认值：0。",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "无"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeKTVSuggestions",
      "description": "获取直播互动曲库联想词",
      "status": "online",
      "parameters": [
        {
          "name": "KeyWord",
          "type": "string",
          "required": true,
          "description": "联想关键词",
          "example": "\"\""
        }
      ],
      "required": [
        "KeyWord"
      ]
    },
    {
      "name": "DescribeKTVTopList",
      "description": "获取直播互动曲库歌曲的周榜和月榜",
      "status": "online",
      "parameters": [
        {
          "name": "Type",
          "type": "string",
          "required": false,
          "description": "榜单类型。默认Hot Hot, 热歌榜。",
          "example": "Hot"
        },
        {
          "name": "Period",
          "type": "string",
          "required": false,
          "description": "榜单周期 默认为Week Week, 周榜。 Month, 月榜。",
          "example": "Week"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeLyric",
      "description": "根据接口的模式及歌曲ID来取得歌词信息或者波形图信息。",
      "status": "online",
      "parameters": [
        {
          "name": "ItemId",
          "type": "string",
          "required": true,
          "description": "歌曲ID",
          "example": "xxxxx"
        },
        {
          "name": "SubItemType",
          "type": "string",
          "required": false,
          "description": "格式，可选项，可不填写，默认值为：LRC-LRC。 LRC-LRC：歌词； JSON-ST：波形图。",
          "example": "LRC-LRC"
        }
      ],
      "required": [
        "ItemId"
      ]
    },
    {
      "name": "DescribeMusic",
      "description": "获取曲库包歌曲播放信息接口",
      "status": "online",
      "parameters": [
        {
          "name": "ItemId",
          "type": "string",
          "required": true,
          "description": "歌曲ID",
          "example": "xxxx"
        },
        {
          "name": "IdentityId",
          "type": "string",
          "required": true,
          "description": "在应用前端播放音乐C端用户的唯一标识。无需是账户信息，用户唯一标识即可。",
          "example": "xx"
        },
        {
          "name": "SubItemType",
          "type": "string",
          "required": false,
          "description": "MP3-320K-FTD-P 为获取320kbps歌曲热门片段。 MP3-320K-FTD 为获取320kbps已核验歌曲完整资源。",
          "example": "MP3-64K-FTD-P"
        },
        {
          "name": "Ssl",
          "type": "string",
          "required": false,
          "description": "CDN URL Protocol:HTTP or HTTPS/SSL Values:Y , N(default)",
          "example": "无"
        }
      ],
      "required": [
        "ItemId",
        "IdentityId"
      ]
    },
    {
      "name": "DescribeMusicSaleStatus",
      "description": "根据音乐信息查询音乐是否在售",
      "status": "online",
      "parameters": [
        {
          "name": "MusicIds",
          "type": "array",
          "required": true,
          "description": "歌曲Id集合，可传单个，也可传多个，上线查询单次50个",
          "example": "无",
          "item_type": "string"
        },
        {
          "name": "PurchaseType",
          "type": "integer",
          "required": true,
          "description": "查询哪个渠道的数据，1为曲库包，2为单曲",
          "example": "1"
        }
      ],
      "required": [
        "MusicIds",
        "PurchaseType"
      ]
    },
    {
      "name": "DescribePackageItems",
      "description": "获取曲库包下已核销歌曲列表接口",
      "status": "online",
      "parameters": [
        {
          "name": "OrderId",
          "type": "string",
          "required": true,
          "description": "订单id，从获取已购曲库包列表中获取"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "默认0，Offset=Offset+Length"
        },
        {
          "name": "Length",
          "type": "integer",
          "required": false,
          "description": "默认20"
        }
      ],
      "required": [
        "OrderId"
      ]
    },
    {
      "name": "DescribePackages",
      "description": "获取已购曲库包列表接口",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "默认0，Offset=Offset+Length"
        },
        {
          "name": "Length",
          "type": "integer",
          "required": false,
          "description": "默认20"
        }
      ],
      "required": []
    },
    {
      "name": "DescribePkgOfflineMusic",
      "description": "根据购买曲库包用户可查询已回退的歌曲信息",
      "status": "online",
      "parameters": [
        {
          "name": "PackageOrderId",
          "type": "string",
          "required": true,
          "description": "订单id",
          "example": "无"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条(注：单次上限为100)。",
          "example": "无"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "无"
        }
      ],
      "required": [
        "PackageOrderId"
      ]
    },
    {
      "name": "DescribeStations",
      "description": "该服务后续会停用，不再建议使用",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "条数，必须大于0"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "offset (Default = 0)，Offset=Offset+Limit"
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "DestroyKTVRobot",
      "description": "销毁机器人，机器人退出 RTC 房间。",
      "status": "online",
      "parameters": [
        {
          "name": "RobotId",
          "type": "string",
          "required": true,
          "description": "机器人Id。",
          "example": "ame-xxxxx"
        }
      ],
      "required": [
        "RobotId"
      ]
    },
    {
      "name": "ModifyMusicOnShelves",
      "description": "根据资源方，需要变更的参数，请求该接口进行变更，为空的参数默认为无变更",
      "status": "online",
      "parameters": [
        {
          "name": "MusicDetailInfos",
          "type": "object",
          "required": true,
          "description": "歌曲变更信息",
          "example": "无",
          "children": [
            {
              "name": "MusicId",
              "type": "string",
              "required": true,
              "description": "资源方音乐Id",
              "example": "无"
            },
            {
              "name": "AmeId",
              "type": "string",
              "required": true,
              "description": "资源方识别信息",
              "example": "TME"
            },
            {
              "name": "Tags",
              "type": "array",
              "required": false,
              "description": "分类标签",
              "example": "[\"伴奏\"]",
              "item_type": "string"
            },
            {
              "name": "HitWords",
              "type": "array",
              "required": false,
              "description": "关键词",
              "example": "[\"\"]",
              "item_type": "string"
            },
            {
              "name": "Bpm",
              "type": "integer",
              "required": false,
              "description": "节奏信息",
              "example": "0"
            },
            {
              "name": "Score",
              "type": "float",
              "required": false,
              "description": "商业化权益",
              "example": "5.67"
            },
            {
              "name": "Scene",
              "type": "array",
              "required": false,
              "description": "应用歌曲信息,1.图文/短视频,2.网络直播,3.网络电台FM,4.免费游戏,5.商业游戏,6.网店网站设计,7.广告营销,8.网络长视频",
              "example": "[\"1\"]",
              "item_type": "string"
            },
            {
              "name": "Region",
              "type": "array",
              "required": false,
              "description": "应用地域,1. 中国大陆,2. 中国含港澳台,3. 全球",
              "example": "[\"1\"]",
              "item_type": "string"
            },
            {
              "name": "AuthPeriod",
              "type": "string",
              "required": false,
              "description": "授权时间,1. 1年, 5. 随片永久",
              "example": "\"1\""
            },
            {
              "name": "Commercialization",
              "type": "string",
              "required": false,
              "description": "商业化授权，1. 支持商业化 ,2. 不支持商业化",
              "example": "\"1\""
            },
            {
              "name": "Platform",
              "type": "string",
              "required": false,
              "description": "跨平台传播，1. 支持跨平台传播 ,2. 不支持跨平台传播",
              "example": "\"1\""
            },
            {
              "name": "Channel",
              "type": "string",
              "required": false,
              "description": "传播渠道",
              "example": "\"1\""
            }
          ]
        },
        {
          "name": "AmeKey",
          "type": "string",
          "required": false,
          "description": "ame对接资源方密钥",
          "example": "无"
        }
      ],
      "required": [
        "MusicDetailInfos"
      ]
    },
    {
      "name": "PutMusicOnTheShelves",
      "description": "根据资源方所传歌曲信息，进行歌曲上架，多个歌曲同时请求时，需构造复合结构进行请求",
      "status": "online",
      "parameters": [
        {
          "name": "MusicIds",
          "type": "array",
          "required": true,
          "description": "资源方歌曲Id",
          "example": "无",
          "item_type": "string"
        }
      ],
      "required": [
        "MusicIds"
      ]
    },
    {
      "name": "ReportData",
      "description": "客户上报用户数据功能，为了更好地为用户提供优质服务",
      "status": "online",
      "parameters": [
        {
          "name": "ReportData",
          "type": "string",
          "required": true,
          "description": "上报数据 注:reportData为客户端压缩后的上报数据进行16进制转换的字符串数据 压缩说明： a) 上报的json格式字符串通过流的转换（ByteArrayInputStream, java.util.zip.GZIPOutputStream），获取到压缩后的字节数组。 b) 将压缩后的字节数组转成16进制字符串。 reportData由两部分数据组成： 1）report_type（上报类型） 2）data（歌曲上报数据） 不同的report_type对应的data数据结构不一样。 详细说明请...",
          "example": "1f8b08000000000000007xxxxxxx"
        }
      ],
      "required": [
        "ReportData"
      ]
    },
    {
      "name": "SearchKTVMusics",
      "description": "根据搜索条件，返回匹配的歌曲列表。",
      "status": "online",
      "parameters": [
        {
          "name": "KeyWord",
          "type": "string",
          "required": true,
          "description": "搜索关键词",
          "example": "\"\""
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。 取值范围：Offset + Limit 不超过5000。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "分页返回的起始偏移量，默认值：50。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "10"
        },
        {
          "name": "Sort",
          "type": "object",
          "required": false,
          "description": "排序方式。默认按照匹配度排序 Sort.Field 可选 CreateTime Sort.Order 可选 Desc 当 KeyWord 不为空时，Sort.Field 字段无效， 搜索结果将以匹配度排序。",
          "example": "\"\"",
          "children": [
            {
              "name": "Field",
              "type": "string",
              "required": true,
              "description": "排序字段",
              "example": "无"
            },
            {
              "name": "Order",
              "type": "string",
              "required": true,
              "description": "排序方式，可选值：Asc（升序）、Desc（降序）",
              "example": "Asc"
            }
          ]
        },
        {
          "name": "TagIds",
          "type": "array",
          "required": false,
          "description": "标签 ID 集合，匹配集合指定所有 ID 。 数组长度限制：10。",
          "example": "\"\"",
          "item_type": "string"
        }
      ],
      "required": [
        "KeyWord",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "SyncKTVRobotCommand",
      "description": "下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。",
      "status": "online",
      "parameters": [
        {
          "name": "RobotId",
          "type": "string",
          "required": true,
          "description": "机器人Id。",
          "example": "ame-xxxxx"
        },
        {
          "name": "Command",
          "type": "string",
          "required": true,
          "description": "指令，取值有： Play：播放 Pause：暂停 SwitchPrevious：上一首 SwitchNext：下一首 SetPlayMode：设置播放模式 Seek：调整播放进度 SetPlaylist：歌单变更 SetAudioParam：音频参数变更 SendMessage：发送自定义消息 SetDestroyMode：设置销毁模式 SetVolume：设置音量（已废弃，请采用 SetRealVolume） SetRealVolume：设置真实音量",
          "example": "Play"
        },
        {
          "name": "PlayCommandInput",
          "type": "object",
          "required": false,
          "description": "播放参数。",
          "example": "无",
          "children": [
            {
              "name": "Index",
              "type": "integer",
              "required": true,
              "description": "歌曲位置索引。",
              "example": "2"
            }
          ]
        },
        {
          "name": "SetPlaylistCommandInput",
          "type": "object",
          "required": false,
          "description": "播放列表变更信息，当Command取SetPlaylist时，必填。",
          "example": "无",
          "children": [
            {
              "name": "Type",
              "type": "string",
              "required": true,
              "description": "变更类型，取值有： Add：添加 Delete：删除 ClearList：清空歌曲列表 Move：移动歌曲",
              "example": "Add"
            },
            {
              "name": "Index",
              "type": "integer",
              "required": false,
              "description": "歌单索引位置， 当 Type 取 Add 时，-1表示添加在列表最后位置，大于-1表示要添加的位置； 当 Type 取 Delete 时，表示待删除歌曲的位置； 当 Type 取 Move 时，表示待调整歌曲的位置。",
              "example": "1"
            },
            {
              "name": "ChangedIndex",
              "type": "integer",
              "required": false,
              "description": "当 Type 取 Move 时，必填，表示移动歌曲的目标位置。",
              "example": "2"
            },
            {
              "name": "MusicIds",
              "type": "array",
              "required": false,
              "description": "歌曲 ID 列表，当 Type 取 Add 时，与MusicURLs必填其中一项。",
              "example": "xxxxxx",
              "item_type": "string"
            },
            {
              "name": "MusicURLs",
              "type": "array",
              "required": false,
              "description": "歌曲 URL 列表，当 Type 取 Add 时，与MusicIds必填其中一项。 注：URL必须以.mp3结尾且必须是mp3编码文件。",
              "example": "http://demo.mp3",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "SeekCommandInput",
          "type": "object",
          "required": false,
          "description": "播放进度，当Command取Seek时，必填。",
          "example": "无",
          "children": [
            {
              "name": "Position",
              "type": "integer",
              "required": true,
              "description": "播放位置，单位：毫秒。",
              "example": "120"
            }
          ]
        },
        {
          "name": "SetAudioParamCommandInput",
          "type": "object",
          "required": false,
          "description": "音频参数，当Command取SetAudioParam时，必填。",
          "example": "无",
          "children": [
            {
              "name": "Definition",
              "type": "string",
              "required": false,
              "description": "规格，取值有： audio/mi：低规格 audio/lo：中规格 audio/hi：高规格",
              "example": "audio/hi"
            },
            {
              "name": "Type",
              "type": "string",
              "required": false,
              "description": "音频类型，取值有： Original：原唱 Accompaniment：伴奏",
              "example": "Original"
            }
          ]
        },
        {
          "name": "SendMessageCommandInput",
          "type": "object",
          "required": false,
          "description": "自定义消息，当Command取SendMessage时，必填。",
          "example": "无",
          "children": [
            {
              "name": "Message",
              "type": "string",
              "required": true,
              "description": "自定义消息，json格式字符串。",
              "example": "{\"field\":\"value\"}"
            },
            {
              "name": "Repeat",
              "type": "integer",
              "required": false,
              "description": "消息重复次数，默认为 1。",
              "example": "2"
            }
          ]
        },
        {
          "name": "SetPlayModeCommandInput",
          "type": "object",
          "required": false,
          "description": "播放模式，当Command取SetPlayMode时，必填。",
          "example": "无",
          "children": [
            {
              "name": "PlayMode",
              "type": "string",
              "required": true,
              "description": "播放模式，取值有： RepeatPlaylist：列表循环 Order：顺序播放 RepeatSingle：单曲循环 Shuffle：随机播放",
              "example": "RepeatPlaylist"
            }
          ]
        },
        {
          "name": "SetDestroyModeCommandInput",
          "type": "object",
          "required": false,
          "description": "销毁模式，当Command取SetDestroyMode时，必填。",
          "example": "无",
          "children": [
            {
              "name": "DestroyMode",
              "type": "string",
              "required": true,
              "description": "销毁模式，取值有： Auto：房间没人时自动销毁 Expire：房间没人时过期自动销毁 Never：不自动销毁，需手动销毁默认为：Auto。",
              "example": "Auto"
            },
            {
              "name": "DestroyExpireTime",
              "type": "integer",
              "required": false,
              "description": "过期销毁时间，单位：秒，当DestroyMode取Expire时必填。",
              "example": "120"
            }
          ]
        },
        {
          "name": "SetVolumeCommandInput",
          "type": "object",
          "required": false,
          "description": "音量，当Command取SetVolume时，必填。 （已废弃，请采用 SetRealVolumeCommandInput ）",
          "example": "无",
          "children": [
            {
              "name": "Volume",
              "type": "integer",
              "required": true,
              "description": "音量大小，取值范围为 0~100，默认值为 50。",
              "example": "50"
            }
          ]
        },
        {
          "name": "SetRealVolumeCommandInput",
          "type": "object",
          "required": false,
          "description": "真实音量，当Command取SetRealVolume时，必填。",
          "example": "无",
          "children": [
            {
              "name": "RealVolume",
              "type": "integer",
              "required": true,
              "description": "真实音量大小，取值范围为 0~100，默认值为 50。",
              "example": "50"
            }
          ]
        }
      ],
      "required": [
        "RobotId",
        "Command"
      ]
    },
    {
      "name": "TakeMusicOffShelves",
      "description": "根据资源方所传MusicId进行将歌曲进行下架，多个MusicId使用逗号隔开",
      "status": "online",
      "parameters": [
        {
          "name": "TakeMusicOffShelves",
          "type": "array",
          "required": true,
          "description": "资源方下架必传结构",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "MusicIds",
              "type": "string",
              "required": true,
              "description": "资源方对应音乐Id",
              "example": "无"
            },
            {
              "name": "SaleStatus",
              "type": "string",
              "required": true,
              "description": "当曲目临时下架时：已订购客户无影响，无需消息通知。当曲目封杀下架后，推送消息至已订购老客户，枚举值，判断是否上/下架 在售状态，0在售，1临时下架，2永久下架",
              "example": "1"
            }
          ]
        }
      ],
      "required": [
        "TakeMusicOffShelves"
      ]
    }
  ]
}