2.2.2.6.2 setSubscribers Request

  • Article

SIP SERVICE request and response messages are used to manage subscriber lists. In the following example, Bob acknowledges john@contoso.com.

SERVICE sip:bob@contoso.com SIP/2.0
Via: SIP/2.0/TCP 172.24.32.124:54111
Max-Forwards: 70
From: <sip:bob@contoso.com>;tag=aa5b2cc9ef;epid=84d3db8c23
To: <sip:bob@contoso.com>
Call-ID: 345dfe18894e4e608ae845de4f6108fa
CSeq: 1 SERVICE
Contact: <sip:bob@contoso.com;opaque=user:epid:fvceImg6cFWG7W6lvUt_-AAA;gruu>
User-Agent: UCCP/2.0.6362.0 OC/2.0.6362.0 (Microsoft Office Communicator)
Proxy-Authorization: …
Content-Type: application/msrtc-presence-setsubscriber+xml
Content-Length: …
 
<setSubscribers xmlns="http://schemas.microsoft.com/2006/09/sip/presence-subscribers">
  <subscriber user="john@contoso.com" acknowledged="true"/>
</setSubscribers>

The Content-Type header field MUST be set to "application/msrtc-presence-setsubscriber+xml ". The XML body MUST be a valid http://schemas.microsoft.com/2006/09/sip/presence-subscribers document.

The To-URI and the From-URI MUST contain the SIP URI of the user who acknowledges the subscriber.

A setSubscribers request does not support batching, or acknowledging multiple subscribers at the same time.

Key elements and attributes are defined in this section. For the full XML schema, see section 6.

The XML elements of a set subscribers document MUST conform to the schema defined in section 6.12.

subscriber: This element is used to describe the operation. It has two attributes:

  • user: This mandatory attribute in the subscriber element is the URI for the subscriber to be acknowledged. The value MUST be a valid URI.

  • acknowledged: The value of this attribute MUST be true.

If the operation is successful, the server MUST return a 200 OK response.