The following table contains the Buddies RESTful interface definition.
Get all buddies |
|
| URL | http://<server>/dialogicwebservice/mediacontrol/buddies?appid=<appid> |
| Method | GET |
| Returns | 200 OK & XML (dialogic/buddys+xml) |
Create a new buddy |
|
| URL | http://<server>/dialogicwebservice/mediacontrol/buddies?appid=<appid> |
| Method | POST |
| Request Body | XML (dialogic/buddy+xml) |
| Returns | 201 Created & Location + XML (dialogic/buddy+xml) |
| 415 Unsupported Media Type | |
Get a specific buddy |
|
| URL | http://<server>/dialogicwebservice/mediacontrol/buddies/<identifier>?appid=<appid> |
| Method | GET |
| Request Body | XML (dialogic/buddy+xml) |
| Returns | 200 OK & XML (dialogic/buddy+xml) |
| 404 Not Found | |
Delete a specific buddy |
|
| URL | http://<server>/dialogicwebservice/mediacontrol/buddies/<identifier>?appid=<appid> |
| Method | DELETE |
| Returns | 204 No Content |
| 404 Not Found | |
Update a specific buddy |
|
| URL | http://<server>/dialogicwebservice/mediacontrol/buddies/<identifier>?appid=<appid> |
| Method | PUT |
| Request Body | XML (dialogic/buddy+xml) |
| Returns | 201 Created & Location |
| 404 Not Found | |
| 415 Unsupported Media Type | |
dialogic/buddies and dialogic/buddy XML definitions
<buddies size="<size>">
<buddy identifier="<identifier>" appid="<appid>"
href="http://server/dialogicwebservice/mediacontrol/buddies/<identifier>">
<mediastream identifier="<stream identifier>" action=”<action>” />
<mediastream identifier="<stream identifier>" action=”<action>” />
<mediastream identifier="<stream identifier>" action=”<action>” />
...
</buddy>
<buddy identifier="<identifier>" appid="<appid>"
href="http://server/dialogicwebservice/mediacontrol/buddies/<identifier>">
<mediastream identifier="<stream identifier>" action=”<action>” />
<mediastream identifier="<stream identifier>" action=”<action>” />
<mediastream identifier="<stream identifier>" action=”<action>” />
...
</buddy>
...
</conferences>
For more information refer to Buddy.