cURL Header

api-key specify your api-key to get access to API
user-client-token user client token
user-access-token user access token

response-type specify API response type : ("json" or "xml")
api-version specify required API version : ("v1.0" o "v1.1")

Live

URL :

 http://api.westream.com/live/create

Response :

{
    "message":"created successfully",
    "code":201,
    "success":true
}

Parameters :

 username(string) title(string) dateStart(DateTime yyyy-mm-dd hh:mm:ss) dateEnd(DateTime yyyy-mm-dd hh:mm:ss) type(standard/360)

URL :

 http://api.westream.com/live/list

Response :

{
    "message":
                [
                    {
                        "idLive":"abcd1234",
                        "title":"Title test",
                        "dateStart":"2016-02-20 15:00:00",
                        "dateEnd":"2016-03-01 16:00:00",
                        "streamName":"abcd1-username",
                        "status":"available",
                        "type":"standard"
                    },
                    {
                        "idLive":"abcde12345",
                        "title":"Title test 2",
                        "dateStart":"2016-02-25 14:00:00",
                        "dateEnd":"2016-02-27 14:00:00",
                        "streamName":"1234-username",
                        "status":"on-air",
                        "type":"360"
                    }
                ],
    "code":200,
    "success":true
}

Parameters :

username(string)

URL :

 http://api.westream.com/live/update

Response :

{
    "message":"Updated successfully",
    "code":200,
    "success":true
}

Parameters :

idLive(string) title(string) dateStart(string) dateEnd(string)

URL :

 http://api.westream.com/live/on-air

Response :

{
    "message":"Updated successfully",
    "code":200,
    "success":true
}

Parameters :

idLive(string) title(string) dateStart(DateTime yyyy-mm-dd hh:mm:ss) dateEnd(DateTime yyyy-mm-dd hh:mm:ss)

URL :

 http://api.westream.com/live/delete

Response :

{
    "message":"Deleted successfully",
    "code":200,
    "success":true
}

Parameters :

idLive(string)

URL :

 http://api.westream.com/live/recreate

Response :

    {
    "message":"recreated successfully",
    "code":200,
    "success":true
    }

Parameters :

username(string) idLive(string) dateStart(DateTime yyyy-mm-dd hh:mm:ss) dateEnd(DateTime yyyy-mm-dd hh:mm:ss)

URL :

 http://api.westream.com/live

Response :

{
    "message": {
                    "idLive":"xxxx",
                    "title":"user title",
                    "dateStart":"0000-00-00 00:00:00",
                    "dateEnd":"0000-00-00 00:00:00",
                    "streamName":"1ds2-username",
                    "status":"available",
                    "recordStart":"false",
                    "type":"standard"
                },
    "code":200,
    "success":true
}

Parameters :

idLive(string)

Recording

link :

 http://api.westream.com/live/record/start

Response :

{
    "message":
                {
                    "idRecording":"1234abcd",
                    "fileName":"Channel0_1234.mp4",
                    "streamName":"dfsdf-Channel0"
                },
    "code":200,
    "success":true
}

Parameters :

idLive (string)

link :

 http://api.westream.com/live/record/stop

Response :

{
    "message":"Record stopped",
    "code":200,
    "success":true
}

Parameters :

idLive (string) idRecording(string) - Response id of start or split

link :

 http://api.westream.com/live/record/split

Response :

{
    "message":
                {
                    "idRecording":"1234abcd",
                    "fileName":"Channel0_1234.mp4",
                    "streamName":"dfsdf-Channel0"
                },
    "code":200,
    "success":true
}

Parameters :

idLive (string)

link :

 http://api.westream.com/live/record/status

Response :

{
    "message":"record stoped",
    "code":200,
    "success":true
}

Parameters :

idLive (string)

Record stream file

link :

 http://api.westream.com/live/record/stream/list

Response :

{
    "message":
                [
                    {
                        "idRecording":"abcd123",
                        "title":"Channel test",
                        "date":"2016-02-26 10:52:02",
                        "fileName":"123-username.mp4",
                        "streamName":"123-username"
                    },
                    { ... },
                    { ... }
                ],
    "code":200,
    "success":true
}

Parameters :

username(string)

link :

 http://api.westream.com/live/record/stream/delete

Response :

{
    "message":"Deleted successfully",
    "code":200,
    "success":true
}

Parameters :

idRecording(string)

Output response example 

{
    "api_version": "v1.1"
    "results":
                [
                    { ... },
                    { ... }
                ],
    "message" : " ... ",
    "status_code" : "200",
    "success" : "true/false",
    "errors":
                {
                    "err_message" : " test error",
                    "err_code" : 34
                }
}
                        
{
    "api_version": "v1.0"
    "message":
                [
                    { ... },
                    { ... }
                ],
    "code" : "200",
    "success" : "true/false",
}

Errors

200 : Ok - Success!!

201 : Created

204 : Non content - There was no data to return.

400 : bad request - The request was invalid or cannot be otherwise served.

401 : Unauthorized - Authentication credentials were missing or incorrect.

403 : forbidden - The request is understood, but it has been refused or access is not allowed.

404 : Not found - The URI requested is invalid or the resource requested, such as a user, does not exists.

406 : Not Acceptable

500 : Internal Server Error - Something is broken.