REFERENCE GUIDE
Poly G7500
Command-Line API
3.8.0 | November 2021 | 3725-86004-009A
GETTING HELP
For more information about installing, configuring, and
administering Poly/Polycom products or services, go to the Poly
Online Support Center.
Plantronics, Inc. (Poly – formerly Plantronics and Polycom)
345 Encinal Street
Santa Cruz, California
95060
© 2021 Plantronics, Inc. All rights reserved. Poly, the propeller
design, and the Poly logo are trademarks of Plantronics, Inc. All
other trademarks are the property of their respective owners.
Contents
Contents
Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Audience, Purpose, and Required Skills . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Related Poly and Partner Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Additional Command-Line API Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Enable SSH Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Access the Command-Line API Over SSH . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Enable Telnet Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Access the Command-Line API Over Telnet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Enable Serial Port Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Access the Command-Line API Using a Serial Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Command-Line API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
About the Command-Line API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
addrbook . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
advnetstats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
all register . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
all unregister . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
amxdd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
answer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
apiport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
audio3p5inputfaronly . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
audiotransmitlevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
autoanswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
calendardiscovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
calendardomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
calendarmeetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
calendarpassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
calendarplaytone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
calendarprotocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
calendarregisterwithserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
calendarremindertime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
calendarresource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Plantronics, Inc. 1
Contents
calendarserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
calendarshowpvtmeetings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
calendarstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
calendaruser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
callinfo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
callstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
camera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
camera near tracking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
configdisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
configparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
configpresentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
contentauto . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
content list . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
daylightsavings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
defaultgateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
dhcp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
dial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
dial addressbook_entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
dns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
dynamicbandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
e164ext . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
echo . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
echocanceller . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
echoreply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
enableacousticfence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
enableaudioadd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
enablefirewalltraversal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
enablekeyboardnoisereduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
enablelivemusicmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
enablepvec . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
enablersvp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
enablesipka . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
enablesnmp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
encryption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
exportdirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
exportprofile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
farcontrolnearcamera . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
farnametimedisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
Plantronics, Inc. 2
Contents
favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
gatekeeperip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
gdsdirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
gdspassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
gdsserverip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
gendial . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
generatetone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
getcallstate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
getconfiguredipaddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108
globaldir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
h323authenticate enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
h323authenticate name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
h323authenticate password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
h323name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
hangup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
hostname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
importdirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
importprofile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
ipaddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
lanport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
ldapauthenticationtype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
ldapbasedn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
ldapbinddn . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
ldapdirectory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
ldapntlmdomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
ldappassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
ldapserveraddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
ldapserverport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
ldapsslenabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
ldapusername . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
listen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
localdir . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
loglevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
maxtimeincall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
monitor1screensaveroutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
monitor2screensaveroutput . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
mute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
muteautoanswer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
natconfig . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
nath323compatible . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Plantronics, Inc. 3
Contents
nearloop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151
netstats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
nonotify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153
notify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
ntpmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
ntpsecondaryserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159
ntpserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
oobcomplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
powerdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
preset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
provisionserveraddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
provisionserverdomain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
provisionserverenable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
provisionserverpassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
provisionserverstatus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
provisionservertype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
provisionserverupdate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
provisionserveruser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171
reboot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
recentcalls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
resetsettings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
rs232 baud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
rs232 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
rs232login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
serialnum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
session . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
setpassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
sleep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
sleeptime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
snmpadmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
snmpcommunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
snmpconsoleip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
snmplocation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
snmpnotification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
snmpsystemdescription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
snmptrapversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
sshenable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
subnetmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193
systemname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Plantronics, Inc. 4
Contents
systemsetting 323gatewayenable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
systemsetting bfcptransportprotocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
systemsetting dialingmethod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197
systemsetting displayiconsincall . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
systemsetting iph323enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
systemsetting lineinlevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
systemsetting lineoutmode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
systemsetting maxrxbandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
systemsetting maxtxbandwidth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
systemsetting mediainlevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
systemsetting model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
systemsetting sipaccountname . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
systemsetting sipdebug . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
systemsetting sipenable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
systemsetting sipforcereuse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
systemsetting sippassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
systemsetting sipproxyserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
systemsetting sipregistrarserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
systemsetting siptransportprotocol . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
systemsetting sipusername . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214
systemsetting stereoenable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
systemsetting telnetenabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
systemsetting transcodingenabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
systemsetting webenabled . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
systemsetting whitebalancemode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
uptime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
usegatekeeper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
vcbutton . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
videocallorder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
videomute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
wake . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229
wanipaddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
whoami . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Plantronics, Inc. 5
Before You Begin
This guide helps audio/video (AV) integrators, developers, and administrators use the Poly system
command-line API.
Audience, Purpose, and Required Skills
This guide is written for a technical audience. You must be familiar with the following concepts before
beginning:
● Current telecommunications practices, protocols, and principles
● Telecommunication basics, video teleconferencing, and voice or data equipment
● Open SIP networks and VoIP endpoint environments
Related Poly and Partner Resources
See the following sites for information related to this release.
● The Poly Online Support Center
information including Video Tutorials, Documents & Software, Knowledge Base, Community
Discussions, Poly University, and additional services.
● The Poly Document Library
solutions. The documentation displays in responsive HTML5 format so that you can easily access
and view installation, configuration, or administration content from any online device
● The Poly Community
account to access Poly support personnel and participate in developer and support forums. You can
find the latest information on hardware, software, and partner solutions topics, share ideas, and solve
problems with your colleagues
● The Poly Partners
RealPresence Platform with their customers' current UC infrastructures, making it easy for you to
communicate face-to-face with the applications and devices you use every day.
● The Poly Services
benefits of collaboration.
provides access to the latest developer and support information. Create an
are industry leaders who natively integrate the Poly standards-based
help your business succeed and get the most out of your investment through the
is the entry point to online product, service, and solution support
provides support documentation for active products, services, and
Additional Command-Line API Resources
The following resources are available to help you use the command-line API.
Plantronics, Inc. 6
Before You Begin
Contacting Technical Support
Go to the Poly Online Support Center to contact technical support.
Requesting Feature Enhancements
Contact your Poly sales engineer to submit a feature request.
Video Test Numbers
See the Video Test Numbers page to test with various Poly systems worldwide.
Plantronics, Inc. 7
Getting Started
The command-line API lets you externally configure and control a G7500 system. You can access the API
with the following connections:
● SSH
● Te ln e t
● Serial
Enable SSH Access
Use SSH on port 22 if you want encrypted access to the G7500 system command-line API.
1 In the web interface, go to Security > Access.
2 Select the Enable Legacy API Over SSH check box if it’s cleared.
Access the Command-Line API Over SSH
You can use your G7500 system local administrator credentials or external authentication to start an SSH
session. For information on configuring system accounts, see the system Administrator Guide at the Poly
Online Support Center.
1 Start an SSH session using the system IP address (for example, ssh 10.xxx.xx.xx).
2 When prompted, enter the system credentials.
Enable Telnet Access
Use port 24 or 23 to access the G7500 system command-line API using telnet.
1 In the web interface, go to Security > Access.
2 Select the Enable Telnet Access check box.
3 Choose an API Port for telnet connections: 24 (default) or 23.
Access the Command-Line API Over Telnet
From a device connected to the same LAN as your G7500 system, you can access the command-line API
using telnet (port 23 or 24 depending on how you’ve configured the system).
Plantronics, Inc. 8
Getting Started
1 Start a telnet session using the system IP address and port number configured for the API Port
setting (for example, telnet 10.xxx.xx.xx 24).
2 If prompted, log in with the system’s local administrator password.
Enable Serial Port Access
To use the command-line API with an RS-232 interface, you must connect and configure the control system
and G7500 system for serial communication.
1 In the system web interface, go to General Settings > Serial Port and set RS-232 Mode to
Control.
2 Configure a Baud Rate (for example, 19200).
3 Configure the same baud rate for your control system.
4 For the G7500 system Login Mode setting, choose one of the following:
Admin password only: (Default) Requires the administrator password (if you set one) when the
control system connects.
Username/Password: Requires the user name and administrator password (if you set one) when
the control system connects.
None: The system doesn’t require a user name or password when the control system connects.
Access the Command-Line API Using a Serial Connection
Once you’ve configured your G7500 system and control system for serial communication, you can start a
command-line API session.
1 Connect an RS-232 cable from your control system to the system’s serial port.
2 From the control system, start a serial session using PuTTY or a similar utility.
3 If prompted, log in with the system’s local administrator password.
Plantronics, Inc. 9
Command-Line API Reference
The G7500 system command-line API is organized in alphabetical order.
While every attempt is made to ensure that the expected results of executing API commands are accurate, Poly
Note:
cannot be responsible for system behaviors and control actions that are not explicitly documented.
About the Command-Line API
Use the following guidelines to help you understand the command-line API.
Definitions
The following definitions help you read the command-line API reference.
Terms Description
Command Description Brief statement about the purpose of the command.
Syntax Format required to execute the command.
Parameter A list of parameters defined for the command.
Description (parameter) A description of each parameter that is defined for the command.
Feedback Examples Examples of expected results when a command and variant are executed.
Limitations Important notes about support for the command on the system.
Comments Important notes about the command.
Syntax Conventions
The following conventions are used for the API command descriptions. Commands are case sensitive.
Plantronics, Inc. 10
Command-Line API Reference
Convention Meaning
<param1|param2|param3> Multiple valid parameters are enclosed in angle brackets and separated by the
pipe (“|”) character.
[param]
[“param”]
{a..z} A range of possible alphanumeric values is enclosed in braces.
“x” Quotation marks indicate string input. You don’t need to enclose the value in
Although the command-line API parser may accept the minimum number of characters in a command that
makes it unique, you should always use the full command string.
Optional parameters are enclosed in square brackets. Quotation marks
indicate string input.
quotes unless it contains a space.
Command Availability
Command-Line APIs are only supported in Poly Video Mode. API command availability depends on the
connected equipment, security settings, installed software version, among other factors. If a particular
command isn’t supported, the command returns feedback such as, “command is not available in
current system configuration”.
If a setting is configured by a provisioning service, the command may return, “this setting is
controlled by a provisioning service and cannot be changed. For more information
about provisioned settings, refer to your provisioning service administrator.”
Commands that are not listed are not supported by Poly. Commands might change or be removed at any
time. Poly discourages integrators from using unpublished commands.
Command Response Syntax
When you send a command, the system returns responses using the syntax described in the following sections, where <CR> indicates a carriage return and <LF> indicates a line feed.
Unregistered for Notifications
When your system is not registered to receive notifications and you send an API command, a single API
acknowledgement is returned.
For example:
camera near 1<CR> API command
returns
camera near 1<CR><LF> API acknowledgement
In the previous example, the command was sent with a carriage return <CR>.
The API expects a carriage return <CR> and the standard end of line characters carriage return/line feed
<CR><LF>. All API responses end in carriage return/line feed <CR><LF>.
Plantronics, Inc. 11
Command-Line API Reference
Registered for Notifications
Registering for notifications adds extra line responses. The number of additional lines depends on the
specific registration. In the following example, the response shows an API acknowledgement and
registration response returned:
camera near 1 <CR> API command
returns
camera near 1<CR><LF> API acknowledgement
notification:vidsourcechange:near:1:Main:people<CR><LF>
API registration response
When your system is registered for notifications, always use the API registration response for status.
Commands that Restart the System Without a Prompt
The following API commands restart your system without notification:
● reboot now
● resetsettings
Additional Tips
Refer to the following information when using the command-line API:
● The system does not provide flow control.
● If you lose an API connection (e.g., the system restarts), you must re-establish it.
● The API processes one command at a time.
● Poly does not recommend sending multiple commands simultaneously without a pause or delay
between each.
● For commands with a single action and response: A delay of 200 milliseconds between commands
is usually sufficient. Examples of these commands include the commands for switching cameras
(camera near 1), sending content (vcbutton play), and checking the status of audio mute
(mute near get).
● For commands with a single action and more extensive response: The time it takes to receive the
response (and in effect the time between commands) may be longer than 200 milliseconds. The
response length, which can vary, determines the time required to receive the response. Examples
include the commands for retrieving directory information (such as addrbook all) and system
session information (such as whoami).
● When developing your application, always allow enough time for a command response before
sending another command.
● Poly does not recommend sending commands while a call is being established.
● The API provides feedback status in two ways: registrations or polling.
● Send registration and notification API commands only once. Registrations are written to flash
memory and retained when the system restarts.
● Poly recommends putting registrations in the initialization or startup of Crestron and AMX systems.
● Registrations are recommended over polling since they provide status updates without having to
query for changes.
Plantronics, Inc. 12
Command-Line API Reference
● Never poll for registrations.
● Registrations are specific to the port from which they are registered. If you register for notifications
from com port 1, registration will not be sent to com port 2 or telnet port 24.
Plantronics, Inc. 13
Command-Line API Reference
addrbook
Returns local directory (address book) entries.
Syntax
Commands for local directory
addrbook all
addrbook batch {0..59}
addrbook batch search “pattern” “count”
addrbook batch define “start_no” “stop_no”
addrbook letter {a..z}
addrbook range “start_no” “stop_no”
Commands for groups
addrbook names <all|video> [<range_start>] [<range_end>]
addrbook names <all|video> size
addrbook names search "search_pattern" <all|video>
[<range_start>] [<range_end>]
addrbook names search "search_pattern" <all|video size
addrbook group "group_name" [<range_start>] [<range_end>]
addrbook group "group_name" size
addrbook address "sys_name" ["sys_label"]
Parameter Description
all Returns all the entries in the local directory.
batch Returns a batch of 10 local directory entries. Requires a batch number, which must be an
integer in the range {0..59}.
search Specifies a batch search.
“pattern” Specifies a pattern to match for the batch search.
“count” Specifies the number of entries to list that match the pattern.
define Returns a batch of entries in the range defined by “start_no” to “stop_no.”
letter Returns entries beginning with the letter specified from the range {a..z}. Requires one or
two alphanumeric characters. Valid characters are:
- _ / ; @ , . \
0 through 9
a through z
range Returns local directory entries numbered “start_no” through “stop_no”. Requires two
integers.
“start_no” Specifies the beginning of the range of entries to return.
Plantronics, Inc. 14
Command-Line API Reference
Parameter Description
“stop_no” Specifies the end of the range of entries to return.
names Returns a list of system names in the local address book. Also returns the system type:
video, multicodec, phone, or multisite. A multicodec system will appear as a single row.
The response is in the following format:
addrbook names {0..n}. name:"sys_name"
sys_label:"sys_label"
type: <video|multicodec|phone|group>
...
addrbook names <all|video|phone> done
<all|video> Specifies the type of entries to return. video returns entries that have video addresses. all
returns entries with video numbers or phone numbers or both.
size Returns the size of the result set that will be returned by the command. The size parameter
can be used with the names and the names search commands.
The response is in the following format:
addrbook names <all|video|phone> size {0..n}
addrbook names search "search_pattern"
<all|video|phone> size {0..n}
range_start For the names, names search, and group commands, specifies the beginning of the range
of entries to return.
range_end For the names, names search, and group commands, specifies the end of the range of
entries to return. If a range_start is specified without a range_end, then the single
range_start entry will be returned. If range_end is -1, all entries starting with
range_start will be returned.
search Returns a list local directory names that match the search criteria.
The response is similar to the names command described above:
addrbook search {0..n}. name:"sys_name"
sys_label:"sys_label"
type: <video|multicodec|phone|group>
...
addrbook names search "search_pattern"
<all|video|phone> done
search_pattern Specifies the string pattern for which to search. Wildcard characters are not supported. The
search string is used to match the beginning of any of the attributes listed using descriptions
for the names and search parameters. For example, the search string “Jo” would match
any name that begins with Jo, such as John or Jones. The search is not case sensitive.
group Returns a list of the names of all the sites included in a local directory group in this format:
addrbook group {0..n}. name:"site_sys_name"
sys_label:"site_sys_label"
...
addrbook group "group_name" [range] done
addrbook group size <num_entries>
group_name A local address book group name.
Plantronics, Inc. 15
Command-Line API Reference
Parameter Description
address Obtains the address information for a specified entry. If the entry is an ITP system, the
results will include the addresses for all codecs. If codecs support multiple protocols, the
different addresses will be returned on separate lines. This command is not supported for
multisite entries.
sys_name The friendly name for an address book entry. It is the name of the person or the room. It is
surrounded by quotes if it contains spaces.
sys_label If a person/room has more than one system, the result set will include a row for each
system. If those systems are of the same type the client will consider that entry to be a
telepresence system with multiple codecs rather than separate systems. If the systems are
of different types, then this sys_label attribute will be included to differentiate the systems.
type The type of local address book entry. Possible values are:
video, multicodec, phone, group
site_sys_name The name of a site in a group. It is surrounded by quotes if it contains spaces
site_sys_label The label associated with a site name in a local group. It is surrounded by quotes if it
contains spaces.
codec:<1..4> If the entry is a telepresence system, each codec will include a codec number attribute.
h323_spd The preferred speed for an H.323 call to this entry. If no speed is associated with the entry,
then the value of the configuration variable globaladdrmaxh323 is returned. The default
is 384.
h323_num H.323 address or alias.
h323_ext H.323 extension or E.164 number.
sip_spd The preferred speed for a SIP call to this entry. If no speed is associated with the entry, then
this is the same as the h323_spd.
sip_num IP address.
Feedback Examples
● addrbook all
returns
addrbook 0. “Polycom Demo 1” h323_spd:384 h323_num:192.168.1.101
h323_ext:7878
addrbook 1. “Polycom Demo 2” sip_spd:384 sip_num:polycomg7500@polycom.com
addrbook 2. “Polycom Demo 3” phone_num:1.512.5121212
(and so on, until all entries in the local directory are listed, then:)
addrbook all done
● addrbook batch 0
returns
addrbook 0. “Polycom Demo 1” h323_spd:384 h323_num:192.168.1.101
h323_ext:7878
addrbook 1. “Polycom Demo 2” sip_spd:384 sip_num:polycomg7500@polycom.com
addrbook 2. “Polycom Demo 3” phone_num:1.512.5121212
(and so on, through the last entry in the batch of 10 directory entries,
such as:)
Plantronics, Inc. 16
Command-Line API Reference
addrbook 9. “Polycom Demo 20” h323_spd:384 h323_num:192.168.1.120
h323_ext:
addrbook batch 0 done
● addrbook batch define 0 2
returns
addrbook 0. “Polycom Demo 1” h323_spd:384 h323_num:192.168.1.101
h323_ext:7878
addrbook 1. “Polycom Demo 2” sip_spd:384 sip_num:polycom@polycom.com
addrbook batch define 0 2 done
● addrbook names all size
returns
addrbook names all size 21
● addrbook names all size 21
returns
addrbook names all size 21
addrbook names 0. name:"Eng RPX" sys_label:"" type:multicodec
addrbook names 1. name:"Doe" sys_label:"" type:video
addrbook names 2. name:"Gen Group" sys_label:"" type:group
addrbook names 3. name:"John Doe" sys_label:"" type:video
addrbook names 4. name:"John Doe" sys_label:"" type:video
addrbook names 5. name:"Lab TPX" sys_label:"" type:video
addrbook names 6. name:"Minuteman RPX" sys_label:"" type:multicodec
addrbook names 7. name:"Monday Staff Mtg" sys_label:"" type:group
addrbook names 8. name:"Polycom Austin Stereo" sys_label:"" type:video
addrbook names 9. name:"Polycom Austin HD" sys_label:"" type:video
addrbook names all 0 9 done
● addrbook names all
returns
addrbook names 0. name:"Eng RPX" sys_label:"HDX" type:multicodec
addrbook names 1. name:"Doe" sys_label:"" type:video
addrbook names 2. name:"Gen Group" sys_label:"" type:group
addrbook names 3. name:"John Doe" sys_label:"" type:video
addrbook names 4. name:"John Doe" sys_label:"" type:video
addrbook names 5. name:"Lab TPX" sys_label:"" type:video
addrbook names 6. name:"Minuteman RPX" sys_label:"" type: multicodec
addrbook names 7. name:"Monday Staff Mtg" sys_label:"" type:group
addrbook names 8. name:"Polycom Austin Stereo" sys_label:"" type:video
addrbook names 9. name:"Polycom Austin HD" sys_label:"" type:video
addrbook names 10. name:"Polycom Austin USA IP" sys_label:"" type:video
addrbook names 11. name:"Polycom Japan" sys_label:"" type:video
addrbook names 12. name:"Scott CMAD IP" sys_label:"" type:video
addrbook names 13. name:"Scott Phone" sys_label:"" type:phone
addrbook names 14. name:"Scott PVX" sys_label:"" type:video
addrbook names 15. name:"Scott Quasar 19" sys_label:"" type:video
addrbook names 16. name:"SQA " sys_label:"" type:video
addrbook names 17. name:"John Doe" sys_label:"" type:video
addrbook names 18. name:"Test System 1" sys_label:"" type:video
addrbook names 19. name:"Test System 2A" sys_label:"" type:video
addrbook names 20. name:"Test System 2B" sys_label:"" type:video
addrbook names all done
Plantronics, Inc. 17
Command-Line API Reference
● addrbook names search "p" all
returns
addrbook search 0. name:"Polycom Austin HD" sys_label:"" type:video
addrbook search 1. name:"Polycom Austin Stereo" sys_label:"" type:video
addrbook search 2. name:"Polycom Austin USA IP" sys_label:"" type:video
addrbook search 3. name:"Polycom Japan" sys_label:"" type:video
addrbook search 4. name:"Scott Phone" sys_label:"" type:phone
addrbook search 5. name:"Scott Group Series" sys_label:"" type:video
addrbook search search p all done
● addrbook names search "p" all 0 2
returns
addrbook search 0. name:"Polycom Austin HD" sys_label:"" type:video
addrbook search 1. name:"Polycom Austin Stereo" sys_label:"" type:video
addrbook search 2. name:"Polycom Austin USA IP" sys_label:"" type:video
addrbook search search p all 0 2 done
● addrbook group "Monday Staff Mtg"
returns
addrbook group 0. name:"Eng RPX" sys_label:"HDX"
addrbook group 1. name:"John Doe" sys_label:""
addrbook group 2. name:"John Doe" sys_label:""
addrbook group 3. name:"TPW" sys_label:"HDX"
addrbook group "Monday Staff Mtg" done
● addrbook address "John Doe"
return
addrbook address 0. name:"John Doe" sys_label:"" codec:1
h323_spd:384 h323_num:172.25.137.101 h323_ext:
addrbook address name:"John Doe" sys_label:"" done
Limitations
None
Comments
This command is deprecated. Poly recommends using localdir instead.
Plantronics, Inc. 18
Command-Line API Reference
advnetstats
Gets advanced network statistics for a call connection.
Syntax
advnetstats [{0..n}]
Parameter Description
{0..n} Specifies a connection in a call, where n is the maximum number of connections supported
by the system. 0 is call #1, 1 is call #2, 2 is call #3, and so on. Select a number from this
range to specify a remote site call for which you want to obtain advanced network statistics.
Omit this parameter when retrieving statistics for a point-to-point call.
Feedback Examples
● advnetstats 0
returns
call:0 tar:96 K rar:96 K tvr:224 K rvr:416 K
tvru:219 K rvru:154 K tvfr:29 rvfr:26 vfe:0
tapl:0 rapl:0 taj:6 ms raj:5 ms tvpl:0 rvpl:0
tvj:6 ms rvj:11 ms
dc:Disabled rsid:Sams RP700 ccaps:9
tcr:0 rcr:128 K tcru:0 rcru:128k
tcfr:0 rcfr:64 K tcpl:0 rcpl:0
where:
tar = transmit audio rate
rar = receive audio rate
tvr = transmit video rate
rvr = receive video rate
tvru = transmit video rate used
rvru = receive video rate used
tvfr = transmit video frame rate
rvfr = receive video frame rate
vfe = video FEC errors
tapl = transmit audio packet loss (H.323 calls only)
tlsdp = transmit LSD protocol (H.320 calls only)
rapl = receive audio packet loss (H.323 calls only)
rlsdp = receive LSD protocol (H.320 calls only)
taj = transmit audio jitter (H.323 calls only)
tlsdr = transmit LSD rate (H.320 calls only)
raj = receive audio jitter (H.323 calls only)
rlsd = receive LSD rate (H.320 calls only)
tvpl = transmit video packet loss (H.323 calls only)
tmlpp = transmit MLP protocol (H.320 calls only)
rvpl = receive video packet loss (H.323 calls only)
rmlpp = receive MLP protocol (H.320 calls only)
tvj = transmit video jitter (H.323 calls only)
tmlpr = transmit MLP rate (H.320 calls only)
rvj = receive video jitter (H.323 calls only)
rmlpr = receive MLP rate (H.320 calls only)
Plantronics, Inc. 19
Command-Line API Reference
dc = encryption information
rsid = remote system id
ccaps = content capability, where possible responses include “E”
(enterprise dual streams), “N” (none), and “P” (content over the people
stream)
tcr = transmit content rate
rcr = receive content rate
tcru = transmit content rate used
rcru = receive content rate used
tcfr = transmit content frame rate
rcfr = receive content frame rate
tcpl = transmit content packet loss
rcpl = receive content packet loss
Limitations
None
Comments
None
See Also
To return network statistics for a call, use the nearloop command.
Plantronics, Inc. 20
Command-Line API Reference
all register
Registers for most commonly-used user registration events.
Syntax
all register
Additional Restrictions
None
Feedback Examples
● all register
returns
callstate registered
camera registered
linestate registered
mute registered
preset registered
vcbutton registered
volume registered
Comments
Registers changes to any of the following types of parameters:
● Current near- or far-site source
● State of privacy
● Current volume level
● Active camera presets
● Call status
● IP connection to codec
● System information
This command is useful when two control systems are used simultaneously, such as the web and API
commands. The system maintains the registration changes through restarts.
To register for events not included in this feedback, refer to the specific registration command.
This is a one-time registration command that is retained in flash memory. Sending the command a second
time results in the following feedback response:
● info: event/notification already active:callstate
info: event/notification already active:camera
info: event/notification already active:linestate
info: event/notification already active:mute
Plantronics, Inc. 21
Command-Line API Reference
info: event/notification already active:preset
info: event/notification already active:vcbutton
info: event/notification already active:volume
The all register command does not return local camera movements if the camera is moved using the
remote control.
Use the notify command for camera notifications.
Limitations
None
Plantronics, Inc. 22
Command-Line API Reference
all unregister
Simultaneously unregisters all registered user feedback so that the API no longer reports changes to the
parameters.
Syntax
all unregister
Additional Restrictions
None
Feedback Examples
● all unregister
returns
callstate unregistered
camera unregistered
linestate unregistered
mute unregistered
preset unregistered
vcbutton unregistered
volume unregistered
Limitations
None
Comments
The following types of parameters are unregistered:
● Current near-site or far-site source
● State of privacy
● Current volume level
● Active camera presets
● Status of point-to-point or multipoint calls
● IP connection to codec
● System information
Plantronics, Inc. 23
Command-Line API Reference
amxdd
Gets or sets the AMX Device Discovery beacon.
Syntax
amxdd get
amxdd <on|off>
Parameter Description
get Returns the current setting.
on Turns on the AMX Device Discovery beacon.
off Turns off the AMX Device Discovery beacon.
Feedback Examples
● amxdd get
returns
amxdd off
● amxdd on
returns
amxdd on
Limitations
None
Comments
The default setting for this signal is off.
Plantronics, Inc. 24
Command-Line API Reference
answer
Answers incoming video calls.
Syntax
answer <video>
Parameter Description
video Answers incoming video calls when Auto Answer Point-to-Point Video or Auto Answer
Multipoint Video is set to No.
Feedback Examples
● answer video
returns
answer incoming video call failed
● answer video
returns
answer incoming video call passed
Limitations
None
Comments
None
Plantronics, Inc. 25
Command-Line API Reference
apiport
Gets or sets the command-line API telnet port.
Syntax
apiport get
apiport <23|24>
Parameter Description
get Returns the configured command-line API port.
23 Sets the command-line API telnet port to 23.
24 Sets the command-line API telnet port to 24. Default setting.
Feedback Examples
● apiport get
returns
apiport 24
● apiport 23
returns
apiport 23
Limitations
None
Comments
After sending the command to change the port, you must exit the current session and reconnect on the new
port.
Plantronics, Inc. 26
Command-Line API Reference
audio3p5inputfaronly
Gets or sets the preference for 3.5mm audio input from the system’s 3.5mm audio port.
Syntax
audio3p5inputfaronly <get|enable|disable>
Parameter Description
get Returns the current settings.
enable 3.5 mm audio input is sent only to the far site.
disable 3.5 mm audio input is sent to both far and near sites.
Feedback Examples
●
audio3p5inputfaronly
returns
audio3p5inputfaronly
●
audio3p5inputfaronly
returns
audio3p5inputfaronly
get
enable
disable
disable
Limitations
None
Comments
None
Plantronics, Inc. 27
Command-Line API Reference
audiotransmitlevel
Sets or gets the audio volume transmitted to the far site. Also register for notifications of audio transmit level
changes.
Syntax
audiotransmitlevel <get|up|down|register|unregister>
audiotransmitlevel set {-6..18}
Parameter Description
get Returns the current setting.
up Sets the volume 1 decibel higher than the current setting.
down Sets the volume 1 decibel lower than the current setting.
register Registers to receive notification when audio transmit level changes.
unregister Unregisters to receive notification when audio transmit level changes.
set Sets the volume to the specified dB level. Valid values are: {-6..18}.
Feedback Examples
● audiotransmitlevel set 2
returns
audiotransmitlevel 2
● audiotransmitlevel get
returns
audiotransmitlevel 2
● audiotransmitlevel up
returns
audiotransmitlevel 3
● audiotransmitlevel down
returns
audiotransmitlevel 2
● audiotransmitlevel register
returns
audiotransmitlevel registered
● audiotransmitlevel unregister
returns
audiotransmitlevel unregistered
Limitations
None
Plantronics, Inc. 28
Command-Line API Reference
Comments
None
Plantronics, Inc. 29
Command-Line API Reference
autoanswer
Sets how the system handles incoming point-to-point calls.
Syntax
autoanswer <get|yes|no|donotdisturb>
Parameter Description
get Returns the current setting.
yes Incoming calls are connected automatically. This is the default setting.
no Prompts the user to answer incoming calls.
donotdisturb Notifies the user of incoming calls but does not connect. The far side receives a
rejected call notification.
Feedback Examples
● autoanswer yes
returns
autoanswer yes
● autoanswer no
returns
autoanswer no
● autoanswer get
returns
autoanswer no
● autoanswer donotdisturb
returns
autoanswer donotdisturb
Limitations
None
Comments
If autoanswer is set to no or donotdisturb, you must rely on API session notifications to answer
inbound calls.
Plantronics, Inc. 30
Command-Line API Reference
button
Simulates remote control buttons. Some commands may not be available with your conferencing provider.
Syntax
Parameters available in Poly Video Mode only:
button <call|graphics]hangup>
button <camera|directory|home|info|keyboard|mute>
Parameters available for all conferencing applications:
button <#|*|0|1|2|3|4|5|6|7|8|9|.>
button <down|left|right|up|select>
button <back|menu>
button <mute|volume+|volume->
button <delete|period>
Parameter Description
. Types a period if the cursor is on a text field.
# Sends the # button signal to the user interface.
* Sends the * button signal to the user interface.
0|1|2|3|4|5|6|7|8|9 Sends the corresponding numeric button signal to the user interface.
back Returns you to the previous screen.
call Displays the Call screen.
camera Displays the Camera Control screen. If camera tracking is enabled the Camera
Control screen doesn’t display. You must disable camera tracking before using this
command.
delete Deletes the last character in a text field.
directory Displays the contacts view in the Call screen. If the contacts view isn’t configured no
action is taken.
down Sends the Down button signal to the user interface.
graphics In a content sharing session, displays the content tray.
Out of a content sharing session, displays the Content screen.
hangup In a call, removes all content, ends the call, and returns you to the Home screen. In
a content session, removes all content, ends the session, and returns you to the
Home screen.
home Returns you to the Home screen.
info Displays the video system’s System Detail screen.
keyboard Brings up the on-screen keyboard if the cursor is on a text field.
Plantronics, Inc. 31
Command-Line API Reference
Parameter Description
left Sends the Left button signal to the user interface.
menu In Poly Video mode, displays the quick access menu.
In Partner Mode, performs the same action as the remote control Menu button
action for the selected conferencing partner application.
mute Toggles microphone mute.
period Types a period if the cursor is in a text field.
right Sends the Right button signal to the user interface.
select Sends the Select (center button in the directional pad) button to the user interface.
up Sends the Up button to the user interface.
volume- Decreases the system volume.
volume+ Increases the system volume.
Feedback Examples
● button hangup
returns
button hangup
● button up
sends the up command to the user interface and returns
button up
The command checks for invalid input and reports the button responses as they’re processed. The system
returns one of three status values when you issue a command for multiple buttons:
● succeeded - All buttons are valid.
● failed - All input is invalid and none of the commands perform a valid action.
● completed - Some commands are invalid, and the responses specify each command as valid or
invalid.
For example:
● button camera right center select
returns
button camera
button right
error: button center not a recognized command
button select
button completed
Long button command sequences complete before the system executes a second command. Feedback
for button sequences that include multiple buttons show only the first button name.
Plantronics, Inc. 32
Command-Line API Reference
Limitations
Some button commands require you to return to the Home screen before execution. If you don’t return to
the Home screen the command may not execute properly.
Comments
You can combine several parameters in the same command in any order.
Use the camera command for camera control. Don’t use the following commands for camera control:
● button left
● button right
● button down
● button up
Plantronics, Inc. 33
Command-Line API Reference
calendardiscovery
Gets the Microsoft Exchange Server address based on the associated email address or registered SIP
server address configured for the system.
Syntax
calendardiscovery get
calendardiscovery emaildomain
calendardiscovery sipdomain
Parameter Description
get Gets the Microsoft Exchange Server address that the system is using to register with
the calendaring service.
emaildomain Gets the Microsoft Exchange Server address based on an email address.
sipdomain Gets the Microsoft Exchange Server address based on a SIP server address.
Feedback Examples
● calendardiscovery sipdomain get
returns
calendardiscovery 192.168.44.168
● calendardiscovery emaildomain get
returns
calendardiscovery mail.exchangeserver.local.com
● calendardiscovery get
returns
calendardiscovery not available (if not configured or not found)
● calendardiscovery emaildomain get
returns
calendardiscovery not available (if not configured or not found)
● calendardiscovery get
returns
error: command needs more parameters to execute successfully
● calendardiscovery
returns
error: command needs more parameters to execute successfully
Limitations
None
Plantronics, Inc. 34
Command-Line API Reference
Comments
None
Plantronics, Inc. 35
Command-Line API Reference
calendardomain
Gets or sets the domain used by the calendaring service to log in to the Microsoft Exchange Server.
Syntax
calendardomain get
calendardomain set “domain”
Parameter Description
get Returns the domain used by the calendaring service.
set Sets the domain used by the calendaring service.
“domain” Specifies the domain for the calendaring service when using the set
command.
Feedback Examples
● calendardomain get
returns
calendardomain smithfield
● calendardomain set fairview
returns
calendardomain fairview
Limitations
None
Comments
None
Plantronics, Inc. 36
Command-Line API Reference
calendarmeetings
Retrieves scheduled meetings within a provided time or for a meeting ID.
Syntax
calendarmeetings list “starttime” [“endtime”]
calendarmeetings info “meetingid”
Parameter Description
list Returns the meeting id or ids for meetings that start at or after the specified start time
and end time.
“starttime” The start time of meetings to be retrieved.
The start time can be entered in one of the following formats:
• YYYY-MM-DD:HH:MM
• today:HH:MM
• today
• tomorrow:HH:MM
• tomorrow
The times are interpreted to be local times in the time zone the system was
configured for.
“endtime” The end time of meetings to be retrieved.
This parameter can be given in the following format.
• YYYY-MM-DD:HH:MM
• today:HH:MM
• today
• tomorrow:HH:MM
• tomorrow
The times are interpreted to be local times in the time zone the system was
configured for.
info Retrieves meeting details for scheduled meetings when the system is registered with
the calendaring service. Returns information such as the location, subject and
organizer of the meeting.
“meetingid” The ID of the meeting for which you want to find details.
Feedback Examples
● calendarmeetings list tomorrow
returns
calendarmeetings list begin
meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9
GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxk
LKAAADI/F8BAAA|2010-03-30:08:30|2010-03-30:09:00|Discuss Budget
meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9
GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxk
Plantronics, Inc. 37
Command-Line API Reference
LKAAAA/9PhAAAQ|2010-03-30:09:00|2010-03-30:09:30|Program Review
meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9
GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAABZ29fOU0S5Q6xzZ1lzDD
NnAABFQAQ3AAAQ|2010-03-30:10:00|2010-03-30:11:00|Customer Care Commitment
Meeting
calendarmeetings list end
● calendarmeetings list 2010-03-30:08:00 2010-04-01:17:00
returns
calendarmeetings list begin
meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9
GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxk
LKAAADI/G8AAAQ|2010-03-30:08:30|2010-03-30:09:00|Bug Scrub
meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9
GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAABZ29fOU0S5Q6xzZ1lzDD
NnAABFQARCAAAQ|2010-03-30:11:30|2010-03-30:12:30|groupseries/IP7000/Confe
rence Coordination
meeting|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9
GlhsSjWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAABZ29fOU0S5Q6xzZ1lzDD
NnAABFQAQ3AAAQ|2010-04-01:16:30|2010-04-01:17:00|Customer Care Commitment
Meeting
calendarmeetings list end
● calendarmeetings info
AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9GlhsSjWE
ZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAADI/
G8AAAQ
returns
calendarmeetings info start
id|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMne2/ndgARgAAAADr9GlhsS
jWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAA
DI/G8AAAQ
2010-03-30:08:30|2010-03-30:09:00|dialable|public
organizer|Russell Bell
location|Russell's Meeting Room - IP Video Number: 123456 (if registered
to corp GK); 888-123-4567/978-123-4567 with passcode: #760900
subject|Bug Scrub
dialingnumber|video|733397@vsgwstdma01.r13.vsg.local2|sip
dialingnumber|video|733397|h323
dialingnumber|audio|48527
meetingpassword|none
attendee|Russell Bell
attendee|Rebecca Sharp
calendarmeetings info end
● calendarmeetings info
AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMn4AUcVgARgAAAADr9GlhsSjWE
ZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAAA30
GwAAAQ
returns
calendarmeetings info start
id|AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMn4AUcVgARgAAAADr9GlhsS
jWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAA
A30GwAAAQ
2010-04-01:10:30|2010-04-01:11:00|nondialable|private
organizer|Rebecca Sharp
Plantronics, Inc. 38
Command-Line API Reference
location|Red River conference room
subject|Escalations Review
attendee|Roslin Adam
attendee|Conference.Main
attendee|Claudia Nevarez
calendarmeetings info end
Limitations
None
Comments
If the meeting’s end time is more than 31 days from the meeting’s start time, the response is shortened to
starttime+31days, and meetings that start in that time span are returned.
If an API client is logged in with user-level credentials and if the system is configured to hide private meeting
information on the web interface, the API hides the information from the API client and shows the subject of
the meeting as "Private Meeting", for example:
calendarmeetings list begin
meeting|
jWEZBcAAKzMphJBwA4wicbtr3UEZArAKAk09LtAAACZpKWAADe7hJleQIOS7j2mzRJxkLKAAAA30Gw
AAAQ
calendarmeetings list end
If a system is configured to provide private meeting information on the web interface, the API provides the
same information to the API client, for example:
calendarmeetings list begin
meeting|
CASOLXUYMOMEKYBQJJ1Z0MBWASDQANHQAASOLXUYMOMEKYBQJJ1Z0MBWASDQASVGAA
8:30|2009-09-25:09:15| Demo
calendarmeetings list end
If the API client is logged in with admin-level credentials, the API provides private meeting information to the
API client, regardless of the configuration for displaying private meeting information, for example:
calendarmeetings list begin
meeting|
CASOLXUYMOMEKYBQJJ1Z0MBWASDQANHQAASOLXUYMOMEKYBQJJ1Z0MBWASDQASVGAA
8:30|2009-09-25:09:15|Release plan
meeting|
CASOLXUYMOMEKYBQJJ1Z0MBWASDQANHQAASOLXUYMOMEKYBQJJ1Z0MBWASDQASVGAA
1:00|2009-09-23:11:45|Product roadmap for 2010
calendarmeetings list end
The calendaring service must be registered with Microsoft Exchange Server for the
command to work successfully. If the calendar credentials are invalid, the server address is not valid, or the
configured user credentials don't have access permissions to the resource mailbox calendar, the service will
fail to register.
This command has multiline output.
AAAaAEFsZXguTWFjRG9uYWxkQHBvbHljb20uY29tAVEACIjMn4AUcVgARgAAAADr9GlhsS
|2009-09-25:08:30|2009-09-25:09:15|private meeting
AAAZAGV4Y2H1C2VYMDFACJEZLNZZZY5SB2NHBDIARGAAAAAAKQKC8WW3CUWGCPM+AP66WQ
|2009-09-25:0
AAAZAGV4Y2H1C2VYMDFACJEZLNZZZY5SB2NHBDIARGAAAAAAKQKC8WW3CUWGCPM+AP66WQ
|2009-09-25:0
AAAZAGV4Y2H1C2VYMDFACJEZLNZZZY5SB2NHBDIARGAAAAAAKQKC8WW3CUWGCPM+AP66WQ
|2009-09-23:1
calendarmeetings
The following characters in the meeting subject will not be displayed:
Plantronics, Inc. 39
Command-Line API Reference
● | (vertical bar)
● CR (carriage return)
● LF (line feed)
See Also
To enable or disable the calendaring service, use the calendarregisterwithserver command.
To configure the Microsoft Exchange Server address that is used by this service, use the calendarserver
command.
Plantronics, Inc. 40
Command-Line API Reference
calendarpassword
Sets the password used by the calendaring service to log in to the Microsoft Exchange Server.
Syntax
calendarpassword “password”
Parameter Description
“password”
The password used by the calendaring service to log in to the
Microsoft Exchange Server.
Feedback Examples
● calendarpassword Dsca1end@r
returns
calendarpassword Dsca1end@r
Limitations
None
Comments
The password is case-sensitive and can contain a maximum of 15 characters. Use strong passwords that
combine uppercase and lowercase letters, numbers, and symbols.
Plantronics, Inc. 41
Command-Line API Reference
calendarplaytone
Gets or sets the reminder alert tone that plays with the meeting reminder when the system is registered
with the calendaring service.
Syntax
calendarplaytone get
calendarplaytone <yes|no>
Parameter Description
get Gets the current setting for the alert tone.
yes Enables the alert tone.
no Disables the alert tone.
Feedback Examples
● calendarplaytone get
returns
calendarplaytone yes
● calendarplaytone yes
returns
calendarplaytone yes
● calendarplaytone no
returns
calendarplaytone no
Limitations
None
Comments
None
Plantronics, Inc. 42
Command-Line API Reference
calendarprotocol
Gets or sets the protocol to use when connecting to the calendaring service.
Syntax
calendarprotocol <get|auto|tls>
Parameter Description
get Gets the current setting.
auto Sets the connection protocol to automatic discovery.
tls Sets the connection protocol to TLS.
Feedback Examples
● calendarprotocol get
returns
calendarprotocol tls
● calendarprotocol auto
returns
calendarprotocol auto
Limitations
None
Comments
None
Plantronics, Inc. 43
Command-Line API Reference
calendarregisterwithserver
Enables or disables the calendaring service.
Syntax
calendarregisterwithserver get
calendarregisterwithserver <yes|no>
Parameter Description
get Returns the current server registration status.
yes Enables the calendaring service.
no Disables the calendaring service.
Feedback Examples
● calendarregisterwithserver get
returns
calendarregisterwithserver no
● calendarregisterwithserver yes
returns
calendarregisterwithserver yes
● calendarregisterwithserver no
returns
calendarregisterwithserver no
Limitations
None
Comments
To configure the Microsoft Exchange Server address used by the calendaring service, use the
calendarserver command.
Plantronics, Inc. 44
Command-Line API Reference
calendarremindertime
Gets or sets the meeting reminder time when the system is registered with the calendaring service.
Syntax
calendarremindertime <get|1|5|10|15|30|none>
Parameter Description
get Gets the current reminder time.
1|5|10|15|30|none The number of minutes before a meeting starts that
a meeting reminder is given. The default is 5.
Feedback Examples
● calendarremindertime get
returns
calendarremindertime 5
● calendarremindertime 15
returns
calendarremindertime 15
● calendarremindertime none
returns
calendarremindertime none
Limitations
None
Comments
None
See Also
Use the notify command to register for meeting reminders.
See also calendarplaytone command.
Plantronics, Inc. 45
Command-Line API Reference
calendarresource
Gets or sets the resource (i.e., account) monitored for calendar events.
Syntax
calendarresource get
calendarresource “resource”
Parameter Description
get Returns the resource monitored for calendar
events.
“resource” The resource to monitor for calendaring
events.
Feedback Examples
● calendarresource get
returns
calendarresource radam@abcde.com
● calendarresource jmcnulty@abcde.com
returns
calendarresource jmcnulty@abcde.com
Limitations
None
Comments
A resource can be a user or resource account. A resource account is assigned to a meeting room.
See Also
Use the calendarregisterwithserver command to enable or disable the calendaring service. See the
calendarserver command to configure the Microsoft Exchange Server address used by the calendaring
service.
Plantronics, Inc. 46
Command-Line API Reference
calendarserver
Gets or sets the Microsoft Exchange Server used by the calendaring service.
Syntax
calendarserver get
calendarserver "server"
Parameter Description
get Gets the current Microsoft Exchange Server used by the
calendaring service.
“server” The IP address or DNS name of the Microsoft Exchange Server
used by the calendaring service.
Feedback Examples
● calendarserver get
returns
calendarserver 192.168.44.168
● calendarserver 192.168.23.221
returns
calendarserver 192.168.23.221
● calendarserver get
returns
calendarserver mail.exchangeserver.local.com
● calendarserver mail2.exchserver.local.com
returns
calendarserver mail2.exchserver.local.com
Limitations
None
Comments
None
See Also
Use the calendarregisterwithserver command to enable or disable the calendaring service.
Plantronics, Inc. 47
Command-Line API Reference
calendarshowpvtmeetings
Enables or disables the display of private meetings in the calendar when the system is registered with the
calendaring service.
Syntax
calendarshowpvtmeetings get
calendarshowpvtmeetings <yes|no>
Parameter Description
get Gets the current setting for private meeting
display.
yes Enables the display of private meetings.
no Blocks the display of private meetings.
Feedback Examples
● calendarshowpvtmeetings get
returns
calendarshowpvtmeetings no
● calendarshowpvtmeetings yes
returns
calendarshowpvtmeetings yes
● calendarshowpvtmeetings no
returns
calendarshowpvtmeetings no
Limitations
None
Comments
None
Plantronics, Inc. 48
Command-Line API Reference
calendarstatus
Returns the status of the Microsoft Exchange Server connection.
Syntax
calendarstatus get
Parameter Description
get Returns the Microsoft Exchange Server
connection status.
Feedback Examples
● calendarstatus get
returns
calendarstatus established
● calendarstatus get
returns
calendarstatus unavailable
Limitations
None
Comments
None
See Also
Use the calendarregisterwithserver command to enable or disable the calendaring service.
Plantronics, Inc. 49
Command-Line API Reference
calendaruser
Gets or sets the user name the calendaring service uses to log in to the Microsoft Exchange Server.
Syntax
calendaruser get
calendaruser “username”
Parameter Description
get Returns the user name being used by the calendaring service.
username The user name the calendaring service uses to log in to the
Microsoft Exchange Server.
Feedback Examples
● calendaruser get
returns
calendaruser jpolycom
Limitations
None
Comments
None
See Also
See the calendarserver command to configure the Microsoft Exchange Server address used by this service.
Plantronics, Inc. 50
Command-Line API Reference
callinfo
Returns information about the current call.
Syntax
callinfo all
callinfo callid “callid”
Parameter Description
all Returns information about each connection in the call.
callid Returns information about the connection with the specified call ID.
Feedback Examples
● callinfo callid 36
returns
callinfo:36:192.168.1.102:256:connected:muted:outgoing:videocall
● callinfo all
returns
system is not in a call
when no call is currently connected
Limitations
None
Comments
The callid information is returned using the following format:
callinfo:<callid>:<far site name>:<far site number>:<speed>:
<connection status>:<mute status>:<call direction>:<call type>
Plantronics, Inc. 51
callstate
Sets or gets the call state notification for call state events.
Syntax
callstate <get|register|unregister>
Parameter Description
get Returns the current setting.
register Registers the system to give notification of call activities.
unregister Disables the register mode.
Feedback Examples
● callstate register
returns
callstate registered
● callstate unregister
returns
callstate unregistered
● callstate get
returns
callstate unregistered
After registering, the following callstate
cs: call[34] chan[0] dialstr[192.168.1.103] state[ALLOCATED]
cs: call[34] chan[0] dialstr[192.168.1.103] state[RINGING]
cs: call[34] chan[0] dialstr[192.168.1.103] state[COMPLETE]
active: call[34] speed [384]
After registering, the following response occurs when disconnecting an IP call:
cleared: ca ll[34]
dialstr[IP:192.168.1.103 NAME:
ended: call[34]
(cs:) data is returned when connecting an IP call:
Polycom Demo
]
Command-Line API Reference
Limitations
None
Comments
To retrieve call state status, Poly recommends using
register.
If you use
Plantronics, Inc.
callstate register,
don’t also use
notify callstatus.
notify callstatus
instead of
callstate
52
Command-Line API Reference
See Also
You can also use the notify command and the nonotify command for notifications.
Plantronics, Inc. 53
Command-Line API Reference
camera
Sets or gets the near- or far-site camera settings.
Syntax
camera near {1..4}
camera far {1..4}
camera <near|far> move <left|right|up|down|zoom+|zoom-|stop>
camera <near|far> source
camera <near|far> stop
camera near <getposition|setposition “x” “y” “z”>
camera near tracking statistics
camera near tracking <get|on|off>
camerainvert near <get|on|off>
Parameter Description
get Returns the current setting.
on Sets the camera to present an inverted (upside down) video image.
off Sets the camera to present a normal (right-side up) video image.
near Specifies that the command selects or controls the near camera.
far Specifies that the command selects or controls the far camera.
{1..4} Specifies a near or far camera as the main video source.
move Changes the near or far camera’s direction or zoom. Valid directions are:
left, right, up, down, zoom+, zoom-, and stop.
left Starts moving the camera left.
right Starts moving the camera right.
up Starts moving the camera up.
down Starts moving the camera down.
zoom+ Starts zooming in.
zoom- Starts zooming out.
stop Stops the movement of the near or far camera. Returns no feedback.
source Returns the number of the near or far camera source currently selected.
getposition Gets the pan, tilt, and zoom coordinates of the currently selected PTZ
camera in the format of pan tilt zoom.
Plantronics, Inc. 54
Command-Line API Reference
Parameter Description
setposition
“x” “y” “z”
tracking
statistics
tracking
<get|on|off>
camerainvert
near
Sets the pan (x), tilt (y), and zoom (z) coordinates of the selected PTZ
camera.
Note:
Different cameras might have different PTZ values.
Some D30 cameras might not be able to reach the full range limit. For
example, although the pan limit is 5000, the camera might only be able
to reach a nearby value.
Gets tracking statistics. Tracking statistics measure:
• The amount of time tracking is turned off divided by the total call time
in the most recent 100 calls lasting more than five minutes.
• The amount of room and close-up view switches divided by the total
call time in the most recent 100 calls lasting more than five minutes.
Enables or disables the Polycom EagleEye Director II or EagleEye
Producer camera tracking feature. on turns the tracking feature on, off
turns the tracking feature off, and get returns the current tracking
feature setting.
Sets the video image of the EagleEye IV camera to upside down (
normal (
off
).
Feedback Examples
● camera far 2
specifies camera 2 at the far-site and returns
camera far 2
● camera far move left
causes the far-site camera to start panning to the left and returns
event: camera far move left
● camera near move zoom+
causes the near-site camera to zoom in and returns
event: camera near move zoom+
● camera near tracking off
returns
camera near tracking off
● camera near tracking on
returns
camera near tracking on
● camera near setposition 100 100 219
returns
camera near setposition 100 100 219
● camera near getposition
returns
camera near getposition 100 99 218
● camerainvert near get
returns
camerainvert near off
on
) or
Plantronics, Inc. 55
Command-Line API Reference
● camerainvert near on
returns
camerainvert near on
● camerainvert near off
returns
camerainvert near off
Limitations
None.
Comments
The number assigned to USB cameras may vary.
The camera commands function only when the system is in a wake state. If necessary, use the wake
command prior to using the camera commands.
If the camera near {1..4} API command is used for an input configured as content, the command
becomes a toggle. You must send the command once to send the content source and a second time to
stop the content source.
After using a camera command to move a Polycom EagleEye Producer or Polycom EagleEye Director II
camera, you must use the
camera <near|far> stop
command to update the camera position.
Plantronics, Inc. 56
Command-Line API Reference
camera near tracking
Enables or disables camera tracking for a Polycom EagleEye Director II or EagleEye Producer
camera.
The camera near tracking get command returns the following value: on/off.
Syntax
camera near tracking
cameratracking near calibrate <get|on|off>
cameratracking near framing <get|wide|medium|tight>
cameratracking near mode <get|off|group|speaker|groupwithtransition>
cameratracking near participant <get|on|off>
cameratracking near pip <get|on|off>
cameratracking near speed <get|slow|normal|fast>
cameratracking near wake <get|on|off>
Parameter Description
get Returns the current setting.
on Enables camera near tracking.
<get|on|off>
off Disables camera near tracking.
calibrate Enables (
EagleEye Producer camera.
framing Sets camera tracking framing adjustments for a EagleEye Producer
camera to one of the following:
•
•
•
mode Set the tracking mode for the EagleEye Director II or EagleEye
Producer camera.
EagleEye Director II:
•
•
EagleEye Producer:
•
participant Enables (on) or disables (
EagleEye Producer camera.
pip Enables (
Director II camera.
on
) or disables (
wide
- wide view of meeting participants
medium
tight
group
speaker
- default (normal) framing
- close-up view of meeting participants
- Frames the meeting participants.
- Frames the active speaker.
groupwithtransition
framing of participants in the room while displaying camera
motion.
on
) or disables (
off
) automatic calibration for the
- Enables the automatic locating and
off
) the Participant feature for the
off
) the self view setting of the EagleEye
Plantronics, Inc. 57
Command-Line API Reference
Parameter Description
speed Sets the rate at which an EagleEye Director II or EagleEye
Producer camera detects active speakers to
fast
.
Camera tracking must be enabled.
slow, normal
, or
wake Enables (on) or disables (
EagleEye Producer camera.
To use these commands, you must go to Admin Settings >
System Settings > Polycom Labs in the web interface and enable
the auto wake up feature for the EagleEye Producer camera.
off
Feedback Examples
● camera near tracking get
returns
camera near tracking on/off
● camera tracking get
returns
error: There is no tracking camera
● camera near tracking off
returns
camera near tracking off
● camera near tracking on
returns
camera near tracking on
● cameratracking near calibrate get
returns
cameratracking near calibrate on
● cameratracking near framing get
returns
cameratracking near framing medium
● ccameraautohanguptimer off
returns
cameraautohanguptimer off
● cameraautohanguptimer 30
returns
cameraautohanguptimer 30
● cameratracking near mode get
returns
cameratracking near mode group
● cameratracking near participant get
returns
cameratracking near participant on
● cameratracking near participant off
returns
cameratracking near participant off
) the auto wake up feature for the
Plantronics, Inc. 58
Command-Line API Reference
● cameratracking near pip get
returns
cameratracking near pip on
Limitations
None
Comments
None
Plantronics, Inc. 59
Command-Line API Reference
configdisplay
Gets or sets the resolution and refresh rate for Monitor 1 or Monitor 2.
Syntax
configdisplay [<monitor1|monitor2>] get
configdisplay monitor1
<auto|50hz1920x1080p|60hz1920x1080p|25hz3840x2160p|30hz3840x2160p|50hz3840x2160p|60hz3
840x2160p>
configdisplay monitor2 <off|auto|50hz1920x1080p|60hz1920x1080p>
Parameter Description
get Returns the current setting.
monitor1 Specifies Monitor 1.
monitor2 Specifies Monitor 2.
off Sets Monitor 2 to off.
auto Sets the monitor signal type to auto detection.
<refreshrateRe
solution>
Sets the resolution and refresh rate. For example, entering
configdisplay monitor1 60hz3840x2160p configures
Monitor 1 to 3840x2160p, 60Hz.
Feedback Examples
● configdisplay get
returns
configdisplay monitor1 1920x1080p 60Hz, monitor2 1920x1080p 60Hz
● configdisplay monitor1
returns
configdisplay monitor1 1920x1080p 30Hz
● configdisplay monitor2 get
returns
configdisplay monitor2 1920x1080p 60Hz
● configdisplay monitor2 off
returns
configdisplay monitor2 off
30hz1920x1080p
Limitations
None
Comments
None
Plantronics, Inc. 60
Command-Line API Reference
configparam
Gets or sets the video quality setting for the specified video input for motion or sharpness.
Syntax
configparam <“parameter”> get
configparam <“parameter”> set <“value”>
Parameter Description
get Gets the video quality setting for the specified video input.
set Sets the video quality setting for the specified video input.
camera_video_quality
<motion|sharpness>
Sets the video quality setting for the specified video input for
motion or for sharpness (for images without motion).
Feedback Examples
● configparam camera_video_quality 1 set motion
returns
camera1_video_quality motion
● configparam camera_video_quality 1 get
returns
camera1_video_quality sharpness
Limitations
None
Comments
None
Plantronics, Inc. 61
Command-Line API Reference
configpresentation
Gets or sets the dual display settings, including self view and content.
Syntax
configpresentation [<self-view>|<content>] get
configpresentation self-view <corner|full-screen>
configpresentation content <single|dual>
Parameter Description
get Returns the current dual-display settings for self-view or content.
self-view Specifies settings for self view. Precedes the corner or full-screen
parameter.
corner Displays self view in the bottom corner of a monitor.
full-screen Displays full screen Self View.
content Specifies where content displays on the connected monitor(s). Precedes
the single or dual parameter.
single Displays content on one monitor.
dual Displays content on both monitors.
Feedback Examples
● configpresentation self-view get
returns
configpresentation self-view Corner
● configpresentation self-view full-screen
returns
configpresentation self-view full-screen
● configpresentation content get
returns
configpresentation content dual
● configpresentation content single
returns
configpresentation content single
Limitations
None
Comments
None
Plantronics, Inc. 62
Command-Line API Reference
contentauto
Gets or sets the automatic bandwidth adjustment for people and content in point-to-point H.323 calls.
Automatic adjustment maintains equal image quality in the two streams.
Syntax
contentauto <get|on|off>
Parameter Description
get Returns the current setting.
on Enables automatic bandwidth adjustment for people and content.
off Disables automatic bandwidth adjustment for people and content.
The Quality Preference setting is used instead.
Feedback Examples
● contentauto off
returns
contentauto off
● contentauto on
returns
contentauto on
● contentauto get
returns
contentauto on
Limitations
None
Comments
None
Plantronics, Inc. 63
Command-Line API Reference
content
Controls video content by showing, hiding, or closing shared content.
Syntax
content show <ID>
content hide <ID>
content close <ID>
Parameter Description
show If content is hidden in the content tray, starts
showing specific content by <ID>.
hide Hides specific displayed content in the content
tray by <ID>. Use all in place of the <ID> to
hide all active content in the content tray.
close Closes specific content source by <ID>.
Feedback Examples
● content show 987
returns
content show successful
● content hide 987
returns
content hide successful
● content hide all
returns
content hide all successful
● content close 987
returns
content close successful
● content show 115
returns
error: input 115 is not a content source
content show failed
Limitations
You can’t close some content sources, only hide them. For example, HDMI content.
Plantronics, Inc. 64
Command-Line API Reference
Comments
If you try to call content show for content already shown or content hide for content already hidden,
“
the system returns
error:not allowed”.
Plantronics, Inc. 65
Command-Line API Reference
content list
Displays a list containing information on system content status.
Syntax
content list
content list <type|ID>
content list shown
content list hidden
Parameter Description
content list Returns all content.
type Returns all content of a given type. Type
values are: UNKNOWN,CONTENTCAM, PPCIP,
MIRACAST, AIRPLAY, DRAWINGBOARD.
ID Returns all content with a given source ID.
shown Returns content this is displaying on your
system.
hidden Returns content that is hidden in the content
tray.
Feedback Examples
● content list
returns
content list start
content: id:
content list done
● content list shown
returns
content list start
content: name: id:
content list done
● content list contentcam
returns
content list start
content: name: id:
content list done
● content list 12347
returns
content list start
content: name: id:
content list done
“
id” name:“name” type:”source type” shown:true/false
“
123456” “Blackboard-1” type:”drawingboard” shown:true
“
1234” “HDMI” type:”contentcam” shown:true
“
12347” “My iphone” type:”airplay” shown:false
Plantronics, Inc. 66
Command-Line API Reference
Limitations
None
Comments
The system returns an empty list if the filter doesn’t match a source.
Plantronics, Inc. 67
Command-Line API Reference
daylightsavings
Gets or sets the daylight saving time setting. When you enable this setting, the system clock automatically
changes for daylight saving time.
Syntax
daylightsavings <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables automatic adjustment for daylight savings time.
no Disables automatic adjustment for daylight savings time.
Feedback Examples
● daylightsavings no
returns
daylightsavings no
● daylightsavings yes
returns
daylightsavings yes
● daylightsavings get
returns
daylightsavings yes
Limitations
None
Comments
None
Plantronics, Inc. 68
Command-Line API Reference
defaultgateway
Gets or sets the default gateway.
Syntax
defaultgateway get
defaultgateway set “xxx.xxx.xxx.xxx”
Parameter Description
get Returns the default gateway IP address.
set Sets the default gateway when followed by the “xxx.xxx.xxx.xxx” parameter.
“xxx.xxx.xxx.xxx” IP address to use as the default gateway.
Feedback Examples
● defaultgateway set 192.168.1.101
returns
defaultgateway 192.168.1.101
Limitations
None
Comments
You can only change the defaultgateway setting if DHCP is turned off.
Plantronics, Inc. 69
Command-Line API Reference
dhcp
Gets or sets DHCP options.
Syntax
dhcp <get|off|client>
Parameter Description
get Returns the selected DHCP option.
off Disables DHCP.
client Enables DHCP client. The system obtains an IP address from a server on your network.
Feedback Examples
● dhcp off
returns
dhcp off
● dhcp client
returns
dhcp client
● dhcp get
returns
dhcp client
Limitations
None
Comments
You must restart the system after making a change to a setting.
Plantronics, Inc. 70
Command-Line API Reference
dial
Dials video or audio calls manually or from the directory.
Syntax
dial addressbook “addr book name”
dial auto “speed” “dialstr”
dial manual “speed” “dialstr1” [“dialstr2”] [h323|ip|sip]
dial phone <sip|h323|auto|> "dialstring"
Parameter Description
addressbook Dials a directory (address book) entry. Requires the name of the entry.
“addr book name” The name of the directory (address book) entry. The name may be up to 25
characters. Use quotation marks around strings that contain spaces. For example:
“John Doe”.
auto Automatically dials a number. When used with “speed” and “dialstr, dials a
video call number dialstr1 at speed of type h323.
“speed” Valid data rate for the network.
“dialstr”,
“dialstr1”,
“dialstr2”
manual Dials a video call number dialstr1 at speed of type h323. Requires the
h323|ip|sip Call type
phone Dials an audio call. This option Is supported only when the Enable Audio Add In
“dialstring” Numeric string specifying the phone number to dial. Enclose the string in quotation
IP directory number.
parameters “speed” and “dialstr1”.
Use dial manual “speed” “dialstr” “type” when you do not want
automatic call rollover or when the dialstring might not convey the intended
transport.
Use dial manual without specifying a call type
call feature is enabled.
marks if it includes spaces. Example: “512 555 1212”
Feedback Examples
● If registered for callstate notifications (callstate register), the API returns
cs: call[44] chan[0] dialstr[5551212] state[ALLOCATED]
cs: call[44] chan[0] dialstr[5551212] state[RINGING]
cs: call[44] chan[0] dialstr[5551212] state[CONNECTED]
cs: call[44] chan[0] dialstr[5551212] state[CONNECTED]
cs: call[44] chan[0] dialstr[5551212] state[COMPLETE]
cs: call[44] chan[0] dialstr[5551212] state[COMPLETE]
active: call[44] speed[64]
Plantronics, Inc. 71
Command-Line API Reference
● dial addressbook "John Polycom"
returns
dialing addressbook "John Polycom"
● dial phone sip 1234
returns
dialing voice_sip
● If SIP is not enabled dial phone sip 1234
returns
info: IP line (SIP) not enabled.
● Note: The [BONDING] responses in IP calls are extraneous text that will be removed in a subsequent
software version.
Call ID (call [44]) is an example of the response. The Call ID number depends upon the call type.
● If registered for callstatus notifications (notify callstatus), the API returns,
notification:callstatus:outgoing:45:null 1::opened::0:videocall
notification:callstatus:outgoing:45: Polycom Austin:
192.168.1.101:connecting:384:0:videocall
notification:callstatus:outgoing:45: Polycom Austin:
192.168.1.101:connected:384:0:videocall
Note: The call ID number (45) is an example of the response. The Call ID number depends upon the
call type.
Limitations
None
Comments
None
See Also
You can use callstate register or notify callstatus to obtain updated information on the status
of a call. For example, when using dial manual to place a call, both registration commands will tell you
when the call is connected. Refer to the callstate command and the notify command.
Plantronics, Inc. 72
Command-Line API Reference
dial addressbook_entry
Dials a system using a unique identifier retrieved by the globaldir command.
Syntax
dial addressbook_entry “UID”
Parameter Description
“UID” Unique identifier associated with a site or group, for example:
ldap#g#f82be96eea3bd644a1963dc7fdf45011
The complete UID must be specified
Feedback Examples
● dial addressbook_entry ldap#g#35086aa0ecc9014facdcaa89bd34ccf6
returns
dialing addressbook_entry ldap#g#35086aa0ecc9014facdcaa89bd34ccf6Comments
Limitations
None
Comments
The “UID” value must be retrieved by the globaldir command.
Plantronics, Inc. 73
Command-Line API Reference
dns
Gets or sets the configuration for up to four DNS servers.
Syntax
dns get {1..4}
dns set {1..4} “xxx.xxx.xxx.xxx”
Parameter Description
get Returns the current IP address of the specified server.
A server identification number {1..4} is required.
{1..4} Specifies the server identification number.
set Sets the IP address of the specified DNS server when followed by the
“xxx.xxx.xxx.xxx” parameter.
A server identification number {1..4} is required.
“xxx.xxx.xxx.xxx” Specifies the IP address for the specified server.
Feedback Examples
● dns set 1 192.168.1.205
returns
dns 1 192.168.1.205
Limitations
None
Comments
After making a change, you must restart the system for the setting to take effect.
You cannot set these values if the system is in DHCP client mode.
Plantronics, Inc. 74
Command-Line API Reference
dynamicbandwidth
Gets or sets the use of dynamic bandwidth allocation for Quality of Service.
Syntax
dynamicbandwidth <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables the dynamic bandwidth option.
no Disables the dynamic bandwidth option.
Feedback Examples
● dynamicbandwidth yes
returns
dynamicbandwidth yes
● dynamicbandwidth no
returns
dynamicbandwidth no
● dynamicbandwidth get
returns
dynamicbandwidth no
Limitations
None
Comments
The system’s dynamic bandwidth function automatically finds the optimum speed for a call. If you
experience excessive packet loss during a call, the dynamic bandwidth function decrements the speed until
there’s no packet loss. This is supported in calls with endpoints that also support dynamic bandwidth.
Plantronics, Inc. 75
Command-Line API Reference
e164ext
Gets or sets an H.323 (IP) extension (also known as an E.164 name).
Syntax
e164ext get
e164ext set “e.164name”
Parameter Description
get Returns the current setting.
set Sets the E.164 extension when followed by the “e.164name” parameter. To erase the
current setting, omit “e.164name”.
“e.164name” A valid E.164 extension (usually a four-digit number).
Feedback Examples
● e164ext set 7878
returns
e164ext 7878
● e164ext get
returns
e164ext 7878
Limitations
None
Comments
The extension number is associated with a specific LAN device.
Plantronics, Inc. 76
Command-Line API Reference
echo
Returns a string that is sent to the system.
Syntax
echo <string>
Parameter Description
echo <string> Returns a string sent to the system.
Feedback Examples
● echo “Are you there?”
returns
Are you there?
● echo KA
returns
KA
Limitations
None
Comments
None
Plantronics, Inc. 77
Command-Line API Reference
echocanceller
Gets and sets the configuration of line-input port echo cancellation that prevents users from hearing their
voices loop back from the far site.
Syntax
echocanceller <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables the echo canceller option.
no Disables the echo canceller option.
Feedback Examples
● echocanceller get
returns
echocanceller no
Limitations
None
Comments
None
Plantronics, Inc. 78
Command-Line API Reference
echoreply
Gets or sets the system’s ability to send an Echo Reply message in response to an Echo Request message
sent to an IPv4 multicast/anycast address.
Syntax
echoreply <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables the echo reply option.
no Disables the echo reply option.
Feedback Examples
● echoreply get
returns
echoreply yes
● echoreply no
returns
echoreply no
Limitations
None
Comments
The number of responses may be traffic-conditioned to limit the effect of a denial-of-service (DoS) attack.
You must restart the system after making a change to a setting.
Plantronics, Inc. 79
Command-Line API Reference
enableacousticfence
Gets or sets the current setting for the Polycom® Acoustic Fence™ technology feature.
Syntax
enableacousticfence <get|on|off>
Parameter Description
get Returns the current setting.
on Enables Polycom Acoustic Fence.
off Disables Polycom Acoustic Fence.
Feedback Examples
● enableacousticfence get
returns
enableacousticfence on
● enableacousticfence on
returns
enableacousticfence on
● enableacousticfence off
returns
enableacousticfence off
Limitations
None
Comments
None
Plantronics, Inc. 80
Command-Line API Reference
enableaudioadd
Enables or disables the Audio Add In feature, which allows one additional outbound, audio-only call from a
G7500 system when the maximum number of calls allowed for a license is reached.
Syntax
enableaudioadd <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables the Audio Add-In features. This is the default setting.
no Disables the Audio Add-In feature.
Feedback Examples
● enableaudioadd get
returns
enableaudioadd yes
● enableaudioadd yes
returns
enableaudioadd yes
● enableaudioadd no
returns
enableaudioadd no
Limitations
None
Comments
None
Plantronics, Inc. 81
Command-Line API Reference
enablefirewalltraversal
Gets or sets the system’s ability to traverse firewalls. This feature requires a session border controller that
supports H.460.
Syntax
enablefirewalltraversal <get|on|off>
Parameter Description
get Returns the current setting.
on Enables the firewall traversal feature.
off Disables the firewall traversal feature.
Feedback Examples
● enablefirewalltraversal on
returns
enablefirewalltraversal on
● enablefirewalltraversal off
returns
enablefirewalltraversal off
● enablefirewalltraversal get
returns
enablefirewalltraversal off
Limitations
None
Comments
None
Plantronics, Inc. 82
Command-Line API Reference
enablekeyboardnoisereduction
Gets or sets the keyboard noise reduction feature.
Syntax
enablekeyboardnoisereduction <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables keyboard noise reduction.
no Disables keyboard noise reduction.
Feedback Examples
● enablekeyboardnoisereduction yes
returns
enablekeyboardnoisereduction yes
● enablekeyboardnoisereduction no
returns
enablekeyboardnoisereduction no
● enablekeyboardnoisereduction get
returns
enablekeyboardnoisereduction no
Limitations
None
Comments
None
Plantronics, Inc. 83
Command-Line API Reference
enablelivemusicmode
Gets or sets the M-Mode feature.
Syntax
enablelivemusicmode <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables M-Mode.
no Disables M-Mode.
Feedback Examples
● enablelivemusicmode yes
returns
enablelivemusicmode yes
● enablelivemusicmode no
returns
enablelivemusicmode no
Limitations
None
Comments
M-Mode was previously known as MusicMode. The feature functions the same way as before despite the
name change.
Plantronics, Inc. 84
Command-Line API Reference
enablepvec
Gets or sets the Polycom Video Error Concealment (PVEC) setting on the system.
Syntax
enablepvec <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables the PVEC option.
no Disables the PVEC option.
Feedback Examples
● enablepvec yes
returns
enablepvec yes
● enablepvec no
returns
enablepvec no
● enablepvec get
returns
enablepvec no
Limitations
None
Comments
This option, Enable Lost Packet Recovery in the web interface, is enabled by default.
Plantronics, Inc. 85
Command-Line API Reference
enablersvp
Gets or sets the Resource Reservation Protocol (RSVP) setting, which requests that routers reserve
bandwidth along an IP connection path.
Syntax
enablersvp <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables the RSVP option.
no Disables the RSVP option.
Feedback Examples
● enablersvp yes
returns
enablersvp yes
● enablersvp no
returns
enablersvp no
● enablersvp get
returns
enablersvp no
Limitations
None
Comments
This option is enabled by default.
Plantronics, Inc. 86
Command-Line API Reference
enablesipka
Gets or sets the option to send SIP keep-alive messages.
Syntax
enablesipka <get|on|off>
Parameter Description
get Returns the current setting.
on Enables SIP keep alive messages.
no Disables SIP keep alive messages.
Feedback Examples
● enablesipka get
returns
enablesipka off
● enablesipka on
returns
enablesipka on
Limitations
None
Comments
None
Plantronics, Inc. 87
Command-Line API Reference
enablesnmp
Gets or enables/disables SNMP.
Syntax
enablesnmp <get|yes|no>
Parameter Description
get Returns the current setting.
yes Enables SNMP.
no Disables SNMP.
Feedback Examples
● enablesnmp yes
returns
enablesnmp yes
● enablesnmp no
returns
enablesnmp no
● enablesnmp get
returns
enablesnmp no
Limitations
None
Comments
None
Plantronics, Inc. 88
Command-Line API Reference
encryption
Gets or sets the AES encryption mode for the system.
Syntax
encryption <get|yes|no|requiredvideocallsonly|requiredallcalls>
Parameter Description
get Returns the current setting.
yes Use encryption when the far site is capable of encryption.
Note: This parameter is When Available in the user interface.
no Disables encryption.
Note: This parameter is Off in the web interface.
requiredvideocallsonly Enforces encryption on all video endpoints. Any video calls to or from
systems that do not have encryption enabled are not connected. Audio-only
calls are connected.
requiredallcalls Enforces encryption on all endpoints. Any video or audio calls to or from
systems that do not have encryption enabled are rejected and are not
connected.
Feedback Examples
● encryption yes
returns
encryption yes
● encryption no
returns
encryption no
● encryption get
returns
encryption no
● encryption requiredvideocallsonly
returns
encryption requiredvideocallsonly
● encryption requiredallcalls
returns
encryption requiredallcalls
Limitations
None
Plantronics, Inc. 89
Command-Line API Reference
Comments
You cannot execute the
system is in a call returns the following message:
error: command has illegal parameters
encryption
command while a call is in progress. Using this command while the
Plantronics, Inc. 90
Command-Line API Reference
exit
Ends the command-line API session.
Syntax
exit
Additional Restrictions
None
Feedback Examples
● exit
returns
Connection to host lost.
Limitations
None
Comments
For serial sessions, this command starts a new session.
Plantronics, Inc. 91
Command-Line API Reference
exportdirectory
Exports a directory in XML format.
Syntax
exportdirectory
Additional Restrictions
None
Feedback Example
exportdirectory
returns
exportdirectory started
<?xml version="1.0" encoding="UTF-8" ?>
<addresses>
<entrytype type="entry" name="dawn" filename="dawn" uniqueid="local:26">
<address filename="dawn
" langid="
" displayname="dawn
" name="dawn">
<h323 address="192.168.1.120"
speed="0"/>
<sip address="192.168.1.120"
speed="0"/>
<category category="CONTACTS"/>
</address>
</entrytype>
<entrytype type="entry" name="dawn " filename="dawn " uniqueid="local:28">
<address filename="dawn
" langid="
" displayname="dawn
" name="dawn ">
<h323 address="192.168.1.120"
speed="0"/>
<sip address="192.168.1.120"
speed="0"/>
<category category="CONTACTS"/>
</address>
</entrytype>
<address filename="testGroup
" langid="
" displayname="testGroup
" name="testGroup ">
<multisitename meeting_name="testGroup " />
Plantronics, Inc. 92
Command-Line API Reference
<multisitespeed meeting_speed="auto"/>
<multisitename0 site_name_0="dawn "/>
<mulitsitetype0 site_type_0="2" type_0="1000"/>
<mulitsiteprefcalltype0 pref_call_type_0="H323"/>
<multisiteuniqueid0 unique_id_0="local:28"/>
<multisitename1 site_name_1="dawn2 "/>
<mulitsitetype1 site_type_1="2" type_1="1000"/>
<mulitsiteprefcalltype1 pref_call_type_1="H323"/>
<multisiteuniqueid1 unique_id_1="local:30"/>
<multisitename2 site_name_2="dawn3 "/>
<mulitsitetype2 site_type_2="2" type_2="1000"/>
<mulitsiteprefcalltype2 pref_call_type_2="H323"/>
<multisiteuniqueid2 unique_id_2="local:29"/>
</address>
</entrytype>
<entrytype type="group" name="testGroup1" filename="testGroup1"
uniqueid="local:38">
<address filename="testGroup1
" langid="
" displayname="testGroup1
" name="testGroup1">
<multisitename meeting_name="testGroup1" />
<multisitespeed meeting_speed="auto"/>
</address>
</entrytype>
</addresses>
</xml>
exportdirectory done
Limitations
None
Comments
exportdirectory done indicates that all directory data has been exported.
Do not use the exportdirectory command to interpret the data that is returned. Simply store and use
the data as input to the importdirectory command or import directory utility in the web interface. The
format of the exported directory data might change in future software releases and any application
attempting to interpret the data could find its ability to do so compromised in later software releases.
Exporting a directory on one system model and importing the directory on another model is not supported.
Attempts to export and import directory information between different systems might also fail. The message
importdirectory failed indicates that the system was not able to import the information.
When importing directory data back into the system, use the data in its entirety (not edited in any form).
There is information that is used by the system to determine what type (XML or CSV) of data is being
imported.
Plantronics, Inc. 93
Command-Line API Reference
See Also
See the importdirectory command.
Plantronics, Inc. 94
Command-Line API Reference
exportprofile
Exports system and user profile information in CSV format. The output is available through a telnet or serial port connection.
Syntax
exportprofile
Additional Restrictions
None
Feedback Example
exportprofile
returns
exportprofile started
profileversion,0.2
system.info.eulafile,eula
system.info.hardwareversion,9
system.info.humanreadablemodel,RealPresence
system.info.humanreadableplatform,
system.info.humanreadableversion,Dev - 4.1.3-0
system.info.plcmstandardversion,Dev - 4.1.3-0
system.info.serialnumber,8213130FE433CV
audio.lineIO.lineinechocanceller,"False"
audio.volume.speakervolume,"46"
comm.Firewall.fixedportstcphigh,"3241"
comm.Firewall.fixedportsudphigh,"3301"
comm.NICs.H323Nic.h323extension,"177704997"
comm.NICs.H323Nic.h323name,"177704997"
comm.NICs.SipNic.bfcptransportprotocol,"Prefer_UDP"
comm.NICs.SipNic.thirdpartyinterop.ocs.sipuuid,"d503b976-c62f-5484-82c0-64a479
63 18d1"
comm.Qos.tos.tosaudio,"5"
comm.Qos.tos.tosfecc,"3"
comm.Qos.tos.tosoam,"0"
comm.Qos.tos.tosvideo,"4"
Plantronics, Inc. 95
Command-Line API Reference
location.country,"United States"
location.language,"ENGLISHUS"
pm.monRoleAuto,"True"
pm.monitor[1].enable,"True"
softupdate.url,"http://builds.softupdate.com/~test/softupdate /"
sourceman.camera[1].autowhitebalancegainb,"33"
sourceman.camera[1].autowhitebalancegainr,"37"
sourceman.camera[1].backlightcomp,"False"
sourceman.camera[1].brightness,"11"
sourceman.camera[1].contrast,"13"
sourceman.camera[1].name,"Main"
sourceman.camera[1].role,"People"
sourceman.camera[1].saturation,"6"
sourceman.camera[1].sharpness,"3"
sourceman.camera[1].videoquality,"Sharpness"
sourceman.camera[1].whitebalancemode,"atw"
video.monitor[1].Resolution,"1920x1080p 60Hz"
video.monitor[2].Resolution,"1920x1080p 60Hz"
exportprofile done
Comments
exportprofile done indicates that all profile data is exported.
When importing directory data back into the system, use the data in its entirety (not edited in any form).
There is information that is used by the system to determine what type data (XML or CSV) is being imported.
See Also
See the importprofile command.
Plantronics, Inc. 96
Command-Line API Reference
farcontrolnearcamera
Gets or sets far control of the near camera, which allows far sites to control the camera on your system.
Syntax
farcontrolnearcamera <get|yes|no>
Parameter Description
get Returns the current setting.
yes Allows the far site to control the near camera if the far site has this capability.
no Disables far-site control of the near camera.
Feedback Examples
● farcontrolnearcamera yes
returns
farcontrolnearcamera yes
● farcontrolnearcamera no
returns
farcontrolnearcamera no
● farcontrolnearcamera get
returns
farcontrolnearcamera no
Limitations
None
Comments
None
Plantronics, Inc. 97
Command-Line API Reference
farnametimedisplay
Enables or disables the name that is displayed on a far site monitor.
Syntax
farnametimedisplay <get|on|off>
Parameter Description
get Returns the current setting.
on Enables the name to be displayed for defined amount of time.
off Disables the name on a far site monitor.
Feedback Examples
● farnametimedisplay get
returns
farnametimedisplay on
● farnametimedisplay on
returns
farnametimedisplay on
● farnametimedisplay off
returns
farnametimedisplay off
Limitations
None
Comments
The name will time out in 10 seconds after displayed.
Plantronics, Inc. 98
Command-Line API Reference
favorites
Returns entries in the Favorites list. Favorites can link to local or global directory entries.
Syntax
favorites names <all|video|phone> [range_start] [range_end]
favorites names <all|video|phone> size
favorites address "sys_name" ["sys_label"]
Parameter Description
names Returns names in the Favorites list and the associated system type: video,
multicodec, phone, or multisite (a multicodec system displays as a single row).
The response is in the following format:
favorites names
name:"sys_name" sys_label:"sys_label" type:
<video|multicodec|phone|multisite>
favorites names done
<all|video|phone> video returns entries with video systems, phone returns entries with phone systems,
and all returns entries with both types.
size Specifies the size of the returned set based on the parameters you are including.
For example, a response could look like this:
favorites names video size 9
range_start For the names parameter, it specifies the beginning of the range of entries to return.
range_end For the names parameter, it specifies the end of the range of entries to return.
If range_start is specified without a range_end, the single range_start entry is
returned. If range_end is -1, all entries starting with range_start are returned.
address Obtains the address information for a specified entry. If the entry is an ITP system, the
results include the addresses for all its codecs. If the codecs support multiple
protocols, the different addresses are returned on separate lines. This parameter is not
supported for multisite entries.
sys_name The user-friendly name for a Favorites entry (for example, the name of a person or
room). It is surrounded by quotes if it contains spaces.
sys_label If a person or room has more than one system, the returned set includes a row for
each system. If those systems are of the same type, it is considered to be a single ITP
system with multiple codecs rather than separate systems. If there are different types
of systems, the sys_label parameter is included to differentiate the systems.
type The type of Favorites entry (possible values are video, multicodec, phone, and
multisite).
codec: <1..4> If the entry is an ITP system, each codec has a unique value.
h323_spd The preferred speed for an H.323 call to this entry.
Plantronics, Inc. 99
Loading...