Package com.bandwidth.sdk.model

Class TransferCompleteCallback

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class TransferCompleteCallback
extends Object
    This event is sent to the transferCompleteUrl of the A-leg's <Transfer> verb when the transferred call (B-leg) completes. In a simultaneous ringing scenario, only one B-leg succeeds and this event corresponds to that successful leg. If none of the calls were answered, the transferComplete event corresponds to one of the legs.

    • Constructor Detail

      • TransferCompleteCallback

        public TransferCompleteCallback()

    • Method Detail

      • 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)

      • 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)

      • getAccountId

        @Nullable
public String getAccountId()
        The user account associated with the call.
        Returns:
        accountId

      • setAccountId

        public void setAccountId​(String accountId)

      • getApplicationId

        @Nullable
public String getApplicationId()
        The id of the application associated with the call.
        Returns:
        applicationId

      • setApplicationId

        public void setApplicationId​(String applicationId)

      • 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)

      • 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)

      • getDirection

        @Nullable
public CallDirectionEnum getDirection()
        Get direction
        Returns:
        direction

      • getCallId

        @Nullable
public String getCallId()
        The call id associated with the event.
        Returns:
        callId

      • setCallId

        public void setCallId​(String callId)

      • getCallUrl

        @Nullable
public String getCallUrl()
        The URL of the call associated with the event.
        Returns:
        callUrl

      • setCallUrl

        public void setCallUrl​(String callUrl)

      • 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)

      • getStartTime

        @Nullable
public OffsetDateTime getStartTime()
        Time the call was started, in ISO 8601 format.
        Returns:
        startTime

      • setStartTime

        public void setStartTime​(OffsetDateTime startTime)

      • getAnswerTime

        @Nullable
public OffsetDateTime getAnswerTime()
        Time the call was answered, in ISO 8601 format.
        Returns:
        answerTime

      • setAnswerTime

        public void setAnswerTime​(OffsetDateTime answerTime)

      • 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)

      • 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)

      • 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)

      • getCause

        @Nullable
public String getCause()
        Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown.
        Returns:
        cause

      • setCause

        public void setCause​(String cause)

      • getErrorMessage

        @Nullable
public String getErrorMessage()
        Text explaining the reason that caused the call to fail in case of errors.
        Returns:
        errorMessage

      • setErrorMessage

        public void setErrorMessage​(String errorMessage)

      • getErrorId

        @Nullable
public String getErrorId()
        Bandwidth's internal id that references the error event.
        Returns:
        errorId

      • setErrorId

        public void setErrorId​(String errorId)

      • putAdditionalProperty

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

      • hashCode

        public int hashCode()
        Overrides:
        hashCode 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 TransferCompleteCallback

      • fromJson

        public static TransferCompleteCallback fromJson​(String jsonString)
                                         throws IOException
        Create an instance of TransferCompleteCallback given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of TransferCompleteCallback
        Throws:
        IOException - if the JSON string is invalid with respect to TransferCompleteCallback

      • toJson

        public String toJson()
        Convert an instance of TransferCompleteCallback to an JSON string
        Returns:
        JSON string