Jump to Content
Public Sonos Documentation
Plan & BuildAPI ReferenceSMAPITools
Dev PortalPublic Sonos Documentation
Plan & Build
Dev Portal
Plan & BuildAPI ReferenceSMAPITools

Getting Started

  • How Sonos Works

Content Services

  • Getting started with Content Services
  • Components and interfaces
  • Supported audio content
  • Key requirements
  • SOAP requests and responses
  • Content on Sonos
  • Playback on Sonos
  • Synchronize your service
  • Security
  • Error handling
  • Test your service
  • Submit your service
    • Partner account types

Content Service Features

  • Adding Content Service features
  • Add actions
    • Album & artist
    • Related text
    • Related browse
    • Related play
    • Webpage
    • REST request
  • Add authentication
    • Add app authentication
    • Use authentication tokens
    • Add browser authentication
    • Add create account
    • Handle auth errors
    • Upgrade to OAuth
  • Add capabilities
  • Add favorites
  • Add images
    • Add album art
    • Add logos
    • Add browse icons
  • Add pagination
  • Add playlists
  • Add play/Shuffle all
  • Add podcasts
  • Add programmed radio
  • Add ratings
    • Configure ratings
    • Develop ratings
    • Use rating icons
  • Add reporting
  • Add search
  • Customize display
    • Configure display types
    • Create grids
    • Create lists
    • Create hero views
    • Customize root browse
  • Encrypt content
  • High-definition audio badging
  • Play audio (Cloud queue)
    • Account matching
    • Error handling (Cloud Queue)
    • Set playback policies
    • Playback policy list
    • Playback sessions
  • Save & resume playback
  • Localization
  • Supported audio formats
    • Streaming basics
    • HTTP Live Streaming (HLS)
    • FLAC best practices
  • Tag & filter explicit content
  • Troubleshooting
  • URL schemes

Connected Home

  • Connected Home
  • Architecture
  • Features
  • Quotas and spike arrests

Control Sonos Players

  • Control Sonos Players
  • Authorize
  • Discover
  • Control
  • Subscribe
  • Volume

Sound Experience Guidelines

  • Sound Experience Guidelines
  • Principles
  • Households
  • Groups
  • Playback
  • Volume
  • Hardware
  • Performance
  • Restrictions
  • Audio Feedback

Sonos Music API

  • Sonos Music API
    • addToContainer
    • createContainer
    • createItem
    • deleteContainer
    • deleteItem
    • getAppLink
    • getContentKey
    • getDeviceAuthToken
    • getDeviceLinkCode
    • getExtendedMetadata
    • getExtendedMetadataText
    • getLastUpdate
    • getMediaMetadata
    • getMediaURI
    • getMetadata
    • getScrollIndices
    • getSessionId
    • getUserInfo
    • rateItem
    • refreshAuthToken
    • removeFromContainer
    • renameContainer
    • reorderContainer
    • reportAccountAction
    • reportPlaySeconds
    • reportPlayStatus
    • reportStatus
    • search
    • setPlayedSeconds
  • SMAPI object types

Tools

  • Sample apps
    • JavaScript Control API Sample App

Types

  • Types
    • globalError
    • playMode
    • queueAction
    • Playback objects

Resources

  • Support
  • Terms of Service
  • Sonos Partners' 3P Guidelines & TOU

Sonos Partners' 3P Guidelines & TOU

  • Spotify Developer Terms

Updated almost 2 years ago