Player Collectors - Interface Definition

PlayerCollectors RESTful interface definition

Get all playercollectors

URL

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

Method

GET

Returns

200 OK & XML (dialogic/playercollectors+xml)

 

  

Create a new playercollector

URL

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

Method

POST

Request Body

XML (dialogic/playercollector+xml)

Returns

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

415 Unsupported Media Type

 

  

Get a specific playercollector

URL

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

Method

GET

Returns

200 OK & XML (dialogic/playercollector+xml)

404 Not Found

 

  

Delete a specific playercollector

URL

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

Method

DELETE

Returns

204 No Content

404 Not Found

 

  

Update a specific playercollector

URL

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

Method

PUT

Request Body

XML (dialogic/playercollector+xml)

Returns

201 Created & Location

404 Not Found

415 Unsupported Media Type
   

 

dialogic/playercollectors and dialogic/playercollector XML definitions

<playercollectors size="<size>">
    <playercollector identifier="<identifier>" appid="<appid>"
        href="http://server/dialogicwebservice/mediacontrol/playercollectors/
            <identifier>"
        streamidentifier="<stream identifier>" offset="<offset>" barge="<boolean>"
         <source location="<source>" />
        num_digits="<num_digits>" digit_mask="<digit_mask>" firstdigit_timer="<MS>"
            interdigit_timer="<MS>" extradigit_timer="<MS>” return_digits="<return_digits>">
    </playercollector>

    <playercollector identifier="<identifier>" appid="<appid>"
        href="http://server/dialogicwebservice/mediacontrol/playercollectors/<identifier>"
        streamidentifier="<stream identifier>" offset="<offset>" barge="<boolean>"
        num_digits="<num_digits>" digit_mask="<digit_mask>" firstdigit_timer="<MS>"
            interdigit_timer="<MS>" extradigit_timer="<MS>" return_digits="<return_digits>">
        <source location="<source>" />
    </playercollector>
    ...
</playercollectors>

For more information refer to PlayerCollector.