查询闹铃

查询单个分机、多个分机或所有分机的闹铃信息。

请求地址

{base_url}/{api_path}/wakeupcall/query?token={token}

请求参数

参数 是否必选 类型 描述
number 是 String 分机号码。

取值范围：

  • 单个分机号码：查询指定分机的闹铃。

    例如："number":"1000"

  • 多个分机号码：查询多个分机的闹铃。多个分机号码用半角逗号（,）隔开。

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

  • all：查询所有分机的闹铃。

    例如："number":"all"

响应参数

注： 如果查询的分机没有闹铃信息，PBX 只响应请求成功或请求失败的参数。
参数 类型 描述
status String 请求结果。
  • Success：成功。
  • Failed：失败。
wakeups Array <WakeupInfo> 闹铃列表。
WakeupInfo
参数 类型 描述
number String 分机号码。
wakeup Array <ExtensionWakeup> 分机闹铃信息列表。
ExtensionWakeup
参数 类型 描述
wakeupid Integer 闹铃的唯一 ID。
time String 闹铃时间。
type String 闹铃类型。
  • onetime：一次。
  • everyday：每天。
  • custom：自定义。
weekdays Integer type 为 custom 时，闹铃适用的星期。
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6

其中，0表示周日，1-6表示周一到周六。
repeats Integer 闹铃的重复次数。
  • 1
  • 2
  • 3
repeatinterval Integer 重复响铃间隔时间，以分钟为单位。
prompt String 闹铃提示音。

示例

请求示例

查询分机5000的闹铃信息。

POST /api/v2.0.0/wakeupcall/query?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "5000"
}
响应示例
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",
	"wakeups": [
		{
			"number": "5000",
			"wakeup": [
				{
					"wakeupid": "9",
					"time": "15:00",
					"type": "onetime",
					"prompt": "macroform-cold_day",
					"repeats": "3",
					"repeatinterval": "5"
				}
			]
		}
	]
}