查询闹铃列表

查询闹铃列表信息。

请求 URL

GET {base_url}/{api_path}/wakeupcall/list?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
data Array <Wakeup_Info> 闹铃列表。
Wakeup_Info
表 3.
参数 类型 说明
ext_id Integer 分机的唯一 ID。
wakeup_call Array <Extension_Wakeup> 分机的闹铃信息。
Extension_Wakeup
表 4.
参数 类型 说明
id Integer 闹铃的唯一 ID。
alarm_time String 闹铃的响铃时间。
repeat_type String 闹铃的重复频率。
number_of_snoozes Integer 闹铃的重复响铃次数。
snooze_duration Integer

闹铃的重复响铃间隔时间。

(单位：分钟)
alarm_prompt String 闹铃提示音。

示例

请求示例

GET /openapi/v1.0/wakeupcall/list?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": [
        {
            "ext_id": 39,
            "wakeup_call": [
                {
                    "id": 19,
                    "alarm_time": "09:30",
                    "repeat_type": "never",
                    "number_of_snoozes": 3,
                    "snooze_duration": 5,
                    "alarm_prompt": "alarm_prompt"
                },
                {
                    "id": 21,
                    "alarm_time": "07:00",
                    "repeat_type": "never",
                    "number_of_snoozes": 2,
                    "snooze_duration": 1,
                    "alarm_prompt": "alarm_prompt"
                }
            ]
        },
        {
            "ext_id": 223,
            "wakeup_call": [
                {
                    "id": 20,
                    "alarm_time": "07:00",
                    "repeat_type": "never",
                    "number_of_snoozes": 2,
                    "snooze_duration": 1,
                    "alarm_prompt": "alarm_prompt"
                }
            ]
        }
    ]
}