Add/Update Listen

Endpoint

POST /listens - starts/updates an user’s podcast episode listening session

Parameters

Parameter Parameter Type Data Type
api-key header string Required
Authorization header string Required
episode_id form param integer Required
progress form param float Required
type form param string available values: episode, record

For starting a session progress will be 0.

Error messages

  • invalid HTTP_API_KEY
  • Not authenticated

HTTP response codes:

  • 200 - Success
  • 401 - Unauthorized action

Example request

curl --request POST \
  --url https://api-dev.radiozu.ro/v1/listens \
  --header 'Authorization: Bearer AUTH_TOKEN' \
  --header 'api-key: API_KEY' \
  --data episode_id=11 \
  --data progress=15.1 
  --data type=episode

Response fields

A listen object containing a link between an user and a podcast episode.

  • id - id of listening session
  • user_id - user_id
  • episode_id - id of the episode being listened
  • progress - progress
  • type - type of listen: episode, record

Example response for type=record

{
    "data": {
        "id": 8,
        "episode_id": 3,
        "user_id": 4,
        "progress": "159.1",
        "type": "record"
    }
}

Example response for type=episode

{
	"data": {
		"id": 1,
		"episode_id": 11,
		"user_id": 4,
		"progress": "159.1",
		"type": "episode"
	}
}