查询单个中继信息

查询单个 SIP 中继的详细信息。

使用限制

此接口仅支持查询 SIP 中继的信息。

请求 URL

GET { base_url}/{api_path}/trunk/get?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
id 是 Integer 中继的唯一 ID。
注： 可使用 搜索特定中继 接口查询中继的 ID。

响应参数

注册中继
表 2.
参数 是否必填 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Array <Trunk_Info> 中继详细信息。
Trunk_Info
表 3.
参数 类型 说明
id Integer 中继的唯一 ID。
name String 中继名称。
enable Integer 中继是否启用。

  • 0：禁用

  • 1：启用
country String SIP 运营商所在的国家。
itsp String SIP 运营商。
type String 中继类型。
  • register：注册中继
transport String 传输协议。
hostname String SIP 运营商的域名/ IP 地址。
port Integer SIP 中继注册端口。
domain String SIP 运营商的域名/ IP 地址。
username String SIP 运营商提供的 SIP 账号的用户名。
password String SIP 运营商提供的 SIP 账号的密码。
auth_name String SIP 运营商提供的认证名称。
enb_outbound_proxy Integer 是否启用了呼出代理服务器。
  • 0：禁用
  • 1：启用
outbound_proxy_server String 呼出代理服务器的域名 / IP 地址。
outbound_proxy_port Integer 呼出代理服务器的端口。
codec_sel String 中继的语音编码设置。
def_outbound_cid String 默认的去电显示号码。
def_outbound_cid_name String 默认的去电显示名称。
outbound_cid_list Array <OutCaller_Info> 为分机自定义的去电显示信息。
did_list Array <DID_List> 中继绑定的 DID 信息。
OutCaller_Info
表 4.
参数 类型 说明
id Integer 去电显示号码条目的唯一 ID。
outbound_cid_option String 去电显示号码的类型。
  • range：分机范围对应去电显示号码范围。
  • shared：一到多个分机使用一个去电显示号码。
outbound_cid String 去电显示号码。
outbound_cid_name String 去电显示名称。
outbound_cid_to_ext_range String 去电显示号码范围对应的分机范围。
注： 仅当 outbound_cid_option 设置为 range时，才会显示此参数。
ext_list Array <Extension_Info> 绑定的分机信息。
注： 仅当 outbound_cid_option 设置为 shared时，才会显示此参数。
outbound_cid_label String 去电显示号码的默认标签。
表 5. Extension_Info
参数 类型 说明
id Integer 分机 ID 或分机组 ID。
type String 分机或分机组。
  • extension：分机
  • ext_group：分机组
ext_number String 分机号码或分机组名称。
ext_name String 分机名称或分机组名称。
DID_List
表 6.
参数 类型 说明
id Integer DID 条目的唯一 ID。
did String 中继绑定的 DID 号码。
did_name String 中继绑定的 DID 名称。
点对点中继
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Array <Trunk_Info> 中继详细信息。
Trunk_Info
表 7.
参数 类型 说明
id Integer 中继的唯一 ID。
name String 中继名称。
enable Integer 中继是否启用。

  • 0：禁用

  • 1：启用
country String SIP 运营商所在的国家。
itsp String SIP 运营商。
type String 中继类型。
  • peer：点对点中继
transport String 传输协议。
hostname String SIP 运营商的域名/ IP 地址。
port Integer SIP 中继注册端口。
domain String SIP 运营商的域名/ IP 地址。
codec_sel String 中继的语音编码设置。
def_outbound_cid String 默认的去电显示号码。
def_outbound_cid_name String 默认的去电显示名称。
outbound_cid_list Array <OutCaller_Info> 为分机自定义的去电显示信息。
did_list Array <DID_List> 中继绑定的 DID 信息。
OutCaller_Info
表 8.
参数 类型 说明
id Integer 去电显示号码条目的唯一 ID。
outbound_cid_option String 去电显示号码的类型。
  • range：分机范围对应去电显示号码范围。
  • shared：一到多个分机使用一个去电显示号码。
outbound_cid String 去电显示号码。
outbound_cid_name String 去电显示名称。
outbound_cid_to_ext_range String 去电显示号码范围对应的分机范围。
注： 仅当 outbound_cid_option 设置为 range时，才会显示此参数。
ext_list Array <Extension_Info> 绑定的分机信息。
注： 仅当 outbound_cid_option 设置为 shared时，才会显示此参数。
outbound_cid_label String 去电显示号码的默认标签。
Extension_Info
表 9.
参数 类型 说明
id Integer 分机 ID 或分机组 ID。
type String 分机或分机组。
  • extension：分机
  • ext_group：分机组
ext_number String 分机号码或分机组名称。
ext_name String 分机名称或分机组名称。
DID_List
表 10.
参数 类型 说明
id Integer DID 条目的唯一 ID。
did String 中继绑定的 DID 号码。
did_name String 中继绑定的 DID 名称。
账号中继
表 11.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Array <Trunk_Info> 中继详细信息。
Trunk_Info
表 12.
参数 类型 说明
id Integer 中继的唯一 ID。
name String 中继名称。
enable Integer 中继是否启用。

  • 0：禁用

  • 1：启用
country String SIP 运营商所在的国家。
itsp String SIP 运营商。
type String 中继类型。
  • account：账号中继
transport String 传输协议。
username String SIP 账号中继的用户名。
password String 与用户名匹配的密码。
auth_name String 供第三方设备注册的认证名称。
codec_sel String 中继的语音编码设置。
def_outbound_cid String 默认的去电显示号码。
def_outbound_cid_name String 默认的去电显示名称。
outbound_cid_list Array <OutCaller_Info> 为分机自定义的去电显示信息。
OutCaller_Info
表 13.
参数 类型 说明
id Integer 去电显示号码条目的唯一 ID。
outbound_cid_option String 去电显示号码的类型。
  • range：分机范围对应去电显示号码范围。
  • shared：一到多个分机使用一个去电显示号码。
outbound_cid String 去电显示号码。
outbound_cid_name String 去电显示名称。
outbound_cid_to_ext_range String 去电显示号码范围对应的分机范围。
注： 仅当 outbound_cid_option 设置为 range 时，才会显示此参数。
ext_list Array <Extension_Info> 绑定的分机信息。
注： 仅当 outbound_cid_option 设置为 shared时，才会显示此参数。
outbound_cid_label String 去电显示号码的默认标签。
Extension_Info
表 14.
参数 类型 说明
id Integer 分机 ID 或分机组 ID。
type String 分机或分机组。
  • extension：分机
  • ext_group：分机组
ext_number String 分机号码或分机组名称。
ext_name String 分机名称或分机组名称。

示例

请求示例

查询 SIP 中继 (ID: "8") 的详细信息。

GET /openapi/v1.0/trunk/get?id=8&access_token=lLWhMzGKmWFQ4gNztelxaRq9voCj9PaU HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 8,
        "name": "Local_Calls",
        "enable": 1,
        "country": "general",
        "type": "register",
        "transport": "udp",
        "hostname": "abc.provider.com",
        "port": 5060,
        "domain": "abc.provider.com",
        "username": "6701",
        "password": "0T9crrZ0gx",
        "auth_name": "mubJwYEWs9",
        "enb_outbound_proxy": 0,
        "outbound_proxy_server": "",
        "outbound_proxy_port": 0,
        
        "codec_sel": "ulaw,alaw,g729",
        "def_outbound_cid": "",
        "def_outbound_cid_name": "",
        "outbound_cid_list": [
            {
                "id": 11,
                "outbound_cid_option": "shared",
                "outbound_cid": "5503302",
                "outbound_cid_name": "Sales",
                "ext_list": [
                    {
                        "ext_number": "Sales",
                        "ext_name": "Sales",
                        "type": "ext_group",
                        "id": 7
                    }
                ],
               "outbound_cid_label": "Yeastar Sales" 
            }
        ],
        "did_list": [
            {
                "id": 8,
                "did": "5503300",
                "did_name": "Sales"
            }
        ]
    }
}