CallCreator (plivo-java 4.0.1 API)

java.lang.Object
- com.plivo.api.models.base.BaseRequest
- - com.plivo.api.models.base.Creator<CallCreateResponse>
  - - com.plivo.api.models.call.CallCreator

public class CallCreator
extends Creator<CallCreateResponse>

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`answerMethod()`
`CallCreator`	`answerMethod(java.lang.String answerMethod)`
`java.lang.String`	`answerUrl()`
`java.lang.String`	`callerName()`
`CallCreator`	`callerName(java.lang.String callerName)`
`java.lang.Boolean`	`errorIfParentNotFound()`
`CallCreator`	`errorIfParentNotFound(java.lang.Boolean errorIfParentNotFound)`
`java.lang.String`	`fallbackMethod()`
`CallCreator`	`fallbackMethod(java.lang.String fallbackMethod)`
`java.lang.String`	`fallbackUrl()`
`CallCreator`	`fallbackUrl(java.lang.String fallbackUrl)`
`java.lang.String`	`from()`
`java.lang.String`	`hangupMethod()`
`CallCreator`	`hangupMethod(java.lang.String hangupMethod)`
`java.lang.Long`	`hangupOnRing()`
`CallCreator`	`hangupOnRing(java.lang.Long hangupOnRing)`
`java.lang.String`	`hangupUrl()`
`CallCreator`	`hangupUrl(java.lang.String hangupUrl)`
`java.lang.String`	`machineDetection()` Used to detect if the call has been answered by a machine.
`CallCreator`	`machineDetection(java.lang.String machineDetection)`
`java.lang.String`	`machineDetectionMethod()`
`CallCreator`	`machineDetectionMethod(java.lang.String machineDetectionMethod)`
`java.lang.Long`	`machineDetectionTime()`
`CallCreator`	`machineDetectionTime(java.lang.Long machineDetectionTime)`
`java.lang.String`	`machineDetectionUrl()`
`CallCreator`	`machineDetectionUrl(java.lang.String machineDetectionUrl)`
`protected retrofit2.Call<CallCreateResponse>`	`obtainCall()`
`java.lang.String`	`parentCallUuid()`
`CallCreator`	`parentCallUuid(java.lang.String parentCallUuid)`
`java.lang.String`	`ringMethod()`
`CallCreator`	`ringMethod(java.lang.String ringMethod)`
`java.lang.Long`	`ringTimeout()`
`CallCreator`	`ringTimeout(java.lang.Long ringTimeout)`
`java.lang.String`	`ringUrl()`
`CallCreator`	`ringUrl(java.lang.String ringUrl)`
`java.lang.String`	`sendDigits()` Plivo plays DTMF tones when the call is answered.
`CallCreator`	`sendDigits(java.lang.String sendDigits)`
`java.lang.Boolean`	`sendOnPreanswer()`
`CallCreator`	`sendOnPreanswer(java.lang.Boolean sendOnPreanswer)`
`java.util.Map<java.lang.String,java.lang.String>`	`sipHeaders()`
`CallCreator`	`sipHeaders(java.util.Map<java.lang.String,java.lang.String> sipHeaders)`
`java.lang.Long`	`timeLimit()`
`CallCreator`	`timeLimit(java.lang.Long timeLimit)`
`java.util.List<java.lang.String>`	`to()`

Methods inherited from class com.plivo.api.models.base.Creator
create

Methods inherited from class com.plivo.api.models.base.BaseRequest
client, client, handleResponse, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - from
```
public java.lang.String from()
```
    Returns:
    
    The phone number to be used as the caller id (with the country code).
  - to
```
public java.util.List<java.lang.String> to()
```
    Returns:
    
    The regular number(s) or sip endpoint(s) to call. Regular number must be prefixed with country code but without the + sign).
  - answerUrl
```
public java.lang.String answerUrl()
```
    Returns:
    
    The URL invoked by Plivo when the outbound call is answered.
  - answerMethod
```
public java.lang.String answerMethod()
```
    Returns:
    
    The method used to call the answer_url. Defaults to POST.
  - ringUrl
```
public java.lang.String ringUrl()
```
    Returns:
    
    The URL that is notified by Plivo when the call is ringing. Defaults not set.
  - ringMethod
```
public java.lang.String ringMethod()
```
    Returns:
    
    The method used to call the ring_url. Defaults to POST.
  - hangupUrl
```
public java.lang.String hangupUrl()
```
    Returns:
    
    The URL that is notified by Plivo when the call hangs up. Defaults to answer_url.
  - hangupMethod
```
public java.lang.String hangupMethod()
```
    Returns:
    
    The method used to call the hangup_url. Defaults to POST.
  - fallbackUrl
```
public java.lang.String fallbackUrl()
```
    Returns:
    
    Invoked by Plivo only if answer_url is unavailable or the XML response is invalid. Should contain a XML response.
  - fallbackMethod
```
public java.lang.String fallbackMethod()
```
    Returns:
    
    The method used to call the fallback_url. Defaults to POST.
  - callerName
```
public java.lang.String callerName()
```
    Returns:
    
    Caller name to use with the call.
  - sendDigits
```
public java.lang.String sendDigits()
```
    Plivo plays DTMF tones when the call is answered. This is useful when dialing a phone number and an extension. Plivo will dial the number, and when the automated system picks up, sends the DTMF tones to connect to the extension. E.g. If you want to dial the 2410 extension after the call is connected, and you want to wait for a few seconds before sending the extension, add a few leading 'w' characters. Each 'w' character waits 0.5 second before sending a digit. Each 'W' character waits 1 second before sending a digit. You can also add the tone duration in ms by appending @duration after the string (default duration is 2000 ms). For example, 1w2w3@1000 See the DTMF API for additional information.
    
    Returns:
    
    DTMF tones to play
  - sendOnPreanswer
```
public java.lang.Boolean sendOnPreanswer()
```
    Returns:
    
    If set to true and send_digits is also set, digits are sent when the call is in preanswer state. Defaults to false.
  - timeLimit
```
public java.lang.Long timeLimit()
```
    Returns:
    
    Schedules the call for hangup at a specified time after the call is answered.
  - hangupOnRing
```
public java.lang.Long hangupOnRing()
```
    Returns:
    
    Schedules the call for hangup at a specified time after the call starts ringing.
  - machineDetection
```
public java.lang.String machineDetection()
```
    Used to detect if the call has been answered by a machine. The valid values are true and hangup. Default time to analyze is 5000 milliseconds (or 5 seconds). You can change it with the machine_detection_time parameter. Note that no XML is processed during the analysis phase. If a machine is detected during the call and machine_detection is set to true, the Machine parameter will be set to true and will be sent to the answer_url, hangup_url, or any other URL that is invoked by the call. If a machine is detected during the call and machine_detection is set to hangup, the call hangs up immediately and a request is made to the hangup_url with the Machine parameter set to true
  - machineDetectionTime
```
public java.lang.Long machineDetectionTime()
```
    Returns:
    
    Time allotted to analyze if the call has been answered by a machine.
  - machineDetectionUrl
```
public java.lang.String machineDetectionUrl()
```
    Returns:
    
    A URL where machine detection parameters will be sent by Plivo.
  - machineDetectionMethod
```
public java.lang.String machineDetectionMethod()
```
    Returns:
    
    The HTTP method which will be used by Plivo to request the machine_detection_url. Defaults to POST.
  - sipHeaders
```
public java.util.Map<java.lang.String,java.lang.String> sipHeaders()
```
    Returns:
    
    List of SIP headers in the form of 'key=value' pairs, separated by commas.
  - ringTimeout
```
public java.lang.Long ringTimeout()
```
    Returns:
    
    Determines the time in seconds the call should ring.
  - parentCallUuid
```
public java.lang.String parentCallUuid()
```
    Returns:
    
    The call_uuid of the first leg in an ongoing conference call.
  - errorIfParentNotFound
```
public java.lang.Boolean errorIfParentNotFound()
```
    Returns:
    
    If set to true and the parent_call_uuid cannot be found, the API request would return an error.
  - answerMethod
```
public CallCreator answerMethod(java.lang.String answerMethod)
```
  - ringUrl
```
public CallCreator ringUrl(java.lang.String ringUrl)
```
  - ringMethod
```
public CallCreator ringMethod(java.lang.String ringMethod)
```
  - hangupUrl
```
public CallCreator hangupUrl(java.lang.String hangupUrl)
```
  - hangupMethod
```
public CallCreator hangupMethod(java.lang.String hangupMethod)
```
  - fallbackUrl
```
public CallCreator fallbackUrl(java.lang.String fallbackUrl)
```
  - fallbackMethod
```
public CallCreator fallbackMethod(java.lang.String fallbackMethod)
```
  - callerName
```
public CallCreator callerName(java.lang.String callerName)
```
  - sendDigits
```
public CallCreator sendDigits(java.lang.String sendDigits)
```
  - sendOnPreanswer
```
public CallCreator sendOnPreanswer(java.lang.Boolean sendOnPreanswer)
```
  - timeLimit
```
public CallCreator timeLimit(java.lang.Long timeLimit)
```
  - hangupOnRing
```
public CallCreator hangupOnRing(java.lang.Long hangupOnRing)
```
  - machineDetection
```
public CallCreator machineDetection(java.lang.String machineDetection)
```
  - machineDetectionTime
```
public CallCreator machineDetectionTime(java.lang.Long machineDetectionTime)
```
  - machineDetectionUrl
```
public CallCreator machineDetectionUrl(java.lang.String machineDetectionUrl)
```
  - machineDetectionMethod
```
public CallCreator machineDetectionMethod(java.lang.String machineDetectionMethod)
```
  - sipHeaders
```
public CallCreator sipHeaders(java.util.Map<java.lang.String,java.lang.String> sipHeaders)
```
  - ringTimeout
```
public CallCreator ringTimeout(java.lang.Long ringTimeout)
```
  - parentCallUuid
```
public CallCreator parentCallUuid(java.lang.String parentCallUuid)
```
  - errorIfParentNotFound
```
public CallCreator errorIfParentNotFound(java.lang.Boolean errorIfParentNotFound)
```
  - obtainCall
```
protected retrofit2.Call<CallCreateResponse> obtainCall()
```
    Specified by:
    
    obtainCall in class Creator<CallCreateResponse>

Class CallCreator

Method Summary

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

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

Methods inherited from class java.lang.Object

Method Detail

from

to

answerUrl

answerMethod

ringUrl

ringMethod

hangupUrl

hangupMethod

fallbackUrl

fallbackMethod

callerName

sendDigits

sendOnPreanswer

timeLimit

hangupOnRing

machineDetection

machineDetectionTime

machineDetectionUrl

machineDetectionMethod

sipHeaders

ringTimeout

parentCallUuid

errorIfParentNotFound

answerMethod

ringUrl

ringMethod

hangupUrl

hangupMethod

fallbackUrl

fallbackMethod

callerName

sendDigits

sendOnPreanswer

timeLimit

hangupOnRing

machineDetection

machineDetectionTime

machineDetectionUrl

machineDetectionMethod

sipHeaders

ringTimeout

parentCallUuid

errorIfParentNotFound

obtainCall