API Reference
Dev Portal

match

post
{protocol}://api.ws.sonos.com/control/api/{version}/households//musicServiceAccounts/match

Use the match command in the musicServiceAccounts namespace to get the account ID of a music service user account from the player.

All players in the household return the same accounts. Changes made to a player are automatically replicated throughout the household.

Path Params
string
required

Target householdId

Body Params
string
required
length ≤ 256

Opaque hash of the user account. You must use the same algorithm used by your SMAPI server. See getDeviceAuthToken and getUserInfo SMAPI requests for details.

string
required
length ≤ 64

The name for the music service account presented to the user when they view their account from the Sonos app.

string
required
length ≤ 10

The unique identifier for the music service. Maximum length of 20 characters.

string | null

(Optional) The link code generated for device authentication. Your SMAPI service can also send this to the player in the getAppLink SMAPI request. The player can send it back in the getDeviceAuthToken SMAPI request.

string | null

(Optional) Private data associated with the link code to prevent phishing. Like linkCode, also sent in the getAppLink SMAPI request and returned in the getDeviceAuthToken SMAPI request.

Headers
uuid
deprecated

Client API Key for the integration. Required in V1 but deprecated in V2.

uuid

Correlation UUID for data tracking purposes

Responses

Updated over 2 years ago

Language
Credentials
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 2 years ago