Skip to main content

​
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.

​
HTTP request

POST /Agent/Xmpp/PresenceProbe

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

{
	"to":Required(Str(PTo))
}

​
Input parameters

ParameterDescription
PToBare JID of contact to whom the presence probe is directed.

​
Response (JSON)

{
	"jid": Required(Str(PJid)),
	"type": Required(Str(PType)),
	"received": Required(DateTime(PReceived)),
	"Stanza": Required(PStanza)
}

​
Response parameters

ParameterDescription
PJidJID of latest presence from contact.
PTypeType of presence sent. Can be the empty string (meaning available) or unavailable.
PReceivedWhen presence was received by the server of the contact.
PStanzaActual presence stanza, containing information sent by the contact. Contents may vary depending on type of contact.

​
Notes

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