搜索特定中继

在中继列表中搜索特定中继。

请求 URL

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

请求参数

1.
参数 是否必填 类型 说明
page Integer 定义显示第几个页面。
page_size Integer 定义每页显示几项查询结果。
sort_by String 定义排序字段。

取值范围

  • id
  • name
  • type
  • host_port
  • def_outbound_cid
  • username
order_by String 定义显示顺序。

取值范围

  • asc:升序
  • desc:降序
search_value String 搜索关键字。

响应参数

2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
total_number Integer 搜索到的中继总数量。
data Array <Trunk_Info> 中继信息。
Trunk_Info
3.
参数 类型 说明
id Integer 中继的唯一 ID。
status Integer 中继状态 (Trunk status)
name String 中继名称。
type String 中继类型。
  • register
  • peer
  • account
  • FXO
  • BRI
  • E1
  • J1
  • T1
  • GSM
  • UMTS
  • LTE
  • CDMA
host_port String 域名/ IP 地址和端口。
gsm_signal_level Integer GSM 信号强度。
  • 1:弱
  • 2:中等
  • 3:强
def_outbound_cid String 去电显示号码。
username String 用户名。
注: 此字段仅在中继类型为 registeraccount 时返回。
Trunk status
4.
状态码 说明
0 未知状态。
1 空闲。
2 忙碌。
3 SIP 中继空闲但未监控。
4 SIP 中继注册中。
5 GSM 中继注册中。
11 FXO 口故障。
12 FXO 口未接入 PSTN 线路。
21 E1/BRI 中继不可用:协议层参数配置错误。
22 E1/BRI 中继故障:接口/模块故障。
23 E1/BRI 中继故障:未接线。
31 GSM 模块故障。
32 GSM 模块已关机。
33 GSM 模块未检测到 SIM 卡。
34 GSM 中继无信号。
35 GSM 中继 PIN 码错误。
36 GSM 运营商注册失败。
41 SIP 注册中继注册失败。
42 SIP 中继网络不可达。
43 SIP 账号中继不可用。
44 SIP 中继被禁用。

示例

请求示例

搜索 peer 查找 PBX 上的点对点中继。
GET /openapi/v1.0/trunk/search?search_value=peer&access_token=apz5vsX2UjbOYq1XN9jhFbc4V20mSVuq HTTP/1.1
Host: 192.168.5.150:8088

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "data": [
        {
            "id": 27,
            "status": 1,
            "name": "peer-to-41",
            "type": "peer",
            "host_port": "112.48.19.180:18000",
            "def_outbound_cid": "13200000092"
        }
    ]
}