CTI (Computer-Telephony Integration) provides the ability to manage phone calls from a computer including basic call operations such as making and answering calls, and advanced call operations such as call forward, conference, call hold, and more.

Grandstream GRP26XX series supports CTI operations and commands providing complete control over phone calls from a desktop computer. CTI commands can be integrated with a 3^rd party application to control the interaction between the customer’s phone and desk computer or can be run using a web browser on the customer’s computer.

This guide describes available operations and commands with examples how to run them from a web browser.

BENEFITS OF CTI

The significant benefits of using Computer Telephony Integration (CTI) are the following:

• Complete control over calls (answer, hang-up, call on hold, manage “do not disturb”, call forward, conference, call transfer and etc…).
• Incoming call notifications on the desk computer allow caller numbers to be screened against a database to collect or provide more information related to the caller.
• Initiate outbound calls from the computer directly with the possibility of automatic and pre-dial calls commonly used for telemarketing.
• Increase productivity and improve customer service.

ENABLING CTI FEATURE

To enable the CTI feature on the GRP26XX series, follow the steps below:

1. Access GRP26XX web GUI as administrator.
2. Navigate to Network 🡪 Remote Control (on GRP261x/GRP2624/GRP2634) or Network Settings 🡪 Advanced Settings 🡪 Remote Control (on GRP260x).
3. Enable Action URI Support by checking “Enabled”.
4. On field Action, URI Allowed IP List, put the remote party’s IP address. If the IP address is unknown, add “any”.
5. Set Remote Control Pop-up Window Support to “Disabled” to allow remote control without confirmation on the physical phone.
6. Press the Save and Apply button.

CTI COMMANDS FORMAT DEFINITION

Request format

The general CTI commands request format is:

http://Phone-IP-Address/cgi-bin/function?passcode=PASSWORD&param=value

“Function” is one of CTI functions as described in next chapter (api-get_line_status for example)

“Password” is the phone’s admin/user level password

“Param=value” is the parameter for specific CTI function type

Response format

TYPE OF CTI FUNCTIONS

Please refer to following table describing type of CTI functions supported:

CTI COMMANDS AND EXAMPLES

Following commands have been run in a web browser on computer in same phone’s network. In the examples below, a GRP26XX phone is used with IP address 192.168.5.135 and admin/user level password set to (passcode=admin).

Functions used on GRP26XX

Line Status Function

General Format

The general format of CTI command to retrieve the line status is:

http://Phone-IP-Address/cgi-bin/api-get_line_status?passcode=PASSWORD

Example

In this example, the phone shows that only one account is available on line 1; other lines are not registered.

Phone Status Function

General Format

The general format of CTI command to retrieve phone status is:

http://Phone-IP-Address/cgi-bin/api-get_phone_status?passcode=PASSWORD

Example

Request	http://192.168.5.135/cgi-bin/api-get_phone_status?passcode=admin
Response	Phone available {“response”:”success”, “body”: “available”, “misc”: “0”} Phone busy {“response”:”success”, “body”: “busy”, “misc”: “0”}

Phone Operations Functions

General format

The general format of CTI command to send phone operations is:

http://Phone-IP-Address/cgi-bin/api-phone_operation?passcode=PASSWORD&cmd=OPERATION

Examples

Operation	Function	Examples
endcall	End established call	http://192.168.5.135/cgi-bin/api-phone_operation?passcode=admin&cmd=endcall
holdcall	Put the established call on Hold	http://192.168.5.135/cgi-bin/api-phone_operation?passcode=admin&cmd=holdcall
acceptcall	Accept incoming call	http://192.168.5.135/cgi-bin/api-phone_operation?passcode=admin&cmd=acceptcall
rejectcall	Reject incoming call	http://192.168.5.135/cgi-bin/api-phone_operation?passcode=admin&cmd=rejectcall
cancel	Reject or cancel calls	http://192.168.5.135/cgi-bin/api-phone_operation?passcode=admin&cmd=cancel

Positive answer

If accepted, the command will be run instantly on the phone and below positive answer can be returned:

{“response”: “success”, “body”: true}

Negative answer

If not accepted, the phone will not react to it and below negative answer can be returned:

{“response”: “error”, “body”: false}

Account Status Function

General Format

The general format of CTI command to retrieve account status is:

http://Phone-IP-Address/cgi-bin/api-get_accounts?passcode=PASSWORD

Example

In this example, the phone shows account 1’s basic SIP information and that account 1 is registered.

Make Call

General format

The general format of CTI command to initiate a call is:

http://Phone-IP-Address/cgi-bin/api-make_call?passcode=PASSWORD&phonenumber=NUMBER

Example

Request	http://192.168.5.135/cgi-bin/api-make_call?passcode=admin&phonenumber=3501
Response	{ “response”: “success”, “body”: true }

System Operations Functions

General Format

The general CTI command to send phone system operations is:

http://Phone-IP-Address/cgi-bin/api-sys_operation?passcode=PASSWORD&request=OPERATION

Examples

Operation	Function	Example
REBOOT	Reboot the phone	http://192.168.5.135/cgi-bin/api-sys_operation?passcode=admin&request=REBOOT
RESET	Reset the phone to default settings	http://192.168.5.135/cgi-bin/api-sys_operation?passcode=admin&request=RESET

Positive answer

If accepted, the command will be run instantly on the phone and below positive answer can be returned:

Reboot: {“response”:”success”, “body”: “savereboot”}

Reset: {“response”:”success”, “body”: “reset”}

Negative answer

If not accepted, the phone will not react to it and below negative answer can be returned:

{“response”:”error”, “body”: “unknown”}

Sending Keys Functions

General format

The general format of CTI command to send keys functions is:

http://Phone-IP-Address/cgi-bin/api-send_key?passcode=PASSWORD&keys=KEY

Examples

Positive answer

If accepted, the command will be run instantly on the phone, and the below positive answer can be returned:

{“response”:”success”, “body”: “complete”}

Negative answer

If not accepted, the phone will not react to it and the below negative answer can be returned:

{“response”:”error”, “body”: “unknown”}

SUPPORTED DEVICES

The following table shows Grandstream products supporting CTI commands:

---