Query Extension List

Get basic information of the PBX extension list, like extension number, extension name, extension status, type, etc.


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

Request Parameters

No parameter. Only need to send the request.

Response Parameters

Name Type Description
extlist Object Extension object.
extnumber Int The extension number.
status String Current status of the extension.
  • Unavailable
  • Registered
  • Ringing
  • Busy
  • Hold
  • Malfunction
  • Idle
type String The extension type.
username String Username.
agentid String The agent ID to be announced in the greeting prompt. The parameter is null by default and, if it is not specified, the extension number will be announced instead.


Request Example

POST /api/v1.1.0/extensionlist/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",
    "extlist": [
            "extnumber": "1000",
            "status": "Registered",
            "type": "SIP",
            "username": "Jayson",
            "agentid": ""
            "extnumber": "1001",
            "status": "Unavailable",
            "type": "SIP",
            "username": "Erwin Co",
            "agentid": ""