Skip to main content

​
Overview

Gets messages for the account from the server.

​
HTTP request

POST /Agent/Xmpp/PopMessages

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

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

​
Input parameters

ParameterDescription
PMaxCountMaximum number of messages to return.

​
Response (JSON)

{
	"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[])
	}?[]
}

​
Response parameters

ParameterDescription
PIdOptional ID associated with message.
PFromJID of entity sending the message.
PToJID of recipient.
PLanguageOptional language code associated with message.
PTypeType of message.
PPTimestampDate and time when message was received by server.
PContentContent of message.

​
Notes

This endpoint uses the request schema notation described in Pattern matching.