Query Trunk List

Query basic information like trunk name, trunk status, trunk type, etc. of all trunks.

Endpoint

POST /api/v1.1.0/trunklist/query?token={token}

Request Parameters

No parameter. Only need to send the request.

Response Parameters

Name Type Description
trunklist Object Object.
trunkname Int The trunk name.
type String The trunk type.
  • SIP
status String Current status of the trunk.
  • Registering
  • Failure
  • Registered (Unmonitored)
  • Disable
  • Unknown

Examples

Request Example

POST /api/v1.1.0/trunklist/query?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success",
    "trunklist": [
        {
            "trunkname": "voip123",
            "status": "failure",
            "type": "SIP"
        },
        {
            "trunkname": "siptrunk8",
            "status": "failure",
            "type": "SIP"
        }
    ]
}