Skip to main content
POST
/
Agent
/
Xmpp
/
InformationQuery
Information Query
curl --request POST \
  --url https://{host}/Agent/Xmpp/InformationQuery \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>",
  "type": "<string>",
  "xml": {}
}
'
{
  "ok": true,
  "errorCode": 123,
  "errorText": "<string>",
  "errorType": "<string>",
  "ErrorElement": {},
  "Stanza": {}
}

Overview

Sends an Information Query (iq) to an entity on the XMPP network, given its Full JID. For connected entities, you need to have an presence subscription to that entity, approved by the entity, to get the Full JID. You get the Full JID using the Presence Probe resource.

Authentication

Requires a valid JWT bearer token.

Notes

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

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
to
string
required
type
string
required
xml
object
required

Response

200 - application/json

Success

ok
boolean
required
errorCode
integer
errorText
string
errorType
string
ErrorElement
object
Stanza
object