WebhooksCreate - 创建webhook--机器翻译-火山引擎

文档中心

导航

WebhooksCreate - 创建webhook

最近更新时间：2025.12.10 14:26:07首次发布时间：2025.12.10 14:26:07

创建webhook，在翻译、配音达到特定节点的时候调用该接口

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	WebhooksCreate	要执行的操作，取值：WebhooksCreate。
Version	String	是	2021-05-21	API的版本，取值：2021-05-21。
hookIds	Array of Integer	是	`{ "video.task.created": 57, "video.ai.process.fail": 58, "ai.quality.check.finished": 59, "subtitle.task.finished": 60, "title.brief.task.finished": 61, "cover.task.finished": 62, "video.task.delivered": 63 }`	hooksIds，当流程达到这些节点的时候hui
name	String	是	创建任务的hooks	hook的名称
type	String	是	用于判断给什么类型的项目创建，视频类型传值为2	{ text: 0, doc: 1, video: 2 }
projectId	String	是	10450295321856	项目id
url	String	是	https://yoururl.com/api	webhook回调地址。，注意是post请求。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
message	String	success	接口返回信息

请求示例

POST /?Action=WebhooksCreate&Version=2021-05-21&name=bbEa&projectId=RiWjIbUbn&url=Jhw HTTP/1.1
Host: volcengineapi-boe-stable.byted.org
Content-Type: application/json; charset=UTF-8
X-Date: 20251108T103237Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251108/cn-beijing/i18n_openapi/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "hookIds": [
    0
  ],
  "type": "用于判断给什么类型的项目创建，视频类型传值为2"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202511081832430480351340531884B8",
    "Action": "WebhooksCreate",
    "Version": "2021-05-21",
    "Service": "i18n_openapi",
    "Region": "cn-beijing"
  },
  "Result": {
    "message": "DvS"
  }
}

错误码

您可访问公共错误码，获取更多错误码信息。

通知数据说明

// video.task.created 示例
{"event":"video.task.created",
"projectId":"26573440770",
"operator":"2100332519",
"timestamp":1764145716380,
"operationType":0,
"type":2,
"taskId":"26800504322"}
// video.task.finished 示例
{
"event": "video.task.finished",
"projectId": "25949905666",
"operator": "2100332519",
"timestamp": 1763703132450,
"operationType": 0,
"type": 2,
"taskId": "25949874946",
"subtasks": [
{
"subtaskId": 25949876226,
"episodeNum": 1,
"suppressionVideoUrl": "xxxxx"
},
{
"subtaskId": 25949876482,
"episodeNum": 2,
"suppressionVideoUrl": "xxxxx"
}
]