Sonos

Click here for a complete list of operations.

getAppLink

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /Sonos.asmx HTTP/1.1
Host: sonos.jukeboxy.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.sonos.com/Services/1.1#getAppLink"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <credentials xmlns="http://www.sonos.com/Services/1.1">
      <loginToken>
        <token>string</token>
        <key>string</key>
        <householdId>string</householdId>
      </loginToken>
      <deviceId>string</deviceId>
      <deviceProvider>string</deviceProvider>
    </credentials>
  </soap:Header>
  <soap:Body>
    <getAppLink xmlns="http://www.sonos.com/Services/1.1">
      <householdId>string</householdId>
      <hardware>string</hardware>
      <osVersion>string</osVersion>
      <sonosAppName>string</sonosAppName>
      <callbackPath>string</callbackPath>
    </getAppLink>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <getAppLinkResponse xmlns="http://www.sonos.com/Services/1.1">
      <getAppLinkResult>
        <authorizeAccount>
          <appUrl>string</appUrl>
          <appUrlStringId>string</appUrlStringId>
          <deviceLink>
            <regUrl>string</regUrl>
            <linkCode>string</linkCode>
            <showLinkCode>boolean</showLinkCode>
            <linkDeviceId>string</linkDeviceId>
          </deviceLink>
        </authorizeAccount>
        <createAccount>
          <appUrl>string</appUrl>
          <appUrlStringId>string</appUrlStringId>
        </createAccount>
      </getAppLinkResult>
    </getAppLinkResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /Sonos.asmx HTTP/1.1
Host: sonos.jukeboxy.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <credentials xmlns="http://www.sonos.com/Services/1.1">
      <loginToken>
        <token>string</token>
        <key>string</key>
        <householdId>string</householdId>
      </loginToken>
      <deviceId>string</deviceId>
      <deviceProvider>string</deviceProvider>
    </credentials>
  </soap12:Header>
  <soap12:Body>
    <getAppLink xmlns="http://www.sonos.com/Services/1.1">
      <householdId>string</householdId>
      <hardware>string</hardware>
      <osVersion>string</osVersion>
      <sonosAppName>string</sonosAppName>
      <callbackPath>string</callbackPath>
    </getAppLink>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <getAppLinkResponse xmlns="http://www.sonos.com/Services/1.1">
      <getAppLinkResult>
        <authorizeAccount>
          <appUrl>string</appUrl>
          <appUrlStringId>string</appUrlStringId>
          <deviceLink>
            <regUrl>string</regUrl>
            <linkCode>string</linkCode>
            <showLinkCode>boolean</showLinkCode>
            <linkDeviceId>string</linkDeviceId>
          </deviceLink>
        </authorizeAccount>
        <createAccount>
          <appUrl>string</appUrl>
          <appUrlStringId>string</appUrlStringId>
        </createAccount>
      </getAppLinkResult>
    </getAppLinkResponse>
  </soap12:Body>
</soap12:Envelope>