Send XML message - Neuron Agent API

Overview

Allows the client to send a custom XML normal message from its account to an XMPP recipient.

HTTP request

POST /Agent/Xmpp/SendXmlMessage

Authentication

Requires a valid JWT bearer token.

Request (JSON)

{
	"to":Required(Str(PTo)),
	"subject":Optional(Str(PSubject)),
	"language":Optional(Str(PLanguage)),
	"id":Optional(Str(PId)),
	"xml":Required(Str(PXml))
}

Input parameters

Parameter	Description
PTo	A Bare or Full JID (XMPP network address).
PSubject	Optional subject of message.
PLanguage	Optional ISO 639-1 language code.
PId	Optional Message ID.
PXml	The XML message to send. It can be sent as text or directly in XML (if sent embedded in XML).

Response (JSON)

{
	"sent":Required(Bool(PSent)),
	"id":Required(Str(PId))
}

Response parameters

Parameter	Description
PSent	If the XMPP stanza was sent or not.
Pid	ID of stanza sent. Can be used to update message. If no ID was provided in the call, a message ID will be generated.

Notes

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

Send formatted message Send presence subscription

⌘I

​Overview

​HTTP request

​Authentication

​Request (JSON)

​Input parameters

​Response (JSON)

​Response parameters

​Notes