接口描述
接口名称:
/Project/ModifyProject
。接口功能:修改项目,支持修改项目的名称、描述信息、封面、宽高比等信息。
调用方式
输入参数
字段 | 类型 | 必填 | 描述 |
ProjectId | String | 是 | 项目 ID。 |
Name | String | 否 | 项目名称,长度限制:20个字符。 |
Description | String | 否 | 项目描述。 |
CoverUrl | String | 否 | 封面 URL。 |
CoverSource | String | 否 | 封面来源,可选值: USER:用户上传; DEFAULT:系统默认。 |
WHRatio | String | 否 | 项目视频宽高比,取值 9:16 16:9 |
SwitcherInfo | 否 | 导播台项目变更信息。 | |
StreamConnectInfo | 否 | 云转推项目变更信息。 |
输出参数
注意
除公共返回字段外,该接口无其他返回字段。
示例
示例1:修改项目成功
修改 ID 为
cmepid_5fbb72524e70c2000192d4ede
的项目,返回成功。输入示例
{"ProjectId": "cmepid_5fbb72524e70c2000192d4ed","Name": "修改项目名称"}
输出示例
{"Code": "Success","Message": "成功","EnglishMessage": "success"}
示例2:修改项目失败
修改 ID 为
cmepid_5fbb72524e70c2000192d4ede
的项目,返回失败。输入示例
{"ProjectId": "cmepid_5fbb72524e70c2000192d4ed","Name": "修改项目名称"}
输出示例
{"Code": "InvalidParameterValue.ProjectId","Message": "项目不存在","EnglishMessage": "project not exist"}