Query Extension List

Query basic information of PBX extension list, such as extension number, extension status, extension type, extension name, etc.

Request URL


Request parameters

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

Response parameters

Parameter Type Description
status String Request result.
  • Success.
  • Failed.
extlist Array <ExtensionInfo> Extension list.
Parameter Type Description
number String Extension number.
status String Current status of the extension.
  • Unavailabl
  • Registered
  • Ringing
  • Busy
  • Hold
  • Malfunction
  • Idle
  • Fxsnoport
type String Extension type.
  • FXS
  • IAX
  • SIP
port String Extension port. If the extension is an FXS extension, the parameter will be displayed.
username String Caller ID name.
agentid String The agent ID to be announced in the greeting prompt when users call to a queue. By default, the parameter is null, which means that the extension number will be announced.
Tip: Call extension/update to edit the extension agentid.


Request example

POST /api/v2.0.0/extension/list?token=7dff09fe45414a4f340e978e274b53ea
Content-Type:application/json; charset=utf-8
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",
	"extlist": [
			"number": "1022",
			"status": "Idle",
			"type": "SIP",
			"username": "1022"
			"number": "1023",
			"status": "Registered",
			"type": "SIP",
			"username": "1023"