Tích hợpWebhooks

Đăng ký webhook

Đăng ký một webhook mới để nhận thông báo tự động khi job Text to Speech hoặc Speech to Text xử lý xong.

Scope yêu cầu: webhooks:manage.

Headers

X-Api-KeystringRequired

Request

This endpoint expects an object.
namestringRequired

Tên webhook, dùng để dễ nhận biết.

urlstringRequiredformat: "uri"

Endpoint của bạn sẽ nhận dữ liệu khi có sự kiện.

eventslist of enumsRequired

Danh sách sự kiện sẽ kích hoạt webhook. tts.completed/ tts.failed — job Text to Speech xử lý xong/thất bại. stt.completed/stt.failed — job Speech to Text xử lý xong/thất bại.

activebooleanOptionalDefaults to true

Bật/tắt webhook — tắt thì hệ thống ngừng gửi thông báo tới URL này.

retryOnFailurebooleanOptionalDefaults to false

Nếu bật, hệ thống tự động gửi lại tối đa 2 lần, mỗi lần cách nhau 60 giây, khi máy chủ đích trả về lỗi HTTP (ngoài 200–299) hoặc không phản hồi.

securityobjectOptional

Phương thức xác thực đính kèm trong request mà hệ thống gửi tới URL webhook của bạn.

alertingobjectOptional

Cấu hình cảnh báo khi webhook liên tục gửi thất bại.

Response

Thành công.

webhookIdstringformat: "uuid"

Mã webhook, dùng cho các endpoint sửa/xoá.

namestring
urlstringformat: "uri"
eventslist of enums
activeboolean
retryOnFailureboolean
securityobject

Giá trị nhạy cảm (apiKey, giá trị header tuỳ chỉnh) chỉ trả về đầy đủ khi type là API_KEY; với CUSTOM_HEADER chỉ trả về tên các header (headerKeys), không trả về giá trị.

alertingobject

Cấu hình cảnh báo khi webhook liên tục gửi thất bại.

createdAtdatetime
updatedAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error