Package com.bandwidth.sdk.model

Class MachineDetectionCompleteCallback

java.lang.Object

com.bandwidth.sdk.model.MachineDetectionCompleteCallback

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.10.0")
public class MachineDetectionCompleteCallback
extends Object

This event is sent to the url informed when requesting a machine detection operation. It contains the machine detection operation result, which can be: human, answering-machine, silence, timeout, error. This event is not sent when sync answering machine detection mode is chosen.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MachineDetectionCompleteCallback.CustomTypeAdapterFactory

Field Summary

Fields

Modifier and Type	Field	Description
static HashSet<String>	openapiFields
static HashSet<String>	openapiRequiredFields
static final String	SERIALIZED_NAME_ACCOUNT_ID
static final String	SERIALIZED_NAME_ANSWER_TIME
static final String	SERIALIZED_NAME_APPLICATION_ID
static final String	SERIALIZED_NAME_CALL_ID
static final String	SERIALIZED_NAME_CALL_URL
static final String	SERIALIZED_NAME_DIRECTION
static final String	SERIALIZED_NAME_ENQUEUED_TIME
static final String	SERIALIZED_NAME_EVENT_TIME
static final String	SERIALIZED_NAME_EVENT_TYPE
static final String	SERIALIZED_NAME_FROM
static final String	SERIALIZED_NAME_MACHINE_DETECTION_RESULT
static final String	SERIALIZED_NAME_START_TIME
static final String	SERIALIZED_NAME_TAG
static final String	SERIALIZED_NAME_TO

Constructor Summary

Constructors

Constructor	Description
MachineDetectionCompleteCallback()

Method Summary

Modifier and Type	Method	Description
MachineDetectionCompleteCallback	accountId(String accountId)
MachineDetectionCompleteCallback	answerTime(OffsetDateTime answerTime)
MachineDetectionCompleteCallback	applicationId(String applicationId)
MachineDetectionCompleteCallback	callId(String callId)
MachineDetectionCompleteCallback	callUrl(URI callUrl)
MachineDetectionCompleteCallback	direction(CallDirectionEnum direction)
MachineDetectionCompleteCallback	enqueuedTime(OffsetDateTime enqueuedTime)
boolean	equals(Object o)
MachineDetectionCompleteCallback	eventTime(OffsetDateTime eventTime)
MachineDetectionCompleteCallback	eventType(String eventType)
MachineDetectionCompleteCallback	from(String from)
static MachineDetectionCompleteCallback	fromJson(String jsonString)	Create an instance of MachineDetectionCompleteCallback given an JSON string
String	getAccountId()	The user account associated with the call.
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
OffsetDateTime	getAnswerTime()	Time the call was answered, in ISO 8601 format.
String	getApplicationId()	The id of the application associated with the call.
String	getCallId()	The call id associated with the event.
URI	getCallUrl()	The URL of the call associated with the event.
CallDirectionEnum	getDirection()	Get direction
OffsetDateTime	getEnqueuedTime()	(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.
OffsetDateTime	getEventTime()	The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format.
String	getEventType()	The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.
String	getFrom()	The provided identifier of the caller.
MachineDetectionResult	getMachineDetectionResult()	Get machineDetectionResult
OffsetDateTime	getStartTime()	Time the call was started, in ISO 8601 format.
String	getTag()	(optional) The tag specified on call creation.
String	getTo()	The phone number that received the call, in E.164 format (e.g.
int	hashCode()
MachineDetectionCompleteCallback	machineDetectionResult(MachineDetectionResult machineDetectionResult)
MachineDetectionCompleteCallback	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAccountId(String accountId)
void	setAnswerTime(OffsetDateTime answerTime)
void	setApplicationId(String applicationId)
void	setCallId(String callId)
void	setCallUrl(URI callUrl)
void	setDirection(CallDirectionEnum direction)
void	setEnqueuedTime(OffsetDateTime enqueuedTime)
void	setEventTime(OffsetDateTime eventTime)
void	setEventType(String eventType)
void	setFrom(String from)
void	setMachineDetectionResult(MachineDetectionResult machineDetectionResult)
void	setStartTime(OffsetDateTime startTime)
void	setTag(String tag)
void	setTo(String to)
MachineDetectionCompleteCallback	startTime(OffsetDateTime startTime)
MachineDetectionCompleteCallback	tag(String tag)
MachineDetectionCompleteCallback	to(String to)
String	toJson()	Convert an instance of MachineDetectionCompleteCallback to an JSON string
String	toString()
static void	validateJsonElement(com.google.gson.JsonElement jsonElement)	Validates the JSON Element and throws an exception if issues found

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_EVENT_TYPE

public static final String SERIALIZED_NAME_EVENT_TYPE

See Also:

• Constant Field Values

SERIALIZED_NAME_EVENT_TIME

public static final String SERIALIZED_NAME_EVENT_TIME

See Also:

• Constant Field Values

SERIALIZED_NAME_ACCOUNT_ID

public static final String SERIALIZED_NAME_ACCOUNT_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_APPLICATION_ID

public static final String SERIALIZED_NAME_APPLICATION_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_FROM

public static final String SERIALIZED_NAME_FROM

See Also:

• Constant Field Values

SERIALIZED_NAME_TO

public static final String SERIALIZED_NAME_TO

See Also:

• Constant Field Values

SERIALIZED_NAME_DIRECTION

public static final String SERIALIZED_NAME_DIRECTION

See Also:

• Constant Field Values

SERIALIZED_NAME_CALL_ID

public static final String SERIALIZED_NAME_CALL_ID

See Also:

• Constant Field Values

SERIALIZED_NAME_CALL_URL

public static final String SERIALIZED_NAME_CALL_URL

See Also:

• Constant Field Values

SERIALIZED_NAME_ENQUEUED_TIME

public static final String SERIALIZED_NAME_ENQUEUED_TIME

See Also:

• Constant Field Values

SERIALIZED_NAME_START_TIME

public static final String SERIALIZED_NAME_START_TIME

See Also:

• Constant Field Values

SERIALIZED_NAME_ANSWER_TIME

public static final String SERIALIZED_NAME_ANSWER_TIME

See Also:

• Constant Field Values

SERIALIZED_NAME_TAG

public static final String SERIALIZED_NAME_TAG

See Also:

• Constant Field Values

SERIALIZED_NAME_MACHINE_DETECTION_RESULT

public static final String SERIALIZED_NAME_MACHINE_DETECTION_RESULT

See Also:

• Constant Field Values

openapiFields

public static HashSet<String> openapiFields

openapiRequiredFields

public static HashSet<String> openapiRequiredFields

Constructor Details

MachineDetectionCompleteCallback

public MachineDetectionCompleteCallback()

Method Details

eventType

public MachineDetectionCompleteCallback eventType(@Nullable
 String eventType)

getEventType

@Nullable
public String getEventType()

The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect.

Returns:

eventType

setEventType

public void setEventType(@Nullable
 String eventType)

eventTime

public MachineDetectionCompleteCallback eventTime(@Nullable
 OffsetDateTime eventTime)

getEventTime

@Nullable
public OffsetDateTime getEventTime()

The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution.

Returns:

eventTime

setEventTime

public void setEventTime(@Nullable
 OffsetDateTime eventTime)

accountId

public MachineDetectionCompleteCallback accountId(@Nullable
 String accountId)

getAccountId

@Nullable
public String getAccountId()

The user account associated with the call.

Returns:

accountId

setAccountId

public void setAccountId(@Nullable
 String accountId)

applicationId

public MachineDetectionCompleteCallback applicationId(@Nullable
 String applicationId)

getApplicationId

@Nullable
public String getApplicationId()

The id of the application associated with the call.

Returns:

applicationId

setApplicationId

public void setApplicationId(@Nullable
 String applicationId)

from

public MachineDetectionCompleteCallback from(@Nullable
 String from)

getFrom

@Nullable
public String getFrom()

The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).

Returns:

from

setFrom

public void setFrom(@Nullable
 String from)

to

public MachineDetectionCompleteCallback to(@Nullable
 String to)

getTo

@Nullable
public String getTo()

The phone number that received the call, in E.164 format (e.g. +15555555555).

Returns:

to

setTo

public void setTo(@Nullable
 String to)

direction

public MachineDetectionCompleteCallback direction(@Nullable
 CallDirectionEnum direction)

getDirection

@Nullable
public CallDirectionEnum getDirection()

Get direction

Returns:

direction

setDirection

public void setDirection(@Nullable
 CallDirectionEnum direction)

callId

public MachineDetectionCompleteCallback callId(@Nullable
 String callId)

getCallId

@Nullable
public String getCallId()

The call id associated with the event.

Returns:

callId

setCallId

public void setCallId(@Nullable
 String callId)

callUrl

public MachineDetectionCompleteCallback callUrl(@Nullable
 URI callUrl)

getCallUrl

@Nullable
public URI getCallUrl()

The URL of the call associated with the event.

Returns:

callUrl

setCallUrl

public void setCallUrl(@Nullable
 URI callUrl)

enqueuedTime

public MachineDetectionCompleteCallback enqueuedTime(@Nullable
 OffsetDateTime enqueuedTime)

getEnqueuedTime

@Nullable
public OffsetDateTime getEnqueuedTime()

(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.

Returns:

enqueuedTime

setEnqueuedTime

public void setEnqueuedTime(@Nullable
 OffsetDateTime enqueuedTime)

startTime

public MachineDetectionCompleteCallback startTime(@Nullable
 OffsetDateTime startTime)

getStartTime

@Nullable
public OffsetDateTime getStartTime()

Time the call was started, in ISO 8601 format.

Returns:

startTime

setStartTime

public void setStartTime(@Nullable
 OffsetDateTime startTime)

answerTime

public MachineDetectionCompleteCallback answerTime(@Nullable
 OffsetDateTime answerTime)

getAnswerTime

@Nullable
public OffsetDateTime getAnswerTime()

Time the call was answered, in ISO 8601 format.

Returns:

answerTime

setAnswerTime

public void setAnswerTime(@Nullable
 OffsetDateTime answerTime)

tag

public MachineDetectionCompleteCallback tag(@Nullable
 String tag)

getTag

@Nullable
public String getTag()

(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.

Returns:

tag

setTag

public void setTag(@Nullable
 String tag)

machineDetectionResult

public MachineDetectionCompleteCallback machineDetectionResult(@Nullable
 MachineDetectionResult machineDetectionResult)

getMachineDetectionResult

@Nullable
public MachineDetectionResult getMachineDetectionResult()

Get machineDetectionResult

Returns:

machineDetectionResult

setMachineDetectionResult

public void setMachineDetectionResult(@Nullable
 MachineDetectionResult machineDetectionResult)

putAdditionalProperty

public MachineDetectionCompleteCallback putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - name of the property

value - value of the property

Returns:

the MachineDetectionCompleteCallback instance itself

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

a map of objects

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - name of the property

Returns:

an object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

validateJsonElement

public static void validateJsonElement(com.google.gson.JsonElement jsonElement)
                                throws IOException

Validates the JSON Element and throws an exception if issues found

Parameters:

jsonElement - JSON Element

Throws:

IOException - if the JSON Element is invalid with respect to MachineDetectionCompleteCallback

fromJson

public static MachineDetectionCompleteCallback fromJson(String jsonString)
                                                 throws IOException

Create an instance of MachineDetectionCompleteCallback given an JSON string

Parameters:

jsonString - JSON string

Returns:

An instance of MachineDetectionCompleteCallback

Throws:

IOException - if the JSON string is invalid with respect to MachineDetectionCompleteCallback

toJson

public String toJson()

Convert an instance of MachineDetectionCompleteCallback to an JSON string

Returns:

JSON string