查询中继列表

查询 PBX 的中继列表信息。

请求 URL

GET {base_url}/{api_path}/trunk/list?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：降序

响应参数

表 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_did
  • peer_port
  • peer_private
  • account
host_port String 域名/ IP 地址和端口。
def_outbound_cid String 去电显示号码。
username String 用户名。
注： 此字段仅在中继类型为 register 或 account 时返回。
Trunk status
表 4.
状态码 说明
0 未知状态。
1 空闲。
2 忙碌。
3 SIP 中继空闲但未监控。
4 SIP 中继注册中。
41 SIP 注册中继注册失败。
42 SIP 中继网络不可达。
43 SIP 账号中继不可用。
44 SIP 中继被禁用。
45 SIP 注册中继鉴权失败。

示例

请求示例

GET /openapi/v1.0/trunk/list?page=1&page_size=20&sort_by=id&order_by=asc&access_token=ibKIdUFs0r7uARhRzrMg8TTOfiZPtaav HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 3,
    "data": [
        {
            "id": 8,
            "status": 41,
            "name": "Local_Calls",
            "type": "register",
            "host_port": "abc.provider.com:5060",
            "username": "6701",
            "def_outbound_cid": "5503300"
        },
        {
            "id": 9,
            "status": 4,
            "name": "International_Calls",
            "type": "peer_did",
            "host_port": "test.provider.com:5060",
            "def_outbound_cid": "5502283"
        },
        {
            "id": 12,
            "status": 43,
            "name": "ToPAE",
            "type": "account",
            "username": "6700"
        }
    ]
}