Package org.openapitools.client.model
Class TransferAnswerCallback
- java.lang.Object
-
- org.openapitools.client.model.TransferAnswerCallback
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-02-21T09:43:53.001100-05:00[America/New_York]") public class TransferAnswerCallback extends Object
When processing a <Transfer> verb, this event is sent when a called party (B-leg) answers. The event is sent to the endpoint specified in the transferAnswerUrl attribute of the <PhoneNumber> tag that answered. BXML returned by this callback will be executed for the called party only. After all BXML has been executed, the called party will be bridged to the original call. Most BXML verbs are allowed in response to a transferAnswer event, but some are not allowed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TransferAnswerCallback.CustomTypeAdapterFactory
-
Field Summary
Fields Modifier and Type Field Description static HashSet<String>
openapiFields
static HashSet<String>
openapiRequiredFields
static String
SERIALIZED_NAME_ACCOUNT_ID
static String
SERIALIZED_NAME_ANSWER_TIME
static String
SERIALIZED_NAME_APPLICATION_ID
static String
SERIALIZED_NAME_CALL_ID
static String
SERIALIZED_NAME_CALL_URL
static String
SERIALIZED_NAME_DIRECTION
static String
SERIALIZED_NAME_ENQUEUED_TIME
static String
SERIALIZED_NAME_EVENT_TIME
static String
SERIALIZED_NAME_EVENT_TYPE
static String
SERIALIZED_NAME_FROM
static String
SERIALIZED_NAME_START_TIME
static String
SERIALIZED_NAME_TAG
static String
SERIALIZED_NAME_TO
static String
SERIALIZED_NAME_TRANSFER_CALLER_ID
static String
SERIALIZED_NAME_TRANSFER_TO
-
Constructor Summary
Constructors Constructor Description TransferAnswerCallback()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TransferAnswerCallback
accountId(String accountId)
TransferAnswerCallback
answerTime(OffsetDateTime answerTime)
TransferAnswerCallback
applicationId(String applicationId)
TransferAnswerCallback
callId(String callId)
TransferAnswerCallback
callUrl(String callUrl)
TransferAnswerCallback
direction(CallDirectionEnum direction)
TransferAnswerCallback
enqueuedTime(OffsetDateTime enqueuedTime)
boolean
equals(Object o)
TransferAnswerCallback
eventTime(String eventTime)
TransferAnswerCallback
eventType(String eventType)
TransferAnswerCallback
from(String from)
static TransferAnswerCallback
fromJson(String jsonString)
Create an instance of TransferAnswerCallback given an JSON stringString
getAccountId()
The user account associated with the call.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.String
getCallUrl()
The URL of the call associated with the event.CallDirectionEnum
getDirection()
Get directionOffsetDateTime
getEnqueuedTime()
(optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format.String
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: can be a phone number in E.164 format (e.g.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.String
getTransferCallerId()
The phone number used as the from field of the B-leg call, in E.164 format (e.g.String
getTransferTo()
The phone number used as the to field of the B-leg call, in E.164 format (e.g.int
hashCode()
void
setAccountId(String accountId)
void
setAnswerTime(OffsetDateTime answerTime)
void
setApplicationId(String applicationId)
void
setCallId(String callId)
void
setCallUrl(String callUrl)
void
setDirection(CallDirectionEnum direction)
void
setEnqueuedTime(OffsetDateTime enqueuedTime)
void
setEventTime(String eventTime)
void
setEventType(String eventType)
void
setFrom(String from)
void
setStartTime(OffsetDateTime startTime)
void
setTag(String tag)
void
setTo(String to)
void
setTransferCallerId(String transferCallerId)
void
setTransferTo(String transferTo)
TransferAnswerCallback
startTime(OffsetDateTime startTime)
TransferAnswerCallback
tag(String tag)
TransferAnswerCallback
to(String to)
String
toJson()
Convert an instance of TransferAnswerCallback to an JSON stringString
toString()
TransferAnswerCallback
transferCallerId(String transferCallerId)
TransferAnswerCallback
transferTo(String transferTo)
static void
validateJsonObject(com.google.gson.JsonObject jsonObj)
Validates the JSON Object and throws an exception if issues found
-
-
-
Field Detail
-
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_TRANSFER_CALLER_ID
public static final String SERIALIZED_NAME_TRANSFER_CALLER_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TRANSFER_TO
public static final String SERIALIZED_NAME_TRANSFER_TO
- See Also:
- Constant Field Values
-
-
Method Detail
-
eventType
public TransferAnswerCallback eventType(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(String eventType)
-
eventTime
public TransferAnswerCallback eventTime(String eventTime)
-
getEventTime
@Nullable public String 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(String eventTime)
-
accountId
public TransferAnswerCallback accountId(String accountId)
-
getAccountId
@Nullable public String getAccountId()
The user account associated with the call.- Returns:
- accountId
-
setAccountId
public void setAccountId(String accountId)
-
applicationId
public TransferAnswerCallback applicationId(String applicationId)
-
getApplicationId
@Nullable public String getApplicationId()
The id of the application associated with the call.- Returns:
- applicationId
-
setApplicationId
public void setApplicationId(String applicationId)
-
from
public TransferAnswerCallback from(String from)
-
getFrom
@Nullable public String getFrom()
The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous.- Returns:
- from
-
setFrom
public void setFrom(String from)
-
to
public TransferAnswerCallback to(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(String to)
-
direction
public TransferAnswerCallback direction(CallDirectionEnum direction)
-
getDirection
@Nullable public CallDirectionEnum getDirection()
Get direction- Returns:
- direction
-
setDirection
public void setDirection(CallDirectionEnum direction)
-
callId
public TransferAnswerCallback callId(String callId)
-
getCallId
@Nullable public String getCallId()
The call id associated with the event.- Returns:
- callId
-
setCallId
public void setCallId(String callId)
-
callUrl
public TransferAnswerCallback callUrl(String callUrl)
-
getCallUrl
@Nullable public String getCallUrl()
The URL of the call associated with the event.- Returns:
- callUrl
-
setCallUrl
public void setCallUrl(String callUrl)
-
enqueuedTime
public TransferAnswerCallback enqueuedTime(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(OffsetDateTime enqueuedTime)
-
startTime
public TransferAnswerCallback startTime(OffsetDateTime startTime)
-
getStartTime
@Nullable public OffsetDateTime getStartTime()
Time the call was started, in ISO 8601 format.- Returns:
- startTime
-
setStartTime
public void setStartTime(OffsetDateTime startTime)
-
answerTime
public TransferAnswerCallback answerTime(OffsetDateTime answerTime)
-
getAnswerTime
@Nullable public OffsetDateTime getAnswerTime()
Time the call was answered, in ISO 8601 format.- Returns:
- answerTime
-
setAnswerTime
public void setAnswerTime(OffsetDateTime answerTime)
-
tag
public TransferAnswerCallback tag(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(String tag)
-
transferCallerId
public TransferAnswerCallback transferCallerId(String transferCallerId)
-
getTransferCallerId
@Nullable public String getTransferCallerId()
The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable.- Returns:
- transferCallerId
-
setTransferCallerId
public void setTransferCallerId(String transferCallerId)
-
transferTo
public TransferAnswerCallback transferTo(String transferTo)
-
getTransferTo
@Nullable public String getTransferTo()
The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555).- Returns:
- transferTo
-
setTransferTo
public void setTransferTo(String transferTo)
-
validateJsonObject
public static void validateJsonObject(com.google.gson.JsonObject jsonObj) throws IOException
Validates the JSON Object and throws an exception if issues found- Parameters:
jsonObj
- JSON Object- Throws:
IOException
- if the JSON Object is invalid with respect to TransferAnswerCallback
-
fromJson
public static TransferAnswerCallback fromJson(String jsonString) throws IOException
Create an instance of TransferAnswerCallback given an JSON string- Parameters:
jsonString
- JSON string- Returns:
- An instance of TransferAnswerCallback
- Throws:
IOException
- if the JSON string is invalid with respect to TransferAnswerCallback
-
toJson
public String toJson()
Convert an instance of TransferAnswerCallback to an JSON string- Returns:
- JSON string
-
-