Package com.bandwidth.sdk.model
Class AnswerCallback
java.lang.Object
com.bandwidth.sdk.model.AnswerCallback
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
comments="Generator version: 7.6.0")
public class AnswerCallback
extends Object
The Answer event is sent to the answerUrl specified in the createCall request when an outbound call is answered.
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionanswerTime
(OffsetDateTime answerTime) applicationId
(String applicationId) direction
(CallDirectionEnum direction) enqueuedTime
(OffsetDateTime enqueuedTime) boolean
eventTime
(OffsetDateTime eventTime) static AnswerCallback
Create an instance of AnswerCallback given an JSON stringThe user account associated with the call.Return the additional (undeclared) property.Return the additional (undeclared) property with the specified name.Time the call was answered, in ISO 8601 format.The id of the application associated with the call.The call id associated with the event.The URL of the call associated with the event.Get direction(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format.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.getFrom()
The provided identifier of the caller.Get machineDetectionResultTime the call was started, in ISO 8601 format.getTag()
(optional) The tag specified on call creation.getTo()
The phone number that received the call, in E.164 format (e.g.int
hashCode()
machineDetectionResult
(MachineDetectionResult machineDetectionResult) 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
void
setCallUrl
(String callUrl) void
setDirection
(CallDirectionEnum direction) void
setEnqueuedTime
(OffsetDateTime enqueuedTime) void
setEventTime
(OffsetDateTime eventTime) void
setEventType
(String eventType) void
void
setMachineDetectionResult
(MachineDetectionResult machineDetectionResult) void
setStartTime
(OffsetDateTime startTime) void
void
startTime
(OffsetDateTime startTime) toJson()
Convert an instance of AnswerCallback to an JSON stringtoString()
static void
validateJsonElement
(com.google.gson.JsonElement jsonElement) Validates the JSON Element and throws an exception if issues found
-
Field Details
-
SERIALIZED_NAME_EVENT_TYPE
- See Also:
-
SERIALIZED_NAME_EVENT_TIME
- See Also:
-
SERIALIZED_NAME_ACCOUNT_ID
- See Also:
-
SERIALIZED_NAME_APPLICATION_ID
- See Also:
-
SERIALIZED_NAME_FROM
- See Also:
-
SERIALIZED_NAME_TO
- See Also:
-
SERIALIZED_NAME_DIRECTION
- See Also:
-
SERIALIZED_NAME_CALL_ID
- See Also:
-
SERIALIZED_NAME_CALL_URL
- See Also:
-
SERIALIZED_NAME_ENQUEUED_TIME
- See Also:
-
SERIALIZED_NAME_START_TIME
- See Also:
-
SERIALIZED_NAME_ANSWER_TIME
- See Also:
-
SERIALIZED_NAME_TAG
- See Also:
-
SERIALIZED_NAME_MACHINE_DETECTION_RESULT
- See Also:
-
openapiFields
-
openapiRequiredFields
-
-
Constructor Details
-
AnswerCallback
public AnswerCallback()
-
-
Method Details
-
eventType
-
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
-
eventTime
-
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
-
accountId
-
getAccountId
The user account associated with the call.- Returns:
- accountId
-
setAccountId
-
applicationId
-
getApplicationId
The id of the application associated with the call.- Returns:
- applicationId
-
setApplicationId
-
from
-
getFrom
The provided identifier of the caller. Must be a phone number in E.164 format (e.g. +15555555555).- Returns:
- from
-
setFrom
-
to
-
getTo
The phone number that received the call, in E.164 format (e.g. +15555555555).- Returns:
- to
-
setTo
-
direction
-
getDirection
Get direction- Returns:
- direction
-
setDirection
-
callId
-
getCallId
The call id associated with the event.- Returns:
- callId
-
setCallId
-
callUrl
-
getCallUrl
The URL of the call associated with the event.- Returns:
- callUrl
-
setCallUrl
-
enqueuedTime
-
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
-
startTime
-
getStartTime
Time the call was started, in ISO 8601 format.- Returns:
- startTime
-
setStartTime
-
answerTime
-
getAnswerTime
Time the call was answered, in ISO 8601 format.- Returns:
- answerTime
-
setAnswerTime
-
tag
-
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
-
machineDetectionResult
-
getMachineDetectionResult
Get machineDetectionResult- Returns:
- machineDetectionResult
-
setMachineDetectionResult
-
putAdditionalProperty
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 propertyvalue
- value of the property- Returns:
- the AnswerCallback instance itself
-
getAdditionalProperties
Return the additional (undeclared) property.- Returns:
- a map of objects
-
getAdditionalProperty
Return the additional (undeclared) property with the specified name.- Parameters:
key
- name of the property- Returns:
- an object
-
equals
-
hashCode
public int hashCode() -
toString
-
validateJsonElement
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 AnswerCallback
-
fromJson
Create an instance of AnswerCallback given an JSON string- Parameters:
jsonString
- JSON string- Returns:
- An instance of AnswerCallback
- Throws:
IOException
- if the JSON string is invalid with respect to AnswerCallback
-
toJson
Convert an instance of AnswerCallback to an JSON string- Returns:
- JSON string
-