添加 SIP 中继
添加并设置 SIP 中继。
请求地址
{base_url}/{api_path}/trunk/add_siptrunk?token={token}请求参数
根据不同类型的中继，需要发送不同的请求参数。
- 添加注册中继
-
参数 是否必选 类型 描述 trunkname 是 String 中继名称。 trunktype 是 String 中继类型。 取值：
register：注册中继。
host 是 String SIP 运营商的域名或 IP 地址。 port 是 String 中继的 SIP 端口。 默认值：5060。
domain 是 String SIP 运营商的域名或 IP 地址。 username 是 String SIP 运营商提供的 SIP 账号。 authname 是 String SIP 运营商提供的 SIP 账号。 fromuser 否 String From 头域。 注： 如果 SIP 运营商不支持，则放空。password 是 String SIP 账号的密码。 extensionsdod 否 String 分机绑定的 DOD 号码。
取值范围：
- 单个 DOD 号码：
格式：
"extensionsdod": "{dod_number}-{dod_name}-{extension_number}"示例：
"extensionsdod":"5503301-yeastar-1000"
- 多个 DOD
号码：
格式：
多个 DOD 号码用半角逗号（,）隔开。"extensionsdod":"{dod_number}-{dod_name}-{extension_number}"示例：
"extensionsdod":"5503301-yeastar-1000,5503302-yeastar-1001"
extensionsgroupdod 否 String 分机组绑定的 DOD 号码。 取值范围：
- 单个 DOD 号码：
格式：
"extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}示例：
"extensionsgroupdod":"5503301-yeastar-sales"
- 多个 DOD
号码：
格式：
多个 DOD 号码用半角逗号（,）隔开。"extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}示例：
"extensionsgroupdod":"5503301-yeastar-sales,5503302-yeastar-support"
- 单个 DOD 号码：
- 添加点对点中继
-
参数 类型 描述 trunkname String 中继名称。 trunktype String 中继类型。 取值：
peer：点对点中继。
host String SIP 运营商的域名或 IP 地址。 port String 中继的 SIP 端口。 默认值：5060。
domain String SIP 运营商的域名或 IP 地址。 extensionsdod String 分机绑定的 DOD 号码。
取值范围：
- 单个 DOD 号码：
格式：
"extensionsdod": "{dod_number}-{dod_name}-{extension_number}"示例：
"extensionsdod":"5503301-yeastar-1000"
- 多个 DOD
号码：
格式：
多个 DOD 号码用半角逗号（,）隔开。"extensionsdod":"{dod_number}-{dod_name}-{extension_number}"示例：
"extensionsdod":"5503301-yeastar-1000,5503302-yeastar-1001"
extensionsgroupdod String 分机组绑定的 DOD 号码。 取值范围：
- 单个 DOD 号码：
格式：
"extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}示例：
"extensionsgroupdod":"5503301-yeastar-sales"
- 多个 DOD
号码：
格式：
多个 DOD 号码用半角逗号（,）隔开。"extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}示例：
"extensionsgroupdod":"5503301-yeastar-sales,5503302-yeastar-support"
- 单个 DOD 号码：
- 添加账号中继
-
参数 类型 描述 trunkname String 中继名称。 trunktype String 中继类型。 取值：
account：账号中继。
username String 账号中继的用户名。 authname String 账号中继的认证名。 password String 账号中继的密码。 extensionsdod String 分机绑定的 DOD 号码。
取值范围：
- 单个 DOD 号码：
格式：
"extensionsdod": "{dod_number}-{dod_name}-{extension_number}"示例：
"extensionsdod":"5503301-yeastar-1000"
- 多个 DOD
号码：
格式：
多个 DOD 号码用半角逗号（,）隔开。"extensionsdod":"{dod_number}-{dod_name}-{extension_number}"示例：
"extensionsdod":"5503301-yeastar-1000,5503302-yeastar-1001"
extensionsgroupdod String 分机组绑定的 DOD 号码。 取值范围：
- 单个 DOD 号码：
格式：
"extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}示例：
"extensionsgroupdod":"5503301-yeastar-sales"
- 多个 DOD
号码：
格式：
多个 DOD 号码用半角逗号（,）隔开。"extensionsgroupdod":"{dod_number}-{dod_name}-{extension_group_name}示例：
"extensionsgroupdod":"5503301-yeastar-sales,5503302-yeastar-support"
- 单个 DOD 号码：
响应参数
| 参数 | 类型 | 描述 |
|---|---|---|
| id | Integer | 中继的唯一 ID。 |
| status | String | 请求结果。
|
示例
请求示例
添加一个注册类型的中继，中继名称为“Trunk1”。
POST /api/v2.0.0/trunk/add_siptrunk?token=277ac400357b509b4a587ff2157f7ad5 Content-Type:application/json; charset=utf-8 Host: 192.168.5.150 { "trunkname": "Trunk1", "trunktype": "register", "host": "192.168.12.161", "port": "5060", "domain": "192.168.12.161", "username": "1001", "authname": "1001", "password": "Pajsjx9183", }
响应示例
中继添加成功后，系统会为中继自动分配一个 id。
HTTP/1.1 200 OK Server: Boa/0.94.14rc21 Accept-Ranges: bytes Connection: close Content-Type: application/json Access-control-allow-origin: * Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE { "id": "10", "status": "Success" }