Contents

Get a Media Queue

Provide a playback queue from a successfully processed play media intent.

URL

POST https://cloudextension-testservice.local/api/queues/playMedia

Header Parameters

NameTypeDescription
Accept-Language Requiredstring

The client’s current user interface language. Respond with localized content for this language, if available.

User-Agent Requiredstring

The extension protocol running on the client. This is an RFC 7231-compliant string that contains the product name AppleCloudExtension and the SiriKit Extension library version running on the client.

x-applecloudextension-retry-count Optionaluint32

The number of previous requests from the client. The client omits this header on the first attempt.

x-applecloudextension-session-id Requiredstring

A constant session identifier to include in each request and response. Respond to each request with the session ID the client sends in that request.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
Queue

The request is successful.

204No Content

No more content exists for the requested queue.

401Unauthorized

The request requires authorization. The client may attempt to reauthorize and then retry.

410Gone

The request’s UserActivity is permanently expired and invalid for requesting a queue.

Discussion

There isn’t a default path for this endpoint. Specify the URL for this endpoint in your ExtensionConfig.Media.Queues.PlayMedia object.

HTTP Body

A UserActivity and constraints for the queue your service provides.

Topics

Receiving a Queue Request

Creating or Updating a Playback Queue

Providing Queue Items

Customizing Playback Controls

See Also

Media Play Queues