添加闹铃

通过本接口可以给酒店房间的分机设置闹铃。

注:
  • 一次只能添加一个闹铃。如果一次添加多个,则只有第一个生效。
  • 为多个分机设置相同的闹铃,分机之间使用, 隔开,如:

    {"extid":"1000,1001","wakeup":[{"time":"00:45","type":"onetime","repeats":"3","repeatinterval":"5"}]}

Endpoint

POST /api/v1.1.0/wakeupcall/create?token={token}

请求参数

名称 是否必需 类型 描述
extid Int 分机号。
wakeup Object 对象参数。
time String 闹铃时间。
type String 闹铃频率。
  • onetime:一次
  • everyday:每天
  • custom:自定义
注: 设置为 onetime 时,当闹铃完成设置的重复次数之后,该条闹铃将被自动删除。
weekdays String 类型为自定义时的选项。

可选值:0、1、2、3、4、5、6

1-6表示周一到周六,0:为周日。

repeats String 闹铃的重复次数

可选值:1、2、3

Repeatinterval String 重复时间,设置好重复次数和重复时间后,话机响铃一次后,间隔所设置的重复时间后会再次响铃。

单位:分钟。

Prompt String 闹铃提示音

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

实际示例

请求示例
POST /api/v1.1.0/wakeupcall/create?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
{
    "extid": "1000",
    "wakeup": [
        {
            "time": "00:45",
            "type": "onetime",
            "repeats": "3",
            "repeatinterval": "5"
        }
    ]
}
响应示例
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
{
    "status": "Success"
}