编辑 WebSocket 音频推送设置

编辑 WebSocket 音频推送功能设置，包括 WebSocket 服务器地址，传输采样率，订阅对象等。

请求 URL

POST {base_url}/{api_path}/websocketaudiostream/update?access_token={access_token}

请求参数

参数 是否必填 类型 说明
enable 否 Integer 是否启用 WebSocket 音频推送功能。

取值范围：

  • 0：禁用
  • 1：启用
websocket_url 否 String 用于接收音频流的 WebSocket 服务器地址。

例如，ws://docs.example.cloud.com:8080。

注： 地址长度不能超过 255 个字节。
auth_key 否 String 第三方平台所需的鉴权字段的名称。
注： 名称长度不能超过 63 个字节。
auth_value 否 String 鉴权值。
注： 鉴权值长度不能超过 255 个字节。
sample_rate 否 Integer 采样率。

取值范围：

  • 0：8000Hz
  • 1：16000Hz
enable_ext 否 Integer 是否订阅指定分机以获取其相关的通话音频。

取值范围：

  • 0：禁用
  • 1：启用
enable_trunk 否 Integer 是否订阅指定中继以获取其路由的通话音频。

取值范围：

  • 0：禁用
  • 1：启用
enable_did 否 Integer 是否订阅指定 DID 号码以获取拨打至该 DID 号码的通话音频。

取值范围：

  • 0：禁用
  • 1：启用
subscribe_list 否 Array <Subscribe_List> 订阅对象的详细信息。
注： 要成功添加订阅对象，需将 enable_ext、enable_trunk 或 enable_did 的值对应设置为 1。
Subscribe_List
参数 是否必填 类型 说明
subscribe_id 是 Integer 订阅对象的唯一 ID。
提示： 可使用 获取菜单选项 接口查询分机、分机组、部门、中继或 DID 号码的 ID。
subscribe_type 是 Integer 订阅对象的类型。

取值范围：

  • extension：分机
  • ext_group：分机组
  • organization：部门
  • trunk：中继
  • did： DID 号码

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

POST /openapi/v1.0/websocketaudiostream/update?access_token=iioRRjGzPoYGGJLjh7zkYfYxj3Xe4oqW HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "auth_key": "yyyy",
    "auth_value": "chasnCjhsbvkslMCWJIEOFKCJKABHCOACLNHCSHJBCssss",
    "enable": 1,
    "enable_did": 0,
    "enable_ext": 1,
    "enable_trunk": 0,
    "sample_rate": 1,
    "subscribe_list": [
        {
            "subscribe_id": 50,
            "subscribe_type": "extension"
        }
    ],
    "websocket_url": "wss://docs.example.cloud.com"
}

响应示例

HTTP 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}