查询分机设置

查询单个或者多个分机的详细信息，如：高级配置信息等。当发送查询多个分机请求的时候，请求参数需用逗号隔开。

Endpoint

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

请求参数

名称 是否必需 类型 描述
extid 否 Int 分机号码。
  • 查询单个分机：设置 extid 为分机号码。

    例如："extid":"1000"

  • 查询多个分机：设置 extid 为 分机号码，多个分机之间用 , 隔开。

    例如："extid": "1000,1001"

  • 查询所有分机：不带 extid 请求参数。

响应参数

名称 类型 描述
extinfos Object 对象参数。
extnumber Int 分机号。
username String 用户名。
status String 分机当前状态：
  • Unavailable：不可使用。
  • Registered：已注册。
  • Ringing：响铃。
  • Busy：忙线。
  • Hold：通话保持。
  • Malfunction：故障。
  • Idle：空闲。
type String 分机类型。
callerid String 来电显示号码。
registername String 注册名称。
registerpassword String 注册密码。
maxregistrations Int 同时注册数。
loginpassword String 用户密码。
email String 邮件地址。
moblie String 电话号码。
language String 提示音语言。
hasvoicemail String 启用语音邮箱。
  • on：开启。
  • off：关闭。
vmsecret Int 语音邮箱密码。
enablevmtoemail String 发送语音邮件到邮箱。
  • on：开启。
  • off：关闭。
alwaysforward String 总是转移功能。
  • on：开启。
  • off：关闭。
atransferto

atransferext

atransferprefix

atransfernum

 String 总是转移目的地，如果选择总是转移到分机，则需设置要转移到的分机号；如果总是转移到外线号码，则需设置要转移到的外线号码以及呼叫规则。
noanswerforward String 无应答转移功能。
  • on：开启。
  • off：关闭。
ntransferto

ntransferext

ntransferprefix

ntransfernum

 String 无应答转移目的地，如果选择总是转移到分机，则需设置要转移到的分机号；如果总是转移到外线号码，则需设置要转移到的外线号码以及呼叫规则。
busyforward String 忙时转移功能。
  • on：开启。
  • off：关闭。
btransferto

btransferext

btransferprefix

btransfernum

 String 忙时转移目的地，如果选择总是转移到分机，则需设置要转移到的分机号；如果总是转移到外线号码，则需设置要转移到的外线号码以及呼叫规则。
allowbeingmonitored String 允许被监听。
  • on：开启。
  • off：关闭。
monitormode String 监听模式。
ringtimeout String 响铃超时。
maxduration String 最大通话时长。
dnd String 免打扰功能。
  • on：开启。
  • off：关闭。
callrestriction String 外呼限制。
  • on：开启。
  • off：关闭。
agentid String 报工号时要播报的号码。此参数默认为空，表示播报分机号。
inbound Object 来电，呼入的外线通话。
inboundid String 来电的编号，依据该参数对来电进行转接、查询、挂断等操作。
from String 主叫号码。
to String 被叫号码。
trunk String 呼入时通过的中继名。
outbound String 去电，呼出到外线的通话。
outboundid Object 去电的编号，依据该参数对来电进行转接、查询、挂断等操作。
from String 主叫号码。
to String 被叫号码。
trunk String 呼出时通过的中继名。
ext Object 内部分机互拨的通话方。
extid Int 和查询分机正在通话的分机号。
unselectoutroute String 分机不可用的呼出路由。
selectoutroute String 分机可用的呼出路由。

实际示例

请求示例

查询分机1000。

POST /api/v1.1.0/extension/query?token=277ac400357b509b4a587ff2157f7ad5 HTTP/1.1 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "extid": "1000"
}

查询所有分机。

POST /api/v1.1.0/extension/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",
    "extinfos": [
        {
            "extnumber": "1000",
            "username": "Jayson",
            "status": "Registered",
            "type": "SIP",
            "callerid": "1000",
            "registername": "1000",
            "registerpassword": "xMn5W4Gs",
            "maxregistrations": "1",
            "loginpassword": "5e12ba8dd1083a7f946e457cf3c18779",
            "email": "",
            "moblie": "",
            "language": "System Default",
            "hasvoicemail": "on",
            "enablevmtoemail": "off",
            "vmsecret": "1000",
            "alwaysforward": "off",
            "noanswerforward": "on",
            "ntransferto": "Voicemail",
            "ntransferprefix": "",
            "busyforward": "on",
            "btransferto": "Voicemail",
            "btransferprefix": "",
            "ringsimultaneous": "off",
            "mobileprefix": "",
            "enablemobile": "off",
            "allowbeingmonitored": "off",
            "monitormode": "Disabled",
            "ringtimeout": "30",
            "maxduration": "Follow System",
            "dnd": "off",
            "callrestriction": "off",
            "agentid": ""
        }
    ]
}