|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AgiRequest
Provides client request information to an AgiScript
.
This includes information about the channel the script is invoked on and parameters passed from the dialplan.
Method Summary | |
---|---|
java.lang.String |
getAccountCode()
Returns the account code set for the call. |
java.lang.String[] |
getArguments()
Returns the array of arguments passed from the AGI dialplan command. |
java.lang.String |
getCallerId()
Deprecated. as of 0.3, use getCallerIdNumber() instead. |
java.lang.String |
getCallerIdName()
Returns the the Caller*ID Name, for example "John Doe". |
java.lang.String |
getCallerIdNumber()
Returns the Caller*ID number, for example "1234". |
java.lang.Integer |
getCallingAni2()
Returns the Callerid ANI 2 (Info digits). |
java.lang.Integer |
getCallingPres()
Returns the Callerid presentation/screening. |
java.lang.Integer |
getCallingTns()
Returns the Callerid Transit Network Select. |
java.lang.Integer |
getCallingTon()
Returns the Callerid Type of Number. |
java.lang.String |
getChannel()
Returns the name of the channel. |
java.lang.String |
getContext()
Returns the context in the dial plan from which the AGI script was called. |
java.lang.String |
getDnid()
Returns the number, that has been dialed by the user. |
java.lang.Boolean |
getEnhanced()
Returns wheather this agi is passed audio (EAGI - Enhanced AGI). |
java.lang.String |
getExtension()
Returns the extension in the dial plan from which the AGI script was called. |
java.lang.String |
getLanguage()
Returns the language set for the current channel, for example "en". |
java.net.InetAddress |
getLocalAddress()
Returns the local address this channel, that is the IP address of the AGI server. |
int |
getLocalPort()
Returns the local port of this channel, that is the port the AGI server is listening on. |
java.lang.String |
getParameter(java.lang.String name)
Returns the value of a request parameter as a String, or null if the parameter does not exist. |
java.util.Map<java.lang.String,java.lang.String[]> |
getParameterMap()
Returns a Map of the parameters of this request. |
java.lang.String[] |
getParameterValues(java.lang.String name)
Returns an array of String objects containing all of the values the given request parameter has, or an empty array if the parameter does not exist. |
java.lang.Integer |
getPriority()
Returns the priority of the dial plan entry the AGI script was called from. |
java.lang.String |
getRdnis()
If this call has been forwared, the number of the person doing the redirect is returned (Redirected dialed number identification service). |
java.net.InetAddress |
getRemoteAddress()
Returns the remote address of this channel, that is the IP address of the Asterisk server. |
int |
getRemotePort()
Returns the remote port of this channel, that is the client port the Asterisk server is using for the AGI connection. |
java.util.Map |
getRequest()
Returns a Map containing the raw request name/value pairs. |
java.lang.String |
getRequestURL()
Returns the full URL of the requestURL in the form agi://host[:port][/script][?param1=value1¶m2=value2]. |
java.lang.String |
getScript()
Returns the name of the script to execute including its full path. |
java.lang.String |
getType()
Returns the type of the channel, for example "SIP". |
java.lang.String |
getUniqueId()
Returns the unqiue id of the channel. |
Method Detail |
---|
java.util.Map getRequest()
java.lang.String getScript()
This corresponds to the request url with protocol, host, port and parameters stripped off.
As Async AGI does not yet pass a script parameter this property will
be null
for requests received through Async AGI.
java.lang.String getRequestURL()
java.lang.String getChannel()
java.lang.String getUniqueId()
java.lang.String getType()
java.lang.String getLanguage()
java.lang.String getCallerId()
getCallerIdNumber()
instead.
Note: even with Asterisk 1.0 is contains only the numerical part of the Caller ID.
null
is returned.java.lang.String getCallerIdNumber()
Note: even with Asterisk 1.0 is contains only the numerical part of the Caller ID.
null
is returned.java.lang.String getCallerIdName()
null
is returned.java.lang.String getDnid()
null
is returned.java.lang.String getRdnis()
This is usally only only available on PRI.
null
is returned.java.lang.String getContext()
java.lang.String getExtension()
java.lang.Integer getPriority()
java.lang.Boolean getEnhanced()
Enhanced AGI is currently not supported on FastAGI.
java.lang.String getAccountCode()
java.lang.Integer getCallingPres()
Available since Asterisk 1.2.
java.lang.Integer getCallingAni2()
Available since Asterisk 1.2.
java.lang.Integer getCallingTon()
Available since Asterisk 1.2.
java.lang.Integer getCallingTns()
Available since Asterisk 1.2.
java.lang.String getParameter(java.lang.String name)
null
if the parameter does not exist. You should only use
this method when you are sure the parameter has only one value.
If the parameter might have more than one value, use
getParameterValues(String)
.
If you use this method with a multivalued parameter, the value returned
is equal to the first value in the array returned by
getParameterValues
.
name
- a String containing the name of the parameter whose value is
requested.
getParameterValues(String)
java.lang.String[] getParameterValues(java.lang.String name)
If the parameter has a single value, the array has a length of 1.
name
- a String containing the name of the parameter whose value is requested.
java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
java.lang.String[] getArguments()
Example: AGI(agi://localhost/HelloWorld,value1,,value2)
results in
getArguments()[0] = "value1"
, getArguments()[1] = null
and getArguments()[2] = "value2"
.
Available since Asterisk 1.6
null
.java.net.InetAddress getLocalAddress()
int getLocalPort()
java.net.InetAddress getRemoteAddress()
int getRemotePort()
|
Asterisk-Java | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |