Table of Contents
  1. JSON
  2. XML
  3. Input Parameters
  4. Response Parameters
  5. Javascript Library

/Xmpp/SendPresenceSubscription

Allows the client to send a presence unsubscription from its account to an XMPP recipient.

JSON

Request
{
	"to":Required(Str(PTo)),
	"id":Optional(Str(PId))
}
Response (if successful)
{
	"sent":Required(Bool(PSent)),
	"id":Required(Str(PId))
}

XML

Request
<SendPresenceUnsubscription xmlns="https://waher.se/Schema/BrokerAgent.xsd"
                            to=(Required(Str(PTo)))
                            id=(Optional(Str(PId))) />
Response (if successful)
<StanzaResult xmlns="https://waher.se/Schema/BrokerAgent.xsd"
              sent=(Required(Bool(PSent)))
              id=(Required(Str(PId))) />

Input Parameters

Parameter Description
PTo A Bare or Full JID (XMPP network address).
PId Optional Message ID.

Response Parameters

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

Javascript Library

Use the following asynchronous method in the Javascript Library, to call this resource. 

var Response = await AgentAPI.Xmpp.SendPresenceUnsubscription(To,Id);

Note: The Id argument is optional, and can be omitted, or set to null or undefined.

Test



Request Payload:

Response Payload: