Query Trunk List

Query basic information of the PBX trunk list, such as trunk name, trunk status, trunk type, etc.

Request URL

{base_url}/{api_path}/trunk/list?token={token}

Request parameters

No request parameters. Send the request directly to query trunk list.

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
trunklist Array <TrunkInfo> Trunk list.
TrunkInfo
Parameter Type Description
trunkname String Trunk name.
id Integer The unique ID of a trunk.
type String Trunk type.
status String Current status of the trunk.
  • Registering
  • Failure
  • Registered
  • Disable
  • Unknown

Examples

Request example

POST /api/v2.0.0/trunk/list?token=277ac400357b509b4a587ff2157f7ad5 
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com

Response example

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

{
	"status": "Success",
	"trunklist": [
		{
			"trunkname": "siptrunk",
			"id": "7",
			"status": "registered",
			"type": "SIP"
		}
	]
}