CTI
From Taridium
(Difference between revisions)
(→CTI XML Format) |
(→CTI Control) |
||
| (16 intermediate revisions not shown) | |||
| Line 1: | Line 1: | ||
| - | This optional ipbx module is installed under '''Advanced Setup''' → '''Modules'''. Registered modules are displayed with '''registered module'''. The CTI module has been made available in ipbx 2.1 and higher versions. | + | This optional ipbx module is installed under '''Advanced Setup''' → '''Modules'''. Registered modules are displayed with '''registered module'''. The CTI module has been made available in ipbx 2.1 and higher versions and is a standard component of ipbx Elite. |
| - | ipbx's CTI module provides a standardized way to interact with incoming calls using external applications. Applications include web driven pop-up windows and call manipulation. | + | ipbx's CTI module provides a standardized way to interact with incoming calls using external applications. Applications include web driven pop-up windows and call manipulation. CTI interfaces use standard HTTP/S protocol and are completely language agnostic. |
CTI integration is available in two places | CTI integration is available in two places | ||
| - | # as CTI control, where calls coming | + | # as CTI control, where calls coming in/out will cause interaction with external web enabled applications. |
# as a means to pop-up an application page in the ipbx [[End User Panel]]. | # as a means to pop-up an application page in the ipbx [[End User Panel]]. | ||
| Line 13: | Line 13: | ||
The CTI configuration can be accessed '''Advanced Setup''' → '''CTI'''. | The CTI configuration can be accessed '''Advanced Setup''' → '''CTI'''. | ||
| + | |||
| + | === Inbound Pop-Up Configuration === | ||
| + | |||
Basic CTI configuration allows you to specify an URL which will be loaded into the End User Panel CTI window as soon as a call is routed to a user. | Basic CTI configuration allows you to specify an URL which will be loaded into the End User Panel CTI window as soon as a call is routed to a user. | ||
| Line 20: | Line 23: | ||
http://192.168.77.123/crm_app/?calleridnumber=%%calleridnumber%%&calleridname=%%calleridname%% | http://192.168.77.123/crm_app/?calleridnumber=%%calleridnumber%%&calleridname=%%calleridname%% | ||
| + | |||
| + | === General CTI Control === | ||
| + | |||
| + | Specifies URL's which will be called before any inbound and outbound calls respectively. | ||
| + | |||
| + | === Post Call CTI === | ||
| + | |||
| + | A URL which will be called after each call. This URL's reply will not be processed, but can be used to pass call detail records in the GET argument. The valid variables for the URL correspond to the [[CDR]] field names using the common ipbx variable format, e.g. %%accountcode%%. | ||
== CTI User Panel == | == CTI User Panel == | ||
| Line 29: | Line 40: | ||
== CTI Control == | == CTI Control == | ||
| - | The CTI control option is available in the [[IVR]], [[Groups]] and [[Queues]] applications. The CTI control options can be accessed in each of the application editors by clicking on '''CTI Control''' → '''configure options'''. | + | The CTI control option is available for inbound/outbound call control, in the [[IVR]], [[Groups]] and [[Queues]] applications, for inbound [[Routes|Routing]], for timeout functions and for call accounting (see Call Accounting Module). A CTI URL can also be called after every call, but does not provide any control options. The CTI control options can be accessed in each of the application editors by clicking on '''CTI Control''' → '''configure options'''. |
In it's simplest form the CTI control allows you to signal that a call was routed to an application, usually passing along some identifying information such as the caller ID. | In it's simplest form the CTI control allows you to signal that a call was routed to an application, usually passing along some identifying information such as the caller ID. | ||
| Line 38: | Line 49: | ||
http://192.168.77.123/myctitest.html?calleridnumber=%%calleridnumber%%&calleridname=%%calleridname%% | http://192.168.77.123/myctitest.html?calleridnumber=%%calleridnumber%%&calleridname=%%calleridname%% | ||
| - | In the above situation an incoming call would cause the URL to be called and the variables '''%%calleridnumber%%''' and '''%%calleridname%%''' to be replaced with the actual information. | + | In the above situation an incoming call would cause the URL to be called and the variables '''%%calleridnumber%%''' and '''%%calleridname%%''' to be replaced with the actual information. The default request timeout is 2 seconds. Both HTTP and HTTPS are supported. |
For a complete list of variables refer to [[CTI#CTI_URL_Variables|CTI URL variables]]. | For a complete list of variables refer to [[CTI#CTI_URL_Variables|CTI URL variables]]. | ||
| Line 63: | Line 74: | ||
</ipbx> | </ipbx> | ||
| - | The '''<set>''' tag can contain any of the following sub-tags: | + | The '''<set/>''' tag can contain any of the following sub-tags: |
| - | * <calleridname | + | * <calleridname/> sets the caller ID name for the call |
| - | * <calleridnumber | + | * <calleridnumber/> sets the caller ID number for the call |
| - | * <calleridani | + | * <calleridani/> sets the ANI for the call |
| - | * <accountcode | + | * <accountcode/> sets the accountcode for the call |
| - | * <userfield | + | * <userfield/> sets the userfield for the call |
| - | * <acc_code1 | + | * <acc_code1/> sets an additional account code in the accounting table |
| - | * <acc_code2 | + | * <acc_code2/> sets an additional account code in the accounting table |
| - | * <acc_code3 | + | * <acc_code3/> sets an additional account code in the accounting table |
| - | * <record | + | * <record/> 0 or not set, yes(1) whether to record the call, using '''no''' will disable any systemwide recordings |
'''Example Code 2''' | '''Example Code 2''' | ||
| Line 86: | Line 97: | ||
<type>extension</type> | <type>extension</type> | ||
<name>18005554444</name> | <name>18005554444</name> | ||
| - | + | <break>0</break> | |
| + | </route> | ||
</call> | </call> | ||
</cti> | </cti> | ||
</ipbx> | </ipbx> | ||
| - | The '''<type>''' tag can contain any of the following keywords: | + | The '''<type/>''' tag can contain any of the following keywords: |
* extension | * extension | ||
| Line 103: | Line 115: | ||
* user | * user | ||
| - | The '''<name>''' tag must contain a valid application/function name. | + | The '''<name/>''' tag must contain a valid application/function name. Use a function instead of an extension whenever possible. |
| + | |||
| + | The '''<break/>''' tag is boolean, 0 or 1 and indicated whether to break execution after CTI processing has been completed. | ||
== CTI URL Variables == | == CTI URL Variables == | ||
| Line 116: | Line 130: | ||
* '''%%channel%%''' The channel, if available | * '''%%channel%%''' The channel, if available | ||
* '''%%exten%%''' The called extension | * '''%%exten%%''' The called extension | ||
| + | * '''%%acc_code[1-3]%%''' an additional account code | ||
