Skip to main content

​
Overview

Allows the client to send a presence subscription from its account to an XMPP recipient. If the account to which the client is logged in has an approved Legal ID associated with it, this ID will be included in the request, to allow the recipient to know who has made the request.

​
HTTP request

POST /Agent/Xmpp/SendPresenceSubscription

​
Authentication

Requires a valid JWT bearer token.

​
Request (JSON)

{
	"to":Required(Str(PTo)),
	"customXml":Optional(Str(PCustomXml)),
	"language":Optional(Str(PLanguage)),
	"id":Optional(Str(PId))
}

​
Input parameters

ParameterDescription
PToA Bare or Full JID (XMPP network address).
PCustomXmlOptional Custom XML that can be added to the presence subscription request.
PLanguageOptional ISO 639-1 language code.
PIdOptional Message ID.

​
Response (JSON)

{
	"sent":Required(Bool(PSent)),
	"id":Required(Str(PId)),
	"RosterItem":
	{
		"bareJid": Required(Str(PBareJid)),
		"pendingSubscription": Required(Bool(PPendingSubscription)),
		"status": Required(Str(PStatus)),
		"name": Required(Str(PName)),
		"Groups": Optional(Str(PGroups)[])
	}
}

​
Response parameters

ParameterDescription
PSentIf the XMPP stanza was sent or not.
PIdID of stanza sent. Can be used to match responses. If no ID was provided in the call, a message ID will be generated.
PBareJidBare JID of roster item.
PPendingSubscriptionIf the account has a pending subscription request to the remote entity.
PStatusStatus of roster item.
PNameName given to the roster item.
PGroupsNames of groups to which the roster item is assigned.

​
Notes

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