API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 音速达直播音乐版权引擎 > 机器人相关接口 > 获取机器人信息

获取机器人信息

最近更新时间：2024-03-12 02:08:03

我的收藏

本页目录：

1. 接口描述

接口请求域名： yinsuda.tencentcloudapi.com 。

获取机器人列表，支持 Id、状态等过滤条件。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeKTVRobots。
Version 是 String 公共参数，本接口取值：2022-05-27。
Region 否 String 公共参数，本接口不需要传递此参数。
AppName 是 String 应用名称。
示例值：ktv
UserId 是 String 用户标识。
示例值：10001
RobotIds.N 否 Array of String 机器人Id列表。
Statuses.N 否 Array of String 机器人状态，取值有：
  • Play：播放
  • Pause：暂停
  • Destroy：销毁
    		•
    CreateTime 否 TimeRange 匹配创建时间在此时间段内的机器人。
  • 包含所指定的头尾时间点。
    		•
    Offset 否 Integer 分页返回的起始偏移量，默认值：0。将返回第 Offset 到第 Offset+Limit-1 条。
    示例值：0
    Limit 否 Integer 分页返回的起始偏移量，默认值：10。
    示例值：10

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 机器人总数。
    示例值：100
    KTVRobotInfoSet Array of KTVRobotInfo 机器人信息集合。
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询机器人信息

    输入示例

    POST / HTTP/1.1
Host: yinsuda.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeKTVRobots
<公共请求参数>

{
    "AppName": "ktv",
    "UserId": "10001",
    "RobotIds": [
        "ame-xxxxx1"
    ],
    "Statuses": [
        "Play"
    ],
    "CreateTime": {
        "After": "2022-01-10T07:25:52Z",
        "Before": "2022-01-11T07:25:52Z"
    }
}

    输出示例

    {
    "Response": {
        "TotalCount": 1,
        "KTVRobotInfoSet": [
            {
                "RobotId": "ame-xxxxx1",
                "Status": "Play",
                "Playlists": [
                    "xxxx1",
                    "xxxx2",
                    "xxxx3",
                    "xxxx4"
                ],
                "CurIndex": 2,
                "Position": 120,
                "RTCSystem": "TRTC",
                "JoinRoomInput": {
                    "TRTCJoinRoomInput": {
                        "Sign": "xxxxxxxxxxx",
                        "RoomId": "12345",
                        "SdkAppId": "140000001",
                        "UserId": "tom"
                    }
                },
                "SetAudioParamInput": {
                    "Type": "Original"
                },
                "SetPlayModeInput": {
                    "PlayMode": "Order"
                }
            }
        ],
        "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。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    AuthFailure CAM签名/鉴权错误。
    FailedOperation 操作失败。
    InternalError 内部错误。
    InvalidParameter 参数错误。
    InvalidParameterValue 参数取值错误。
    ResourceNotFound 资源不存在。
    ResourceUnavailable 资源不可用。
    中国站