Basic Operation and Commands

The following sections provide examples of basic commands.

Receiving an Inbound Call

The Call tab is used to handle setup and teardown of a call. Inbound calls require a SIP softphone to initiate the call using any SIP user name (or extension). When a call is made to the IP address of the PowerMedia XMS, notification of the call is sent to XMSTool and displayed in the Input window as shown below:

The call offered event ("incoming") can be observed in the Event Monitor window. Proceed as follows to reply to the event:

  1. In the Call tab, select the ID of the received call.

  2. Select AnswerCall from the Features drop-down list. Alternately, AcceptCall could be selected if, for example, early media were desired. This would allow a file to be played to the caller before the call is answered.

  3. Click Initialize Input to create a reply to the call offered event.
    The answer message will be automatically generated. Note that the default values set in the message may be edited if desired.

    answercall.png

  4. Click Update to send the answer message.
    The connection to the SIP softphone is now established.

Making an Outbound Call

The Call tab is used to handle outbound call setup and teardown. The SIP softphone to call should be set in a mode where it can detect incoming calls and either ring or automatically answer them.

  1. Click Initialize Input to generate a RESTful Call command.

  2. Edit the default command. For example, the destination_uri and source_uri should reflect the SIP address of the SIP softphone being called and the PowerMedia XMS, respectively. Other default values may be adjusted if desired.

  3. Click Create to launch the call.
    The SIP softphone will ring and the call is connected when answered.

Playing a File into a Call

Once a call is connected, media commands may be issued. In the following example, a multimedia file is played.

  1. Select the call ID.

  2. Select Play from the Features drop-down list.

  3. Click Initialize Input to provide a call action command to play a file.
    Although a default file and default parameters are provided, these may be edited before being sent.

  4. Click Update to send the message.
    If successful, the audio/video is heard/seen on the SIP softphone. The response to the play command is displayed in the Output window when the play is initiated, and a play termination event seen in the Event Monitor window once the play is complete.

Establishing a Conference

Once a call is idle, a video conference may be started. First, create a conference in which to add the call.

  1. Click the Conference tab.

  2. Click Initialize Input to get the default conference creation parameters. Edit them if desired.

  3. Click Create to establish the conference and generate a conference ID.

  4. Click the Call tab.

  5. Select the call ID and the ID of the conference just created.

  6. Select AddParty from the Features drop-down list.

  7. Click Initialize Input to build the XML message, which may be edited as desired.

  8. Click Update to add the caller to the conference.
    The SIP caller will be in a single-person conference.

For a multi-party conference, make additional calls and add each to the conference using the above procedure.

addparty.png

The conference may be torn down and cleaned up in the following order:

  1. Click the Conference tab.

  2. Select the call ID and click RemoveParty from the Features drop-down list.
    Repeat for each party in the conference.

  3. Select the call ID and click Disconnect for each party in the conference.

  4. Select the conference ID and click Delete.