查询多个中继信息

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

请求 URL

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

请求参数

表 1.
参数	是否必填	类型	说明
ids	是	String	中继的唯一 ID。注：可使用搜索特定中继接口查询中继的 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 信息。
transparent_trans_180_msg	Integer	是否根据对端的 SDP 携带情况，决定本端 180 消息是否包含 SDP。
enb_sipauth_cache	Integer	是否启用了 SIP 鉴权缓存。 `0`：禁用。 `1`：启用。PBX 会缓存已成功的 SIP 鉴权信息，并在同一会话或注册周期内的后续请求 (`INVITE` 和 `BYE`) 中复用。
force_dod_from	Integer	当分机选择特定 DOD 发起外呼时，PBX 是否忽略中继的 From User Part 配置，直接强制使用分机选择的 DOD 号码作为 `From` 头域的值。 `0`：禁用。 `1`：启用。
force_sip_uri_scheme	Integer	PBX 在注册请求中是否强制使用 `sip:` URI 格式替代 `sips:`，从而将 SIP 传输方式从加密传输更改为非加密传输。 `0`：禁用。 `1`：启用。
enb_send_302_on_cf_external	Integer	PBX 在将外线来电前转至外部号码时，是否会向主叫方返回 “302 Moved Temporarily” 响应。 `0`：禁用。 `1`：启用。

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	去电显示号码的默认标签。
outbound_cid_short_code	String	去电显示号码的短号。

Extension_Info

表 5.
参数	类型	说明
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_did`：点对点中继（基于 DID） `peer_port`：点对点中继（基于端口） `peer_private`：点对点中继（私网）
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 信息。
transparent_trans_180_msg	Integer	是否根据对端的 SDP 携带情况，决定本端 180 消息是否包含 SDP。
force_dod_from	Integer	当分机选择特定 DOD 发起外呼时，PBX 是否忽略中继的 From User Part 配置，直接强制使用分机选择的 DOD 号码作为 `From` 头域的值。 `0`：禁用。 `1`：启用。
enb_send_302_on_cf_external	Integer	PBX 在将外线来电前转至外部号码时，是否会向主叫方返回 “302 Moved Temporarily” 响应。 `0`：禁用。 `1`：启用。

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	去电显示号码的默认标签。
outbound_cid_short_code	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>	为分机自定义的去电显示信息。
transparent_trans_180_msg	Integer	是否根据对端的 SDP 携带情况，决定本端 180 消息是否包含 SDP。
force_dod_from	Integer	当分机选择特定 DOD 发起外呼时，PBX 是否忽略中继的 From User Part 配置，直接强制使用分机选择的 DOD 号码作为 `From` 头域的值。 `0`：禁用。 `1`：启用。
enb_send_302_on_cf_external	Integer	PBX 在将外线来电前转至外部号码时，是否会向主叫方返回 “302 Moved Temporarily” 响应。 `0`：禁用。 `1`：启用。

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	去电显示号码的默认标签。
outbound_cid_short_code	String	去电显示号码的短号。

Extension_Info

表 14.
参数	类型	说明
id	Integer	分机 ID 或分机组 ID。
type	String	分机或分机组。 `extension`：分机 `ext_group`：分机组
ext_number	String	分机号码或分机组名称。
ext_name	String	分机名称或分机组名称。

示例

请求示例

GET /openapi/v1.0/trunk/query?ids=8,12&access_token=47I1W4RwMGyDYlXfdymHUqFesJF6QIwi HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

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",
                    "outbound_cid_short_code": "123" 
                }
            ],
            "did_list": [
                {
                    "id": 8,
                    "did": "5503300",
                    "did_name": "Sales"
                }
            ]，
            "transparent_trans_180_msg": 0,
           
           ,
           "enb_sipauth_cache": 1,
            "force_dod_from": 1,
            "enb_send_302_on_cf_external": 1
        },
        {
            "id": 12,
            "name": "ToPAE",
            "enable": 1,
            "country": "general",
            "type": "account",
            "transport": "udp",
            "hostname": "",
            "port": 0,
            "domain": "",
            "username": "6700",
            "password": "HSkQfXVg5V",
            "auth_name": "y7H9V8oFv1",
            "enb_outbound_proxy": 0,
            "outbound_proxy_server": "",
            "outbound_proxy_port": 0,
            "codec_sel": "ulaw,alaw,g729",
            "def_outbound_cid": "5502200",
            "def_outbound_cid_name": "Hotline",
            "transparent_trans_180_msg": 0,
            "outbound_cid_list": [
                {
                    "id": 13,
                    "outbound_cid_option": "shared",
                    "outbound_cid": "5502201",
                    "outbound_cid_name": "Test",
                    "ext_list": [
                        {
                            "ext_number": "Default_All_Extensions",
                            "ext_name": "Default_All_Extensions",
                            "type": "ext_group",
                            "id": 1
                        }
                    ],
                    "outbound_cid_label": "Tech support",
                    "outbound_cid_short_code": "124" 
                },
                {
                    "id": 15,
                    "outbound_cid_option": "range",
                    "outbound_cid": "5503301-5503302",
                    "outbound_cid_name": "",
                    "outbound_cid_to_ext_range": "1001-1002",
                    "outbound_cid_label": "",
                    "outbound_cid_short_code": ""
                }
            ],
            "force_dod_from": 1,
            "enb_send_302_on_cf_external": 0
        }
    ]
}