查询分机列表

查询 PBX 上分机列表的基本信息，如：分机名、分机号、分机状态、类型等。

Endpoint

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

请求参数

无参数，直接发送查询分机列表的请求即可。

响应参数

名称 类型 描述
extlist Object 分机对象。
extnumber Int 分机号。
status String 分机当前状态：
  • Unavailable：不可使用。
  • Registered：已注册。
  • Ringing：响铃。
  • Busy：忙线。
  • Hold：通话保持。
  • Malfunction：故障。
  • Idle：空闲。
type String 分机类型。
username String 用户名。
agentid String 报工号时要播报的号码。此参数默认为空，表示播报分机号。

实际示例

请求示例

POST /api/v1.1.0/extensionlist/query?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
响应示例
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": ""
        }
    ]
}