/Xmpp/ClearMessages

Clears any offline messages available for the account from the server.

JSON

Request
{
}
Response (if successful)
{
	"count": Required(Int(PCount))
}

XML

Request
<ClearMessages xmlns="https://waher.se/Schema/BrokerAgent.xsd" />
Response (if successful)
<MessagesCleared xmlns="https://waher.se/Schema/BrokerAgent.xsd"
                 count=(Required(Int(PCount))) />

Input Parameters

Call does not include input parameters.

Response Parameters

Parameter Description
PCount Number of messages deleted.

Javascript Library

Use the following asynchronous method in the Javascript Library, to call this resource.

var Response = await AgentAPI.Xmpp.ClearMessages();
Test

Request Payload:

   

Response Payload: