com.telapi.api.domain
Class Call

java.lang.Object
  com.telapi.api.domain.BaseTelapiObject
      com.telapi.api.domain.Call

public class Call
extends BaseTelapiObject

A call resource provides information about an individual call that has occurred through TelAPI. Both inbound and outbound voice communication through TelAPI are categorized as calls.

Constructor Summary

Call()

Method Summary

AnsweredBy	getAnsweredBy()
Boolean	getCallerIdBlocked()
String	getCallerName()
CallSubresourceUris	getCallSubresourceUris()
SmsDirection	getDirection()
Long	getDuration()
Date	getEndTime()
String	getForwardedFrom()
String	getFrom()
String	getParentCallSid()
String	getPhoneNumberSid()
BigDecimal	getPrice()
Boolean	getPrivacyHideNumber()
String	getSipPrivacy()
Date	getStartTime()
CallStatus	getStatus()
String	getTo()
void	setAnsweredBy(AnsweredBy answeredBy)
void	setCallerIdBlocked(Boolean callerIdBlocked)
void	setCallerName(String callerName)
void	setCallSubresourceUris(CallSubresourceUris subresourceUris)
void	setDirection(SmsDirection direction)
void	setDuration(Long duration)
void	setEndTime(Date endTime)
void	setForwardedFrom(String forwardedFrom)
void	setFrom(String from)
void	setParentCallSid(String parentCallSid)
void	setPhoneNumberSid(String phoneNumberSid)
void	setPrice(BigDecimal price)
void	setPrivacyHideNumber(Boolean privacyHideNumber)
void	setSipPrivacy(String sipPrivacy)
void	setStartTime(Date startTime)
void	setStatus(CallStatus status)
void	setTo(String to)

Methods inherited from class com.telapi.api.domain.BaseTelapiObject

getAccountSid, getApiVersion, getDateCreated, getDateUpdated, getSid, getUri, setAccountSid, setApiVersion, setDateCreated, setDateUpdated, setSid, setUri

Methods inherited from class java.lang.Object

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

Constructor Detail

Call

public Call()

Method Detail

getParentCallSid

public String getParentCallSid()

Returns:

If the call was created during a different call using InboundXML, this is the sid of that initiating call.

setParentCallSid

public void setParentCallSid(String parentCallSid)

getTo

public String getTo()

Returns:

The number that was called.

setTo

public void setTo(String to)

getFrom

public String getFrom()

Returns:

The number that initiated the call.

setFrom

public void setFrom(String from)

getPhoneNumberSid

public String getPhoneNumberSid()

Returns:

The sid of the TelAPI number calling, or being called. If no TelAPI phone number is involved in the call, this property is empty.

setPhoneNumberSid

public void setPhoneNumberSid(String phoneNumberSid)

getStatus

public CallStatus getStatus()

Returns:

The status of the call: queued, ringing, in-progress, completed, failed, busy, no-answer.

setStatus

public void setStatus(CallStatus status)

getStartTime

public Date getStartTime()

Returns:

The date the call started.

setStartTime

public void setStartTime(Date startTime)

getEndTime

public Date getEndTime()

Returns:

The date the call ended.

setEndTime

public void setEndTime(Date endTime)

getDuration

public Long getDuration()

Returns:

The length of the call in seconds.

setDuration

public void setDuration(Long duration)

getPrice

public BigDecimal getPrice()

Returns:

The cost of the call, if availible.

setPrice

public void setPrice(BigDecimal price)

getDirection

public SmsDirection getDirection()

Returns:

The direction of the call from the perspective of TelAPI. Inbound for calls to TelAPI, outbound-api for calls from the TelAPI via REST request or outbound-dial for calls from TelAPI via InboundXML.

setDirection

public void setDirection(SmsDirection direction)

getAnsweredBy

public AnsweredBy getAnsweredBy()

Returns:

If the initiated call has answering machine detection, this specifies whether the machine answered. Can be human or machine.

setAnsweredBy

public void setAnsweredBy(AnsweredBy answeredBy)

getForwardedFrom

public String getForwardedFrom()

Returns:

The number that forwared the call, if any.

setForwardedFrom

public void setForwardedFrom(String forwardedFrom)

getSipPrivacy

public String getSipPrivacy()

Returns:

setSipPrivacy

public void setSipPrivacy(String sipPrivacy)

getPrivacyHideNumber

public Boolean getPrivacyHideNumber()

Returns:

setPrivacyHideNumber

public void setPrivacyHideNumber(Boolean privacyHideNumber)

getCallerIdBlocked

public Boolean getCallerIdBlocked()

Returns:

Specifies whether the caller ID of the inbound phone number was blocked.

setCallerIdBlocked

public void setCallerIdBlocked(Boolean callerIdBlocked)

getCallSubresourceUris

public CallSubresourceUris getCallSubresourceUris()

Returns:

List of a calls various subresources and their URI path. Examples of call subresources are notifications, recordings, etc.

setCallSubresourceUris

public void setCallSubresourceUris(CallSubresourceUris subresourceUris)

getCallerName

public String getCallerName()

setCallerName

public void setCallerName(String callerName)