创建分身数字人视频字幕文件 - CreateSubtitleFile
功能介绍
该接口用于创建分身数字人视频字幕文件任务。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/subtitle-files
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
|
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
|
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
|
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
|
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
script_id |
否 |
String |
剧本ID。 |
|
sequence_no |
否 |
Integer |
剧本序号。
说明:
取值范围: 0~2147483647 |
|
callback_config |
否 |
CallBackConfig object |
回调设置。字幕文件生成完成后触发回调。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
callback_url |
是 |
String |
回调URL。 回调请求body为json格式,带参数如下: result: SUCCEED或FAILED asset_id: 资产ID job_id: 任务 |
|
auth_type |
否 |
String |
认证类型。
默认取值: NONE |
|
key |
否 |
String |
密钥Key |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
任务ID。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
状态码:500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码。 |
|
error_msg |
String |
错误描述。 |
请求示例
POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/subtitle-files
{
"script_id" : "a5d295cdb345c11bd9f36bc22ced3a7a"
}
响应示例
状态码:200
处理成功返回。
{
"job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
}
状态码:400
请求传参异常,包含错误码及对应描述。
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
}
状态码:401
未鉴权或鉴权失败。
{
"error_code" : "MSS.00000001",
"error_msg" : "Unauthorized"
}
状态码:500
内部服务错误。
{
"error_code" : "MSS.00000004",
"error_msg" : "Internal Error"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
处理成功返回。 |
|
400 |
请求传参异常,包含错误码及对应描述。 |
|
401 |
未鉴权或鉴权失败。 |
|
500 |
内部服务错误。 |
错误码
请参见错误码。