1. 接口描述
接口请求域名： yinsuda.tencentcloudapi.com 。
下发操作机器人指令，支持播放、暂停、恢复、歌单设置等操作指令，实现对机器人行为的控制。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SyncKTVRobotCommand。 |
| Version | 是 | String | 公共参数，本接口取值：2022-05-27。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| AppName | 是 | String | 应用名称。 示例值：ktv |
| UserId | 是 | String | 用户标识。 示例值：100001 |
| RobotId | 是 | String | 机器人Id。 示例值：xxxxx |
| SyncRobotCommands.N | 是 | Array of SyncRobotCommand | 指令及指令参数数组。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 播放指定音乐
播放第2首歌曲
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncKTVRobotCommand
<公共请求参数>
{
"AppName": "ktv",
"UserId": "10001",
"RobotId": "xxxxx",
"SyncRobotCommands": [
{
"Command": "Play",
"PlayCommandInput": {
"Index": 1
}
}
]
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}示例2 设置播放模式
设置播放模式为随机播放。
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncKTVRobotCommand
<公共请求参数>
{
"AppName": "ktv",
"UserId": "10001",
"RobotId": "xxxxx",
"SyncRobotCommands": [
{
"Command": "SetPlayMode",
"SetPlayModeCommandInput": {
"PlayMode": "Shuffle"
}
}
]
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}示例3 设置销毁模式
设置销毁模式为：房间没人后，2分钟内无人进入自动销毁。
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncKTVRobotCommand
<公共请求参数>
{
"AppName": "ktv",
"UserId": "10001",
"RobotId": "xxxxx",
"SyncRobotCommands": [
{
"Command": "SetDestroyMode",
"SetDestroyModeCommandInput": {
"DestroyMode": "Expire",
"DestroyExpireTime": 120
}
}
]
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}示例4 切换下一首歌曲
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncKTVRobotCommand
<公共请求参数>
{
"AppName": "ktv",
"UserId": "10001",
"RobotId": "xxxxx",
"SyncRobotCommands": [
{
"Command": "SwitchNext"
}
]
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}示例5 发送自定义消息
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncKTVRobotCommand
<公共请求参数>
{
"AppName": "ktv",
"UserId": "10001",
"RobotId": "xxxxx",
"SyncRobotCommands": [
{
"Command": "SendMessage",
"SendMessageCommandInput": {
"Message": "{\"Field1\":\"Value1\"}",
"Repeat": 2
}
}
]
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}示例6 变更歌曲音频参数
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncKTVRobotCommand
<公共请求参数>
{
"AppName": "ktv",
"UserId": "10001",
"RobotId": "xxxxx",
"SyncRobotCommands": [
{
"Command": "SetAudioParam",
"SetAudioParamCommandInput": {
"Type": "Accompaniment"
}
}
]
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}示例7 播放列表添加歌曲并播放
输入示例
POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncKTVRobotCommand
<公共请求参数>
{
"AppName": "ktv",
"UserId": "10001",
"RobotId": "xxxxx",
"SyncRobotCommands": [
{
"Command": "SetPlaylist",
"SetPlaylistCommandInput": {
"Type": "Add",
"MusicIds": [
"xxxxxxx"
],
"Index": -1
}
},
{
"Command": "Play"
}
]
}输出示例
{
"Response": {
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |