Players - Interface Definition

Players RESTful interface definition

Get all players

URL

http://<server>/dialogicwebservice/mediacontrol/players?appid=<appid>

Method

GET

Returns

200 OK & XML (dialogic/players+xml)

 

 

Create a new player

URL

http://<server>/dialogicwebservice/mediacontrol/players?appid=<appid>

Method

POST

Request Body

XML (dialogic/player+xml)

Returns

201 Created & Location + XML (dialogic/player+xml)

415 Unsupported Media Type

 

 

Get a specific player

URL

http://<server>/dialogicwebservice/mediacontrol/players/<identifier>?appid=<appid>

Method

GET

Returns

200 OK & XML (dialogic/player+xml)

404 Not Found

 

 

Delete a specific player

URL

http://<server>/dialogicwebservice/mediacontrol/players/<identifier>?appid=<appid>

Method

DELETE

Returns

204 No Content

404 Not Found

 

 

Update a specific player

URL

http://<server>/dialogicwebservice/mediacontrol/players/<identifier>?appid=<appid>

Method

PUT

Request Body

XML (dialogic/player+xml)

Returns

201 Created & Location

404 Not Found

415 Unsupported Media Type

 

 

dialogic/players and dialogic/player XML definitions

<players size="<size>">
    <player identifier="<identifier>" appid="<appid>"
        href="http://server/dialogicwebservice/mediacontrol/players/<identifier>"
        streamidentifier="<stream identifier>" conferenceidentifier="<conference identifier>"
        offset="<offset>" barge=”<boolean>”>
       <source location="<source>" />
   player/>
   <player identifier="<identifier>" appid="<appid>"
        href="http://server/dialogicwebservice/mediacontrol/players/<identifier>"
        streamidentifier="<stream identifier>" conferenceidentifier="<conference identifier>"
        offset="<offset>" barge=”<boolean>”>
       <source location="<source>" />
    player/>
    ...
</players>

 

For more information refer to Player.