{
  "name": "trro",
  "display_name": "实时互动-工业能源版",
  "description": "介绍如何使用API创建项目和设备，并对现场设备和远端设备进行管理，查看设备会话指标数据等",
  "domain": "other",
  "api_version": "2022-03-25",
  "endpoint": "trro.tencentcloudapi.com",
  "actions": [
    {
      "name": "BatchDeleteDevices",
      "description": "用于批量删除设备",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "目标删除设备所属项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "DeviceIds",
          "type": "array",
          "required": true,
          "description": "目标删除设备的设备ID数组",
          "example": "[\"dev1\",\"dev2\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "ProjectId",
        "DeviceIds"
      ]
    },
    {
      "name": "BatchDeletePolicy",
      "description": "用于批量删除修改权限配置",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "删除权限配置的项目ID",
          "example": "f3glr49rc96pralw"
        },
        {
          "name": "RemoteDeviceIds",
          "type": "array",
          "required": true,
          "description": "删除权限配置的远端设备ID列表",
          "example": "[\"test1\",\"test2\"]",
          "item_type": "string"
        },
        {
          "name": "PolicyMode",
          "type": "string",
          "required": true,
          "description": "删除权限配置的权限模式, black为黑名单，white为白名单",
          "example": "black"
        }
      ],
      "required": [
        "ProjectId",
        "RemoteDeviceIds",
        "PolicyMode"
      ]
    },
    {
      "name": "BoundLicenses",
      "description": "为推流设备绑定license，优先绑定到期时间最近的，到期时间相同优先绑定月包",
      "status": "online",
      "parameters": [
        {
          "name": "Count",
          "type": "integer",
          "required": true,
          "description": "license数量",
          "example": "2"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "设备id",
          "example": "\"trro_dev\""
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "\"m82k5408n123phvb\""
        }
      ],
      "required": [
        "Count",
        "DeviceId",
        "ProjectId"
      ]
    },
    {
      "name": "CreateCloudRecording",
      "description": "启动云端录制功能，完成房间内的音视频录制，并上传到指定的云存储。",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目id",
          "example": "m82k5408n123phvb"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "设备id",
          "example": "trro_dev"
        },
        {
          "name": "VideoStreamId",
          "type": "integer",
          "required": true,
          "description": "视频流号",
          "example": "0"
        },
        {
          "name": "CloudStorage",
          "type": "object",
          "required": true,
          "description": "腾讯云对象存储COS以及第三方云存储的账号信息",
          "example": "无",
          "children": [
            {
              "name": "Vendor",
              "type": "integer",
              "required": true,
              "description": "腾讯云对象存储COS以及第三方云存储账号信息 0：腾讯云对象存储 COS 1：AWS 【注意】目前第三方云存储仅支持AWS，更多第三方云存储陆续支持中 示例值：0",
              "example": "0"
            },
            {
              "name": "Region",
              "type": "string",
              "required": true,
              "description": "腾讯云对象存储的[地域信息]（https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F）。 示例值：cn-shanghai-1 AWS S3[地域信息]（https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions） 示例值：ap-shanghai(cos, 具体参考云存储厂商支持的地域)",
              "example": "ap-nanjing"
            },
            {
              "name": "Bucket",
              "type": "string",
              "required": true,
              "description": "云存储桶名称。",
              "example": "recording-1304123456"
            },
            {
              "name": "AccessKey",
              "type": "string",
              "required": true,
              "description": "云存储的access_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。",
              "example": "test-accesskey"
            },
            {
              "name": "SecretKey",
              "type": "string",
              "required": true,
              "description": "云存储的secret_key账号信息。 若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。",
              "example": "test-secretkey"
            },
            {
              "name": "FileNamePrefix",
              "type": "array",
              "required": false,
              "description": "云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，录制文件xxx.m3u8在 [\"prefix1\", \"prefix2\"]作用下，会变成prefix1/prefix2/TaskId/xxx.m3u8。",
              "example": "[\"prefix1\", \"prefix2\"]",
              "item_type": "string"
            }
          ]
        },
        {
          "name": "MaxMediaFileDuration",
          "type": "integer",
          "required": false,
          "description": "如果是aac或者mp4文件格式，超过长度限制后，系统会自动拆分视频文件。单位：分钟。默认为1440min（24h），取值范围为1-1440。【单文件限制最大为2G，满足文件大小 \u003e2G 或录制时长度 \u003e 24h任意一个条件，文件都会自动切分】 Hls 格式录制此参数不生效。",
          "example": "1440"
        },
        {
          "name": "OutputFormat",
          "type": "integer",
          "required": false,
          "description": "输出文件的格式（存储至COS等第三方存储时有效）。0：输出文件为hls格式。1：输出文件格式为hls+mp4。2：输出文件格式为hls+aac 。3：(默认)输出文件格式为mp4。4：输出文件格式为aac。",
          "example": "3"
        },
        {
          "name": "MaxIdleTime",
          "type": "integer",
          "required": false,
          "description": "房间内持续没有主播的状态超过MaxIdleTime的时长，自动停止录制，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。 示例值：30",
          "example": "30"
        }
      ],
      "required": [
        "ProjectId",
        "DeviceId",
        "VideoStreamId",
        "CloudStorage"
      ]
    },
    {
      "name": "CreateDevice",
      "description": "用于创建设备",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "创建设备所归属的项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "创建设备ID，项目内需要唯一，由小写英文字母、数字和下划线构成，长度不超过18",
          "example": "test_device1"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": true,
          "description": "创建设备名称，长度小于24, 可包含中文、数字、英文字母和下划线",
          "example": "vin123"
        },
        {
          "name": "DeviceType",
          "type": "string",
          "required": true,
          "description": "设备类型，field为现场设备（受控设备），remote为远端设备（操控设备），不填默认为field",
          "example": "field"
        },
        {
          "name": "DeviceToken",
          "type": "string",
          "required": true,
          "description": "设备认证口令，由大小写英文字母和数字构成，须为16位",
          "example": "abcd1234abcd1234"
        }
      ],
      "required": [
        "ProjectId",
        "DeviceId",
        "DeviceName",
        "DeviceType",
        "DeviceToken"
      ]
    },
    {
      "name": "CreateProject",
      "description": "用于创建项目",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectName",
          "type": "string",
          "required": true,
          "description": "项目名称，长度不超过24个字符",
          "example": "project1"
        },
        {
          "name": "ProjectDescription",
          "type": "string",
          "required": false,
          "description": "项目描述，长度不超过120个字符，不填默认为空",
          "example": "test project"
        },
        {
          "name": "PolicyMode",
          "type": "string",
          "required": false,
          "description": "权限模式，black为黑名单，white为白名单，不填默认为black",
          "example": "black"
        }
      ],
      "required": [
        "ProjectName"
      ]
    },
    {
      "name": "DeleteCloudRecording",
      "description": "成功开启录制后，可以使用此接口来停止录制任务。停止录制成功后不代表文件全部传输完成，如果未完成后台将会继续上传文件，成功后通过事件回调通知客户文件全部传输完成状态。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "录制任务的唯一Id，在启动录制成功后会返回。",
          "example": "D1ls6oRRsqxbnpbSM4EHpghzM46sszgfPsEhxrFucIB9muIw9pP0FOpOYkgdMNK52kIoPlhHXHxd+m5x662qyDsFSh4TZwA."
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DeleteProject",
      "description": "用于删除项目",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "f3glr49r3axn0fu2"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "DescribeDeviceInfo",
      "description": "用于获取指定设备信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "目标设备所属项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "目标设备ID",
          "example": "dev1"
        }
      ],
      "required": [
        "ProjectId",
        "DeviceId"
      ]
    },
    {
      "name": "DescribeDeviceList",
      "description": "用于获取设备信息列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "设备所属项目ID",
          "example": "\"f3glr49ry0i0xlm7\""
        },
        {
          "name": "DeviceType",
          "type": "string",
          "required": false,
          "description": "设备类型筛选，不填默认为全部设备类型",
          "example": "field"
        },
        {
          "name": "SearchWords",
          "type": "string",
          "required": false,
          "description": "对设备ID或Name按关键字进行模糊匹配，不填则不进行模糊匹配",
          "example": "\"test\""
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页返回的最大设备数，不填默认为10",
          "example": "10"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "当前页码，不填默认为1（首页）",
          "example": "0"
        },
        {
          "name": "DeviceStatus",
          "type": "string",
          "required": false,
          "description": "设备状态筛选，不填默认为不过滤。取值：[\u0026quot;ready\u0026quot;,\u0026quot;connected\u0026quot;,\u0026quot;online\u0026quot;]，online代表ready或connected",
          "example": "ready"
        },
        {
          "name": "RegisterType",
          "type": "integer",
          "required": false,
          "description": "标识查询项目下的设备注册类型，默认不包含免注册登录设备。 若存在免注册登录设备，该参数传\u0026quot;1\u0026quot;枚举值：0： 项目不包含免注册登录设备1： 项目包含免注册登录设备默认值：0",
          "example": "0"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "DescribeDeviceSessionDetails",
      "description": "获取设备会话数据详单",
      "status": "online",
      "parameters": [
        {
          "name": "SessionId",
          "type": "string",
          "required": true,
          "description": "会话ID",
          "example": "f3glr49ry0i0xlm7"
        }
      ],
      "required": [
        "SessionId"
      ]
    },
    {
      "name": "DescribeDeviceSessionList",
      "description": "获取设备会话列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "m82k5408n123phvb"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": true,
          "description": "页码，从1开始",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "每页个数",
          "example": "10"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "设备ID",
          "example": "trro_dev"
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": false,
          "description": "开始时间",
          "example": "1650000000"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": false,
          "description": "结束时间",
          "example": "1650000050"
        }
      ],
      "required": [
        "ProjectId",
        "PageNumber",
        "PageSize"
      ]
    },
    {
      "name": "DescribePolicy",
      "description": "用于查看权限配置",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "查看权限的项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "PolicyMode",
          "type": "string",
          "required": false,
          "description": "查看的权限模式，black为黑名单，white为白名单，不填默认为当前项目生效的权限模式",
          "example": "black"
        },
        {
          "name": "SearchMode",
          "type": "string",
          "required": false,
          "description": "模糊匹配模式，remoteMatch为远端设备ID匹配，fieldMatch为现场ID匹配，不填默认为remoteMatch",
          "example": "remoteMatch"
        },
        {
          "name": "SearchWords",
          "type": "string",
          "required": false,
          "description": "模糊匹配关键字，不填默认不进行模糊匹配",
          "example": "trro"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页返回的最大数量，不填默认为10",
          "example": "10"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "当前页码，不填默认为1（首页）",
          "example": "0"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "DescribeProjectInfo",
      "description": "用于获取项目信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "目标项目ID，必填参数",
          "example": "f3glr49r3axn0fu2"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "DescribeProjectList",
      "description": "用于获取项目列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageSize",
          "type": "integer",
          "required": false,
          "description": "每页返回的最大项目数量，不填默认为10",
          "example": "10"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": false,
          "description": "当前页码，不填默认为1（首页）",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "DescribeRecentSessionList",
      "description": "获取最新设备会话列表",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "m82k5408n123phvb"
        },
        {
          "name": "PageNumber",
          "type": "integer",
          "required": true,
          "description": "页码，从1开始",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "每页个数",
          "example": "10"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "设备ID，支持过滤远端设备或现场设备",
          "example": "trro_dev1"
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": false,
          "description": "时间范围的起始时间。时间范围最大为最近两小时，若不传或超出范围，则起始时间按两小时前计算",
          "example": "1650000000"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": false,
          "description": "时间范围的结束时间。时间范围最大为最近两小时，若不传或超出范围，则结束时间按当前时间计算",
          "example": "1650000050"
        }
      ],
      "required": [
        "ProjectId",
        "PageNumber",
        "PageSize"
      ]
    },
    {
      "name": "DescribeSessionStatistics",
      "description": "获取会话统计值",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "设备ID",
          "example": "dev1"
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": false,
          "description": "起始时间，单位：秒",
          "example": "1600000000"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": false,
          "description": "结束时间，单位：秒",
          "example": "1610000000"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "DescribeSessionStatisticsByInterval",
      "description": "获取各时间段的会话统计值",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "StatisticInterval",
          "type": "string",
          "required": true,
          "description": "统计时间间隔：hour|day|month",
          "example": "hour"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "设备ID",
          "example": "dev1"
        },
        {
          "name": "StartTime",
          "type": "integer",
          "required": false,
          "description": "起始时间，单位：秒",
          "example": "1600000000"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": false,
          "description": "结束时间，单位：秒",
          "example": "1610000000"
        }
      ],
      "required": [
        "ProjectId",
        "StatisticInterval"
      ]
    },
    {
      "name": "GetDeviceLicense",
      "description": "获取设备已经绑定的可用授权数量",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "目标设备所属项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "目标设备ID",
          "example": "dev1"
        }
      ],
      "required": [
        "ProjectId",
        "DeviceId"
      ]
    },
    {
      "name": "GetDevices",
      "description": "查询用户设备的授权绑定情况",
      "status": "online",
      "parameters": [
        {
          "name": "PageNum",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页面数量",
          "example": "10"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": false,
          "description": "项目 ID",
          "example": "m82k5408n123phvb"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "设备ID",
          "example": "trro_dev"
        }
      ],
      "required": [
        "PageNum",
        "PageSize"
      ]
    },
    {
      "name": "GetDurationDetails",
      "description": "查询该时间段、对应项目、设备的不同分辨率的通话时长流水，流水以日期（天）为单位",
      "status": "online",
      "parameters": [
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "开始时间",
          "example": "1680076919"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "结束时间",
          "example": "1688025719"
        },
        {
          "name": "PageNum",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页面数量",
          "example": "10"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目id",
          "example": "asda"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "设备ID，不传查全部设备",
          "example": "dasda"
        }
      ],
      "required": [
        "StartTime",
        "EndTime",
        "PageNum",
        "PageSize",
        "ProjectId"
      ]
    },
    {
      "name": "GetLicenseStat",
      "description": "统计license类型数量",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "GetLicenses",
      "description": "按授权查看license列表",
      "status": "online",
      "parameters": [
        {
          "name": "PageNum",
          "type": "integer",
          "required": true,
          "description": "页码",
          "example": "1"
        },
        {
          "name": "PageSize",
          "type": "integer",
          "required": true,
          "description": "页面数量",
          "example": "10"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": false,
          "description": "projectId",
          "example": "m82k5408n123phvb"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "DeviceId",
          "example": "trro_dev"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "license状态：0:未绑定；1:已绑定；2:已停服；3:已退费",
          "example": "1"
        }
      ],
      "required": [
        "PageNum",
        "PageSize"
      ]
    },
    {
      "name": "GetTotalDuration",
      "description": "查询该时间段、对应项目、设备的不同分辨率的通话时长汇总",
      "status": "online",
      "parameters": [
        {
          "name": "StartTime",
          "type": "integer",
          "required": true,
          "description": "开始时间",
          "example": "无"
        },
        {
          "name": "EndTime",
          "type": "integer",
          "required": true,
          "description": "结束时间",
          "example": "无"
        },
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目id",
          "example": "无"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": false,
          "description": "设备id，不传查全部",
          "example": "无"
        }
      ],
      "required": [
        "StartTime",
        "EndTime",
        "ProjectId"
      ]
    },
    {
      "name": "ModifyCallbackUrl",
      "description": "设置回调URL 录制回调事件内容参考：https://cloud.tencent.com/document/product/647/81113 转推回调事件内容参考：https://cloud.tencent.com/document/product/647/88552",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目id",
          "example": "m82k541ovkfsub1h"
        },
        {
          "name": "CallbackUrl",
          "type": "string",
          "required": true,
          "description": "回调URL",
          "example": "http://123.1.1.1/cb_url"
        },
        {
          "name": "SignKey",
          "type": "string",
          "required": false,
          "description": "回调签名密钥，用于校验回调信息的完整性",
          "example": "abcd1234"
        }
      ],
      "required": [
        "ProjectId",
        "CallbackUrl"
      ]
    },
    {
      "name": "ModifyDevice",
      "description": "用于修改设备信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "要修改设备归属项目的项目ID",
          "example": "f3glr49ry0i0xlm7"
        },
        {
          "name": "DeviceId",
          "type": "string",
          "required": true,
          "description": "要修改设备的设备ID",
          "example": "dev_1"
        },
        {
          "name": "DeviceName",
          "type": "string",
          "required": false,
          "description": "修改后的设备名称，不填则不修改",
          "example": "testdevice1"
        },
        {
          "name": "DeviceToken",
          "type": "string",
          "required": false,
          "description": "修改后的设备认证口令，不填则不修改",
          "example": "abcd1234ABCD5678"
        }
      ],
      "required": [
        "ProjectId",
        "DeviceId"
      ]
    },
    {
      "name": "ModifyPolicy",
      "description": "用于修改权限配置",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "修改权限配置的项目ID",
          "example": "f3glr49rc96pralw"
        },
        {
          "name": "RemoteDeviceId",
          "type": "string",
          "required": true,
          "description": "修改权限配置的远端设备ID",
          "example": "test1"
        },
        {
          "name": "FieldDeviceIds",
          "type": "array",
          "required": true,
          "description": "权限修改涉及的现场设备ID数组",
          "example": "[\"dev1\",\"dev2\"]",
          "item_type": "string"
        },
        {
          "name": "PolicyMode",
          "type": "string",
          "required": true,
          "description": "修改的目标权限模式，black为黑名单，white为白名单",
          "example": "black"
        },
        {
          "name": "ModifyMode",
          "type": "string",
          "required": true,
          "description": "修改模式，add为新增（添加现场设备I关联），remove为删除（解除现场设备关联），set为设置（更新现场设备关联）",
          "example": "add"
        }
      ],
      "required": [
        "ProjectId",
        "RemoteDeviceId",
        "FieldDeviceIds",
        "PolicyMode",
        "ModifyMode"
      ]
    },
    {
      "name": "ModifyProject",
      "description": "用于修改项目信息",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "目标修改项目的项目ID",
          "example": "f3glr49rc96pralw"
        },
        {
          "name": "ProjectName",
          "type": "string",
          "required": false,
          "description": "修改后的项目名称，不填则不修改",
          "example": "mytest"
        },
        {
          "name": "ProjectDescription",
          "type": "string",
          "required": false,
          "description": "修改后的项目描述，不填则不修改",
          "example": "test project"
        },
        {
          "name": "PolicyMode",
          "type": "string",
          "required": false,
          "description": "修改后的权限模式，black为黑名单，white为白名单,不填则不修改",
          "example": "black"
        }
      ],
      "required": [
        "ProjectId"
      ]
    },
    {
      "name": "ModifyProjectSecMode",
      "description": "使用项目共享密钥可动态生成设备登录密钥，登录前无需对设备进行提前注册，适合希望简化业务流程的客户。由于是公共密钥，请务必注意保护项目共享密钥，并及时更新。建议项目共享密钥保存在服务器侧。由服务器生成设备登录密码下发给设备，避免密钥保存在客户端侧产生的密钥泄露风险。 开启项目共享密钥后，对于已注册的设备，仍可使用原设备密码登录。若希望\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "ProjectId",
          "type": "string",
          "required": true,
          "description": "项目ID",
          "example": "m82k540iwduvuuma"
        },
        {
          "name": "Mode",
          "type": "integer",
          "required": true,
          "description": "安全模式 0：关闭项目共享密钥 1：开启项目共享密钥",
          "example": "1"
        },
        {
          "name": "Key",
          "type": "string",
          "required": false,
          "description": "项目密钥 32位 小写英文+数字； 项目密钥模式必填",
          "example": "123456789012345678901234567abcde"
        },
        {
          "name": "AutoRegister",
          "type": "integer",
          "required": false,
          "description": "自动注册方式 0：关闭自动注册 1：仅允许现场设备自动注册 2：仅允许远端设备自动注册 3：允许现场和远端设备均自动注册",
          "example": "1"
        },
        {
          "name": "FieldListEnable",
          "type": "integer",
          "required": false,
          "description": "是否允许远端获取现场设备列表（getGwList） 0：不允许 1：允许",
          "example": "1"
        }
      ],
      "required": [
        "ProjectId",
        "Mode"
      ]
    },
    {
      "name": "StartPublishLiveStream",
      "description": "启动一个混流转推任务，将 TRTC 房间的多路音视频流混成一路音视频流，编码后推到直播 CDN 或者回推到 TRTC 房间。也支持不转码直接转推 TRTC 房间的单路流。启动成功后，会返回一个 SdkAppid 维度唯一的任务 Id（TaskId）。您需要保存该 TaskId，后续需要依赖此 TaskId 更新和结束任务。",
      "status": "online",
      "parameters": [
        {
          "name": "WithTranscoding",
          "type": "integer",
          "required": true,
          "description": "是否转码，0表示无需转码，1表示需要转码。是否收取转码费是由WithTranscoding参数决定的，WithTranscoding为0，表示旁路转推，不会收取转码费用，WithTranscoding为1，表示混流转推，会收取转码费用。 示例值：1",
          "example": "0"
        },
        {
          "name": "MaxIdleTime",
          "type": "integer",
          "required": true,
          "description": "所有参与混流转推的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长，自动停止转推，单位：秒。默认值为 30 秒，该值需大于等于 5秒，且小于等于 86400秒(24小时)。",
          "example": "20"
        },
        {
          "name": "VideoParams",
          "type": "object",
          "required": true,
          "description": "转推视频参数",
          "example": "无",
          "children": [
            {
              "name": "Width",
              "type": "integer",
              "required": true,
              "description": "输出流宽，音视频输出时必填。取值范围[0,1920]，单位为像素值。",
              "example": "1280"
            },
            {
              "name": "Height",
              "type": "integer",
              "required": true,
              "description": "输出流高，音视频输出时必填。取值范围[0,1080]，单位为像素值。",
              "example": "720"
            },
            {
              "name": "Fps",
              "type": "integer",
              "required": true,
              "description": "输出流帧率，音视频输出时必填。取值范围[1,60]，表示混流的输出帧率可选范围为1到60fps。",
              "example": "15"
            },
            {
              "name": "BitRate",
              "type": "integer",
              "required": true,
              "description": "输出流码率，音视频输出时必填。取值范围[1,10000]，单位为kbps。",
              "example": "1500"
            },
            {
              "name": "Gop",
              "type": "integer",
              "required": true,
              "description": "输出流gop，音视频输出时必填。取值范围[1,5]，单位为秒。",
              "example": "2"
            },
            {
              "name": "VideoList",
              "type": "array",
              "required": true,
              "description": "转推视频流列表",
              "example": "[{ \"VideoStreamId\": 0,\"Width\": 1920,\"Height\": 1080,\"DeviceId\": \"geek_gw_2\",\"ProjectId\": \"m82k5408n123phvb\"}]",
              "item_type": "object",
              "children": [
                {
                  "name": "ProjectId",
                  "type": "string",
                  "required": true,
                  "description": "项目id",
                  "example": "m82k5408n123phvb"
                },
                {
                  "name": "DeviceId",
                  "type": "string",
                  "required": true,
                  "description": "设备id",
                  "example": "trro_dev"
                },
                {
                  "name": "VideoStreamId",
                  "type": "integer",
                  "required": true,
                  "description": "流id",
                  "example": "0"
                },
                {
                  "name": "Width",
                  "type": "integer",
                  "required": true,
                  "description": "子画面在输出时的宽度，单位为像素值，不填默认为0。",
                  "example": "1280"
                },
                {
                  "name": "Height",
                  "type": "integer",
                  "required": true,
                  "description": "子画面在输出时的高度，单位为像素值，不填默认为0。",
                  "example": "720"
                }
              ]
            }
          ]
        },
        {
          "name": "PublishParams",
          "type": "array",
          "required": true,
          "description": "转推的URL参数，一个任务最多支持10个推流URL",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "PublishUrl",
              "type": "string",
              "required": true,
              "description": "腾讯云直播推流地址url",
              "example": "rtmp://live-push-test.tencentcs.com/live/test2?txSecret=abcd1234567890\u0026txTime=679C9784"
            },
            {
              "name": "IsTencentUrl",
              "type": "integer",
              "required": true,
              "description": "是否是腾讯云CDN，0为转推非腾讯云CDN，1为转推腾讯CDN，不携带该参数默认为1。",
              "example": "1"
            }
          ]
        }
      ],
      "required": [
        "WithTranscoding",
        "MaxIdleTime",
        "VideoParams",
        "PublishParams"
      ]
    },
    {
      "name": "StopPublishLiveStream",
      "description": "停止指定的混流转推任务。如果没有调用 Stop 接口停止任务，所有参与混流转推的主播离开房间超过MaxIdleTime 设置的时间后，任务也会自动停止。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "唯一标识转推任务。",
          "example": "D0xOlGVRsurq9PRB-Iuak6f-J0ac-twfB4hQwbFucIB9muIw9pP0FOpOYkgdMNK52kIoPlhHe96RlTGxKzJwUgzjD-8pZgA."
        }
      ],
      "required": [
        "TaskId"
      ]
    }
  ]
}