Home Documentation Services FAQ Contact details
Sign in

Clear the message queue

Description

DELETE /clearmessagesqueue

Resource allows to clear all messages and files which are to be sent.

Messages at our servers are stored for 24 hours.

URL resource:

https://app.api-messenger.com/clearmessagesqueue

Input data

Parameter Required Value
files No Remove the files only

If the parameter hasn't been specified, text messages only will be removed by default.

Output data

Output data structure is shown below.

{ 
    "status": "{enum}",
    "message": "{string}"
}

Parameters description:

Parameter Value
status Response status.

Possible values:

  • ERROR — an error has occurred.

  • OK — the request has been completed successfully.
message Successful completion or error message.

Errors description

The server returns an HTTP response code and a brief error description in the event of error.

Examples

Query example:

curl -i -H 'Content-Type: application/json' -X DELETE 'https://app.api-messenger.com/clearmessagesqueue'

Response example:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
...

{ "status": "OK", "message": "2 messages successfully deleted" }