Pop messages - Neuron Agent API

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

Parameter	Description
PMaxCount	Maximum 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

Parameter	Description
PId	Optional ID associated with message.
PFrom	JID of entity sending the message.
PTo	JID of recipient.
PLanguage	Optional language code associated with message.
PType	Type of message.
PPTimestamp	Date and time when message was received by server.
PContent	Content of message.

Notes

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

Clear messages Information query

⌘I

​Overview

​HTTP request

​Authentication

​Request (JSON)

​Input parameters

​Response (JSON)

​Response parameters

​Notes

Overview

HTTP request

Authentication

Request (JSON)

Input parameters

Response (JSON)

Response parameters

Notes