com.sinch.sdk.domains.voice.models.webhooks.AnsweredCallEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation

SDK providing a Java API for the Sinch REST APIs.

There is a newer version: 1.4.0

package com.sinch.sdk.domains.voice.models.webhooks;

import java.time.Instant;

/**
 * This callback is made when the call is picked up by the callee (person receiving the call).
 *
 * It's a POST request to the specified calling callback URL. Look here for allowed {@link
 * com.sinch.sdk.domains.voice.models.svaml.Action instructions} and {@link
 * com.sinch.sdk.domains.voice.models.svaml.Instruction actions}.
 *
 * 
If there is no response to the callback within the timeout period, the call is connected.
 *
 * 
If you have Answering Machine Detection (AMD) enabled, the amd
 * object will also be present on ACE callbacks.
 *
 * Note: ACE Callbacks are not issued for InApp Calls (destination: username), only PSTN and SIP
 * calls.
 *
 * @see ACE
 */
public class AnsweredCallEvent extends CallEvent {

  private final AmdAnswer amd;

  private AnsweredCallEvent(
      String callId, Instant timestamp, Integer version, String custom, AmdAnswer amd) {
    super(callId, timestamp, version, custom);
    this.amd = amd;
  }

  /**
   * If Answering Machine Detection is enabled, this object contains information about whether the
   * call was answered by a machine.
   *
   * @return AMD Answer value
   */
  public AmdAnswer getAmd() {
    return amd;
  }

  @Override
  public String toString() {
    return "AnsweredCallEvent{" + "amd=" + amd + "} " + super.toString();
  }

  public static Builder builder() {
    return new Builder<>();
  }

  public static class Builder> extends CallEvent.Builder> {

    AmdAnswer amd;

    public Builder setAmd(AmdAnswer amd) {
      this.amd = amd;
      return this;
    }

    public AnsweredCallEvent build() {
      return new AnsweredCallEvent(callId, timestamp, version, custom, amd);
    }

    @Override
    @SuppressWarnings("unchecked")
    protected B self() {
      return (B) this;
    }
  }
}