Delete an Alarm

Delete an alarm of a specific extension.

Request URL

{base_url}/{api_path}/wakeupcall/delete?token={token}

Request parameters

Parameter Required Type Description
number Yes String Extension number.
Valid values:
  • An extension number: Delete alarms of the specified extension.

    Example: "number":"1005"

  • Multiple extension numbers: Delete alarms of multiple extensions. Separate multiple extension numbers with ,.

    Example: "number":"1005,1006"

  • all: Delete alarms of all extensions.

    Example: "number":"all"
wakeupid No Integer The unique ID of an alarm. If wakeupid is not carried, it means to delete all alarms of the specified extension.

Valid values:

  • A wakeupid: Delete the specified alarm of the specified extension.

    Example: "wakeupid":"1"

  • Multiple wakeupids: Delete multiple alarms of the specified extensions. Separate multiple wakeupids with ,.

    Example: "wakeupid": "1,2"

  • all: Delete all alarms of the specified extension.

    Example: "wakeupid": "all"

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed

Examples

Request example

Delete alarms of extension 1000.

POST /api/v2.0.0/wakeupcall/delete?token=1e3b3ebb6a974cb42ed31de5413df52d
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"number": "1000"
}
Response example
HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
    "status": "Success"
}