SpecifyDocs

Acquire briefing playback session

/v1/briefing-queues/{listenerPrincipalId}/playback-session

Signed-in sessionLaunch key product.briefingsOperation briefing_playback_session_acquire

Written and audio briefings from a person's work and memory: schedules, a listening queue, one player that keeps playing across the suite, a private feed and verified email delivery.

Path parameters

listenerPrincipalIdstringRequired

Body

idempotencyKeystringRequired
deviceIdstringRequired
expectedVersionnumberRequired
takeoverbooleanRequired

Returns

errorobject
schemaVersion1
idstring
versionnumber
generationnumber
deviceIdstring
leaseExpiresAtnumber
mode"paused" | "playing" | "released"
pauseAfterCurrentboolean
currentItemIdstring
episodeIdstring
renderIdstring
positionMsnumber
positionVersionnumber
sequencenumber
orderVersionnumber

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.