What's New (developer release notes)

When Sonos releases new software, we share release notes with our users. Click the Software Version number in the table below to open these release notes. Click a link in the New Features and Updates section to learn how to add new functionality to your SMAPI service. See below for details about software version and build numbers.

If you're new to SMAPI, be sure to check out the Sonos Music API - Getting Started Guide.

Integrating a Music Service with Sonos


This document guides you through integrating your music service with Sonos. The table below summarizes the phases and time involved in making your service live on the Sonos app.

Phase Duration Description


A few hours to a day

Sonos Music API - Getting Started Guide

The Sonos Wireless HiFi System allows users to wirelessly access and play music from a variety of sources throughout their home. The system consists primarily of players (speakers) organized into groups that play concurrently, controllers (client software to control the system; available for mobile devices, tablets, and computers), and music services (such as yours) that process requests to browse, play, or rate music. The system also supports playing music from a user's own personal collection stored on a mobile device, computer, or network drive.

Sonos Music API - Reference


Sonos uses the Sonos Music API (SMAPI) to communicate with your music service. It is a platform independent, language independent Web services API that uses SOAP for messaging.

Sonos is the client of this API, sending requests via SMAPI to your server endpoint. Your SMAPI implementation responds to these requests, allowing users to access their own personal accounts at your services using Sonos apps and players.

Troubleshooting Your SMAPI Implementation

Here are some common questions other partners have asked after starting their implementation. For more help, see questions tagged "sonos" on StackOverflow.

Why am I seeing so many getExtendedMetadata calls?

If you have implemented ratings or favorites, these capabilities can cause additional getExtendedMetadata requests. See the getExtendedMetadata documentation for details.

Frequently Asked Questions


What kind of music services are eligible to be added to the Sonos Platform?

Sonos Labs is intended for licensed and legal music services such as on demand, subscription, cloud-based access models and radio streaming services.

What is Multiple Account Support?

Sonos provides multiple account support for music services. Each person in a household with an account on your music service can add it to Sonos to play the music they love.

Sequence Diagrams

See the Sequence diagrams in this book for illustrations of communications between Sonos Player Groups, Sonos Controllers, and your Music Service.

Sonos Music API - Glossary

The following terminology is used to describe components of the Sonos system and the Sonos Music APIs.

container - an object containing a group of items potentially including both single elements and other containers. Containers are similar to folders or directories in file systems; they serve to create hierarchical trees and to keep like items together. Both playlists and albums are containers that contain track items.

Syndicate content