Query Trunk List

Query the PBX trunk list.

Request URL

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

Request parameters

Table 1.
Parameter Required Type Description
page No Integer Define which page is displayed.
page_size No Integer Define how many records per page.
sort_by No String Define the sorting field.

Valid value:

  • id
  • name
  • type
  • host_port
  • def_outbound_cid
  • username
order_by No String Define the display order.

Valid value:

  • asc: Ascending order
  • desc: Descending order

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
total_number Integer The total number of trunk.
data Array <Trunk_Info> The information of a trunk.
Table 3.
Parameter Type Description
id Integer Trunk ID.
status Integer Trunk status.
name String Trunk name.
type String Trunk type.
  • register
  • peer
  • account
host_port String Hostname and port.
def_outbound_cid String Trunk outbound caller ID.
username String Username.
Note: This field is only available when the trunk type is register or account.
Trunk status
Table 4.
Status Description
0 Unknown status.
1 The trunk is idle.
2 The trunk is busy.
3 The SIP trunk is idle and unmonitored.
4 The SIP trunk is registering.
41 SIP register trunk registration failed.
42 SIP trunk is unreachable.
43 SIP account trunk is unavailable.
44 SIP trunk is disabled.


Request example

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

Response example

HTTP/1.1 200 OK
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 9,
    "data": [
            "id": 27,
            "status": 1,
            "name": "peer-to-41",
            "type": "peer",
            "host_port": "",
            "def_outbound_cid": "13200000092"
            "id": 29,
            "status": 1,
            "name": "account-for-34",
            "type": "account",
            "username": "6708"
            "id": 30,
            "status": 1,
            "name": "cloud-trunking",
            "type": "register",
            "host_port": "testcloud.example.yeastarcloud.com:5060",
            "username": "6700"