com.plivo.api.models.application

Class Application

java.lang.Object

com.plivo.api.models.base.BaseResource

com.plivo.api.models.application.Application

public class Application
extends BaseResource

Field Summary

Fields inherited from class com.plivo.api.models.base.BaseResource

plivoClient

Constructor Summary

Constructors

Constructor and Description
Application()

Method Summary

Modifier and Type	Method and Description
static ApplicationCreator	creator(java.lang.String appName)
ApplicationDeleter	deleter()
static ApplicationDeleter	deleter(java.lang.String id)
java.lang.String	getAnswerMethod()
java.lang.String	getAnswerUrl()
java.lang.String	getAppId()
java.lang.String	getAppName()
java.lang.Boolean	getDefaultApp()
java.lang.Boolean	getDefaultEndpointApp()
java.lang.Boolean	getEnabled()
java.lang.String	getFallbackAnswerUrl()
java.lang.String	getFallbackMethod()
java.lang.String	getHangupMethod()
java.lang.String	getHangupUrl()
java.lang.String	getId()
java.lang.String	getMessageMethod()
java.lang.String	getMessageUrl()
java.lang.Boolean	getPublicUri()
java.lang.String	getResourceUri()
java.lang.String	getSipUri()
java.lang.String	getSubAccount()
static ApplicationGetter	getter(java.lang.String id)
static ApplicationLister	lister()
ApplicationUpdater	updater()
static ApplicationUpdater	updater(java.lang.String id)

Methods inherited from class com.plivo.api.models.base.BaseResource

getApiId, getPlivoClient, setPlivoClient, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Application

public Application()

Method Detail

creator

public static ApplicationCreator creator(java.lang.String appName)

updater

public static ApplicationUpdater updater(java.lang.String id)

getter

public static ApplicationGetter getter(java.lang.String id)

deleter

public static ApplicationDeleter deleter(java.lang.String id)

lister

public static ApplicationLister lister()

getDefaultEndpointApp

public java.lang.Boolean getDefaultEndpointApp()

getAnswerUrl

public java.lang.String getAnswerUrl()

Returns:

The url returning Plivo XML to be requested when a call is answered.

getAnswerMethod

public java.lang.String getAnswerMethod()

Returns:

The HTTP method which will be used to request the answer_url when an incoming call is answered on the number or the endpoint attached to the application.

getAppId

public java.lang.String getAppId()

getAppName

public java.lang.String getAppName()

Returns:

A friendly name for your Plivo application.

getDefaultApp

public java.lang.Boolean getDefaultApp()

Returns:

Default app.

getEnabled

public java.lang.Boolean getEnabled()

Returns:

Set to true if the application is enabled.

getFallbackAnswerUrl

public java.lang.String getFallbackAnswerUrl()

Returns:

Plivo will request this URL with the same parameters sent to the answer_url if the answer_url returns a non 200 HTTP status code.

getFallbackMethod

public java.lang.String getFallbackMethod()

Returns:

The HTTP method which will be used to request the fallback_answer_url when the answer_url returns a non 200 HTTP status code.

getHangupUrl

public java.lang.String getHangupUrl()

Returns:

When the incoming call is hung up on a number or an endpoint attached to the application, Plivo will send a request to the hangup_url with the attributes of the call.

getHangupMethod

public java.lang.String getHangupMethod()

Returns:

The HTTP method which will be used to request the hangup_url when an incoming call is hung up on the number or the endpoint attached to the application.

getMessageMethod

public java.lang.String getMessageMethod()

Returns:

The HTTP method which will be used to request the message_url when an incoming message (SMS) is received on the number attached to the application

getMessageUrl

public java.lang.String getMessageUrl()

Returns:

When an incoming message (SMS) is received to a number attached to the application, Plivo will make a request to the message_url with the parameters documented here.

getPublicUri

public java.lang.Boolean getPublicUri()

Returns:

Set to true is the application can be called from an external SIP service. By default the application is not public, and external SIP services cannot call your application SIP URI.

getResourceUri

public java.lang.String getResourceUri()

getSipUri

public java.lang.String getSipUri()

Returns:

The SIP URI of the application. All Plivo applications can be called directly without attaching them to a number or an endpoint. When an incoming call is received on this URI, Plivo will follow the same flow as it does with a number or an endpoint.

getSubAccount

public java.lang.String getSubAccount()

Returns:

The subaccount associated with the application. If the application belongs to the main account, this field will be null.

updater

public ApplicationUpdater updater()

deleter

public ApplicationDeleter deleter()

getId

public java.lang.String getId()

Specified by:

getId in class BaseResource