Reads a user

$ curl 'http://platform.wim.tv:8080/rest/wowza/user/john' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000'

Path parameters

/rest/wowza/user/{userCode}

Parameter Description

userCode

The user code.

Request headers

Name Description

Accept

application/json

* Required.

Response

HTTP/1.1 200 OK
Content-Length: 31
Content-Type: application/json;charset=UTF-8

{
  "livePassword" : "public"
}

Response fields

Path Type Description

livePassword

String

The password for WimLive services. May be not provided.

Checks for an authorization token

$ curl 'http://platform.wim.tv:8080/rest/wowza/authtoken/d4ed68ba-39be-4e2e-ae22-f86ae733a84f' -i -X GET \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000'

Path parameters

/rest/wowza/authtoken/{token}

Parameter Description

token

The token.

Response

HTTP/1.1 200 OK

Response for invalid authorization token

HTTP/1.1 401 Unauthorized
Content-Length: 240
Content-Type: application/json;charset=UTF-8

{
  "message" : "Token di autorizzazione 4b10bda4-6d8d-4e28-bc07-67d73df8f016 non valido.",
  "error" : "Unauthorized",
  "timestamp" : 1646650376461,
  "status" : 401,
  "exception" : "net.cedeo.wimtv.ApplicationException",
  "path" : ""
}

Uploads a new content in WimBox

$ curl 'http://platform.wim.tv:8080/rest/wowza/user/john/box' -i -X POST \
    -H 'Accept: application/json' \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000' \
    -F 'file=@sample.mp4' \
    -F 'title=Title 1'

Path parameters

/rest/wowza/user/{userCode}/box

Parameter Description

userCode

Code of the user to impersonate.

Request headers

Name Description

Accept

application/json

* Required.

Request parts

See Uploads a new content in WimBox.

Response

HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 235

{
  "boxId" : "25f80e0e-97dd-448a-841d-f341dd9944be",
  "contentId" : "urn:wim:tv:content:fd270346-ccc5-457a-b031-ce1b91da2f27",
  "resourceId" : "851470ce-8410-4de9-8960-f7f089b1d28a",
  "title" : "Title 1",
  "creatorCode" : "john"
}

Response fields

Path Type Description

boxId

String

The WimBox item identifier.

contentId

String

The content identifier.

title

String

Title.

resourceId

String

The resource identifier.

creatorCode

String

Creator user code.

Reads a file resource

$ curl 'http://platform.wim.tv:8080/rest/wowza/vod?streamName=sample-d1c27507-cb16-4cc6-97cb-0edfb52853dd-tr.mp4' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000'

Request headers

Name Description

Accept

application/json

* Required.

Request parameters

Parameter Description

streamName

The object name.

Response

HTTP/1.1 200 OK
Content-Length: 28
Content-Type: application/json;charset=UTF-8

{
  "creatorCode" : "john"
}

Response fields

Path Type Description

creatorCode

String

Creator user code.

Reads a live channel

$ curl 'http://platform.wim.tv:8080/rest/wowza/live/channel/joetv1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000'

Path parameters

/rest/wowza/live/channel/{streamName}

Parameter Description

streamName

The stream name.

Request headers

Name Description

Accept

application/json

* Required.

Response

HTTP/1.1 200 OK
Content-Length: 28
Content-Type: application/json;charset=UTF-8

{
  "creatorCode" : "john"
}

Response fields

Path Type Description

creatorCode

String

Creator user code.

Reads a live event

$ curl 'http://platform.wim.tv:8080/rest/wowza/live/event/joetv1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000'

Path parameters

/rest/wowza/live/event/{streamName}

Parameter Description

streamName

The stream name.

Request headers

Name Description

Accept

application/json

* Required.

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 24

{
  "recorded" : false
}

Response fields

Path Type Description

recorded

Boolean

Whether the live event has to be recorded or not.

Reads a WimCast channel

$ curl 'http://platform.wim.tv:8080/rest/wowza/cast/channel/channel1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000'

Path parameters

/rest/wowza/cast/channel/{streamName}

Parameter Description

streamName

The stream name.

Request headers

Name Description

Accept

application/json

* Required.

Response

HTTP/1.1 200 OK
Content-Length: 86
Content-Type: application/json;charset=UTF-8

{
  "channelCode" : "ae974244-44e9-4216-8c8a-7d5df847fca3",
  "creatorCode" : "john"
}

Response fields

Path Type Description

channelCode

String

The stream channelCode.

creatorCode

String

Creator user code.

Reads a WimCast entity

$ curl 'http://platform.wim.tv:8080/rest/wowza/cast/entity/channel1' -i -X GET \
    -H 'Accept: application/json' \
    -H 'Accept-Language: it' \
    -H 'X-Wimtv-timezone: 3600000'

Path parameters

/rest/wowza/cast/entity/{streamName}

Parameter Description

streamName

The stream name.

Request headers

Name Description

Accept

application/json

* Required.

Response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 56

{
  "creatorCode" : "john",
  "entityType" : "CHANNEL"
}

Response fields

Path Type Description

entityType

Entity Type

Entity type.

creatorCode

String

Creator user code.

Authentication

The WimTV-Wowza integration APIs require BASIC authentication.

Custom Types

WimCast entity type

Value Description

CHANNEL

Channel.

STREAM

Stream.