添加闹铃
为指定分机设置闹铃。
注:
- 一次只能为 1 个分机添加 1 个闹铃。如果添加多个闹铃,只有最新添加的闹铃才会生效。
- 单个分机最多可添加 23 个闹铃。
请求 URL
POST {base_url}/{api_path}/wakeupcall/create?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
ext_id | 是 | Integer | 分机的唯一 ID。 注: 可通过 搜索特定分机 接口搜索分机
ID。 |
alarm_time | 是 | String | 闹铃的响铃时间,时间格式为 24 小时制。例如:07:30 |
repeat_type | 否 | Integer | 重复闹铃的预约和具体日期。 取值范围:
注:
|
number_of_snoozes | 否 | Integer | 闹铃的重复响铃次数。 取值范围:
|
snooze_duration | 否 | Integer |
闹铃的重复响铃间隔时间,以分钟为单位。 默认值:10 |
alarm_prompt | 否 | String | 闹铃提示音的名称。 注:
|
alarm_day | 否 | String | 闹铃的日期。 时间格式:YYYY/MM/DD,表示年/月/日。例如输入:2025/01/05。 |
repeat_option | 否 | String | 闹铃的重复频率。 取值范围:
|
ring_timeout | 否 | Integer | 闹铃超时前响铃的时间 (单位:秒)。 |
fail_dest_type | 否 | String | 呼叫失败目的地类型。 取值范围:
|
fail_dest_data | 否 | Integer | 如果设置 fail_dest_type 为 ext 或
ringgroup ,指定具体的呼叫失败目的地。 |
remark | 否 | String | 闹铃的备注信息。 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
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":3,
"alarm_time":"06:00",
"repeat_type":"never",
"number_of_snoozes":3,
"snooze_duration":5,
"alarm_prompt":"morning-call.wav",
"alarm_day": "2025/01/05",
"repeat_option": "never",
"ring_timeout": 4,
"fail_dest_type": "ext",
"fail_dest_data": 5
}
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"id": 12
}