修改 SIP 中继

修改 SIP 中继的基本设置和 DOD 号码设置。

请求地址

{base_url}/{api_path}/trunk/update_siptrunk?token={token}

请求参数

根据不同类型的中继,需要发送不同的请求参数。
修改注册中继
参数 是否必选 类型 描述
id 是 Integer 中继的唯一 ID。
trunkname 否 String 中继名称。
trunktype 是 String

取值:

register:注册中继。

host 否 String SIP 运营商的域名或 IP 地址。
port 否 String 中继的 SIP 端口。
domain 否 String SIP 运营商的域名或 IP 地址。
username 否 String SIP 运营商提供的 SIP 账号。
authname 否 String SIP 运营商提供的 SIP 账号。
fromuser 否 String From 头域。
注: 如果 SIP 运营商不支持,则放空。
password 否 String SIP 账号的密码。
extensionsdod 否 String

分机绑定的 DOD 号码。

取值范围:

  • 单个 DOD 号码:

    格式:

    "extensionsdod": "{dod_number}-{dod_name}-{extension_number}"

    示例:

    "extensionsdod":"5503301-yeastar-1000"
  • 多个 DOD 号码:

    格式:

    "extensionsdod":"{dod_number}-{dod_name}-{extension_number}"
    多个 DOD 号码用半角逗号(,)隔开。

    示例:

    "extensionsdod":"5503301-yeastar-1000,5503302-yeastar-1001"
extensionsgroupdod 否 String 分机组绑定的 DOD 号码。

取值范围:

  • 单个 DOD 号码:

    格式:

    "extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}

    示例:

    "extensionsgroupdod":"5503301-yeastar-sales"
  • 多个 DOD 号码:

    格式:

    "extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}
    多个 DOD 号码用半角逗号(,)隔开。

    示例:

    "extensionsgroupdod":"5503301-yeastar-sales,5503302-yeastar-support"
修改点对点中继
参数 是否必选 类型 描述
id 是 Integer 中继的唯一 ID。
trunkname 否 String 中继名称。
trunktype 是 String 中继类型。

取值:

peer:点对点中继。

host 否 String SIP 运营商的域名或 IP 地址。
port 否 String 中继的 SIP 端口。
domain 否 String SIP 运营商的域名或 IP 地址。
extensionsdod 否 String

分机绑定的 DOD 号码。

取值范围:

  • 单个 DOD 号码:

    格式:

    "extensionsdod": "{dod_number}-{dod_name}-{extension_number}"

    示例:

    "extensionsdod":"5503301-yeastar-1000"
  • 多个 DOD 号码:

    格式:

    "extensionsdod":"{dod_number}-{dod_name}-{extension_number}"
    多个 DOD 号码用半角逗号(,)隔开。

    示例:

    "extensionsdod":"5503301-yeastar-1000,5503302-yeastar-1001"
extensionsgroupdod 否 String 分机组绑定的 DOD 号码。

取值范围:

  • 单个 DOD 号码:

    格式:

    "extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}

    示例:

    "extensionsgroupdod":"5503301-yeastar-sales"
  • 多个 DOD 号码:

    格式:

    "extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}
    多个 DOD 号码用半角逗号(,)隔开。

    示例:

    "extensionsgroupdod":"5503301-yeastar-sales,5503302-yeastar-support"
修改账号中继
参数 是否必选 类型 描述
id 是 Integer 中继的唯一 ID。
trunkname 否 String 中继名称。
trunktype 是 String 中继类型。

取值:

account:账号中继。

username 否 String 账号中继的用户名。
authname 否 String 账号中继的认证名。
password 否 String 账号中继的密码。
extensionsdod 否 String

分机绑定的 DOD 号码。

取值范围:

  • 单个 DOD 号码:

    格式:

    "extensionsdod": "{dod_number}-{dod_name}-{extension_number}"

    示例:

    "extensionsdod":"5503301-yeastar-1000"
  • 多个 DOD 号码:

    格式:

    "extensionsdod":"{dod_number}-{dod_name}-{extension_number}"
    多个 DOD 号码用半角逗号(,)隔开。

    示例:

    "extensionsdod":"5503301-yeastar-1000,5503302-yeastar-1001"
extensionsgroupdod 否 String 分机组绑定的 DOD 号码。

取值范围:

  • 单个 DOD 号码:

    格式:

    "extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}

    示例:

    "extensionsgroupdod":"5503301-yeastar-sales"
  • 多个 DOD 号码:

    格式:

    "extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}
    多个 DOD 号码用半角逗号(,)隔开。

    示例:

    "extensionsgroupdod":"5503301-yeastar-sales,5503302-yeastar-support"

响应参数

参数 类型 描述
status String 请求结果。
  • Success:成功。
  • Failed:失败。

示例

请求示例

POST /api/v2.0.0/trunk/update_siptrunk?token=277ac400357b509b4a587ff2157f7ad5
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
    "id":"8",
    "trunkname": "siptrunk1",
    "trunktype": "register",
    "host": "192.168.12.161",
    "port": "5060",
    "domain": "192.168.12.161",
    "username": "1001",
    "authname": "1001",
    "password": "Pajsjx9183",
}

响应示例

HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}