Reads a user

$ curl 'http://www.wim.tv:8080/rest/wowza/user/john' -i -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-Type: application/json;charset=UTF-8
Content-Length: 31

{
  "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://www.wim.tv:8080/rest/wowza/authtoken/13a3bf04-0846-49cb-b2ce-7d4a84ca301d' -i -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-Type: application/json;charset=UTF-8
Content-Length: 240

{
  "message" : "Token di autorizzazione f9902c11-c0bc-4b2d-b91a-0b5c4ba1641d non valido.",
  "error" : "Unauthorized",
  "timestamp" : 1510765838994,
  "status" : 401,
  "exception" : "net.cedeo.wimtv.ApplicationException",
  "path" : ""
}

Uploads a new content in WimBox

$ curl 'http://www.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

Response

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

{
  "title" : "Title 1",
  "resourceId" : "87f6cf19-10c3-4b7f-8e6a-4236caf58577",
  "contentId" : "urn:wim:tv:content:49ab8188-c849-4c6f-9155-ec51e99ad11b",
  "boxId" : "78cde2c2-dbeb-4ca2-81d7-8a719c5c22ca",
  "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://www.wim.tv:8080/rest/wowza/vod?streamName=sample-1e72d910-59d3-4e09-a094-1b5b9027229f-tr.mp4' -i -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-Type: application/json;charset=UTF-8
Content-Length: 28

{
  "creatorCode" : "john"
}

Response fields

Path Type Description

creatorCode

String

Creator user code.

Reads a live channel

$ curl 'http://www.wim.tv:8080/rest/wowza/live/channel/joetv1' -i -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-Type: application/json;charset=UTF-8
Content-Length: 28

{
  "creatorCode" : "john"
}

Response fields

Path Type Description

creatorCode

String

Creator user code.

Reads a live event

$ curl 'http://www.wim.tv:8080/rest/wowza/live/event/joetv1' -i -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: 23

{
  "recorded" : true
}

Response fields

Path Type Description

recorded

Boolean

Whether the live event has to be recorded or not.

Reads a WimCast channel

$ curl 'http://www.wim.tv:8080/rest/wowza/cast/channel/channel1' -i -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-Type: application/json;charset=UTF-8
Content-Length: 28

{
  "creatorCode" : "john"
}

Response fields

Path Type Description

creatorCode

String

Creator user code.

Reads a WimCast entity

$ curl 'http://www.wim.tv:8080/rest/wowza/cast/entity/channel1' -i -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.