There are three resource-based elements used by the PowerMedia XMS RESTful web service.
These elements are used in conjunction with one another to direct the PowerMedia XMS to make and receive calls, handle media during a call, manipulate audio and video conferences, and to catch events relating to calls, conferences and their media.
Each element makes use of the various HTTP methods – POST, PUT, DELETE and GET. The resource-based element chapters in this document contain HTTP method tables that define the request body content type if a request body is allowed. In addition, the tables supply the possible return code values as well as the response body content. The tables also contain a sample payload for that specific resource-based element type. This XML content is used in both HTTP requests and responses. Refer to the specific resource-based element sections for information about each of the three elements.
The appid shown in the URL request examples is for identifying the resources used, owned and created by a specific application. For example:
<web_service version="1.0">
<call_response
appid="[appid]"
identifier="[call_id]"
href="[base_url]/calls/[call_id]?appid=[appid]"
signaling = "yes"
source_uri=[uri]
sdp=[sdp]
call_type="inbound" />
</web_service>
Discrete appids are defined so that multiple applications may be simultaneously run on a single PowerMedia XMS. The appid indicates the ownership of a RESTful resource so that each resource that is created has an associated appid. The resources can only be viewed, modified, or deleted by an application with a matching appid. The appid is used throughout the PowerMedia XMS RESTful API to identify the intended application.
Note: The appid is pre-defined on the Routing page of the PowerMedia XMS Admin Console (also referred to herein as "Console"), which is used for post-operating system installation and configuration tasks. New appids may be added, or unwanted appids removed on the Routing page. Refer to the Dialogic® PowerMedia™ XMS Installation and Configuration Guide for detailed information about the Console.