Actions

Actions are initiated by requests to the path /ecapi/action. The argument action determines which action will be run.

Call control

Making a call

The action dial calls a number, URI, favorite, or scheduled conference. One of these arguments must be provided.

For example:

• action?action=dial&number=name@example.com dials the URI name@example.com
• action?action=dial&number=%c3%b1%c3%a5m%c3%a9@example.com dials the URI ñåmé@example.com
• action?action=dial&favorite=567 dials the favorite with ID 567
• action?action=dial&scheduled_conference dials the next scheduled meeting (displays the Join Now tile on the Touch)
• action?action=dial&scheduled_conference=890 dials the scheduled meeting 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 only one call, always specify the callid.

Responding to an incoming call

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

Conferencing

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

For example:

• action?action=dial&number=john@example.com sets up a point-to-point call with John
• action?action=add_participant&callid=9876 starts the promotion of the call to a meeting
• action?action=dial&number=alice@example.com adds Alice to the meeting as soon as she answers the call
• action?action=add_participant&callid=9876 prepares to add another participant
• action?action=dial&number=bob@example.com adds Bob to the meeting as soon as he answers the call
• action?action=kick_participant&partid=567 removes Alice from the meeting
• action?action=hangup leaves the meeting and continues the call with remaining participants

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.)

Move camera

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

On Teamline 5141 systems, only PTZ USB cameras can be controlled. Static cameras such as the Logitech Brio cannot be moved.

For example, action?action=camera_control&preset=3 moves the camera to camera preset 3.

Camera preset is one of:

Audio

Audio mute

The audio_mute action modifies the audio mute state of the Teamline system.

Volume

The volume action controls the volume of the devices attached to the Teamline system. Volume levels are integers 0 to 10; attempts to move outside this range will saturate.

• ringer controls the ringer volume
• incall is usually the HDMI/TV output but could be the audio line-out. It affects the audio device used for the call

If no device is specified, the currently active audio device is used. When not in a call, this is the ringer volume.

Video

PC sharing

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

Video mute

The video_mute action modifies the video mute state of the Teamline system.

Self view

The self_view action sets the self view display mode.

Picture-in-picture

The pip action allows you to control picture-in-picture settings. This can be used, for example, if you want to hide the row of video participants when viewing content on a single screen.

Layout

The layout action allows you to scroll through next or previous screen layouts during meetings.

Other actions

Standby

Camera and microphone standby is separate from screen standby; you can locally share content from a PC or other source without causing the camera to come out of standby.

The standby action (on) moves the camera into the privacy position and mutes the microphone. The Maestro setting for AV Standby Timeout must be disabled to use this action.

The tv_standby action (on) stops sending video to the displays. The Maestro setting for Display Standby Timeout must be disabled to use this action.

Keypad

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

Help

The help action enumerates the available actions and returns them as a JSON array.