MusicServiceAccount

The MusicServiceAccount object in the musicServiceAccounts namespace describes the music service account. See Account Matching for implementation details.

KeyTypeValue
userIdHashCodestringOpaque hash of the user account sent by your service in the match command.
nicknamestringThe name for the music service account presented to the user when they view their account from the Sonos app.
idstringThe account ID for the music service account.
isGuestBooleanIndicates whether the account is a guest account or not. If true, the account is a guest account. If false, it is not.
serviceServiceA service object describing the music service.

Example

This object will be sent in the body of a successful match response.

{
    "userIdHashCode": "opaque-user-id-hash",
    "nickname": "some-ui-friendly-nick-name",
    "id": "sn_3",
    "isGuest": false,
    "service": { "name":"abc", "id":"12", "imageUrl":"http://image.url"}
}