Link Search Menu Expand Document
Sonos API

AlarmClockService

Control the sonos alarms

The AlarmClockService is available on these models: v1-S1 / v1-S5 / v1-S9.

  1. Available actions
    1. CreateAlarm
    2. DestroyAlarm
    3. GetDailyIndexRefreshTime
    4. GetFormat
    5. GetHouseholdTimeAtStamp
    6. GetTimeNow
    7. GetTimeServer
    8. GetTimeZone
    9. GetTimeZoneAndRule
    10. GetTimeZoneRule
    11. ListAlarms
    12. SetDailyIndexRefreshTime
    13. SetFormat
    14. SetTimeNow
    15. SetTimeServer
    16. SetTimeZone
    17. UpdateAlarm
  2. Events
    1. Subscribe to events
    2. Event variables
  3. Custom errors

Service data

name value
Control URL http://192.168.x.x:1400/AlarmClock/Control
Event subscription URL http://192.168.x.x:1400/AlarmClock/Event
Discovery url http://192.168.x.x:1400/xml/AlarmClock1.xml
Service ID urn:upnp-org:serviceId:AlarmClock
Service type urn:schemas-upnp-org:service:AlarmClock:1

Sample request 

POST /AlarmClock/Control
Host: 192.168.x.x:1400
soapaction: "urn:schemas-upnp-org:service:AlarmClock:1#{ActionName}"
Content-Type: text/xml; charset="utf-8"

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" s:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <s:Body>
    {ActionBodyHere}
  </s:Body>
</s:Envelope>

Available actions

CreateAlarm

Create a single alarm, all properties are required

Action body:

<u:CreateAlarm xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <StartLocalTime>string</StartLocalTime>
  <Duration>string</Duration>
  <Recurrence>string</Recurrence>
  <Enabled>boolean</Enabled>
  <RoomUUID>string</RoomUUID>
  <ProgramURI>string</ProgramURI>
  <ProgramMetaData>string</ProgramMetaData>
  <PlayMode>string</PlayMode>
  <Volume>ui2</Volume>
  <IncludeLinkedZones>boolean</IncludeLinkedZones>
</u:CreateAlarm>

Inputs:

parameter type description
StartLocalTime string The start time as hh:mm:ss
Duration string The duration as hh:mm:ss
Recurrence string Repeat this alarm on Allowed values: ONCE / WEEKDAYS / WEEKENDS / DAILY
Enabled boolean Alarm enabled after creation
RoomUUID string The UUID of the speaker you want this alarm for
ProgramURI string The sound uri
ProgramMetaData string The sound metadata, can be empty string
PlayMode string Alarm play mode Allowed values: NORMAL / REPEAT_ALL / SHUFFLE_NOREPEAT / SHUFFLE
Volume ui2 Volume between 0 and 100
IncludeLinkedZones boolean Should grouped players also play the alarm?

Outputs:

parameter type description
AssignedID ui4  

DestroyAlarm

Delete an alarm

Action body:

<u:DestroyAlarm xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <ID>ui4</ID>
</u:DestroyAlarm>

Inputs:

parameter type description
ID ui4 The Alarm ID from ListAlarms

GetDailyIndexRefreshTime

Action body:

<u:GetDailyIndexRefreshTime xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
</u:GetDailyIndexRefreshTime>

No input arguments

Outputs:

parameter type description
CurrentDailyIndexRefreshTime string  

GetFormat

Action body:

<u:GetFormat xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
</u:GetFormat>

No input arguments

Outputs:

parameter type description
CurrentTimeFormat string  
CurrentDateFormat string  

GetHouseholdTimeAtStamp

Action body:

<u:GetHouseholdTimeAtStamp xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <TimeStamp>string</TimeStamp>
</u:GetHouseholdTimeAtStamp>

Inputs:

parameter type description
TimeStamp string  

Outputs:

parameter type description
HouseholdUTCTime string  

GetTimeNow

Action body:

<u:GetTimeNow xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
</u:GetTimeNow>

No input arguments

Outputs:

parameter type description
CurrentUTCTime string  
CurrentLocalTime string  
CurrentTimeZone string  
CurrentTimeGeneration ui4  

GetTimeServer

Action body:

<u:GetTimeServer xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
</u:GetTimeServer>

No input arguments

Outputs:

parameter type description
CurrentTimeServer string  

GetTimeZone

Action body:

<u:GetTimeZone xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
</u:GetTimeZone>

No input arguments

Outputs:

parameter type description
Index i4  
AutoAdjustDst boolean  

GetTimeZoneAndRule

Action body:

<u:GetTimeZoneAndRule xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
</u:GetTimeZoneAndRule>

No input arguments

Outputs:

parameter type description
Index i4  
AutoAdjustDst boolean  
CurrentTimeZone string  

GetTimeZoneRule

Action body:

<u:GetTimeZoneRule xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <Index>i4</Index>
</u:GetTimeZoneRule>

Inputs:

parameter type description
Index i4  

Outputs:

parameter type description
TimeZone string  

ListAlarms

Get the AlarmList as XML

Action body:

<u:ListAlarms xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
</u:ListAlarms>

No input arguments

Outputs:

parameter type description
CurrentAlarmList string  
CurrentAlarmListVersion string  

Remarks Some libraries also provide a ListAndParseAlarms where the alarm list xml is parsed

SetDailyIndexRefreshTime

Action body:

<u:SetDailyIndexRefreshTime xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <DesiredDailyIndexRefreshTime>string</DesiredDailyIndexRefreshTime>
</u:SetDailyIndexRefreshTime>

Inputs:

parameter type description
DesiredDailyIndexRefreshTime string  

SetFormat

Action body:

<u:SetFormat xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <DesiredTimeFormat>string</DesiredTimeFormat>
  <DesiredDateFormat>string</DesiredDateFormat>
</u:SetFormat>

Inputs:

parameter type description
DesiredTimeFormat string  
DesiredDateFormat string  

SetTimeNow

Action body:

<u:SetTimeNow xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <DesiredTime>string</DesiredTime>
  <TimeZoneForDesiredTime>string</TimeZoneForDesiredTime>
</u:SetTimeNow>

Inputs:

parameter type description
DesiredTime string  
TimeZoneForDesiredTime string  

SetTimeServer

Action body:

<u:SetTimeServer xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <DesiredTimeServer>string</DesiredTimeServer>
</u:SetTimeServer>

Inputs:

parameter type description
DesiredTimeServer string  

SetTimeZone

Action body:

<u:SetTimeZone xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <Index>i4</Index>
  <AutoAdjustDst>boolean</AutoAdjustDst>
</u:SetTimeZone>

Inputs:

parameter type description
Index i4  
AutoAdjustDst boolean  

UpdateAlarm

Update an alarm, all parameters are required.

Action body:

<u:UpdateAlarm xmlns:u="urn:schemas-upnp-org:service:AlarmClock:1">
  <ID>ui4</ID>
  <StartLocalTime>string</StartLocalTime>
  <Duration>string</Duration>
  <Recurrence>string</Recurrence>
  <Enabled>boolean</Enabled>
  <RoomUUID>string</RoomUUID>
  <ProgramURI>string</ProgramURI>
  <ProgramMetaData>string</ProgramMetaData>
  <PlayMode>string</PlayMode>
  <Volume>ui2</Volume>
  <IncludeLinkedZones>boolean</IncludeLinkedZones>
</u:UpdateAlarm>

Inputs:

parameter type description
ID ui4 The ID of the alarm see ListAndParseAlarms
StartLocalTime string The start time as hh:mm:ss
Duration string The duration as hh:mm:ss
Recurrence string Repeat this alarm on Allowed values: ONCE / WEEKDAYS / WEEKENDS / DAILY
Enabled boolean Alarm enabled after creation
RoomUUID string The UUID of the speaker you want this alarm for
ProgramURI string The sound uri
ProgramMetaData string The sound metadata, can be empty string
PlayMode string Alarm play mode Allowed values: NORMAL / REPEAT_ALL / SHUFFLE_NOREPEAT / SHUFFLE
Volume ui2 Volume between 0 and 100
IncludeLinkedZones boolean Should grouped players also play the alarm?

Remarks Some libraries support PatchAlarm where you can update a single parameter

Events

The AlarmClockService has variables that might be emitted if you subscribe to events.

Subscribe to events 

SUBSCRIBE /AlarmClock/Event
Host: 192.168.x.x:1400
callback: <http://...>
NT: upnp:event
Timeout: Second-3600

Event variables

Variable Sends events* type possible values
AlarmListVersion ✔ string  
DailyIndexRefreshTime ✔ string  
DateFormat ✔ string  
TimeFormat ✔ string  
TimeGeneration ✔ ui4  
TimeServer ✔ string  
TimeZone ✔ string  

If the variable has a ✔ in the Sends events column, the service discovery specifies this variable emits events. A ❌ doesn’t mean that is won’t emit events.

Custom errors

The AlarmClockService has the following known custom errors.

Error code Description
801 Duplicate alarm time

This file is automatically generated with @svrooij/sonos-docs, do not edit manually.