Collectors - Interface Definition

Collectors RESTful interface definition

Get all collectors

URL

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

Method

GET

Returns

200 OK & XML (dialogic/collectors+xml)

 

 

Create a new collector

URL

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

Method

POST

Request Body

XML (dialogic/collector+xml)

Returns

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

415 Unsupported Media Type

 

 

Get a specific collector

URL

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

Method

GET

Returns

200 OK & XML (dialogic/collector+xml)

404 Not Found

 

 

Delete a specific collector

URL

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

Method

DELETE

Returns

204 No Content

404 Not Found

 

 

Update a specific collector

URL

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

Method

PUT

Request Body

XML (dialogic/collector+xml)

Returns

201 Created & Location

404 Not Found

415 Unsupported Media Type

   

 

dialogic/collectors and dialogic/collector XML definitions

<collectors size="<size>">
    <collector identifier="<identifier>" appid="<appid>"
        href="http://server/dialogicwebservice/mediacontrol/collectors/<identifier>"
        streamidentifier="<stream identifier>" />
    <collector identifier="<identifier>" appid="<appid>"
        href="http://server/dialogicwebservice/mediacontrol/collectors/<identifier>"
        streamidentifier="<stream identifier>" />
    <collector identifier="<identifier>" appid="<appid>"
        href="http://server/dialogicwebservice/mediacontrol/collectors/<identifier>"
        streamidentifier="<stream identifier>" state="/>

    ...

</collectors>

For more information refer to Collector.