查询 SIP 中继

查询单个 SIP 中继、多个 SIP 中继 或所有 SIP 中继的基本设置。

Endpoint

POST /api/v1.1.0/siptrunk/query?token={token}

请求参数

名称 是否必需 类型 描述
trunkname String SIP 中继的名称。
  • 查询单个 SIP 中继:设置 trunkname 为 SIP 中继的名称。

    例如:"trunkname":"SIP"

  • 查询多个 SIP 中继:设置 trunkname 为 SIP 中继的名称,多个 SIP 中继之间用 , 隔开。

    例如:"trunkname": "SIP1,SIP2"

  • 查询所有 SIP 中继:设置 trunknameall

响应参数

名称 类型 描述
trunks Object 对象参数。
id Int 中继的标识码。
trunkname String 中继名称。
trunktype String 中继类型。
  • register:注册中继。
  • peer:点对点中继。
  • account:账号中继。
注册中继
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 账号的密码。
点对点中继
host String SIP 运营商的域名或 IP 地址。
port String 中继的 SIP 端口。
domain String SIP 运营商的域名或 IP 地址。
账号中继
username String 账号中继的用户名。
authname String 账号中继的认证名。
password String 账号中继的密码。
DOD 号码
extensionsdod String

分机绑定的 DOD 号码。

显示格式为:{dod_number}-{dod_name}-{extension_number}

例如:"extensionsdod":"5503301-yeastar-1000"
extensionsgroupdod String 分机组绑定的 DOD 号码。

显示格式为:{dod_number}-{dod_name}-{extension_group_name}

例如:"extensionsdod":"5503301-yeastar-sales"

实际示例

请求示例

POST /api/v1.1.0/siptrunk/query?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150
{
    "trunkname": "SIP"
}

响应示例

HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "trunks": [
        {
            "id": "8",
            "trunkname": "SIP",
            "trunktype": "register",
            "host": "192.168.11.158",
            "port": "5060",
            "domain": "192.168.11.158",
            "username": "8001",
            "authname": "8001",
            "fromuser": "8001",
            "password": "E7PO?LywXnXa_B-n",
            "extensionsdod": "",
            "extensionsgroupdod": ""
        }
    ]
}