Skip to main content

​
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

ParameterDescription
PToA Bare or Full JID (XMPP network address).
PSubjectOptional subject of message.
PLanguageOptional ISO 639-1 language code.
PIdOptional Message ID.
PXmlThe 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

ParameterDescription
PSentIf the XMPP stanza was sent or not.
PidID 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.