编辑本地代理网关实例

编辑本地代理网关实例配置。

请求 URL

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

请求参数

参数 是否必填 类型 说明
id Integer 本地代理网关实例的唯一 ID。
注: 可使用 搜索特定本地代理网关实例 查询实例 ID。
name String 本地代理网关实例的名称。
audio_rtp_passthrough Integer 是否启用语音 RTP 透传功能。

启用后,通过同一本地代理网关注册的话机之间的音频流将直接点对点传输,不经过 PBX 和本地代理网关。

注: 若该参数省略或置空,将自动填充为 0
取值范围
  • 0:禁用
  • 1:启用

响应参数

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

示例

请求示例

启用本地代理网关实例 (ID: 68) 的语音 RTP 透传功能。

POST /openapi/v1.0/onsiteproxy/update?access_token=5SwyByhbSfsNlpI1v4GtHxEDmKsZwzjQ HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "id": 68,
    "audio_rtp_passthrough": 1
}

响应示例

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