/Xmpp/PopMessages

Gets messages for the account from the server.

JSON

Request

{
	"maxCount":Optional(Int(0 < PMaxCount <= 2147483647))
}

Response (if successful)

{
	"Messages":
	{
		"id": Optional(Str(PId)),
		"from": Required(Str(PFrom)),
		"to": Required(Str(PTo)),
		"lang": Optional(Str(PLanguage)),
		"type": Required(Str(PType)),
		"timestamp": Required(DateTime(PTimestamp)),
		"Content": Required(PContent[])
	}?[]
}

XML

Request

<PopMessages xmlns="https://waher.se/Schema/BrokerAgent.xsd"
             maxCount=(Required(Int(0 < PMaxCount <= 2147483647))) />

Response (if successful)

<MessagesResult xmlns="https://waher.se/Schema/BrokerAgent.xsd">
	<[
	<Message id=(Optional(Str(PId)))
				   from=(Required(Str(PFrom)))
				   to=(Required(Str(PTo)))
				   lang=(Optional(Str(PLanguage)))
				   type=(Required(Str(PType)))
				   timestamp=(Required(DateTime(PTimestamp)))>
		<[Required(PContent[])]>
	</Message>?[]
	]>
</MessagesResult>

Input Parameters

Response Parameters

Note Underlying communication protocol is XMPP, which encodes information using XML. When requesting information encoded as JSON, this XML is automatically transformed into JSON. When XML is transformed into JSON objects, the special names __name and __ns can be used to get information about what XML names and namespaces have been used. XML attributes are encoded as properties. Child elements are also encoded as properties (if only one child element occurs with the same name), or as vectors of objects (if more than one child element occurs with the same name).

Javascript Library

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

var Response = await AgentAPI.Xmpp.PopMessages(MaxCount);