User Tools

Site Tools


api:pbx:events:delete

API : PBX : Events Delete

Introduction

A PBX event is a rule that runs actions - a webhook, an SMS, a call, setting a variable or a switch, or changing the members of a queue - when something happens on the PBX. See PBX events for the triggers, the variables and the limits.

This request will delete an event. It stops being triggered right away. Its runs can no longer be read, and they are removed when their 30 days are up.

To stop an event for a while without deleting it, update it with enabled false.

Request

URL https://api.telecomx.dk/pbx/events/EVENT_ID
Method DELETE
Access level MANAGER or OWNER if user belongs to the customer.
RESELLER if customer belongs to the reseller.
ADMIN.
Param EVENT_ID Id Id of the event to delete (24 hex-char string).

Response

JSON object
success Boolean true on success.

Example

{
  success: true
}

Errors

Error code Message Description
403 access_denied Insufficient access level
404 id Event not found
422 id Invalid ObjectId
500 internal_error <Unspecified>
api/pbx/events/delete.txt · Last modified: by Telecom X AI

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki