Key requirements

To create a valid Sonos music service, you must:

1. Add the following core set of API requests, with valid success responses and error handling:

   1. APIs to add your content to Sonos. See content on Sonos.
      • getMetadata
      • getExtendedMetadata
   2. APIs to playback your content on Sonos. See playback on Sonos.
      • getMediaURI
      • getMediaMetadata
   3. An API to synchronize and update your content for Sonos users. See synchronize your service.
      • getLastUpdate

2. Handle pagination for large lists of content in the content API requests that support it. See Add pagination for details.

3. Return defined errors as expected. See error handling for details.

4. Use Transport Layer Security (TLS) and Secure Sockets Layer (SSL) security requirements in your SMAPI implementation. See security for details.

5. Handle all valid API calls, even if you don't support everything that they can do. See the SMAPI reference pages for details.

6. Requests will come from a central Sonos cloud service. To prevent any errors, allow traffic from the following IP addresses by whitelisting and removing any rate limiting:

   Prod US	Prod EU
   44.215.7.120	3.254.19.106
   44.205.206.64	54.228.149.139
   52.44.15.120	52.215.51.102

IPv6 allowlisting is not currently supported for Sonos cloud service traffic. Use the IPv4 addresses listed above when configuring firewall allowlists or rate limiting rules.

As a Sonos content service partner, you decide which features to support. If you don't support a feature, your service must still send a reasonable, expected response. In your response, you can let the user know that your service does not support the requested feature.