查询 SIP 中继详情

查询单个 SIP 中继、多个 SIP 中继或所有 SIP 中继的详细配置。

请求地址

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

请求参数

参数 是否必选 类型 描述
id 是 Integer SIP 中继的唯一 ID。
取值范围：
  • 单个 SIP 中继 id：查询指定中继的配置。

    例如："id":"15"

  • 多个 SIP 中继 id：查询多个 SIP 中继的配置。多个 SIP 中继 id 用半角逗号（,）隔开。

    例如："id":"15,16"

  • all：查询所有 SIP 中继的配置。

响应参数

参数 类型 描述
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
trunks Array<TrunkInfo> 中继信息列表。
TrunkInfo
支持三种中继：注册中继信息、点对点中继信息和账号中继信息。
表 1. 注册中继信息
参数 类型 描述
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"
表 2. 点对点中继信息
参数 类型 描述
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"
extensionsgroupdod String 分机组绑定的 DOD 号码。
  • 绑定单个 DOD 号码：

    格式：

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

    示例：

    "extensionsgroupdod":"5503301-yeastar-sales"
表 3. 账号中继信息
参数 类型 描述
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"
extensionsgroupdod String 分机组绑定的 DOD 号码。
  • 绑定单个 DOD 号码：

    格式：

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

    示例：

    "extensionsgroupdod":"5503301-yeastar-sales"

示例

请求示例

查询 id 为15的中继的详细信息。

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

{
    "id": "15"
}

响应示例

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",
	"trunks": [
		{
			"id": "15",
			"trunkname": "test",
			"trunktype": "peer",
			"host": "192.168.6.36",
			"port": "5060",
			"domain": "192.168.6.36",
			"extensionsdod": "",
			"extensionsgroupdod": "5503301-yeastar-sales,5503302-yealink-support,"
		}
	]
}