While playing content, a client application must send regular keep-alive requests to keep the OTT session active. When SSM receives a keep-alive request, it checks the session state and if it is still valid, it returns a success response to the client containing a new session token and an updated licence. This token must be used in the next call.
If a client app does not send keep-alive request for a session within the required time period (as returned in a success response to a session setup request), the session token becomes invalid and after a short time the licence is revoked, which causes playback to stop.
Request
To send a keep-alive request, send an HTTP POST request to:
http://<host>:<port>/{frontEndAddress}/{tenantId}/ssm/v1/sessions/renewal-license-wv
Headers
-
nv-authorizations– the most recent session token (returned by the session setup request or the previous keep-alive call)
Mandatory parameters
-
challenge– the Widevine licence request (Base64-encoded)
Response
A successful response returns an HTTP 200 status. The response body contains:
-
sessionToken– a new SSP session token to be used in the next request -
license– the updated Widevine licence (Base64-encoded)
See the API documentation below for the full list of return codes.
See also
For full details of this API, see Widevine heartbeat.