Query an Alarm

Query an extension user's alarm information.


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

Request Parameters

Name Importance Type Description
extid Required Int The extension number.

Response Parameters

Name Type Description
extid Int The extension number.
wakeup Object Object.
wakeupid Int A unique Identifier for the alarm.
time String Alarm time.
type String Alarm type.
  • onetime
  • everyday
  • custom
Note: If the type is set to yes, PBX will delete the alarm after the alarm has been repeated for the designated repeat times.
weekdays String The options available when the type is set to custom.
repeats String How many times will the alarm be repeated.
Repeatinterval String The interval in minutes between each repeat.
Prompt String Alarm prompt.


Request Example
POST /api/v1.1.0/wakeupcall/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
    "extid": "1000"
Response Sample
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
    "status": "Success",
    "wakeups": [
            "extid": "1000",
            "wakeup": [
                    "wakeupid": "1",
                    "time": "00:45",
                    "type": "onetime",
                    "prompt": "macroform-cold_day",
                    "repeats": "3",
                    "repeatinterval": "5"
                    "wakeupid": "2",
                    "time": "12:45",
                    "type": "custom",
                    "weekdays": "0",
                    "prompt": "macroform-cold_day",
                    "repeats": "3",
                    "repeatinterval": "5"