com.bandwidth.sdk.model.bxml.Forward Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bandwidth-sdk Show documentation
The official client SDK for Bandwidth's Voice, Messaging, MFA, and WebRTC APIs
There is a newer version: 13.1.3
/**
 * The {@code } verb is used to forward an unanswered incoming call to another number. Unlike {@code }, once your call is forwarded,
 * your application will not have any control over either leg of the call. When either leg hangs up, a Disconnect event will be sent to your Call status webhook URL.
 */

package com.bandwidth.sdk.model.bxml;

import static com.bandwidth.sdk.model.bxml.utils.BxmlConstants.DEFAULT_CALL_TIMEOUT;

import com.bandwidth.sdk.model.DiversionReason;
import com.bandwidth.sdk.model.DiversionTreatment;
import jakarta.xml.bind.annotation.XmlAccessType;
import jakarta.xml.bind.annotation.XmlAccessorType;
import jakarta.xml.bind.annotation.XmlAttribute;
import jakarta.xml.bind.annotation.XmlType;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NoArgsConstructor;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = Forward.TYPE_NAME)
@NoArgsConstructor
@AllArgsConstructor
@Builder
@Getter
@EqualsAndHashCode
/**
 *
 * @param to (str): The phone number destination of the call.
 * @param from_ (str, optional): The phone number that the recipient will receive the call from.
 * @param callTimeout (str, optional): The number of seconds to wait before timing out the call.
 * @param diversionTreatment (str, optional): Can be any of the following:
 *     none: No diversion headers are sent on the outbound leg of the transferred call.
 *     propagate: Copy the Diversion header from the inbound leg to the outbound leg. Ignored if there is no Diversion header present on the inbound leg.
 *     stack: After propagating any Diversion header from the inbound leg to the outbound leg, stack on top another Diversion header based on the Request-URI of the inbound call.
 *     Defaults to none. If diversionTreatment is not specified, no diversion header will be included for the transfer even if one came with the inbound call. Defaults to None.
 * @param diversionReason (str, optional): Can be any of the following values:
 *     unknown
 *     user-busy
 *     no-answer
 *     unavailable
 *     unconditional
 *     time-of-day
 *     do-not-disturb
 *     deflection
 *     follow-me
 *     out-of-service
 *     away
 *     This parameter is considered only when diversionTreatment is set to stack. Defaults is unknown.
 *     Defaults to None.
 * @param uui (str, optional): The value of the User-To-User header to send within the outbound INVITE when forwarding to a SIP URI.
 *     Must include the encoding parameter as specified in RFC 7433. Only base64 and jwt encoding are currently allowed.
 *     This value, including the encoding specifier, may not exceed 256 characters.
 */
public class Forward implements Verb {

    public static final String TYPE_NAME = "Forward";

    @XmlAttribute
    private String to;

    @XmlAttribute
    private String from;

    @XmlAttribute
    private String uui;

    @XmlAttribute
    @Builder.Default
    private Double callTimeout = DEFAULT_CALL_TIMEOUT;

    @XmlAttribute
    @Builder.Default
    private DiversionTreatment diversionTreatment = DiversionTreatment.none;

    @XmlAttribute
    @Builder.Default
    private DiversionReason diversionReason = DiversionReason.unknown;

    @Override
    public String getVerbName() {
        return TYPE_NAME;
    }
}