{
  "name": "yinsuda",
  "display_name": "音速达直播音乐版权引擎",
  "description": "音速达直播音乐版权引擎服务基于是基于腾讯音乐娱乐集团（TME）海量线上直播音乐版权资源，结合腾讯云存储、内容加速分发等基础能力，搭配演唱评分、声音美化等智能音乐功能，为解决直播语聊场景中的正版音乐应用设计的 PaaS 产品。您可以前往API概览了解详情。",
  "domain": "other",
  "api_version": "2022-05-27",
  "endpoint": "yinsuda.tencentcloudapi.com",
  "actions": [
    {
      "name": "ApplyChorus",
      "description": "申请合唱相关信息，用于标记用户的演唱是在合唱场景下。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "超酷音乐盒"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "ua21nf932"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "房间号。",
          "example": "93ncds8r"
        },
        {
          "name": "MusicId",
          "type": "string",
          "required": true,
          "description": "歌曲 Id。",
          "example": "912ncsuu412"
        },
        {
          "name": "MaxChorusNum",
          "type": "integer",
          "required": false,
          "description": "最大合唱人数，默认值为 8，最大值为 20。",
          "example": "8"
        },
        {
          "name": "ChorusUserIds",
          "type": "array",
          "required": false,
          "description": "合唱用户标识列表。",
          "example": "[\"02hfw83ef\",\"307023hsdi\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "RoomId",
        "MusicId"
      ]
    },
    {
      "name": "BatchDescribeKTVMusicDetails",
      "description": "批量获取歌曲详细信息，包括：歌词下载链接、播放凭证、音高数据下载链接信息等。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "7jd457rjz2"
        },
        {
          "name": "MusicIds",
          "type": "array",
          "required": true,
          "description": "歌曲 Id 列表。",
          "example": "[\"ttxvqa4buy\",\"c2ez447xpd\"]",
          "item_type": "string"
        },
        {
          "name": "PlayScene",
          "type": "string",
          "required": false,
          "description": "播放场景。默认为Chat Live：直播Chat：语聊",
          "example": "Chat"
        },
        {
          "name": "GuestUserId",
          "type": "string",
          "required": false,
          "description": "玩家用户标识",
          "example": "d2w7m6t9z8"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": false,
          "description": "房间Id",
          "example": "29ds5emhuf"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "MusicIds"
      ]
    },
    {
      "name": "CreateKTVRobot",
      "description": "创建机器人，支持进入 RTC 房间，播放曲库歌曲。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "ktv"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "10001"
        },
        {
          "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": true,
              "description": "TRTC进房参数",
              "example": "{\"Sign\": \"我是孤独的鹰\",\"RoomId\": \"1234\",\"SdkAppId\": \"140000001\",\"UserId\": \"tom\",\"RoomIdType\": \"Integer\"}",
              "children": [
                {
                  "name": "Sign",
                  "type": "string",
                  "required": true,
                  "description": "签名。",
                  "example": "我是孤独的鹰"
                },
                {
                  "name": "RoomId",
                  "type": "string",
                  "required": true,
                  "description": "房间号。",
                  "example": "1234"
                },
                {
                  "name": "SdkAppId",
                  "type": "string",
                  "required": true,
                  "description": "推流应用ID。",
                  "example": "140000001"
                },
                {
                  "name": "UserId",
                  "type": "string",
                  "required": true,
                  "description": "用户唯一标识。",
                  "example": "tom"
                },
                {
                  "name": "RoomIdType",
                  "type": "string",
                  "required": false,
                  "description": "TRTC房间号的类型： Integer：数字类型 String：字符串类型 默认为：Integer 。 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "Integer"
                }
              ]
            }
          ]
        },
        {
          "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：设置销毁模式",
              "example": "Play"
            },
            {
              "name": "PlayCommandInput",
              "type": "object",
              "required": false,
              "description": "播放参数。",
              "example": "{\"Index\": 2}",
              "children": [
                {
                  "name": "Index",
                  "type": "integer",
                  "required": true,
                  "description": "歌曲位置索引。",
                  "example": "2"
                }
              ]
            },
            {
              "name": "SetPlaylistCommandInput",
              "type": "object",
              "required": false,
              "description": "播放列表变更信息，当Command取SetPlaylist时，必填。",
              "example": "{\"Type\": \"Add\",\"Index\": 1,\"ChangedIndex\": 2,\"MusicIds\": [\"d2w7m6t9z8\",\"vvws7nzzxg\"]}",
              "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 时，必填。",
                  "example": "[\"d2w7m6t9z8\",\"vvws7nzzxg\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "SeekCommandInput",
              "type": "object",
              "required": false,
              "description": "播放进度，当Command取Seek时，必填。",
              "example": "{\"Position\": 120}",
              "children": [
                {
                  "name": "Position",
                  "type": "integer",
                  "required": true,
                  "description": "播放位置，单位：毫秒。",
                  "example": "120"
                }
              ]
            },
            {
              "name": "SetAudioParamCommandInput",
              "type": "object",
              "required": false,
              "description": "音频参数，当Command取SetAudioParam时，必填。",
              "example": "{\"Definition\": \"audio/hi,\"Type\": \"Original\"}",
              "children": [
                {
                  "name": "Type",
                  "type": "string",
                  "required": false,
                  "description": "音频类型，取值有： Original：原唱 Accompaniment：伴奏 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "Original"
                }
              ]
            },
            {
              "name": "SendMessageCommandInput",
              "type": "object",
              "required": false,
              "description": "自定义消息，当Command取SendMessage时，必填。",
              "example": "{\"Message\": {\"field\": \"value\"},\"Repeat\": 2}",
              "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": "{\"PlayMode\": \"RepeatPlaylist\"}",
              "children": [
                {
                  "name": "PlayMode",
                  "type": "string",
                  "required": true,
                  "description": "播放模式，取值有： RepeatPlaylist：列表循环 Order：顺序播放 RepeatSingle：单曲循环 Shuffle：随机播放 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "RepeatPlaylist"
                }
              ]
            },
            {
              "name": "SetDestroyModeCommandInput",
              "type": "object",
              "required": false,
              "description": "销毁模式，当Command取SetDestroyMode时，必填。",
              "example": "{\"DestroyMode\": \"Auto\",\"DestroyExpireTime\": 120}",
              "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"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "RTCSystem",
        "JoinRoomInput"
      ]
    },
    {
      "name": "DescribeKTVMatchMusics",
      "description": "根据输入的规则匹配曲库中的歌曲。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "超酷音乐盒子"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "2a7ivdfh4u"
        },
        {
          "name": "Rules",
          "type": "array",
          "required": true,
          "description": "匹配规则列表。",
          "example": "[{\"AMEMusicId\": \"bmp7a8yut5\",\"MusicInfo\": {\"MusicName\": \"反方向的钟\",\"SingerSet\": [\"周杰伦\",\"陈奕迅\"]},\"MusicIdToMatchAME\": \"hr9nqvkz46\"}]",
          "item_type": "object",
          "children": [
            {
              "name": "AMEMusicId",
              "type": "string",
              "required": false,
              "description": "AME 曲库 Id。",
              "example": "bmp7a8yut5"
            },
            {
              "name": "MusicInfo",
              "type": "object",
              "required": false,
              "description": "歌曲匹配信息。 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "{\"MusicName\": \"反方向的钟\",\"SingerSet\": [\"周杰伦\",\"陈奕迅\"]}",
              "children": [
                {
                  "name": "MusicName",
                  "type": "string",
                  "required": true,
                  "description": "歌曲名称。",
                  "example": "反方向的钟"
                },
                {
                  "name": "SingerSet",
                  "type": "array",
                  "required": true,
                  "description": "歌手列表。",
                  "example": "[\"周杰伦\",\"陈奕迅\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "MusicIdToMatchAME",
              "type": "string",
              "required": false,
              "description": "音速达歌曲 Id，用于匹配 AME 曲库歌曲。",
              "example": "hr9nqvkz46"
            }
          ]
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "Rules"
      ]
    },
    {
      "name": "DescribeKTVMusicAccompanySegmentUrl",
      "description": "获取歌曲伴奏片段链接，可用于抢唱",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "test"
        },
        {
          "name": "MusicId",
          "type": "string",
          "required": true,
          "description": "歌曲 Id 。",
          "example": "mid-test"
        },
        {
          "name": "PlayScene",
          "type": "string",
          "required": false,
          "description": "播放场景。默认为Chat Live：直播Chat：语聊",
          "example": "Chat"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": false,
          "description": "房间Id",
          "example": "4324556"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "MusicId"
      ]
    },
    {
      "name": "DescribeKTVMusicAccompanySegmentUrlVip",
      "description": "获取歌曲伴奏高潮的开始、结束时间，可用于抢唱",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识",
          "example": "bmp7a8yut5"
        },
        {
          "name": "MusicId",
          "type": "string",
          "required": true,
          "description": "歌曲 Id",
          "example": "jcrnwqzdp3"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": false,
          "description": "房间Id",
          "example": "sgqufpd75i"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "MusicId"
      ]
    },
    {
      "name": "DescribeKTVMusicsByTag",
      "description": "通过标签过滤歌曲列表。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "d2w7m6t9z8"
        },
        {
          "name": "TagId",
          "type": "string",
          "required": true,
          "description": "标签 Id。",
          "example": "vvws7nzzxg"
        },
        {
          "name": "ScrollToken",
          "type": "string",
          "required": false,
          "description": "滚动标记。",
          "example": "vyg79z45nz"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回条数限制，默认 20，最大 50。",
          "example": "20"
        },
        {
          "name": "RightFilters",
          "type": "array",
          "required": false,
          "description": "权益过滤，取值有： Play：可播； Sing：可唱。",
          "example": "[\"Play\"]",
          "item_type": "string"
        },
        {
          "name": "MaterialFilters",
          "type": "array",
          "required": false,
          "description": "物料过滤，取值有： Lyrics：含有歌词； Midi：含有音高线。",
          "example": "[\"Lyrics\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "TagId"
      ]
    },
    {
      "name": "DescribeKTVPlaylistDetail",
      "description": "根据歌单 Id 获取歌单详情。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "超酷音乐盒"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "wig792a58y"
        },
        {
          "name": "PlaylistId",
          "type": "string",
          "required": true,
          "description": "歌单 Id。",
          "example": "xxv252gtn5"
        },
        {
          "name": "ScrollToken",
          "type": "string",
          "required": false,
          "description": "滚动标记。",
          "example": "vbcekmwwy8"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回条数，默认：20，最大：50。",
          "example": "20"
        },
        {
          "name": "RightFilters",
          "type": "array",
          "required": false,
          "description": "权益过滤，取值有： Play：可播； Sing：可唱。",
          "example": "[\"Play\"]",
          "item_type": "string"
        },
        {
          "name": "PlayScene",
          "type": "string",
          "required": false,
          "description": "播放场景。默认为Chat Live：直播Chat：语聊",
          "example": "Chat"
        },
        {
          "name": "MaterialFilters",
          "type": "array",
          "required": false,
          "description": "物料过滤，取值有： Lyrics：含有歌词； Midi：含有音高线。",
          "example": "[\"Lyrics\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "PlaylistId"
      ]
    },
    {
      "name": "DescribeKTVPlaylists",
      "description": "获取歌单列表。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "超酷音乐盒"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "nkwmazaqmd"
        },
        {
          "name": "Types",
          "type": "array",
          "required": false,
          "description": "类型列表，取值有： OfficialRec：官方推荐； Customize：自定义。 默认值为 OfficialRec。",
          "example": "[\"OfficialRec\"]",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值：20，最大值：50。",
          "example": "20"
        }
      ],
      "required": [
        "AppName",
        "UserId"
      ]
    },
    {
      "name": "DescribeKTVRobots",
      "description": "获取机器人列表，支持 Id、状态等过滤条件。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "10001"
        },
        {
          "name": "RobotIds",
          "type": "array",
          "required": false,
          "description": "机器人Id列表。",
          "example": "[\"d2w7m6t9z8\"]",
          "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": "{\"Before\": \"2020-12-10T07:25:52Z\",\"After\": \"2020-12-10T07:25:52Z\"}",
          "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": [
        "AppName",
        "UserId"
      ]
    },
    {
      "name": "DescribeKTVSuggestions",
      "description": "根据关键词获取联想词列表。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "无"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "无"
        },
        {
          "name": "KeyWord",
          "type": "string",
          "required": true,
          "description": "搜索词。",
          "example": "无"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "KeyWord"
      ]
    },
    {
      "name": "DescribeKTVTags",
      "description": "获取标签分组及分组下的标签列表信息。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "d2w7m6t9z8"
        }
      ],
      "required": [
        "AppName",
        "UserId"
      ]
    },
    {
      "name": "DescribeLiveVipTradeInfos",
      "description": "批量获取直播会员充值流水详细信息，包括：流水号，订单状态，下订单时间等",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "StartTime",
          "type": "string",
          "required": false,
          "description": "直播会员充值下单起始时间，格式为 ISO。默认为当前时间前一天。",
          "example": "2022-06-06T18:29:33Z"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": false,
          "description": "直播会员充值下单截止时间，格式为 ISO。默认为当前时间。 EndTime不能小于StartTime",
          "example": "2022-07-06T18:29:33Z\t"
        },
        {
          "name": "TradeSerialNos",
          "type": "array",
          "required": false,
          "description": "交易流水号集合，匹配集合指定所有流水号 。 数组长度限制：10。",
          "example": "[\"ymccjurfpz\",\"aseycksjxh\"]",
          "item_type": "string"
        },
        {
          "name": "UserIds",
          "type": "array",
          "required": false,
          "description": "用户标识集合，匹配集合指定所有用户标识 。 数组长度限制：10。",
          "example": "[\"pgg5cibqa6\",\"gq2nj5kymz\"]",
          "item_type": "string"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页返回的记录条数，默认值：20，最大值：50。",
          "example": "20"
        }
      ],
      "required": [
        "AppName"
      ]
    },
    {
      "name": "DescribeUserInfo",
      "description": "获取用户信息，包括是否为直播会员，及直播会员信息等",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "d2w7m6t9z8"
        }
      ],
      "required": [
        "AppName",
        "UserId"
      ]
    },
    {
      "name": "DescribeVipUserInfo",
      "description": "获取会员信息：获取用户是否开通会员",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "test"
        }
      ],
      "required": [
        "AppName",
        "UserId"
      ]
    },
    {
      "name": "DestroyKTVRobot",
      "description": "销毁机器人，机器人退出 RTC 房间。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "ktv"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "10001"
        },
        {
          "name": "RobotId",
          "type": "string",
          "required": true,
          "description": "机器人Id。",
          "example": "xxxxxx"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "RobotId"
      ]
    },
    {
      "name": "RechargeLiveVip",
      "description": "充值直播会员，使该用户可以在直播场景使用",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "d2w7m6t9z8"
        },
        {
          "name": "TradeSerialNo",
          "type": "string",
          "required": true,
          "description": "交易流水号，用于标记此次充值记录，多次充值记录传入相同的 TradeSerialNo 会判断为失败，可用于防止重提提交造成重复计费。",
          "example": "vvws7nzzxg"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "房间标识。",
          "example": "vyg79z45nz"
        },
        {
          "name": "VipDays",
          "type": "integer",
          "required": true,
          "description": "充值会员天数。 取值有： 31 93 186 372",
          "example": "60"
        },
        {
          "name": "GiveType",
          "type": "string",
          "required": false,
          "description": "充值分类。取值有：room_card-包月房卡; 其他-保留。",
          "example": "room_card-包月房卡"
        },
        {
          "name": "PlayScene",
          "type": "string",
          "required": false,
          "description": "播放场景。默认为Live Live：直播Chat：语聊",
          "example": "Live"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "TradeSerialNo",
        "RoomId",
        "VipDays"
      ]
    },
    {
      "name": "RechargeVip",
      "description": "充值会员",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "test"
        },
        {
          "name": "RoomId",
          "type": "string",
          "required": true,
          "description": "房间Id。",
          "example": "23431"
        },
        {
          "name": "VipDays",
          "type": "integer",
          "required": true,
          "description": "充值会员天数。(取值有：31、93、186、372)",
          "example": "31"
        },
        {
          "name": "AnchorId",
          "type": "string",
          "required": true,
          "description": "主播id。",
          "example": "78976"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "RoomId",
        "VipDays",
        "AnchorId"
      ]
    },
    {
      "name": "SearchKTVMusics",
      "description": "根据关键词搜索歌曲，返回相关歌曲列表。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "app-test"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "d2w7m6t9z8"
        },
        {
          "name": "KeyWord",
          "type": "string",
          "required": true,
          "description": "关键词。",
          "example": "伤感"
        },
        {
          "name": "ScrollToken",
          "type": "string",
          "required": false,
          "description": "滚动标记。",
          "example": "vvws7nzzxg"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "返回条数限制，默认 20，最大 50.",
          "example": "20"
        },
        {
          "name": "RightFilters",
          "type": "array",
          "required": false,
          "description": "权益过滤，取值有： Play：可播； Sing：可唱。",
          "example": "[\"Play\"]",
          "item_type": "string"
        },
        {
          "name": "PlayScene",
          "type": "string",
          "required": false,
          "description": "播放场景。默认为Chat Live：直播Chat：语聊",
          "example": "Chat"
        },
        {
          "name": "MaterialFilters",
          "type": "array",
          "required": false,
          "description": "物料过滤，取值有： Lyrics：含有歌词； Midi：含有音高线。",
          "example": "[\"Lyrics\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "KeyWord"
      ]
    },
    {
      "name": "SyncKTVRobotCommand",
      "description": "下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。",
      "status": "online",
      "parameters": [
        {
          "name": "AppName",
          "type": "string",
          "required": true,
          "description": "应用名称。",
          "example": "ktv"
        },
        {
          "name": "UserId",
          "type": "string",
          "required": true,
          "description": "用户标识。",
          "example": "100001"
        },
        {
          "name": "RobotId",
          "type": "string",
          "required": true,
          "description": "机器人Id。",
          "example": "xxxxx"
        },
        {
          "name": "SyncRobotCommands",
          "type": "array",
          "required": true,
          "description": "指令及指令参数数组。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Command",
              "type": "string",
              "required": true,
              "description": "可同时传入多个指令，顺序执行。取值有： Play：播放 Pause：暂停 SwitchPrevious：上一首 SwitchNext：下一首 SetPlayMode：设置播放模式 Seek：调整播放进度 SetPlaylist：歌单变更 SetAudioParam：音频参数变更 SendMessage：发送自定义消息 SetDestroyMode：设置销毁模式",
              "example": "Play"
            },
            {
              "name": "PlayCommandInput",
              "type": "object",
              "required": false,
              "description": "播放参数。",
              "example": "{\"Index\": 2}",
              "children": [
                {
                  "name": "Index",
                  "type": "integer",
                  "required": true,
                  "description": "歌曲位置索引。",
                  "example": "2"
                }
              ]
            },
            {
              "name": "SetPlaylistCommandInput",
              "type": "object",
              "required": false,
              "description": "播放列表变更信息，当Command取SetPlaylist时，必填。",
              "example": "{\"Type\": \"Add\",\"Index\": 1,\"ChangedIndex\": 2,\"MusicIds\": [\"d2w7m6t9z8\",\"vvws7nzzxg\"]}",
              "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 时，必填。",
                  "example": "[\"d2w7m6t9z8\",\"vvws7nzzxg\"]",
                  "item_type": "string"
                }
              ]
            },
            {
              "name": "SeekCommandInput",
              "type": "object",
              "required": false,
              "description": "播放进度，当Command取Seek时，必填。",
              "example": "{\"Position\": 120}",
              "children": [
                {
                  "name": "Position",
                  "type": "integer",
                  "required": true,
                  "description": "播放位置，单位：毫秒。",
                  "example": "120"
                }
              ]
            },
            {
              "name": "SetAudioParamCommandInput",
              "type": "object",
              "required": false,
              "description": "音频参数，当Command取SetAudioParam时，必填。",
              "example": "{\"Definition\": \"audio/hi,\"Type\": \"Original\"}",
              "children": [
                {
                  "name": "Type",
                  "type": "string",
                  "required": false,
                  "description": "音频类型，取值有： Original：原唱 Accompaniment：伴奏 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "Original"
                }
              ]
            },
            {
              "name": "SendMessageCommandInput",
              "type": "object",
              "required": false,
              "description": "自定义消息，当Command取SendMessage时，必填。",
              "example": "{\"Message\": {\"field\": \"value\"},\"Repeat\": 2}",
              "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": "{\"PlayMode\": \"RepeatPlaylist\"}",
              "children": [
                {
                  "name": "PlayMode",
                  "type": "string",
                  "required": true,
                  "description": "播放模式，取值有： RepeatPlaylist：列表循环 Order：顺序播放 RepeatSingle：单曲循环 Shuffle：随机播放 注意：此字段可能返回 null，表示取不到有效值。",
                  "example": "RepeatPlaylist"
                }
              ]
            },
            {
              "name": "SetDestroyModeCommandInput",
              "type": "object",
              "required": false,
              "description": "销毁模式，当Command取SetDestroyMode时，必填。",
              "example": "{\"DestroyMode\": \"Auto\",\"DestroyExpireTime\": 120}",
              "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"
                }
              ]
            }
          ]
        }
      ],
      "required": [
        "AppName",
        "UserId",
        "RobotId",
        "SyncRobotCommands"
      ]
    }
  ]
}