Actions are initiated by requests to the path /ecapi/action.

The argument action is used to determine which action will be run.

Call control

Making a call

The action dial calls a number, URI, favorite, or scheduled conference. Exactly one of those arguments must be provided.

Parameter Data type Description
number string Number or URI to dial.
favorite integer Favorite ID to dial.

scheduled_conference

integer Call the scheduled conference with the given ID.
boolean Call the next scheduled conference.


Examples:

  • action?action=dial&number=1234
    Dial the number 1234.
  • action?action=dial&number=name@example.com
    Dial the URI name@example.com.
  • action?action=dial&number=%c3%b1%c3%a5m%c3%a9@example.com
    Dial the URI ñåmé@example.com.
  • action?action=dial&favorite=567
    Dial the favorite with ID 567.
  • action?action=dial&scheduled_conference
    Dial the next scheduled conference (this implements the Join Now button).
  • action?action=dial&scheduled_conference=890
    Dial the scheduled conference with ID 890.

Ending a call

The action hangup ends a call. If no callid is specified, it hangs up the current foreground call. (In general, unless you are sure that you have exactly one call then always specify the callid to avoid surprises.)

Parameter Data type Description
callid integer ID of call to hang up.

Responding to an incoming call

The actions answer, reject and ignore respond to an incoming call. All take zero (to respond to the first incoming call that has not already been responded to) or one (to respond to a specific call) arguments.

Parameter Data type Description
callid integer ID of call to respond to.

Conferencing

The actions add_participant and dial can be used to escalate a point-to-point call into an ad hoc conference and also can be used repeatedly to add more participants to an existing scheduled or ad hoc conference. A participant can be removed from the conference using kick_participant

Parameter Data type Description
callid integer ID of call or conference being acted on.
partid integer ID of participant in the conference to act on.

Example conference sequence:

  1. action?action=dial&number=john@example.com
    Set up a point-to-point call with John
  2. action?action=add_participant&callid=9876
    Start the promotion of the call to a conference
  3. action?action=dial&number=alice@example.com
    Add Alice to the conference as soon as she answers the call
  4. action?action=add_participant&callid=9876
    Prepare to add another participant
  5. action?action=dial&number=bob@example.com
    Add Bob to the conference as soon as he answers the call
  6. action?action=kick_participant&partid=567
    Remove Alice from the conference
  7. action?action=hangup
    Leave the conference; it continues with the two remaining participants (Bob and John)

Camera control

Select camera

The camera_select action selects the active camera on systems with multiple cameras. The cameras are zero-indexed (for example, on a system supporting three cameras, the three cameras are 0, 1 and 2).

Parameter Data type Description
index integer Camera index to switch to.

Move camera

The camera_control action is used to move the local active camera. Moving local cameras other than the active camera is not supported.

Parameter Data type Description
local boolean Move the local camera. This is the default.
stop boolean Stop moving the camera.
direction string Direction to move in: one of up, down, left, right, zoom-in or zoom-out.
duration integer Number of milliseconds to continue the move action for. Defaults to 100ms.

Audio

Audio mute

The audio_mute action modifies the audio mute state of the endpoint.

Parameter Data type Description
on boolean Audio muted.
off boolean Audio unmuted.
toggle boolean Toggle. This is the default.

Volume

The volume action controls the volumes of the devices attached to the endpoint. Volume levels are integers 0 to 10 – attempts to move outside this range will saturate.

Parameter Data type Description
device string Device to modify volume on – see below.
absolute integer Set to the given absolute volume.
relative integer Modify the current volume by the (possibly negative) value given.
direction string up or down – equivalent to relative +1 and –1 respectively.

 

  • ringer – The ringer volume.
  • incall– This is usually the HDMI/TV output, but could equally be the audio line-out. It affects whichever audio device is in-use for the call

If no device is specified, then the currently active audio device is used. (When out of call, this is the ringer.)

Video

PC sharing

The share_pc action changes whether the PC is being shared on the currently active call.

Parameter Data type Description
on boolean Switch on.
off boolean Switch off.
toggle boolean Toggle. This is the default.

Video mute

The video_mute action modifies the video mute state of the endpoint.

Parameter Data type Description
on boolean Switch on.
off boolean Switch off.
toggle boolean Toggle. This is the default.

Self view

The self_view action sets the self view display mode.

Parameter Data type Description
auto boolean Set to automatic mode.
off boolean Set to always off.
on boolean Set to always on.

Other actions

Keypad

The keypad action sends digits as if typed on the keypad. This creates DTMF digits while in call. On a StarLeaf endpoint, this opens a new call and starts dialing when the endpoint is not currently in a call.

Parameter Data type Description
digits string Digits to dial.

Help

The help action enumerates the available actions, returning them as a JSON array.