Edit an alarm

Edit the configuration of an alarm.

Request URL

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

Request parameters

Table 1.
Parameter Required Type Description
id Yes Integer The unique ID of an alarm.
Note: You can query alarm's ID using Query Alarm List.
alarm_time No String The alarm time in 24-hour clock format. For example: 07:30.
repeat_type No String How often will the alarm be repeated.
Valid value:
  • never (default)
  • every_monday
  • every_tuesday
  • every_wednesday
  • every_thursday
  • every_friday
  • every_saturday
  • every_sunday
  • Use a comma to separate multiple types.
  • If repeat_type is set to never, PBX will delete the alarm after the alarm has been repeated for the designated repeat times.
number_of_snoozes No Integer How many times will the alarm be repeated.
Valid value:
  • 0 (default)
  • 1
  • 2
  • 3
snooze_duration No Integer The interval in minutes between each repeat.
alarm_prompt No String The name of alarm prompt.
  • If you don't set the parameter, the system will play the Music on Hold (MoH).
  • This must be a custom prompt. You can obtain the custom prompt name on PBX web portal (Path: PBX Settings > Voice Prompt > Custom Prompt).

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.


Request example

Change alarm time to 07:00 (ID: "14").

POST /openapi/v1.0/wakeupcall/update?access_token=ojPrvnfzPdwc8OCcRmhG16gEHuZcwFco HTTP/1.1

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

Response example

HTTP/1.1 200 OK
    "errcode": 0,
    "errmsg": "SUCCESS"