2025/12/05 11:39:30
Webhook 事件
开通声网消息通知后,声网通知服务器以 HTTPS POST 请求方法向你的服务器发送频道事件通知回调。数据格式为 JSON,字符编码为 UTF-8,签名算法为 HMAC/SHA1 或 HMAC/SHA256。
本页介绍实时转录翻译的各事件类型及含义。
请求的 Body
消息通知回调的请求包体包含以下字段:
| 字段 | 类型 | 描述 |
|---|---|---|
sid | String | 智能体 ID。 |
noticeId | String | 通知 ID,标识来自声网业务服务器的一次事件通知。 |
productId | Number | 业务 ID。20 表示语音转文字业务。 |
eventType | Number | 通知的事件类型。详见事件类型。 |
notifyMs | Number | 声网消息服务器向你的服务器发送事件通知的 Unix 时间戳 (ms)。 |
payload | JSON Object | 通知事件的具体内容。payload 因 eventType 而异,详见事件类型。 |
消息通知回调的请求包体示例:
JSON
{
"sid": "agent_id",
"noticeId": "e94f5b6fd69446ea9d75da90a59ca8a2",
"productId": 20,
"eventType": 101,
"notifyMs": 1750235972193,
"payload": {...}
}
事件类型
声网消息通知服务可以通知语音转文字服务中的以下事件:
eventType | event_name | 事件描述 |
|---|---|---|
| 101 | agent joined | 智能体加入频道。 |
| 102 | agent left | 智能体离开频道。 |
101 agent joined
eventType 为 101 表示智能体加入频道,payload 中包含以下字段:
| 字段 | 数据类型 | 含义 |
|---|---|---|
agent_id | String | 任务 ID。 |
start_ts | Number | 任务创建的时间戳(毫秒)。 |
channel | String | 频道名称。 |
payload 示例:
JSON
{
"agent_id": "agent_id",
"channel": "stt_ncs93369",
"start_ts": 1750235971
}
102 agent left
eventType 为 102 表示智能体离开频道,payload 中包含以下字段:
| 字段 | 数据类型 | 含义 |
|---|---|---|
agent_id | String | 任务 ID。 |
start_ts | Number | 任务开始的时间戳(毫秒)。 |
stop_ts | Number | 任务结束的时间戳(毫秒)。 |
channel | String | 频道名称。 |
status | String | 任务状态:
|
message | String | 表示智能体退出频道的具体原因:
|
智能体因不同原因离开频道的 payload 示例:
- 正常停止
- 超时退出
- RTC 连接错误
- ASR 模块错误
- 翻译模块错误
JSON
{
"agent_id": "agent_id",
"channel": "stt_ncs93369",
"message": "OK",
"start_ts": 1750235971,
"status": "STOPPED",
"stop_ts": 1750235984
}
JSON
{
"agent_id": "agent_id",
"channel": "stt_ncs93369",
"message": "Idle for too long",
"start_ts": 1750235971,
"status": "STOPPED",
"stop_ts": 1750235984
}
JSON
{
"agent_id": "agent_id",
"channel": "stt_ncs93369",
"message": "RTC connection error",
"start_ts": 1750235971,
"status": "FAILED",
"stop_ts": 1750235984
}
JSON
{
"agent_id": "agent_id",
"channel": "stt_ncs93369",
"message": "Fatal ASR error",
"start_ts": 1750235971,
"status": "FAILED",
"stop_ts": 1750235984
}
JSON
{
"agent_id": "agent_id",
"channel": "stt_ncs93369",
"message": "Fatal Translation error",
"start_ts": 1750235971,
"status": "FAILED",
"stop_ts": 1750235984
}