添加闹铃

为指定分机设置闹铃。

注：
  • 一次只能为 1 个分机添加 1 个闹铃。如果添加多个闹铃，只有最新添加的闹铃才会生效。
  • 单个分机最多可添加 23 个闹铃。

请求 URL

POST {base_url}/{api_path}/wakeupcall/create?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
ext_id 是 Integer 分机的唯一 ID。
注： 可通过 搜索特定分机 接口搜索分机 ID。
alarm_time 是 String 闹铃的响铃时间，时间格式为 24 小时制。例如：07:30
repeat_type 否 Integer 闹铃的响铃频率。
取值范围：
  • never (默认)
  • every_monday
  • every_tuesday
  • every_wednesday
  • every_thursday
  • every_friday
  • every_saturday
  • every_sunday
注：
  • 使用半角逗号 , 分隔多个周期。
  • 如果设置 repeat_type 为 never，当闹铃完成设置的重复响铃次数后，该条闹铃将被自动删除。
number_of_snoozes 否 Integer 闹铃的重复响铃次数。
取值范围：
  • 0（默认）
  • 1
  • 2
  • 3
snooze_duration 否 Integer

闹铃的重复响铃间隔时间，以分钟为单位。

默认值：10
alarm_prompt 否 String 闹铃提示音的名称。
注：
  • 如果未设置此参数，则系统默认播放等待音乐。
  • 此提示音必须为自定义提示音。你可以从 PBX 网页上获取提示音名称 (路径： PBX 设置 > 提示音 > 自定义提示音)。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
id Integer 闹铃的唯一 ID。

示例

请求示例

POST /openapi/v1.0/wakeupcall/create?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1
Host: 192.168.5.150:8088
Content-Type: application/json
{
    "ext_id":39,
    "alarm_time":"07:00",
    "repeat_type":"every_monday,every_tuesday,every_wednesday,every_thursday,every_friday",
    "number_of_snoozes":3,
    "snooze_duration":5,
    "alarm_prompt":"alarm_prompt"
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 12
}