API Commands Introduction for

Yealink Video Conferencing Systems

July. 2016
V1.06
API Commands Introduction for Yealink VCS
 Table of Contents

Table of Contents ...................................................................... iii

Introduction ............................................................................... 1
About This Guide .................................................................................................................. 1
Changes for Release 1, Guide Version 1.06................................................................... 1
Overview............................................................................................................................... 1
Supportive Environment ................................................................................................... 1
Using the API with a LAN Connection ............................................................................. 1
Using the API with a Serial Connection .......................................................................... 2
Diagram of Central Control System ............................................................................... 3

About the API Commands ........................................................ 5

Syntax Conventions ............................................................................................................. 5
Format Description of Data Packet .................................................................................... 6
Format of Sending API Command .................................................................................. 6
Format of Returning API Command ................................................................................ 6
Basic Command format ................................................................................................... 6
Command Response Syntax ........................................................................................... 6

Detailed Description of API Commands .................................. 9

answer ................................................................................................................................... 9
addrbook .............................................................................................................................. 9
button................................................................................................................................... 12
camera ................................................................................................................................ 19
callinfo ................................................................................................................................. 20
dial ....................................................................................................................................... 25
donotdisturb........................................................................................................................ 27
gendial ................................................................................................................................ 29
getcallid .............................................................................................................................. 29
history .................................................................................................................................. 30
inputsource ......................................................................................................................... 32
Incoming .............................................................................................................................. 33
Mute ..................................................................................................................................... 34
preset ................................................................................................................................... 35
storage ................................................................................................................................ 35
sysstatus .............................................................................................................................. 36
volume ................................................................................................................................. 39
version ................................................................................................................................. 40
API Commands Introduction for Yealink VCS
 Introduction for Central Control Environment

The features and syntax of central control API commands are covered in this guide. This
guide provides central control module introduction for readers to quickly understand the
related functions, and helps developers to complete follow-up programming work to
realize controlling Yealink video conferencing systems via LAN connection and Serial
connection.

The following parameters are new for this edition:

 callinfo on page 20

 getcallid on page 29

 sysstatus on page 36

 The API commands described in this guide apply to Yealink video conferencing
systems running firmware version 2.0 or later.

 The API commands can be sent to Yealink video conferencing systems over
network or serial port, to realize controlling the Yealink video conferencing systems.

 In order to make it easier for readers to understand the API syntax, the detailed API
syntax is introduced in the following chapters. For more information, refer to About
the API Commands on page 5.

Note The API commands are case sensitive.

If Yealink video conferencing system connects to the LAN, you can send API commands
to it through TCP protocol. The control system needs to know the IP address and port of
the Yealink video conferencing system.

1
API Commands Introduction for Yealink VCS

Configuration parameters needed:

 Console port should be set to 6024

 Yealink video conferencing system IP address

You can use the API with a serial connection to control Yealink video conferencing
system. The USB port on the Yealink video conferencing system can be used as a serial
port, and establishes a connection with serial port on the control system through a serial
cable.

Configuration parameters needed:

 Baudrate: 115200

 Databits: 8

 Stopbits: 1

 Parity: N (None)

2
 Introduction for Central Control Environment

Sends API commands

through LAN/Serial
connection
Video
Control
conferencing System
system Returns system status
through LAN/Serial
connection

Returns video
conferencing system
status

Sends API
commands

Touch Control

3
API Commands Introduction for Yealink VCS

4
 About the API Commands

The following conventions are used for the API command descriptions in this chapter. All
of the commands are case sensitive.

Convention Meaning

Multiple valid parameters are enclosed in angle

brackets and separated by the pipe (“|”)
character.

Example:

button <0|1|2|3|4|5|6|7|8|9|*|#>
<param1|param2|param3>
Returning Example:

Send:
button 0\r\n
return
button 0\r\n

Quotation marks indicate strings to be supplied by

the user.

Example:

dial auto “dialstring“

“x” Returning Example

Send:

dial auto “1235”\r\n

return

dial auto “1235”\r\n

A range of possible numeric values is enclosed in

{1..n}
braces.

Note The API commands listed in this guide are in alphabetical order. To make it easier for
users to manage and organize these commands, new commands will be added to the
table based on this rule.
This rule applies to reading and sorting API commands. It is not a rule for sending API
commands. The format of sending API commands is detailed in each API command.

5
API Commands Introduction for Yealink VCS

\r\n identifier represents the end of the API command. Every API command must end
with \r\n.

\r\n identifier represents the end of the API command. Every API command returned
carries \r\n.

1. Command (without parameter)

2. Command+ space +param1 (with a parameter)

3. Command+ space + param1 + space + param2 + space +... + space + paramN

(with multiple parameters)

4. Command + space + "string" (command with a string, the string is enclosed in

quotes)

5. Command+ space + param1 + space + "string"

Additional Tips

 Parameter list is optional. The command may or may not have parameters.

 Commands may or may not have string. The string should be enclosed in quotes.

 Command and parameter should be separated by a space.

 Multiple parameters should be separated by a space.

 String should be enclosed in quotes.

Successful Response

 Returning control commands (the control system sends control commands to video
conferencing system)

Command param\r\n

 Returning query commands (the control system sends query commands to video
conferencing system)

Command data\r\n

 Returning feedback commands (the video conferencing system provides feedback

6
 About the API Commands

to the control system)

Command data\r\n

Note Param represents parameter supported by command. Data represents the data
user wants to query.

Invalid Response

 Command is correct but the parameter is wrong:

error: command has illegal parameters\r\n

 Command is wrong:

error: command not found\r\n

7
API Commands Introduction for Yealink VCS

8
 Detailed Description of API Commands

The API commands supported by Yealink VCS V2.0 are described below. Readers can
use TCP tools or serial tools to test these API commands in the environment mentioned
above.

The availability of API commands depends on the firmware of video conferencing

system.

The commands listed below are in alphabetical order. To make it easier for users to
manage and organize these commands, new commands will be added to the table
based on this rule.

1. answer <yes|no>

answer answer <yes|no>

Valid values:
Parameter introduction
param - yes: answers calls.
(control command type)
- no: refuses calls.

Sending format answer <yes|no>\r\n

Returning format answer <yes|no>\r\n

Send:

answer yes\r\n
Example
return

answer yes\r\n

1. addrbook all

addrbook addrbook all

Parameter introduction
all Obtains all contacts’ information.
(control command type)

Sending format addrbook all\r\n

addrbook numid type “name” “numberlist”\r\n

Returning format
Note:

9
API Commands Introduction for Yealink VCS

- numid: contact id

- type: contact type

local: local contact

conf: conference contact

- “name”: contact's name strings

- “numberlist”: contact's number strings（maybe

multiple numbers）

Send：
addrbook all
return
addrbook 1 local “xiaoming” “123456” “231456” \r\n
addrbook 2 local “zhangpeng” “123456” “65412”
“98745”\r\n
Example
addrbook 3 local “pengp” “63251”\r\n
addrbook 4 conf “groud1_conf” “11111” “22222”
“5565655” “96363524”\r\n
addrbook 5 conf “group2_conf” “222241” “65412”
“654253”\r\n

addrbook all all done!

2. addrbook <local|conf> get all

addrbook addrbook <local|conf> get all

local Configures local contacts information.

Parameter
introduction conf Configures conference contact information.

(control command get Obtains the selected contacts’ information.

type)
all Obtains all local or conference contacts’ information.

Sending format addrbook <local|conf> get all\r\n

addrbook numid type “name” “numberlist”\r\n

Note:

- numid: contact id

- type: contact type

Returning format local: local contact

conf: conference contact

- “name”: contact's name strings

- “numberlist”: contact's number strings（maybe multiple

numbers）

Send：
Example
addrbook local get all

10
 Detailed Description of API Commands

return
addrbook 1 local “xiaoming” “123456” “231456” \r\n
addrbook 2 local “zhangpeng” “123456” “65412” “98745”\r\n
addrbook 4 local “zzddff” “123456” “231456” \r\n
addrbook 5 local “zmndhdn” “123456” “65412” “98745”\r\n
addrbook local get all all done!

3. addrbook <local|conf> get {1…n}

addrbook addrbook <local|conf> get {1…n}

local Configures local contacts information.

conf Configures conference contact information.

Parameter introduction
(control command type) get Obtains the selected contacts’ information.

n should be a positive integer. It represents

{1…n}
the number of contacts.

Sending format addrbook <local|conf> get {1…n}\r\n

addrbook numid type “name” “numberlist”\r\n

Note:

- numid: contact id

- type: contact type

Returning format local: local contact

conf: conference contact

- “name”: contact's name strings

- “numberlist”: contact's number strings（maybe

multiple numbers）

Send：
addrbook local get 2
return
addrbook 1 local “xiaoming” “123456” “231456” \r\n
addrbook 2 local “zhangpeng” “123456” “65412”
“98745”\r\n
addrbook local get 2 all done!

Example send:
addrbook conf get 3
return:
addrbook 1 conf “groud1_conf” “11111” “22222”
“5565655” “96363524”\r\n
addrbook 2 conf “group2_conf” “222241” “65412”
“654253”\r\n
addrbook 3 conf “group3_conf” “123654” “32165”
“52314”\r\n

11
API Commands Introduction for Yealink VCS

addrbook conf get 3 all done!

4. addrbook search “searchstring”

addrbook addrbook search “searchstring”

search Searches contacts’ information.

Parameter introduction
Configures the name string to be
(control command type) “searchstring”
searched.

Sending format addrbook search “searchstring”\r\n

addrbook numid type “name” “numberlist”\r\n

Note:

- numid: contact id

- type: contact type

Returning format local: local contact

conf: conference contact

- “name”: contact's name strings

- “numberlist”: contact's number strings（maybe

multiple numbers）

Send：
addrbook search “xiaoh”
Example return
addrbook 1 local “xiaoh” “123456” “231456” \r\n
addrbook 2 conf “xiaoh” “123456” “65412” “98745”\r\n

1. button power

button button power

Parameter introduction Sends the power button signal to the video conferencing
(control command type) system.

Sending format button power\r\n

Returning format button power\r\n

Send：
button power\r\n
Example
return
button power\r\n

12
 Detailed Description of API Commands

2. button F1

button button F1

Parameter introduction Sends the red shortcut button signal to the video
(control command type) conferencing system.

Sending format button F1\r\n

Returning format button F1\r\n

Send：
button F1\r\n
Example
return
button F1\r\n

3. button F2

button button F2

Parameter introduction Sends the yellow shortcut button signal to the video
(control command type) conferencing system.

Sending format button F2\r\n

Returning format button F2\r\n

Send：
button F2\r\n
Example
return
button F2\r\n

4. button F3

button button F3

Parameter introduction Sends the blue shortcut button signal to the video
(control command type) conferencing system.

Sending format button F3\r\n

Returning format button F3\r\n

Send：
button F3\r\n
Example
return
button F3\r\n

5. button volume+

button button volume+

Parameter introduction Sends the volume + button signal to the video

(control command type) conferencing system.

Sending format button volume+\r\n

Returning format button volume+\r\n

13
API Commands Introduction for Yealink VCS

Send：
button volume+\r\n
Example
return
button volume+\r\n

6. button volume-

button button volume-

Parameter introduction Sends the volume button signal to the video

(control command type) conferencing system.

Sending format button volume-\r\n

Returning format button volume-\r\n

Send：
button volume-\r\n
Example
return
button volume-\r\n

7. button zoom+

button button zoom+

Parameter introduction Sends the zoom+ button signal to the video

(control command type) conferencing system.

Sending format button zoom+\r\n

Returning format button zoom+\r\n

Send：
button zoom+\r\n
Example
return
button zoom+\r\n

8. button zoom-

button button zoom-

Parameter introduction Sends the zoom - button signal to the video

(control command type) conferencing system.

Sending format button zoom-\r\n

Returning format button zoom-\r\n

Send：
button zoom-\r\n
Example
return
button zoom-\r\n

14
 Detailed Description of API Commands

9. button up

button button up

Parameter introduction Sends the up arrow button signal to the video

(control command type) conferencing system.

Sending format button up\r\n

Returning format button up\r\n

Send：
button up\r\n
Example
return
button up\r\n

10. button down

button button down

Parameter introduction Sends the down arrow button signal to the video
(control command type) conferencing system.

Sending format button down\r\n

Returning format button down\r\n

Send：
button down\r\n
Example
return
button down\r\n

11. button right

button button right

Parameter introduction Sends the right arrow button signal to the video
(control command type) conferencing system.

Sending format button right\r\n

Returning format button right\r\n

Send：
button right\r\n
Example
return
button right\r\n

12. button left

button button left

Parameter introduction Sends the left arrow button signal to the video
(control command type) conferencing system.

Sending format button left\r\n

Returning format button left\r\n

15
API Commands Introduction for Yealink VCS

Send：
button left\r\n
Example
return
button left\r\n

13. button select

button button select

Parameter introduction Sends the OK button signal to the video conferencing

(control command type) system.

Sending format button select\r\n

Returning format button select\r\n

Send：
button select\r\n
Example
return
button select\r\n

14. button mute

button button mute

Parameter introduction Sends the mute button signal to the video conferencing
(control command type) system.

Sending format button mute\r\n

Returning format button mute\r\n

Send：
button mute\r\n
Example
return
button mute\r\n

15. button home

button button home

Parameter introduction Sends the home button signal to the video conferencing
(control command type) system.

Sending format button home\r\n

Returning format button home\r\n

Send：
button home\r\n
Example
return
button home\r\n

16
 Detailed Description of API Commands

16. button show

button button home

Parameter introduction Sends the video source button signal to the video
(control command type) conferencing system.

Sending format button show\r\n

Returning format button show\r\n

Send：
button show\r\n
Example
return
button show\r\n

17. button call

button button call

Parameter introduction Sends the off-hook button signal to the video

(control command type) conferencing system.

Sending format button call\r\n

Returning format button call\r\n

Send：
button call\r\n
Example
return
button call\r\n

18. button delete

button button delete

Parameter introduction Sends the delete button signal to the video conferencing
(control command type) system.

Sending format button delete\r\n

Returning format button delete\r\n

Send：
button delete\r\n
Example
return
button delete\r\n

19. button hangup

button button hangup

Parameter introduction Sends the on-hook button signal to the video

(control command type) conferencing system.

Sending format button hangup\r\n

Returning format button hangup\r\n

17
API Commands Introduction for Yealink VCS

Send：
button hangup\r\n
Example
return
button hangup\r\n

20. button <1|2|3|4|5|6|7|8|9|0|*|#>

button button <1|2|3|4|5|6|7|8|9|0|*|#>

Parameter introduction Sends corresponding numeric button or # or * button

(control command type) signal to the video conferencing system.

Sending format button <1|2|3|4|5|6|7|8|9|0|*|#>\r\n

Returning format button <1|2|3|4|5|6|7|8|9|0|*|#>\r\n

Send：
button 1\r\n
Example
return
button 1\r\n

21. button recordstart

button button recordstart

Parameter introduction Sends video recording button signal to the video

(control command type) conferencing system to start recording.

Sending format button recordstart\r\n

Returning format button recordstart\r\n

Send：
button recordstart\r\n
Example
return
button recordstart\r\n

22. button recordstop

button button recordstop

Parameter introduction Sends video recording button signal to the video

(control command type) conferencing system to stop recording.

Sending format button recordstop\r\n

Returning format button recordstop\r\n

Send：
button recordstop\r\n
Example
return
button recordstop\r\n

18
 Detailed Description of API Commands

23. button screenshot

button button screenshot

Parameter introduction Sends snapshot button signal to the video conferencing

(control command type) system.

Sending format button screenshot\r\n

Returning format button screenshot\r\n

Send：
button screenshot\r\n
Example
return
button screenshot\r\n

1. camera near move <left|right|up|down|zoom+|zoom-|stop>

camera camera near move <left|right|up|down|zoom+|zoom-|stop>

near Controls the near-site camera.

Changes the near-site camera’s direction

move
or zoom.

Parameter left: Starts moving the camera left.

introduction
right: Starts moving the camera right.
(control
command down：Starts moving the camera down.
<left|right|up|dow
type) n|zoom+|zoom-|st up: Starts moving the camera up.
op>
zoom+: Starts zooming in.

zoom-: Starts zooming out.

stop: Stops moving the near-site camera.

camera near move

Sending format
<left|right|up|down|zoom+|zoom-|stop>\r\n
Returning camera near move
format <left|right|up|down|zoom+|zoom-|stop>\r\n
Send：
camera near move left\r\n
Example
return
camera near move left\r\n

2. camera near <getposition|setposition “x” “y” “z”>

camera camera near <getposition|setposition “x” “y” “z”>

Parameter near Controls the near-site camera.

19
API Commands Introduction for Yealink VCS

introduction Obtains the pan(x), tilt(y), and zoom(z)

(control getposition coordinates of the currently selected PTZ camera in
command the format of pan tilt zoom.
type) Configures the pan(x), tilt(y), and zoom(z)
setposition coordinates of the currently selected PTZ camera in
the format of pan tilt zoom.

“x” 0 <= pan <= 1920

“y” 0 <= tilt <= 1080

“z” 0 <= zoom <= 100

Sending format camera near <getposition|setposition “x” “y” “z”>\r\n

Returning
camera near <getposition|setposition “x” “y” “z”>\r\n
format
Send：
camera near getposition\r\n
return
camera near getposition "1910.000000" "1060.000000"
Example "50.000000"\r\n
send:
camera near setposition "110.000000" "160.000000" "30.000000"\r\n
return
camera near setposition "110.000000" "160.000000" "30.000000"\r\n

1. callinfo all

callinfo callinfo all

Parameter
introduction
Returns information about each connection in the
(control all
call.
command
type)

Sending format callinfo all\r\n

For audio call:

callinfo audio “callid:63214” “RemoteStr:[email protected]”

“direction:incomging” “protocol:sip” “devInfo:Yealilnk VC110
Returning
50.20.251.31 38/2”“TotalBwRecv:48” “TotalBwSend:48”
format
“AcodecRecv:G.722.1C” “AcodecSend:G.722.1C” “ABwRecv:48”
“ABwSend:48’ “ASrRecv:32” “ASrSend:32” “AJrRecv:6”
“AJrSend:6” “AtplRecv:0” “AtplSend:0” “AtplpRecv:0”
“AtplpSend:0”\r\n

20
 Detailed Description of API Commands

For video call that does not receive content:

callinfo video “callid:63214” “RemoteStr:[email protected]”

“direction:outgoing” “protocol:sip” “devInfo:Yealilnk VC110
50.20.251.31 38/2”“TotalBwRecv:1664” “TotalBwSend:2096”
“VResRecv:192*1080” “VResSend:1920*1080”
“VCodecRecv:H.264” “VCodecSend:H.264” “VBwRecv:1547”
“VBwSend:2036” “VFrRecv:25:” “VFrSend:29” “VJrRecv:17”
“VJrSend:16” “VtplRecv:0” “VtplSend:0” “VtplpRecv:0”
“VtplpSend:0” “AcodecRecv:G.722.1C” “AcodecSend:G.722.1C”
“ABwRecv:48” “ABwSend:48’ “ASrRecv:32” “ASrSend:32”
“AJrRecv:6” “AJrSend:6” “AtplRecv:0” “AtplSend:0” “AtplpRecv:0”
“AtplpSend:0” “SResRecv:0” “SResSend:0” “SCodecRecv:0”
“SCodecSend:0” “SBwRecv:0” “SBwSend:0” “SFrRecv:0”
“SFrSend:0”\r\n

Parameter explanation:

1. TotalBwRecv: receive total bandwidths

2. TotalBwSend: transmit total bandwidths
3. VResRecv: receive video resolution
4. VResSend: transmit video resolution
5. VCodecRecv: receive video Codec type
6. VCodecSend: transmit video Codec type
7. VBwRecv: receive video bandwidths
8. VBwSend: transmit video bandwidths
9. VFrRecv: receive video frame rate
10. VFrSend：transmit video frame rate
11. VJrRecv: receive video Jitter (ms)
12. VJrSend: transmit video Jitter (ms)
13. VtplRecv: receive video packet loss
14. VtplSend: transmit video packet loss
15. VtplpRecv: receive video packet loss(%)
16. VtplpSend: transmit video packet loss(%)
17. AcodecRecv: receive audio Codec type
18. AcodecSend: transmit audio Codec type
19. ABwRecv: receive audio bandwidths
20. ABwSend: transmit audio bandwidths
21. ASrRecv: receive audio sample rate(k)
22. ASrSend: transmit audio sample rate(k)
23. AJrRecv: receive audio Jitter (ms)
24. AJrSend: transmit audio Jitter (ms)
25. AtplRecv: receive audio packet loss
26. AtplSend: transmit audio packet loss
27. AtplpRecv: receive audio packet loss (%)

21
API Commands Introduction for Yealink VCS

28. AtplpSend: transmit audio packet loss (%)

29. SResRecv: receive content resolution
30. SResSend: transmit content resolution
31. SCodecRecv: receive content Codec type
32. SCodecSend: transmit content Codec type
33. SBwRecv: receive content bandwidths
34. SBwSend: transmit content bandwidths
35. SFrRecv: receive content frame rate
36. SFrSend: transmit content frame rate

Units of bandwidth: kb/s

Units of frame rate: fps

When the video conferencing system is during a video call and an

audio call, the control system can get all call statistics.
Send:
callinfo all\r\n
Return
callinfo audio “callid:63214”
“RemoteStr:[email protected]” “direction:incomging”
“protocol:sip” “devInfo:Yealilnk VC110 50.20.251.31
38/2”“TotalBwRecv:48” “TotalBwSend:48” “AcodecRecv:G.722.1C”
“AcodecSend:G.722.1C” “ABwRecv:48” “ABwSend:48’
“ASrRecv:32” “ASrSend:32” “AJrRecv:6” “AJrSend:6” “AtplRecv:0”
“AtplSend:0” “AtplpRecv:0” “AtplpSend:0”\r\n
callinfo video “callid:63214” “RemoteStr:10.10.37.21”
Example
“direction:outgoing” “protocol:sip” “devInfo:Yealilnk VC110
50.20.251.31 38/2”“TotalBwRecv:1664” “TotalBwSend:2096”
“VResRecv:192*1080” “VResSend:1920*1080”
“VCodecRecv:H.264” “VCodecSend:H.264” “VBwRecv:1547”
“VBwSend:2036” “VFrRecv:25:” “VFrSend:29” “VJrRecv:17”
“VJrSend:16” “VtplRecv:0” “VtplSend:0” “VtplpRecv:0”
“VtplpSend:0” “AcodecRecv:G.722.1C” “AcodecSend:G.722.1C”
“ABwRecv:48” “ABwSend:48’ “ASrRecv:32” “ASrSend:32”
“AJrRecv:6” “AJrSend:6” “AtplRecv:0” “AtplSend:0” “AtplpRecv:0”
“AtplpSend:0” “SResRecv:0” “SResSend:0” “SCodecRecv:0”
“SCodecSend:0” “SBwRecv:0” “SBwSend:0” “SFrRecv:0”
“SFrSend:0”\r\n
callinfo all all done\r\n

2. callinfo callid “callid”

callinfo callinfo callid “callid”

Parameter Returns information about the connection

callid
introduction with the specified call ID.

22
 Detailed Description of API Commands

(control
command
type)

Sending format callinfo callid “63214”\r\n

For audio call:

callinfo audio “callid:63214” “RemoteStr:[email protected]”

“direction:incomging” “protocol:sip” “devInfo:Yealilnk VC110
50.20.251.31 38/2”“TotalBwRecv:48” “TotalBwSend:48”
“AcodecRecv:G.722.1C” “AcodecSend:G.722.1C” “ABwRecv:48”
“ABwSend:48’ “ASrRecv:32” “ASrSend:32” “AJrRecv:6”
“AJrSend:6” “AtplRecv:0” “AtplSend:0” “AtplpRecv:0”
“AtplpSend:0”\r\n

For video call that does not receive content:

callinfo video “callid:63214” “RemoteStr:[email protected]”

“direction:outgoing” “protocol:sip” “devInfo:Yealilnk VC110
50.20.251.31 38/2”“TotalBwRecv:1664” “TotalBwSend:2096”
“VResRecv:192*1080” “VResSend:1920*1080”
“VCodecRecv:H.264” “VCodecSend:H.264” “VBwRecv:1547”
“VBwSend:2036” “VFrRecv:25:” “VFrSend:29” “VJrRecv:17”
“VJrSend:16” “VtplRecv:0” “VtplSend:0” “VtplpRecv:0”
“VtplpSend:0” “AcodecRecv:G.722.1C” “AcodecSend:G.722.1C”
Returning “ABwRecv:48” “ABwSend:48’ “ASrRecv:32” “ASrSend:32”
format “AJrRecv:6” “AJrSend:6” “AtplRecv:0” “AtplSend:0” “AtplpRecv:0”
“AtplpSend:0” “SResRecv:0” “SResSend:0” “SCodecRecv:0”
“SCodecSend:0” “SBwRecv:0” “SBwSend:0” “SFrRecv:0”
“SFrSend:0”\r\n

For video call that receives content:

callinfo video “callid:63214” “RemoteStr:[email protected]”

“direction:outgoing” “protocol:sip” “devInfo:Yealilnk VC110
50.20.251.31 38/2”“TotalBwRecv:1664” “TotalBwSend:2096”
“VResRecv:192*1080” “VResSend:1920*1080”
“VCodecRecv:H.264” “VCodecSend:H.264” “VBwRecv:1547”
“VBwSend:2036” “VFrRecv:25:” “VFrSend:29” “VJrRecv:17”
“VJrSend:16” “VtplRecv:0” “VtplSend:0” “VtplpRecv:0”
“VtplpSend:0” “AcodecRecv:G.722.1C” “AcodecSend:G.722.1C”
“ABwRecv:48” “ABwSend:48’ “ASrRecv:32” “ASrSend:32”
“AJrRecv:6” “AJrSend:6” “AtplRecv:0” “AtplSend:0” “AtplpRecv:0”
“AtplpSend:0” “SResRecv:1920*1080” “SResSend:0”
“SCodecRecv:H.264” “SCodecSend:0” “SBwRecv:1974”
“SBwSend:0” “SFrRecv:30” “SFrSend:0”\r\n

23
API Commands Introduction for Yealink VCS

For video call that sends content:

callinfo video “callid:63214” “RemoteStr:[email protected]”

“direction:outgoing” “protocol:sip” “devInfo:Yealilnk VC110
50.20.251.31 38/2”“TotalBwRecv:1664” “TotalBwSend:2096”
“VResRecv:192*1080” “VResSend:1920*1080”
“VCodecRecv:H.264” “VCodecSend:H.264” “VBwRecv:1547”
“VBwSend:2036” “VFrRecv:25:” “VFrSend:29” “VJrRecv:17”
“VJrSend:16” “VtplRecv:0” “VtplSend:0” “VtplpRecv:0”
“VtplpSend:0” “AcodecRecv:G.722.1C” “AcodecSend:G.722.1C”
“ABwRecv:48” “ABwSend:48’ “ASrRecv:32” “ASrSend:32”
“AJrRecv:6” “AJrSend:6” “AtplRecv:0” “AtplSend:0” “AtplpRecv:0”
“AtplpSend:0” “SResRecv:0” “SResSend:1920*1080”
“SCodecRecv:” “SCodecSend:H.264” “SBwRecv:”
“SBwSend:1974” “SFrRecv:0” “SFrSend:30”\r\n

Parameter explanation:

1. TotalBwRecv: receive total bandwidths

2. TotalBwSend: transmit total bandwidths
3. VResRecv: receive video resolution
4. VResSend: transmit video resolution
5. VCodecRecv: receive video Codec type
6. VCodecSend: transmit video Codec type
7. VBwRecv: receive video bandwidths
8. VBwSend: transmit video bandwidths
9. VFrRecv: receive video frame rate
10. VFrSend：transmit video frame rate
11. VJrRecv: receive video Jitter (ms)
12. VJrSend: transmit video Jitter (ms)
13. VtplRecv: receive video packet loss
14. VtplSend: transmit video packet loss
15. VtplpRecv: receive video packet loss(%)
16. VtplpSend: transmit video packet loss(%)
17. AcodecRecv: receive audio Codec type
18. AcodecSend: transmit audio Codec type
19. ABwRecv: receive audio bandwidths
20. ABwSend: transmit audio bandwidths
21. ASrRecv: receive audio sample rate(k)
22. ASrSend: transmit audio sample rate(k)
23. AJrRecv: receive audio Jitter (ms)
24. AJrSend: transmit audio Jitter (ms)
25. AtplRecv: receive audio packet loss
26. AtplSend: transmit audio packet loss
27. AtplpRecv: receive audio packet loss (%)
28. AtplpSend: transmit audio packet loss (%)

24
 Detailed Description of API Commands

29. SResRecv: receive content resolution

30. SResSend: transmit content resolution
31. SCodecRecv: receive content Codec type
32. SCodecSend: transmit content Codec type
33. SBwRecv: receive content bandwidths
34. SBwSend: transmit content bandwidths
35. SFrRecv: receive content frame rate
36. SFrSend: transmit content frame rate

Units of bandwidth: kb/s

Units of frame rate: fps

1. dial auto “dialstring”

dial auto “dialstring“ (dial one contact)

or
dial auto “dialnumber1” “dialnumber2” “dialnumber3” (dial the
conference contacts)

Note:

This is a dial command. When you dial a contact, the video

dial
conferencing system will call a number. When you dial a
conference contact, the video conferencing system will call
multiple numbers. In other words, when sending one number, the
video conferencing system will call a local contact, when sending
multiple numbers, the video conferencing system will call the
conference contact.
Parameter Allows the user to dial a number using default call
auto
introduction type and call protocol.
(control
command “dialstring” Valid phone numbers string.
type)
dial auto “dialstring”\r\n
Sending format or
dial auto “dialnumber” “dialnumber” “dialnumber”\r\n
dial auto “dialstring”\r\n
Returning
or
format
dial auto “dialnumber” “dialnumber” “dialnumber”\r\n
When dialing a local contact:
Send：
Example dial auto “7001”\r\n
return
dial auto “7001”\r\n

25
API Commands Introduction for Yealink VCS

When dialing a conference contact:

Send:
dial auto “7001” “7002” “7003”\r\n
return
dial auto “7001” “7002” “7003”\r\n

2. dial manual <video|audio|auto> <auto|sip|h323> “speed” “dialstring”

dial manual <video|audio|auto> <auto|sip|h323> “speed”

Dial “dialstring”

Note: It is only applicable to dial a contact.

Allows the user to dial a number using

manual
call type and call protocol set manually.
Valid data rate for the network. Default
“speed”
value is “Auto”.

Specifies the desired call type for

placing calls.

Valid values:

- Auto: the video conferencing system

automatically uses the default call
<video|audio|auto>
type. Default value is Video.

- Video: the video conferencing

system dials video call.
Parameter
- Audio: the video conferencing
introduction
system dials audio call.
(control
command Specifies the desired call protocol for
type) placing calls.

Valid values:

- Auto: the video conferencing system

automatically uses the default call
protocol. Default value is H.323.
<auto|sip|h323>
- SIP: the video conferencing system
uses the SIP protocol for placing
calls.

- H.323: the video conferencing

system uses H.323 protocol for
placing calls.

“dialstring” Valid phone numbers string.

dial manual <video|audio|auto> <auto|sip|h323> “speed”

Sending format
“dialstring”\r\n
Returning dial manual <video|audio|auto> <auto|sip|h323> “speed”
format “dialstring”\r\n

26
 Detailed Description of API Commands

Send：
dial manual video sip “auto” “70001”\r\n
Example
return
dial manual video sip “auto” “70001”\r\n

1. donotdisturb global <get|on|off>

donotdisturb donotdisturb global <get|on|off>

Configures DND for the video conferencing

global
system.
Parameter
Valid values:
introduction
(control command - get: obtains the DND status.
params
type) - on: enables the DND feature.

- off: disables the DND feature.

Sending format from

donotdisturb global <get|on|off>\r\n
the control system
Returning format donotdisturb global get <on|off>\r\n
received by the or
control system donotdisturb global <on|off>\r\n
donotdisturb global get <on|off>\r\n

Note：

Once the DND status changes, the video conferencing

system will provide active feedback to the control system.

Format:

 The video conferencing system provides active

The video
feedback to the control system:
conferencing system
donotdisturb global get on\r\n
provides active
feedback to the  The control system receives the command:
control system donotdisturb global get on\r\n

 The video conferencing system provides active

feedback to the control system:

donotdisturb global get off\r\n

 The control system receives the command:

donotdisturb global get off\r\n

Send：
Example donotdisturb global get\r\n
return

27
API Commands Introduction for Yealink VCS

donotdisturb global get on\r\n

send:
donotdisturb global get\r\n
return
donotdisturb global get off\r\n
send:
donotdisturb global on\r\n
return
donotdisturb global on\r\n

2. donotdisturb talk <get|on|off>

donotdisturb donotdisturb talk <get|on|off>

talk Configures DND during a call.

Parameter
introduction Valid values:

(control - get: obtains the DND status during a call.

params
command - on: enables the DND feature during a call.
type)
- off: disables the DND feature during a call.

Sending format donotdisturb talk <get|on|off>\r\n

donotdisturb talk get <on|off>\r\n

Returning
or
format
donotdisturb talk <on|off>\r\n
donotdisturb talk get <on|off>\r\n

Note：

Once the DND status in a call changes, the video conferencing

system will provide active feedback to the control system.

Format:
The video
 The video conferencing system provides active feedback to
conferencing
the control system:
system
donotdisturb talk get on\r\n
provides active
feedback to  The control system receives the command:
the control donotdisturb talk get on\r\n
system
 The video conferencing system provides active feedback to
the control system:

donotdisturb talk get off\r\n

 The control system receives the command:

donotdisturb talk get off\r\n

Send：
Example donotdisturb talk get\r\n
return

28
 Detailed Description of API Commands

donotdisturb talk get on\r\n

send:
donotdisturb talk get\r\n
return
donotdisturb talk get off\r\n
send:
donotdisturb talk on\r\n
return
donotdisturb talk on\r\n

1. gendial <0|1|2|3|4|5|6|7|8|9|*|#>

gendial gendial <0|1|2|3|4|5|6|7|8|9|*|#>

Parameter introduction
Generates DTMF dialing tones.
(control command type)

Sending format gendial <0|1|2|3|4|5|6|7|8|9|#|*>\r\n

Returning format gendial <0|1|2|3|4|5|6|7|8|9|#|*>\r\n

Send：
gendial 0\r\n
Example
return
gendial 0\r\n

1. getcallid

getcallid getcallid

Parameter introduction Returns call ID information about each connection in the

(control command type) call.

Sending format getcallid\r\n

Returning format getcallid “callid: 654123” “remotestr: 10.3.3.2”\r\n

Send：
getcallid\r\n
return
getcallid “callid: 654121” “remotestr: 10.3.3.1”\r\n
Example
getcallid “callid: 654122” “remotestr: 10.3.3.2”\r\n
getcallid “callid: 654123” “remotestr: 10.3.3.3”\r\n
getcallid “callid: 654124” “remotestr: 10.3.3.4”\r\n
getcallid all done\r\n

29
API Commands Introduction for Yealink VCS

2. history all

history history all

Parameter introduction
all Lists all call history.
(control command type)

Sending format history all\r\n

history numid type “name” “date” “duration”

“numberlist”\r\n

Note:

- numid: call history id

- type: call history type

placed: placed calls

Returning format
received: received calls

misscalled: missed calls

- “name”: name strings of the call history

- “date” : date string of the call history

- “duration”: duration of the call history

- “numberlist”: number strings of the call history

Send：
history all
return
history 1 placed “xiaom” “2015-06-01” “00:00:43”
“123456” “321654” “222222333”\r\n

history 2 placed “mengsde” “2015-06-01” “00:01:43”

Example “16532” “328888” “565622333”\r\n

history 3 received “mengsde” “2015-06-01” “00:11:43”

“3616532” “865328888” “96365622333”\r\n

history 4 misscalled “mengsde” “2015-07-01” “00:00:00”

“3363633” “756288” “363333”\r\n
history all all done!

3. history <placed|received|misscalled> get all

history history <placed|received|misscalled> get all

Parameter Configures the placed calls.

placed
introduction Note:

30
 Detailed Description of API Commands

(control Placed call record that has only one number

command represents a call to a contact. Placed call record that
type) has multiple numbers represents a call to a
conference contact.

Conference contact has “placed calls” only. It does

not support other call history type.

received Configures the received calls.

misscalled Configures the missed calls.

get Obtains the call history.

all Obtains all call history in selected history type.

Sending format history <placed|received|misscalled> get all\r\n

history numid type “name” “date” “duration” “numberlist”\r\n

Note:

- numid: call history id

- type: call history type

placed: placed calls

Returning
received: received calls
format
misscalled: missed calls

- “name”: name strings of the call history

- “date” : date string of the call history

- “duration”: duration of the call history

- “numberlist”: number strings of the call history

Send：
history placed get all\r\n
return
history 1 placed “xiaom” “2015-06-01” “00:00:43” “123456”
Example “321654” “222222333”\r\n

history 2 placed “mengsde” “2015-06-01” “00:01:43” “16532”

“328888” “565622333”\r\n
history placed get all all done!

4. history <placed|received|misscalled> get {1…n}

history history <placed|received|misscalled> get {1…n}

Parameter placed Configures the placed calls.

introduction
received Configures the received calls.
(control
command misscalled Configures the missed calls.

31
API Commands Introduction for Yealink VCS

type) get Obtains the call history.

n should be a positive integer. It represents the

{1…n}
number of call history.

Sending format history <placed|received|misscalled> get {1…n}\r\n

history numid type “name” “date” “duration” “numberlist”\r\n

Note:

- numid: call history id

- type: call history type

placed: placed calls

Returning
received: received calls
format
misscalled: missed calls

- “name”: name strings of the call history

- “date” : date string of the call history

- “duration”: duration of the call history

- “numberlist”: number strings of the call history

Send：
history placed get 2\r\n
return
history 1 placed “xiaom” “2015-06-01” “00:00:43” “123456”
Example “321654” “222222333”\r\n

history 2 placed “mengsde” “2015-06-01” “00:01:43” “16532”

“328888” “565622333”\r\n
history placed get 2 all done!

1. inputsource camera

inputsource inputsource camera

Parameter introduction
camera Specifies the camera to be the video source.
(control command type)

Sending format inputsource camera\r\n

Returning format inputsource camera\r\n

Send：
inputsource camera\r\n
Example
return
inputsource camera\r\n

32
 Detailed Description of API Commands

2. inputsource pc

inputsource inputsource pc

Parameter introduction
pc Specifies the PC to be the video source.
(control command type)

Sending format inputsource pc\r\n

Returning format inputsource pc\r\n

Send：
inputsource pc\r\n
Example
return
inputsource pc\r\n

3. inputsource share

inputsource inputsource share

Specifies the PC+camera to be the video

source.
Parameter introduction
share Note:
(control command type)
PC+camera can be selected during a call
only.

Sending format inputsource share\r\n

Returning format inputsource share\r\n

Send：
inputsource share\r\n
Example
return
inputsource share\r\n

1. incoming “num:string” “name:string”

incoming incoming “num:string” “name:string”

The video conferencing system will provide active

feedback to the control system when receiving an
incoming call.
Parameter introduction
Valid values:
(feedback command type)
- Incoming phone number

- Caller name

Sending format from the

incoming “num:string” “name:string”\r\n
video conferencing system

Format received by control incoming “num:string” “name:string”\r\n

33
API Commands Introduction for Yealink VCS

system

Send：
incoming “num:700051” “name:xiaopeng”\r\n
Example
return
incoming “num:700051” “name:xiaopeng”\r\n

1. mute near <get|on|off|toggle>

mute mute near <get|on|off|toggle>

near Mutes local video conferencing system.

Valid values:

get: obtains the mute status

Parameter introduction
<get|on|off on: enables the mute feature
(control command type)
|toggle> off: disables the mute feature

toggle: toggles between mute and

unmute status.

Sending format from the

mute near <get|on|off|toggle>\r\n
control system
Returning format mute near get <on|off>\r\n
received by the control or
system mute near <on|off|toggle>\r\n
mute near get <on|off>\r\n

Note：

Once the mute status changes, the video conferencing

system will provide active feedback to the control
system.

Format:

The video conferencing  The video conferencing system provides active

system provides active feedback to the control system:
feedback to the control
mute near get on\r\n
system
 The control system receives the command:

mute near get on\r\n

 The video conferencing system provides active

feedback to the control system:

mute near get off\r\n

 The control system receives the command:

34
 Detailed Description of API Commands

mute near get off\r\n

Send：
mute near get
return
mute near get on\r\n
send:
mute near get
Example
return
mute near get off\r\n
send:
mute near on
return
mute near on\r\n

1. preset near <go|set> <0|1|2|3|4|5|6|7|8|9>

Preset preset near <go|set> <0|1|2|3|4|5|6|7|8|9>

Configures the presets for the near-site

near
Parameter camera.
introduction
go Moves the camera to a camera preset.
(control
set Configures a camera preset.
command
type) <0|1|2|3|4|5|6|7|
Camera preset identifier.
8|9>

Sending format preset near <go|set> <0|1|2|3|4|5|6|7|8|9>\r\n

Returning
preset near <go|set> <0|1|2|3|4|5|6|7|8|9>\r\n
format
Send：
preset near go 0\r\n
Example
return
preset near go 0\r\n

1. storage get

storage storage get

Checking parameter, but

the system will provide get Obtains the USB status.
active feedback too

Sending format Checking format storage get\r\n

35
API Commands Introduction for Yealink VCS

The video conferencing system provides active

feedback to the control system or the control system
receives the command:
storage get available\r\n
or
storage get unavailable\r\n
Returning format
Note:

Once USB status changes, the video conferencing

system will provide active feedback to the control
system. If LAN mode and serial port mode are
configured, both of them are able to receive the
feedback.

Send:
storage get\r\n
return
Example storage get available\r\n
storage get\r\n
return
storage get unavailable\r\n

1. sysstatus get

sysstatus Sysstatus get

Obtains status notifications.

Note:

Parameter The video conferencing system may in multiple states.

introduction
The control system can query the video conferencing
system’s status. The video conferencing system can also
provide feedback to the control system.

Sending format sysstatus get\r\n

1. sleeping (the video conferencing system is sleeping）

2. Idle (the video conferencing system is idle）

3. outgoing (the video conferencing system is placing a

Video conferencing call)
system status
4. ringing (the video conferencing system receives an
incoming calls)

5. talking (the video conferencing system establishes a

call)

36
 Detailed Description of API Commands

6. finished (the video conferencing system finishes a

call)

7. talking max (the video conferencing system has

reached maximum sessions)

sleeping (the video conferencing system is sleeping）

The video conferencing system provides active feedback

to the control system:

sysstatus get sleeping\r\n

Sending format from the control system

Send
sysstatus get\r\n
return
sysstatus get sleeping\r\n
sysstatus get all done!

Idle (the video conferencing system is idle）

The video conferencing system provides active feedback

to the control system:

sysstatus get idle\r\n

Example Sending format from the control system

Send
sysstatus get\r\n
return
sysstatus get idle\r\n
sysstatus get all done!

talking max (the video conferencing system has reached

maximum sessions)

The video conferencing system provides active feedback

to the control system:

sysstatus get talking max\r\n

Sending format from the control system

Send
sysstatus get\r\n
Return
sysstatus get talking max\r\n
sysstatus get all done!

37
API Commands Introduction for Yealink VCS

outgoing (the video conferencing system is placing a call)

The video conferencing system provides active feedback

to the control system:

sysstatus get outgoing “diastr:9865412” “callid: 653214”

“calltype: video”\r\n

Sending format from the control system

sysstatus get\r\n
Return
sysstatus get outgoing “diastr:9865412” “callid:
653214” “calltype: video”\r\n
sysstatus get all done!

ringing (the video conferencing system receives an

incoming calls)

The video conferencing system provides active feedback

to the control system:

sysstatus get ringing “dialstr:9865412” “callid:653214”

“calltype:autdio”\r\n

Sending format from the control system

Send:
sysstatus get\r\n
return
sysstatus get ringing “dialstr:9865412” “callid:653214”
“calltype:autdio”\r\n
sysstatus get all done!

talking (the video conferencing system establishes a call)

The video conferencing system provides active feedback

to the control system:

systatus get talking “dialstr:9865412” “callid:654321”

“calltype:audio” “protocol:sip” “direction:
incoming/outgoing”\r\n

Sending format from the control system

Send
systatus get\r\n
return
sysstatus get talking “dialstr:9865412”
“callid:654321” “calltype:audio” “protocol:sip” “direction:
incoming/outgoing”\r\n

38
 Detailed Description of API Commands

sysstatus get all done!

finished (the video conferencing system finishes a call)

The video conferencing system provides active feedback

to the control system:

sysstatus get finished “dialstr: 98653214” “callid:632156”\r\n

Finished status is a real-time status, it does not last for a

certain period, so you can obtain finished status from the
feedback only. You cannot query it from your control
system.

1. You may get multiple states from the Sysstatus get

command.

For example, the video conferencing system receives an

incoming call during a call:

Send
syssstatus get\r\n
Return
sysstatus get talking “dialstr:9865412”
“callid:654321” “calltype:audio” “protocol: sip” “direction:
Note incoming/outgoing”\r\n
sysstatus get ringing “dialstr:9865412”
“callid:653214” “calltype:autdio”\r\n
sysstatus get all done!

2. The video conferencing system does not keep noticing

its status during a call, it only notice its status every
time a call is established.

And for H.323 calls, the video conferencing system will

notice its status again when switching an audio call to
a video call.

1. volume <get|up|down|set {0..10}>

volume volume <get|up|down|set {0..10}>

Obtains the audio volume on the video conferencing

get
system.
Parameter
introduction up Increases the audio volume.

down Decreases the audio volume.

39
API Commands Introduction for Yealink VCS

Configures the volume to a specified level. Requires a

set
volume setting from 0-10.

Sending format volume <get|up|down|set>\r\n

Returning
volume <get|up|down|set>\r\n
format
Send：
volume get\r\n
return
volume get 10\r\n
send:
volume up
Example
return:
volume up\r\n
send:
volume set 10
return
volume set 10\r\n

version version

version\r\n

Note:

The control system can query the video conferencing system’s

version information. The video conferencing system can also
provide version feedback to the control system when a
connection between them is just established.
If it is the first time LAN mode and serial port mode are
configured, both of them are able to receive the version
feedback.

Format:
Sending format
 The video conferencing system provides active feedback to
the control system:

version: “model:Yealink VC400” “firmware:30.20.254.12”

“hardware:10.8.10.1.0.0.2” “productId:201601081434”
“1.00”\r\n

 The control system receives the command:

version: “model:Yealink VC400” “firmware:30.20.254.12”

“hardware:10.8.10.1.0.0.2” “productId:201601081434”
“1.00”\r\n

40
 Detailed Description of API Commands

Returning version: “model: string1” “ firmware: string2” “hardware: string3”

format “productId: string4” “cc_version: string5”\r\n
send:
version
return
Example
version “model: Yealink VC400” “firmware:30.20.254.12”
“hardware:10.8.10.1.0.0.2” “productId:201601081434”
“cc_version:1.00”\r\n

41