Package com.bandwidth.sdk.model

Class ConferenceMemberExitCallback

  • @Generated("org.openapitools.codegen.languages.JavaClientCodegen")
public class ConferenceMemberExitCallback
extends Object
    The Conference Member Exit event is fired whenever a caller exits a conference that specified a callbackUrl. The response may be either empty or a BXML document. Only the following verbs are valid for conferences: PlayAudio, SpeakSentence, StartRecording, StopRecording, PauseRecording, ResumeRecording. Audio verbs will be heard by all members of the conference. Recordings capture audio from all members who are not muted or on hold, as well as any audio verbs that are played into the conference.

    • Constructor Detail

      • ConferenceMemberExitCallback

        public ConferenceMemberExitCallback()

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

      • getConferenceId

        @Nullable
public String getConferenceId()
        The unique, Bandwidth-generated ID of the conference that was recorded
        Returns:
        conferenceId

      • setConferenceId

        public void setConferenceId​(String conferenceId)

      • getName

        @Nullable
public String getName()
        The user-specified name of the conference that was recorded
        Returns:
        name

      • setName

        public void setName​(String name)

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

      • getCallId

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

      • setCallId

        public void setCallId​(String callId)

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

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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