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.
Parameter | Data type | Description |
---|---|---|
number | string | Number or URI to dial |
favorite | integer | Favorite ID to dial |
scheduled_conference |
integer | Call the scheduled meeting with the given ID |
boolean | Call the next scheduled meeting |
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.
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 (responds to the first incoming call that has not already been responded to) or one (responds 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 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
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 |
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.)
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 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.
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: up, down, left, right, zoom-in or zoom-out |
duration | integer | Number of milliseconds to continue the move action for. Defaults to 100ms |
preset | integer | Move the local camera to a camera preset. Camera presets are configured using Maestro |
Camera preset is one of:
Preset | Description |
---|---|
0 | The default preset from Maestro |
1, 2, 3, 4 | Presets 1-4 from Maestro |
Audio
Audio mute
The audio_mute action modifies the audio mute state of the Teamline system.
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 volume of the devices attached to the Teamline system. 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 |
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 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.
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 Teamline system.
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 | Automatic mode |
off | boolean | Always off |
on | boolean | Always on |
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.
Parameter | Data type | Description |
---|---|---|
auto | boolean | Use the PiP setting on the touchscreen |
off | boolean | Always off |
on | boolean | Always on |
Layout
The layout action allows you to scroll through next or previous screen layouts during meetings.
Parameter | Data type | Description |
---|---|---|
next | boolean | Scroll to the next screen |
previous | boolean | Scroll to the previous screen |
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.
Parameter | Data type | Description |
---|---|---|
off | boolean | Set to always off. Move the camera into the default position and unmute the microphone |
on | boolean | Set to always on. Move the camera into the privacy position and mute the microphone |
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.
Parameter | Data type | Description |
---|---|---|
off | boolean | Set to always off. The Teamline system will start sending video to the displays |
on | boolean | Set to always on. The Teamline system will stop sending video to the displays |
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.
Parameter | Data type | Description |
---|---|---|
digits | string | Digits to dial |
Help
The help action enumerates the available actions and returns them as a JSON array.