Edit an Alarm

Edit the alarm settings of an extension.


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

Request Parameters

Name Importance Type Description
extid Required Int The extension number.
wakeupid Required Int A unique Identifier for the alarm.
wakeup Required Object Object.
time Required String Alarm time.
type Required 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 Optional String The options available when the type is set to custom.

Options: 1, 2, 3, 4, 5, 6, 0. 1 to 6 corresponds to Saturday, 0 corresponds to Sunday.

repeats Optional String How many times will the alarm be repeated.

Options: 1, 2, 3

Repeatinterval Optional String The interval in minutes between each repeat.
Prompt Optional String The file name of the custom prompt. Without the parameter, the default prompt "macroform-cold_day" will be played.


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