添加闹铃

为指定分机设置闹铃。

请求地址

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

请求参数

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

取值范围：

  • 单个分机号码：为指定分机添加闹铃。

    例如："number":"1000"

  • 多个分机号码：为多个分机添加同一个闹铃。多个分机号码用半角逗号（,）隔开。

    例如："number":"1000,1001"
wakeup 是 Object<ExtensionWakeup> 分机闹铃信息。
注：

一次只能添加一个闹铃。如果一次添加多个，则只有第一个生效。
ExtensionWakeup
参数 是否必选 类型 描述
time 是 String 闹铃时间。
type 是 String 闹铃类型。

取值范围：

  • onetime：一次。

    当闹铃完成设置的重复次数之后，该条闹铃将被自动删除。

  • everyday：每天。
  • custom：自定义。

    type 为 custom 时，weekdays 不为空。
weekdays 否 Integer

闹铃适用的星期。

取值范围：0~6。

其中，0表示周日，1-6表示周一到周六。
注：

type 为 custom 时，此项不为空。
repeats 是 Integer 闹铃的重复次数。

取值范围：1~3。
repeatinterval 否 String 重复响铃间隔时间，以分钟为单位。

同时设置重复次数和重复间隔时间，话机第一次响铃后，会在间隔时间后再次响铃。
prompt 否 String 闹铃提示音。

此提示音必须为自定义提示音。不加字段则用系统默认的 macroform-cold_day 提示音。

响应参数

参数 类型 描述
status String 请求结果。
  • Success：成功。
  • Failed：失败。

示例

请求示例

为分机1000添加闹铃。

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

{
	"number": "4000",
	"wakeup": 
		{
			"time": "11:00",
			"type": "onetime",
			"repeats": "3",
			"repeatinterval": "5"
		}
}
响应示例
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"
}