| VoIP Console | Attribute | Commands | Index | Value Range |
| Hookstate | VOIPHOOKSTATE | SET, GET, SETD, GETD | 1 | 0 = off-hook 1 = on-hook |
| Digit(s) to Dial | VOIPPHONENUM | DIAL | 1 | enter the phone number |
| Last Number Dialed | VOIPLASTNUM | GET, GETD | 1 | None |
| Redial | VOIPLASTDIALED | DIAL | 1 | None |
| Speed Dial Tel. Number | VOIPSDENTRY | SET, GET, SETD, GETD | 1 & 2 | enter the phone number |
| Speed Dial Name | VOIPSDLABEL | SET, GET, SETD, GETD | 1 & 2 | enter the name |
| Speed Dial Entry to Dial | VOIPSPEEDDIAL | DIAL | 1 | 1 ~ 16 |
| Answer Call | VOIPCALL | ANS | 1 | None |
| Reject or End Call | VOIPCALL | END | 1 | None |
| Auto-Answer | VOIPAAENABLE | SET, GET, SETD, GETD | 1 | 1 = enabled 0 = disabled |
| Number of Rings Before Auto-Answer | VOIPAACOUNT | SET, GET, SETD, GETD | 1 | 0, 1, 2, 3, 4, 5 |
| Place a Call on Hold | VOIPCALL | HOLD | 1 | None |
| Resume a Call on Hold | VOIPCALL | RESUME | 1 | None |
| Line In Use State | VOIPLIUSTATE | GET, GETD | 1 | 0 = not in use 1 = in use |
| Line Ready State | VOIPLRSTATE | GET, GETD | 1 | 0 = not ready 1 = ready |
| Ring Indicator State | VOIPRISTATE | GET, GETD | 1 | 0 = not ringing 1 = ringing |
| CallerID | VOIPCIDUSER | GET, GETD | 1 | "date""phnenum'"name" |
Note: Index 1 is the line number [1,2] and index 2 is the speed dial entry [1,16].
Multiple VOIPPHONENUM commands can be used to dial the individual digits of a phone number, but the VoIP dialer must store the complete dial string and send it in a single request to the VoIP Proxy. To accomplish this task, it must be aware of the end of the dial string. To indicate the end of a dial string, include a # symbol in the dial command (DIAL 1 VOIPPHONENUM 104 1 5551234#) or (DIAL 1 VOIPPHONENUM 104 1 #).
The # symbol indicates to the VoIP dialer, when it is on-hook, to execute the command and dial the number provided. Any time the VoIP dialer is on-hook, the pound symbol is required to execute the call. When the VoIP line is already off-hook the # sign should not be included. This would be the case when dialing a PIN number while trying to enter into voice mail or join a bridge call.
When a # symbol is not used a dialing timeout also can signal the end of a dial string. If the phone is on hook, the first DIAL command will automatically set the hook state of the line to off hook. Once off hook, the dialing sequence will time out and the call executed if a new digit is not received within 3 seconds (configurable). Once this timeout occurs, the call will be placed using the existing digits. After the call is placed, digits can be continued to be dialed without a # symbol terminating the string.
DIAL commands received after the call is connected are sent immediately (as DTMF tones). The dialer can insert delay while sending DTMF tones by inserting commas where desired (each comma provides ½ second of delay).
Redial and Speed Dial numbers are assumed to be complete dial strings and do not require # (or wait for a dialing timeout) to be sent. Redial includes only the dial string used to connect the previous call and does not include DTMF tones sent during the connection.
Both ANS 1 VOIPCALL 104 1 and SET 1 VOIPHOOKSTATE 104 1 0 will answer an incoming call. Both END 1 VOIPCALL 104 1 and SET 1 VOIPHOOKSTATE 104 1 1 will end a call in progress.
VoIP Receive |
Attribute |
Commands |
Index |
Value Range |
Receive Level |
VOIPRXLVL |
SET, SETL, GET, GETL, INC, DEC |
1 |
-100 ~ 12 * |
CPT Level |
VOIPRXCPTLVL |
SET, SETL, GET, GETL, INC, DEC |
1 |
-100 ~ 0 * |
Mute |
VOIPRXMUTE |
SET, GET |
1 |
0 = unmuted 1 = muted |
* Can contain a decimal number.
VoIP Transmit |
Attribute |
Commands |
Index |
Value Range |
Transmit Level |
VOIPTXLVL |
SET, SETL, GET, GETL, INC, DEC |
1 |
-100 ~ 0 * |
Mute |
VOIPTXMUTE |
SET, GET |
1 |
0 = unmuted 1 = muted |
* Can contain a decimal number.
Device |
Attribute |
Commands |
Index |
Value Range |
VoIP FW Ver |
VOIPFWVER |
GET |
None |
Major.Minor (ex: 1.90) |
Device FQ Ver |
DEVFWVER |
GET |
None |
(ex: 3.307-2.3-4.510) |
Below are some examples of possible string usage:
1.Basic Dialing with timeout to send, talk, and then end call locally with end command |
|
| SET 0 VOIPHOOKSTATE 104 1 0 | // go off hook |
| DIAL 1 VOIPPHONENUM 104 1 1 | // dial the digit 1 |
| DIAL 1 VOIPPHONENUM 104 1 2 | // dial the digit 2 |
| DIAL 1 VOIPPHONENUM 104 1 3 | // dial the digit 3 |
| // … 3 seconds pass (from last DIAL) and request is sent | |
| // … Talking... | |
| END 1 VOIPCALL 104 1 | |
2. Basic Dialing with explicit send and end call locally with end command
DIAL 1 VOIPPHONENUM 104 1 1 // go off hook and dial the digit 1 DIAL 1 VOIPPHONENUM 104 1 2 // dial the digit 2 DIAL 1 VOIPPHONENUM 104 1 3 // dial the digit 3 DIAL 1 VOIPPHONENUM 104 1 # // send the dial request to the VoIP Proxy // … Talking... END 1 VOIPCALL 104 1
3. Incoming call & answer and end locally
// incoming call (ringing…) ANS 1 VOIPCALL 104 1 // answer call // … Talking... END 1 VOIPCALL 104 14. Incoming call & answer and end locally
// incoming call (ringing…) SET 1 VOIPHOOKSTATE 104 1 0 // answer call // … Talking... END 1 VOIPCALL 104 15. Incoming call & reject
// incoming call (ringing…) END 1 VOIPCALL 104 1 // reject call6. Incoming call & answer, Place call on hold, resume call, and end locally
// incoming call (ringing…) ANS 1 VOIPCALL 104 1 // answer call // … Talking... HOLD 1 VOIPCALL 104 1 // place call on hold RESUME 1 VOIPCALL 104 1 // resume call // … Talking... END 1 VOIPCALL 104 1