Skip to main content
POST
/
Agent
/
Xmpp
/
PresenceProbe
Presence Probe
curl --request POST \
  --url https://{host}/Agent/Xmpp/PresenceProbe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "to": "<string>"
}
'
{
  "jid": "<string>",
  "type": "<string>",
  "received": "2023-11-07T05:31:56Z",
  "Stanza": {}
}

​
Overview

Gets the latest presence issued by a contact in your roster who has approved your presence subscription request. Note: The result to the presence probe request will give you the latest Full JID published by the contact. This Full JID can be used to make directed information queries to the contact. Security Note: You are only allowed to send a presence probe to contacts that have approved a presence subscription from you. Note 2: If you request the presence of an entity to which you do not have a presence subscription, one will be sent automatically. If you want to send custom XML in the presence subscription request, you should call SendPresenceSubscription.md first.

​
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

Response

200 - application/json

Success

​
jid
string
required
​
type
string
required
​
received
string<date-time>
required
​
Stanza
object
required