创建共享中继

创建注册中继或点对点中继，用于中继共享。

请求 URL

POST {base_url}/dm/open_api/v1/shared_trunk

请求参数

请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
根据不同类型的 SIP 中继，发送对应的请求参数。
创建注册中继
参数 是否必填 类型 说明
name 是 String 设置共享中继的名称。
系统会自动添加一个 6 位随机后缀 (例如 _M8D90A)，以确保名称的唯一性。
注：
  • 名称不能超过 56 个字符。
  • 名称设置后将不可更改。
enable 是 Integer 是否启用中继。
取值范围：
  • 0：禁用。
  • 1：启用。
regionId 是 Integer 共享中继所属区域的 ID。
注： 可使用 查询可用区域 接口查询区域 ID。
country 是 String SIP 运营商所属国家。
注：
  • 可使用 查询共享中继的 SIP 运营商 接口查询支持的 SIP 运营商。
  • 如果查询未返回你的 SIP 运营商，可以将此参数设置为 general 以创建一条通用的 SIP 中继。
itsp 否 String 所选国家中支持的 SIP 运营商的名称。
注： 可使用 查询共享中继的 SIP 运营商 接口查询支持的 SIP 运营商信息。
remark 否 String 中继的备注。
type 是 String 中继类型。

取值范围：

  • register：注册中继。
transport 是 String 传输协议：

取值范围：

  • udp：UDP。
  • tcp：TCP。
  • tls：TLS。
  • dnsnaptr：DNS-NAPTR。
hostname 是 String SIP 运营商提供的中继域名或 IP 地址。
port 是 Integer SIP 运营商提供的 SIP 中继的注册端口。
domain 是 String SIP 运营商提供的中继域名或 IP 地址。
backupHostname 否 String 可选的备用主机名，用于接受来自 SIP 运营商备用地址 (非主地址) 的 SIP 信令，适用于使用多个信令地址的 SIP 运营商。

格式：{域名/IP 地址}:{端口}。

注：
  • 此参数仅在 P 系列云 PBX 的固件为 84.19.0.110 或更高版本时生效。
  • 使用半角逗号 , 分隔多个主机名。例如，47.47.47.47:5060,test.example.xyz:5060。
  • 总长度不能超过 255 个字符。
username 是 String SIP 运营商提供的注册中继的账号名称。
password 是 String 与注册中继的账号关联的密码。
authName 否 String SIP 运营商提供的中继的认证名称。
enbOutboundProxy 否 Integer 是否启用呼出代理服务器。
取值范围：
  • 0：禁用。
  • 1：启用。
outboundProxyServer 否 String 呼出代理服务器的域名或 IP 地址。
outboundProxyPort 否 Integer 呼出代理服务器的端口。
codecSel 是 String 编解码设置。
注： 可使用半角逗号 ，分隔多个编解码。
取值范围：
  • ulaw
  • alaw
  • g729
  • g722
  • g726
  • ilbc
  • opus
  • gsm
  • speex
  • adpcm
  • h264
  • h263
  • h263p
  • mpeg4
  • vp8
dtmfMode 是 String 发送 DTMF 的模式。
取值范围：
  • rfc4733：RFC4733 (RFC2833)。
  • info：Info。
  • inband：Inband。
  • auto：Auto。
dtmfFmtp 否 String 设置 DTMF fmtp 的属性值。

取值范围：

  • 0-16
  • 0-15
authErrorSipCode 是 String 指定 SIP 运营商返回的表示鉴权错误的 SIP 错误代码。
注：
  • 你可以输入多达 10 个错误代码。
  • 使用分号 (;) 分隔多个错误代码，如：401;407;403。
authRegisterAttempt 是 Integer 指定 PBX 在收到 SIP 运营商返回的鉴权错误码 (由 authErrorSipCode 参数指定) 后重新发送注册请求的尝试次数。
globalRegisterRetryInterval 是 Integer PBX 在收到 SIP 运营商返回的任意SIP 错误码 (即非 200 的状态码) 后重新发送注册请求的间隔时间 (单位：秒)。
注： 参数值不能小于 5。
enbQualify 是 Integer 是否启用 Qualify，允许系统向 SIP 中继服务器发送 SIP OPTION 报文，以检测其可用性。
取值范围：
  • 0：禁用。
  • 1：启用。
enbSrtp 是 Integer 是否启用 SRTP。
取值范围：
  • 0：禁用。
  • 1：启用。
enbT38Support 是 Integer 是否启用 T.38 支持。
取值范围：
  • 0：禁用。
  • 1：启用。
enbInbandProgress 是 Integer 是否启用 Inband Progress。该设置用于决定当分机通过此中继发起外呼时，云 PBX 如何处理 Early Media (早期媒体)。
取值范围：
  • 0：禁用。PBX 向分机发送 180 Ringing 作为响铃指示，不传输语音流。
  • 1：启用。PBX 向分机发送 183 Session Progress 作为响铃指示，并立即传输语音流，即彩铃。
ignore183WithoutSdp 是 Integer 是否忽略无 SDP 的 183 消息。
取值范围：
  • 0：禁用。PBX 默认会把所有无 SDP 的 183 信息转为带有 SDP 的 183 信息，并进行转发。
  • 1：启用。PBX 不会转发无 SDP 的 183 信息。
transparentTrans180Msg 是 Integer

是否跟随对端消息格式处理 180 消息。

取值范围：
  • 0：禁用。即使对方发送的 180 消息带有 SDP，PBX 也不会转发 180 (SDP) 消息。
  • 1：启用。如果接收到对方发送的带有 SDP 的 180 消息，PBX 将转发 180 (SDP) 消息。
    注： 当 enbInbandProgress 设置为 1 时，此设置不生效。
enbDedicate 是 Integer 是否启用专线中继。
注： 当 SIP 运营商需要使用专用的内网 IP 地址进行连接时，你需要将此参数设为 1，并联系你的 PBX 提供商进行相关网络设置。
取值范围：
  • 0：禁用。
  • 1：启用。
enbSipauthCache 否 Integer 是否启用 SIP 鉴权缓存。
取值范围：
  • 0：禁用。
  • 1：启用。PBX 会缓存已成功的 SIP 鉴权信息，并在同一会话或注册周期内的后续请求 (INVITE 和 BYE) 中复用。
callRestrictionType 是 String 指定受中继最大并发通话数限制的通话类型。
取值范围：
  • outbound：仅呼出的通话并发会受限制。
  • all：呼出和呼入的通话并发都会受限制。
maxCallChans 是 Integer 指定该中继所允许的最大通话并发数。

0 表示无限制。
callerIdFrom 是 String 指定中继从哪里获取显示号码 (Caller ID)。
取值范围：
  • follow_system：跟随云 PBX 的系统设置 (路径：PBX设置 > SIP设置 > 高级 > 来电显示/ DID 获取来源 > 来电显示获取来源)。
  • from：从 From 头域中获取。
  • contact：从 Contact 头域中获取。
  • rpid：从 Remote-Party-ID 头域中获取。
  • pai：从 P-Asserted-Identity 头域中获取。
  • ppi：从 P-Preferred-Identity 头域中获取。
didFrom 是 String 指定中继从哪里获取 DID 号码。
取值范围：
  • follow_system：跟随云 PBX 的系统设置 (路径： PBX设置 > SIP设置 > 高级 > 来电显示/ DID 获取来源 > DID 获取来源)。
  • to：从 To 头域获取。
  • invite：从 INVITE 头域获取。
  • diversion：从 Diversion 头域获取。
  • rpid：从 Remote-Party-ID 头域获取。
  • pai：从 P-Asserted-Identity 头域获取。
  • ppi：从 P-Preferred-Identity 头域获取。
  • pcpid：从 P-Called-Party-ID 头域获取。
fromUserPart 是 String 用于外呼时的主叫号码 (即 SIP From 头域中的用户部分)。
取值范围：
  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 中继用户名
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
fromUser 否 String 自定义主叫号码。
注： 此参数在 fromUserPart 设为 custom 时必填。
fromDispNamePart 是 String 用于外呼时的主叫名称 (即 SIP From 头域中的显示名称部分)。
取值范围：
  • default：默认值，即显示与实际外呼主叫号码关联的名称。
  • ext_cid_name：分机去电显示名称。
  • trunk_def_outbcid_name：中继去电显示名称。
  • ext_outbcid_name：分机在中继中绑定的去电显示名称。
  • originator_cid_name：第一主叫名称。
  • custom：自定义。
fromDispName 否 String 自定义主叫名称。
注： 此参数在 fromDispNamePart 设为 custom 时必填。
diversionUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 Diversion 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。

取值范围：

  • default：默认值。当来电发生转移时，第一主叫呼入的 DID 号码。
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码。
  • custom：自定义。
diversionUser 否 String Diversion 头域字段自定义值。
注： 此参数在 diversionUserPart 设为 custom 时必填。
rpidUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 Remote-Party-ID 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。

取值范围：

  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 中继用户名
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
rpidUser 否 String Remote-Party-ID 头域字段自定义值。
注： 此参数在 rpidUserPart 设为 custom 时必填。
paiUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 P-Asserted-Identity 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。

取值范围：

  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 中继用户名
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
paiUser 否 String P-Asserted-Identity 头域的自定义值。
注： 此参数在 paiUserPart 设为 custom 时必填。
paiUserPartUriFormat 否 String 指定 P-Asserted-Identity 头域的格式。
注： 此参数在 paiUserPart 设为非空字符串 ("") 必填。
取值范围：
  • sip：SIP URI (sip:)。
  • tel：SIP URI (tel:)。
ppiUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 P-Preferred-Identity 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。
取值范围：
  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 中继用户名
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
ppiUser 否 String P-Preferred-Identity 头域的自定义值。
注： 此参数在 ppiUserPart 设为 custom时必填。
userAgent 否 String 指定用于身份验证的用户代理信息。
注： 如果 SIP 运营商需要用户代理进行身份验证，请输入由 SIP 运营商提供的用户代理信息。
realm 否 String 指定用于 SIP 通信中验证用户凭据的认证域（Realm）。
注： 如果不确定此信息，请联系 SIP 运营商获取指导。
enb100Rel 是 Integer 为中继设置 100rel。

取值范围：

  • 0：禁用。此中继禁用 100rel。
  • 1：支持。此中继支持使用 100rel。
  • 2：需要对端支持。此中继要求使用 100rel，需要对端设备支持该功能。
maxPtime 是 String 设置 PBX 发出 INVITE 数据包时使用的 maxptime 值。
取值范围：
  • default：默认值。PBX 会根据呼出通话所使用的语音编码发送对应的 maxptime。
  • 自定义值：你可以设置一个 20 到 300 之间、且为 10 的倍数的数值。
enbPrivacyId 是 Integer 是否在 SIP 头域中发送 Privacy ID。
取值范围：
  • 0：禁用。
  • 1：启用。
enbUserPhone 是 Integer 是否在 INVITE 包的 SIP 头域中增加 user=phone 的参数。
取值范围：
  • 0：禁用。
  • 1：启用。
enbApiCallId 是 Integer 是否在 SIP INVITE 请求中包含 X-OpenAPI-Call-ID 字段以携带通话的 Call ID。
取值范围：
  • 0：禁用。
  • 1：启用。
enbEarlyMedia 是 Integer 是否在 SIP INVITE 请求中包含 P-Early-Media 字段。
取值范围：
  • 0：禁用。
  • 1：启用。
enbEarlyMediaFor183 是 Integer 是否在通过此中继呼入的通话的 183 消息中包含值为 sendrecv 的 P-Early-Media 字段。
取值范围：
  • 0：禁用。
  • 1：启用。
创建点对点中继
参数 是否必填 类型 说明
name 是 String 设置共享中继的名称。
系统会自动添加一个 6 位随机后缀 (例如 _M8D90A)，以确保名称的唯一性。
注：
  • 名称不能超过 56 个字符。
  • 名称设置后将不可更改。
enable 是 Integer 是否启用中继。
取值范围：
  • 0：禁用。
  • 1：启用。
regionId 是 Integer 共享中继所属区域的 ID。
注： 可使用 查询可用区域 接口查询区域 ID。
country 是 String SIP 运营商所属国家。
注：
  • 可使用 查询共享中继的 SIP 运营商 接口查询支持的 SIP 运营商。
  • 如果查询未返回你的 SIP 运营商，可以将此参数设置为 general 以创建一条通用的 SIP 中继。
itsp 否 String 所选国家中支持的 SIP 运营商的名称。
注： 可使用 查询共享中继的 SIP 运营商 接口查询支持的 SIP 运营商信息。
remark 否 String 中继的备注。
type 是 String 中继类型。

取值范围：

  • did_based：点对点中继 (基于 DID)。
  • port_based：点对点中继 (基于端口)。
transport 是 String 传输协议。

取值范围：

  • 针对点对点中继 (基于 DID)：
    • udp：UDP。
    • tcp：TCP。
  • 针对点对点中继 (基于端口)：
    • udp：UDP。
hostname 是 String SIP 运营商提供的中继域名或 IP 地址。
port 是 Integer SIP 运营商提供的 SIP 中继的注册端口。
domain 是 String SIP 运营商提供的中继域名或 IP 地址。
backupHostname 否 String 可选的备用主机名，用于接受来自 SIP 运营商备用地址 (非主地址) 的 SIP 信令，适用于使用多个信令地址的 SIP 运营商。

格式：{域名/IP 地址}:{端口}。

注：
  • 此参数仅在 P 系列云 PBX 的固件为 84.19.0.110 或更高版本时生效。
  • 使用半角逗号 , 分隔多个主机名。例如，47.47.47.47:5060,test.example.xyz:5060。
  • 总长度不能超过 255 个字符。
failoverServersList 否 Array <Failover_Server> 用于故障转移的 SIP 运营商备用服务器信息列表。
注： 如果你的 SIP 运营商提供了备用服务器，可在此参数中填写服务器信息。
codecSel 是 String 编解码设置。
注： 可使用半角逗号 ，分隔多个编解码。
取值范围：
  • ulaw
  • alaw
  • g729
  • g722
  • g726
  • ilbc
  • opus
  • gsm
  • speex
  • adpcm
  • h264
  • h263
  • h263p
  • mpeg4
  • vp8
dtmfMode 是 String 发送 DTMF 的模式。
取值范围：
  • rfc4733：RFC4733 (RFC2833)。
  • info：Info。
  • inband：Inband。
  • auto：Auto。
dtmfFmtp 否 String 设置 DTMF fmtp 的属性值。

取值范围：

  • 0-16
  • 0-15
enbQualify 是 Integer 是否启用 Qualify，允许系统向 SIP 中继服务器发送 SIP OPTION 报文，以检测其可用性。
取值范围：
  • 0：禁用。
  • 1：启用。
enbSrtp 是 Integer 是否启用 SRTP。
取值范围：
  • 0：禁用。
  • 1：启用。
enbT38Support 是 Integer 是否启用 T.38 支持。
取值范围：
  • 0：禁用。
  • 1：启用。
enbInbandProgress 是 Integer 是否启用 Inband Progress。该设置用于决定当分机通过此中继发起外呼时，云 PBX 如何处理 Early Media (早期媒体)。
取值范围：
  • 0：禁用。PBX 向分机发送 180 Ringing 作为响铃指示，不传输语音流。
  • 1：启用。PBX 向分机发送 183 Session Progress 作为响铃指示，并立即传输语音流，即彩铃。
ignore183WithoutSdp 是 Integer 是否忽略无 SDP 的 183 消息。
取值范围：
  • 0：禁用。PBX 默认会把所有无 SDP 的 183 信息转为带有 SDP 的 183 信息，并进行转发。
  • 1：启用。PBX 不会转发无 SDP 的 183 信息。
transparentTrans180Msg 是 Integer

是否跟随对端消息格式处理 180 消息。

取值范围：
  • 0：禁用。即使对方发送的 180 消息带有 SDP，PBX 也不会转发 180 (SDP) 消息。
  • 1：启用。如果接收到对方发送的带有 SDP 的 180 消息，PBX 将转发 180 (SDP) 消息。
    注： 当 enbInbandProgress 设置为 1 时，此设置不生效。
enbDedicate 是 Integer 是否启用专线中继。
注： 当 SIP 运营商需要使用专用的内网 IP 地址进行连接时，你需要将此参数设为 1，并联系你的 PBX 提供商进行相关网络设置。
取值范围：
  • 0：禁用。
  • 1：启用。
callRestrictionType 是 String 指定受中继最大并发通话数限制的通话类型。
取值范围：
  • outbound：仅呼出的通话并发会受限制。
  • all：呼出和呼入的通话并发都会受限制。
maxCallChans 是 Integer 指定该中继所允许的最大通话并发数。

0 表示无限制。
callerIdFrom 是 String 指定中继从哪里获取显示号码 (Caller ID)。
取值范围：
  • follow_system：跟随云 PBX 的系统设置 (路径：PBX设置 > SIP设置 > 高级 > 来电显示/ DID 获取来源 > 来电显示获取来源)。
  • from：从 From 头域中获取。
  • contact：从 Contact 头域中获取。
  • rpid：从 Remote-Party-ID 头域中获取。
  • pai：从 P-Asserted-Identity 头域中获取。
  • ppi：从 P-Preferred-Identity 头域中获取。
didFrom 是 String 指定中继从哪里获取 DID 号码。
取值范围：
  • follow_system：跟随云 PBX 的系统设置 (路径： PBX设置 > SIP设置 > 高级 > 来电显示/ DID 获取来源 > DID 获取来源)。
  • to：从 To 头域获取。
  • invite：从 INVITE 头域获取。
  • diversion：从 Diversion 头域获取。
  • rpid：从 Remote-Party-ID 头域获取。
  • pai：从 P-Asserted-Identity 头域获取。
  • ppi：从 P-Preferred-Identity 头域获取。
  • pcpid：从 P-Called-Party-ID 头域获取。
fromUserPart 是 String 指定用于外呼时的主叫号码 (即 SIP From 头域中的用户部分)。
取值范围：
  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
fromUser 否 String 自定义主叫号码。
注： 此参数在 fromUserPart 设为 custom 时必填。
fromDispNamePart 是 String 用于外呼时的主叫名称 (即 SIP From 头域中的显示名称部分)。
取值范围：
  • default：默认值，即显示与实际外呼主叫号码关联的名称。
  • ext_cid_name：分机去电显示名称。
  • trunk_def_outbcid_name：中继去电显示名称。
  • ext_outbcid_name：分机在中继中绑定的去电显示名称。
  • originator_cid_name：第一主叫名称。
  • custom：自定义。
fromDispName 否 String 自定义主叫名称。
注： 此参数在 fromDispNamePart 设为 custom 时必填。
fromDomainPart 是 String 指定 SIP INVITE 中 From 头域所使用的域名或 IP 地址。
取值范围：
  • default：使用在 domain 参数中配置的域名或 IP 地址。
  • custom：使用自定义的域名或 IP 地址。
fromDomainValue 否 String 自定义域名或 IP 地址。
注： 此参数在 fromDomainPart 设为 custom 时必填。
toDomainPart 是 String 指定 SIP INVITE 中 To 头域所使用的域名或 IP 地址。
取值范围：
  • default：使用在 domain 参数中配置的域名或 IP 地址。
  • custom：使用自定义的域名或 IP 地址。
toDomainValue 否 String 自定义域名或 IP 地址。
注： 此参数在 toDomainPart 设为 custom 时必填。
diversionUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 Diversion 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。
  • default：默认值。当来电发生转移时，第一主叫呼入的 DID 号码。
  • ext_cid：分机去电显示号码。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码。
  • custom：自定义。
diversionUser 否 String Diversion 头域字段自定义值。
注： 此参数在 diversionUserPart 设为 custom 时必填。
rpidUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 Remote-Party-ID 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。
  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
rpidUser 否 String Remote-Party-ID 头域字段自定义值。
注： 此参数在 rpidUserPart 设为 custom 时必填。
paiUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 P-Asserted-Identit 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。

取值范围：

  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
paiUser 否 String P-Asserted-Identity 头域的自定义值。
注： 此参数在 paiUserPart 设为 custom 时必填。
paiUserPartUriFormat 否 String 指定 P-Asserted-Identity 头域的格式。
注： 此参数在 paiUserPart 设为非空字符串 ("") 必填。
取值范围：
  • sip：SIP URI (sip:)。
  • tel：SIP URI (tel:)。
ppiUserPart 是 String 定义用于外呼时在 SIP INVITE 数据包中携带的 P-Preferred-Identity 头域的值。
注： 若不想在 SIP INVITE 数据包中包含此头域，需将此参数设置为空 ("")。
  • default：默认值。PBX 按从上到下的优先级取值：
    • 呼出路由去电显示号码
    • 分机在中继中绑定的去电显示号码
    • 中继去电显示号码
    • 分机去电显示号码
    • 第一主叫号码
  • ext_cid：分机去电显示号码。
  • trunk_user：中继用户名。
  • trunk_def_outbcid：中继去电显示号码。
  • ext_outbcid：分机在中继中绑定的去电显示号码。
  • outrounter_outbcid：呼出路由去电显示号码。
  • originator_cid：第一主叫号码 (即发起呼叫的主叫 ID)。
  • custom：自定义。
ppiUser 否 String P-Preferred-Identity 头域的自定义值。
注： 此参数在 ppiUserPart 设为 custom时必填。
userAgent 否 String 指定用于身份验证的用户代理信息。
注： 如果 SIP 运营商需要用户代理进行身份验证，请输入由 SIP 运营商提供的用户代理信息。
enb100Rel 是 Integer 为中继设置 100rel。

取值范围：

  • 0：禁用。此中继禁用 100rel。
  • 1：支持。此中继支持使用 100rel。
  • 2：需要对端支持。此中继要求使用 100rel，需要对端设备支持该功能。
maxPtime 是 String 设置 PBX 发出 INVITE 数据包时使用的 maxptime 值。
取值范围：
  • default：默认值。PBX 会根据呼出通话所使用的语音编码发送对应的 maxptime。
  • 自定义值：你可以设置一个 20 到 300 之间、且为 10 的倍数的数值。
enbPrivacyId 是 Integer 是否在 SIP 头域中发送 Privacy ID。
取值范围：
  • 0：禁用。
  • 1：启用。
enbUserPhone 是 Integer 是否在 INVITE 包的 SIP 头域中增加 user=phone 的参数。
取值范围：
  • 0：禁用。
  • 1：启用。
enbApiCallId 是 Integer 是否在 SIP INVITE 请求中包含 X-OpenAPI-Call-ID 字段以携带通话的 Call ID。
取值范围：
  • 0：禁用。
  • 1：启用。
enbEarlyMedia 是 Integer 是否在 SIP INVITE 请求中包含 P-Early-Media 字段。
取值范围：
  • 0：禁用。
  • 1：启用。
enbEarlyMediaFor183 是 Integer 是否在通过此中继呼入的通话的 183 消息中包含值为 sendrecv 的 P-Early-Media 字段。
取值范围：
  • 0：禁用。
  • 1：启用。
Failover_Server
参数 是否必填 类型 说明
host 是 String 备用服务器的域名或 IP 地址。
port 是 Integer 备用服务器的注册端口。
domain 是 String 备用服务器的域名或 IP 地址。

响应参数

参数 类型 说明
data Object <Details> 详情。
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。
Details
参数 类型 说明
id Integer 共享中继的 ID。

示例

请求示例

  • 创建一条注册中继。
    POST /dm/open_api/v1/shared_trunk HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******
Content-Type: application/json
{
    "name": "register-test",
    "enable": 1,
    "regionId": 20,
    "country": "general",
    "itsp": "",
    "remark": "remark",
    "type": "register",
    "transport": "udp",
    "hostname": "1.1.1.1",
    "port": 5060,
    "domain": "1.1.1.1",
    "username": "username",
    "password": "cGFzc3dvcmQ=",
    "authName": "",
    "enbOutboundProxy": 0,
    "codecSel": "gsm,h264,h263,h263p,ilbc",
    "dtmfMode": "rfc4733",
    "dtmfFmtp": "0-16",
    "authErrorSipCode": "401;407;403",
    "authRegisterAttempt": 3,
    "globalRegisterRetryInterval": 20,
    "enbQualify": 0,
    "enbSrtp": 0,
    "enbT38Support": 0,
    "enbInbandProgress": 0,
    "ignore183WithoutSdp": 0,
    "transparentTrans180Msg": 0,
    "enbDedicate": 1,
    "callRestrictionType": "outbound",
    "maxCallChans": 0,
    "callerIdFrom": "follow_system",
    "didFrom": "pcpid",
    "fromUserPart": "default",
    "fromUser": "",
    "fromDispNamePart": "ext_cid_name",
    "fromDispName": "",
    "diversionUserPart": "",
    "rpidUserPart": "",
    "paiUserPart": "",
    "paiUserPartUriFormat": "tel",
    "ppiUserPart": "custom",
    "ppiUser": "custom",
    "userAgent": "user agent",
    "realm": "real",
    "enb100Rel": 1,
    "maxPtime": "100",
    "enbPrivacyId": 0,
    "enbUserPhone": 1,
    "enbApiCallId": 0,
    "enbEarlyMedia": 1,
    "enbEarlyMediaFor183": 1,
    "enbSipauthCache":1    
}
  • 创建一条点对点中继。
    POST /dm/open_api/v1/shared_trunk HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer ******
Content-Type: application/json

{
    "name": "peer-general-ap-2",
    "enable": 1,
    "regionId": 20,
    "country": "general",
    "itsp": "",
    "remark": "general peer trunk",
    "type": "port_based",
    "transport": "udp",
    "hostname": "5.5.5.5",
    "port": 5060,
    "domain": "5.5.5.5",
    "codecSel": "ulaw,alaw,g729",
    "dtmfMode": "rfc4733",
    "dtmfFmtp": "0-16",
    "enbQualify": 1,
    "enbSrtp": 0,
    "enbT38Support": 0,
    "enbInbandProgress": 0,
    "ignore183WithoutSdp": 0,
    "transparentTrans180Msg": 0,
    "enbDedicate": 0,
    "callRestrictionType": "outbound",
    "maxCallChans": 0,
    "callerIdFrom": "follow_system",
    "didFrom": "follow_system",
    "fromUserPart": "default",
    "fromDispNamePart": "custom",
    "fromDispName": "test",
    "fromDomainPart": "default",
    "toDomainPart": "default",
    "diversionUserPart": "",
    "diversionUser": "",
    "rpidUserPart": "",
    "rpidUser": "",
    "paiUserPart": "",
    "paiUser": "",
    "ppiUserPart": "",
    "ppiUser": "",
    "userAgent": "tredt",
    "enb100Rel": 0,
    "maxPtime": "default",
    "enbPrivacyId": 0,
    "enbUserPhone": 0,
    "enbApiCallId": 0,
    "enbEarlyMedia": 0,
    "enbEarlyMediaFor183": 0
}

响应示例

{
    "data": {
        "id": 6692
    },
    "requestId": "9fe88e3fd0437a97166f6cee45db28ec",
    "status": "Success",
    "time": 1747187155
}