查询单个中继信息

注册中继

表 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) 中复用。
ignore_100_response	Integer	PBX 是否忽略 100 Trying 响应。 0：禁用。 1：启用。
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：启用。
registration_attempts	Integer	中继注册失败时系统自动重试的次数。 注： 该字段仅在查询共享中继时返回。
default_registration_time	Integer	默认的注册有效期 (单位：秒)。 注： 该字段仅在查询共享中继时返回。
custom_sip_headers	Array<Custom_SIP_Headers>	通过此中继送出的外线呼出的 SIP INVITE 消息中将包含的自定义 SIP 头及其对应值。 注： 该字段仅在查询共享中继时返回。
refer_to_support	Integer	PBX 是否能够处理通过此中继接收到的 SIP REFER 请求。 0：禁用。 1：启用。
refer_to_mode_list	Array<String>	允许的由 REFER 请求触发的盲转目的地类型。 external_number internal_number
refer_to_prefix	String	由 REFER 请求触发的盲转所用的呼出路由的前缀。
outbound_failover_sip_code	String	指定触发自动切换至同一呼出路由的下一条中继并重新发起呼叫的 SIP 响应码。 default：默认。 注： 默认的 SIP 码包括 408、500、502、503、513、555 和 580。 custom：自定义。
sip_codes	String	触发自动切换至同一呼出路由中的下一条中继并重新发起呼叫的自定义 SIP 响应码。
use_register_ip_for_sip_request	Integer	PBX 是否将后续 SIP 请求发送至注册时使用的 IP 地址。 0：禁用。 1：启用。
enb_rtp_keepalive	Integer	PBX 是否在中继上 10 秒内未传输任何 RTP 包时发送一个 CN 帧进行防火墙穿透，以确保通话期间 RTP 流量正常传输。 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	去电显示号码的短号。

表 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 名称。

Custom_SIP_Headers

参数	类型	说明
key	String	自定义 SIP 头的名称。
value	String	自定义 SIP 头携带的值。

点对点中继

参数	类型	说明
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：启用。
custom_sip_headers	Array<Custom_SIP_Headers>	通过此中继送出的外线呼出的 SIP INVITE 消息中将包含的自定义 SIP 头及其对应值。 注： 该字段仅在查询共享中继时返回。
refer_to_support	Integer	PBX 是否能够处理通过此中继接收到的 SIP REFER 请求。 0：禁用。 1：启用。
refer_to_mode_list	Array<String>	允许的由 REFER 请求触发的盲转目的地类型。 external_number internal_number
refer_to_prefix	String	由 REFER 请求触发的盲转所用的呼出路由的前缀。
outbound_failover_sip_code	String	指定触发自动切换至同一呼出路由的下一条中继并重新发起呼叫的 SIP 响应码。 default：默认。 注： 默认的 SIP 码包括 408、500、502、503、513、555 和 580。 custom：自定义。
sip_codes	String	触发自动切换至同一呼出路由中的下一条中继并重新发起呼叫的自定义 SIP 响应码。
enb_rtp_keepalive	Integer	PBX 是否在中继上 10 秒内未传输任何 RTP 包时发送一个 CN 帧进行防火墙穿透，以确保通话期间 RTP 流量正常传输。 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 名称。

Custom_SIP_Headers

参数	类型	说明
key	String	自定义 SIP 头的名称。
value	String	自定义 SIP 头携带的值。

账号中继

表 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。
ignore_100_response	Integer	PBX 是否忽略 100 Trying 响应。 0：禁用。 1：启用。
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：启用。
refer_to_support	Integer	PBX 是否能够处理通过此中继接收到的 SIP REFER 请求。 0：禁用。 1：启用。
refer_to_mode_list	Array<String>	允许的由 REFER 请求触发的盲转目的地类型。 external_number internal_number
refer_to_prefix	String	由 REFER 请求触发的盲转所用的呼出路由的前缀。
outbound_failover_sip_code	String	指定触发自动切换至同一呼出路由的下一条中继并重新发起呼叫的 SIP 响应码。 default：默认。 注： 默认的 SIP 码包括 408、500、502、503、513、555 和 580。 custom：自定义。
sip_codes	String	触发自动切换至同一呼出路由中的下一条中继并重新发起呼叫的自定义 SIP 响应码。

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/get?id=8&access_token=lLWhMzGKmWFQ4gNztelxaRq9voCj9PaU 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,
        "ignore_100_response": 0,
        "force_dod_from": 1,
        "enb_send_302_on_cf_external": 0,
        "registration_attempts": 5,
        "default_registration_time": 1800,
        "custom_sip_headers": [
            {
                "key": "X-Account-Code",
                "value": "123456,654321"
            },
            {
                "key": "X-Origin",
                "value": "PBX_Office_1"
            },
            {
                "key": "X-Agent-ID",
                "value": "Agent_007"
            }
        ],
        "refer_to_support": 1,
        "refer_to_mode_list": [
            "external_number",
            "internal_number"
        ],
        "refer_to_prefix": "55",
        "outbound_failover_sip_code": "custom",
        "sip_codes": "408;480;500;502;503;513;555;580", 
        "use_register_ip_for_sip_request": 0,
        "enb_rtp_keepalive": 0
    }
}