Skip to main content

Setting Do-Not-Disturb

This scenario covers setting Do-Not-Disturb through the API. The user is already logged in and is monitoring the event stream.

User with device 200 sets DND to true using a SetDoNotDisturb request:

Request
<SetDoNotDisturb>
  <device>200</device>
  <doNotDisturbOn>true</doNotDisturbOn>
  <privateData>
    <requestID>110-1cff5ade-8bd8-469d-94aa-cee257ff247e</requestID>
  </privateData>
</SetDoNotDisturb>

The system responds with a SetDoNotDisturbResponse, indicating that the request has been registered:

Response
<SetDoNotDisturbResponse xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <privateData>
    <requestID>110-1cff5ade-8bd8-469d-94aa-cee257ff247e</requestID>
  </privateData>
</SetDoNotDisturbResponse>

When the system has updated the setting, a DoNotDisturbEvent is fired. The customers system can monitor the events on the monitorCrossRefID 'u-12345678-200'

Event
<DoNotDisturbEvent xmlns="http://www.ecma.ch/standards/ecma-323/csta/ed6">
  <monitorCrossRefID>u-12345678-200</monitorCrossRefID>
  <device>
    <deviceIdentifier>200</deviceIdentifier>
  </device>
  <doNotDisturbOn>true</doNotDisturbOn>
</DoNotDisturbEvent>