Report Playback Progress and Activity
Monitor progress through the playback queue.
URL
POST https://cloudextension-testservice.local/api/queues/updateActivityHeader Parameters
| Name | Type | Description |
|---|---|---|
Accept-Language Required | string | The client’s current user interface language. Respond with localized content for this language, if available. |
User-Agent Required | string | 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 Optional | uint32 | The number of previous requests from the client. The client omits this header on the first attempt. |
x-applecloudextension-session-id Required | string | 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
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | UpdateActivityResponse | The request succeeds, and the response includes an updated UserActivity or Queue. |
| 204 | No Content | The request succeeds, and the client can continue to use its current UserActivity and playback queue. | |
| 401 | Unauthorized | The request requires authorization. The client may attempt to reauthorize and then retry. | |
| 404 | Not Found | The provided QueueIdentifier doesn’t match any current queue, or is permanently expired. The client may still use its current UserActivity to request a new queue. | |
| 410 | Gone | The request’s UserActivity is permanently expired and invalid for requesting a queue. |
HTTP Body
The most recent state of the client’s playback queue.