Appearance
概述
录音产物就绪后,平台向你的 URL POST 一条密文。解密、按 eventId 去重、返回 {"code":2000}。你也可主动调用 /openapi/v1 查询与回调。
本期仅 HTTP。secret 只下发一次,请当场保存。
能力说明
| 项 | 说明 |
|---|---|
| 推送能力 | 处理后音频 / 转写文本。约定类型全部就绪后推一次 |
| 推送方向 | 平台 → 你的接收地址 |
| 推送鉴权 | 无 Token、无签名头。能解密即合法 |
| 开放接口 | 你 → 平台:/openapi/v1/token、/audios、/callback |
| 项 | 说明 |
|---|---|
| 推送能力 | 处理后音频。约定类型全部就绪后推一次 |
| 推送方向 | 平台 → 你的接收地址 |
| 推送鉴权 | 无 Token、无签名头。能解密即合法 |
| 开放接口 | 你 → 平台:/openapi/v1/token、/audios、/callback |
对接方案
| 你提供 | 你收到 |
|---|---|
| 可访问的 HTTPS 接收地址 | 开通时一次性下发的 AES 密钥 secret、enterpriseId |
| 需要的内容类型:处理后音频 / 转写文本 | 类型全部就绪后的 一条 推送 |
同一接收地址对同一 audioId 只推一次。订阅多项时 不会 按类型连推,只在全部就绪后推一次;eventType / data.contentTypes 列出实际勾选的类型。
| 订阅 | eventType | 何时推送 |
|---|---|---|
| 仅处理后音频 | DENOISE_COMPLETED | 处理完成且文件可下载 |
| 仅转写文本 | TRANSCRIPT_COMPLETED | ASR 成功且分句 JSON 合法 |
| 两项 | 所订类型名,逗号拼接 | 所订类型均就绪后推一次 |
| 你提供 | 你收到 |
|---|---|
| 可访问的 HTTPS 接收地址 | 开通时一次性下发的 AES 密钥 secret、enterpriseId |
| 需要的内容类型:处理后音频 | 类型全部就绪后的 一条 推送 |
同一接收地址对同一 audioId 只推一次。订阅多项时 不会 按类型连推,只在全部就绪后推一次;eventType / data.contentTypes 列出实际勾选的类型。
| 订阅 | eventType | 何时推送 |
|---|---|---|
| 仅处理后音频 | DENOISE_COMPLETED | 处理完成且文件可下载 |
接入步骤
- 提供可访问的 HTTPS 接收地址,并确认需要的内容类型。
- 将对应环境的出口 IP 加入防火墙白名单。
- 保存开通时下发的
secret(Base64)与enterpriseId。丢失后旧钥无法再取回,需重新申请。 - 实现:收 POST → 解密 → 按
eventId去重 → 5 秒内返回{"code":2000}。 - (可选)处理完成后异步调用 回调接口,通知平台该录音已接收完成。
- 用联调报文验证解密与响应后,即可接收正式推送。
| 环境 | 出口 IP |
|---|---|
| 测试 | 47.96.228.97 |
| 正式 | 39.99.234.131 |
密钥轮换后 keyVersion +1,旧钥立即失效。只需保存 当前 secret。
接口一览
| 接口 | 方向 | 说明 |
|---|---|---|
| 录音推送 | 平台 → 你 | 产物就绪后 POST 密文 |
| 获取 Token | 你 → 平台 | POST /openapi/v1/token |
| 查询录音 | 你 → 平台 | POST /openapi/v1/audios |
| 回调 | 你 → 平台 | POST /openapi/v1/callback |
| 验证设备 | 你 → 平台 | POST /openapi/v1/devices/verify |
| 设备状态 | 你 → 平台 | GET /openapi/v1/devices/{deviceSn}/info |
| 录音文件 | 你 → 平台 | GET /openapi/v1/devices/{deviceSn}/files |
| 绑定状态 | 你 → 平台 | POST /openapi/v1/devices/binding-status |
| 模板列表 | 你 → 平台 | GET /openapi/v1/devices/templates |
| 按模板下发 | 你 → 平台 | PUT /openapi/v1/devices/{deviceSn}/template |