回调服务器

SSR 提供回调机制,用于在录制作业完成后通知您。这使您能够在录制作业完成后对录制内容采取措施。

设置回调服务器

  1. 要设置回调服务器,您需要创建一个能够接收来自 SSR API 的 POST 请求的服务器。请求将包含一个包含作业状态的 JSON 负载。
  2. SSR 向请求中 callbackUri 字段中的任何 URL 发出请求。如果您指定了 callbackKey,Vivox 会将其包含在请求标头中的 Authorization 下。

回调负载

回调的负载包含以下字段

{
    "job_status": "string",
    "job_id": "string",
    "code": "string",
    "metadata": "object"
}
  • job_status 将为 completefailpartial 之一。
    • 当作业为 partial 时,这意味着并非所有录制或解码的音频都成功。
  • job_id 是作业的 ID。它对应于原始请求响应中的 job_id
  • 如果作业失败,code 是错误代码。有关更多信息,请参阅 错误代码
  • metadata 是您在原始请求中传入的任何元数据。如果您没有设置任何 metadata,此字段将从请求中省略。

错误代码

代码描述
2001服务未启用。
2002内部服务错误。
2003未找到请求的频道音频。
2004存储无效。
2005内部服务错误。
2006由于 filterUri 参数,没有音频解码。
2103不支持的音频格式。
2107AWS 存储桶被限制。