添加本地代理网关实例

添加并配置本地代理网关实例。

请求 URL

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

请求参数

参数 是否必填 类型 说明
name 是 String 本地代理网关实例的名称。
platform 是 String 要部署实例的操作系统。

取值范围：linux
audio_rtp_passthrough 否 Integer 是否启用语音 RTP 透传功能。

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

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

响应参数

Parameter Type Description
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
id Integer 本地代理网关实例的唯一 ID。

示例

请求示例

POST /openapi/v1.0/onsiteproxy/create?access_token=q0GyBcsgO8FsXWxPpzAJVW33vd0OpnUz HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "name": "Region_sales", 
    "platform": "linux",
    "audio_rtp_passthrough": 0
}

响应示例

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