Package com.bandwidth.sdk.model

Class TransferAnswerCallback

java.lang.Object
com.bandwidth.sdk.model.TransferAnswerCallback
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.6.0") 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.

  • Field Details

  • Constructor Details

    • TransferAnswerCallback

      public TransferAnswerCallback()

  • Method Details

    • 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(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(OffsetDateTime 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. Must be a phone number in E.164 format (e.g. +15555555555).
      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).
      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)

    • putAdditionalProperty

      public TransferAnswerCallback 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 TransferAnswerCallback 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 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