Initiate FastAGI session on new connection. Parse AGI input and setup connection socket.

Run commands in current session.

@spec answer(sess :: t()) :: response()

Answers channel if not already in answer state.

@spec asyncagi_break(sess :: t()) :: response()

Interrupts Async AGI. Interrupts expected flow of Async AGI commands and returns control. to previous source (typically, the PBX dialplan)

@spec autohangup(sess :: t(), time :: integer()) :: response()

Cause the channel to automatically hangup at time seconds in the future. Of course it can be hungup before then as well. Setting to 0 will cause the autohangup feature to be disabled on this channel

@spec channel_status(sess :: t(), chan :: String.t()) :: response()

Returns status of the connected channel. If no channel name is given (empty line) then returns the status of the current channel

@spec close(sess :: t()) :: :ok

Close session connection

@spec control_stream_file(
  sess :: t(),
  filename :: String.t(),
  escape_digits :: String.t(),
  skip_ms :: integer(),
  ff_chr :: String.t(),
  rew_chr :: String.t(),
  pause_chr :: String.t(),
  offset_ms :: integer()
) :: response()

Sends audio file on channel and allows the listener to control the stream.

@spec database_del(sess :: t(), family :: String.t(), key :: String.t()) :: response()

Deletes an entry in the Asterisk database for a given family and key

@spec database_deltree(sess :: t(), family :: String.t(), keytree :: String.t()) ::
  response()

Deletes a family or specific keytree within a family in the Asterisk database

@spec database_get(sess :: t(), family :: String.t(), key :: String.t()) :: response()

Retrieves an entry in the Asterisk database for a given family and key

@spec database_put(
  sess :: t(),
  family :: String.t(),
  key :: String.t(),
  value :: String.t()
) ::
  response()

Adds or updates an entry in the Asterisk database for a given family, key, and value

@spec env(sess :: t(), name :: String.t()) :: {:ok, String.t()} | :error

Get AGI environment variable by key

@spec exec(sess :: t(), application :: String.t(), options :: String.t()) ::
  response()

Executes application with given options

@spec get_data(
  sess :: t(),
  file :: String.t(),
  timeout :: integer(),
  maxdigits :: integer()
) ::
  response()

Stream the given file, and receive DTMF data. Returns the digits received from the channel at the other end

@spec get_full_variable(sess :: t(), name :: String.t(), chan_name :: String.t()) ::
  response()

Evaluates the given expression against the channel specified by channelname, or the current channel if channelname is not provided

@spec get_option(
  sess :: t(),
  filename :: String.t(),
  escape_digits :: String.t(),
  timeout :: integer()
) :: response()

Stream file, prompt for DTMF, with timeout. Behaves similar to STREAM FILE but used with a timeout option.

@spec get_variable(sess :: t(), name :: String.t()) :: response()

Gets a channel variable

@spec gosub(
  sess :: t(),
  context :: String.t(),
  exten :: String.t(),
  priority :: String.t(),
  args :: String.t()
) :: response()

Cause the channel to execute the specified dialplan subroutine

@spec hangup(sess :: t()) :: response()

Hangup a channel

@spec init(data :: String.t()) :: {:ok, t()} | {:error, term()}

Initiate from new AGI session

@spec receive_char(sess :: t(), timeout :: integer()) :: response()

Receives one character from channels supporting it

@spec receive_text(sess :: t(), timeout :: integer()) :: response()

Receives text from channels supporting it

@spec record_file(
  sess :: t(),
  filename :: String.t(),
  format :: String.t(),
  escape_digits :: String.t(),
  timeout :: integer(),
  offset :: integer(),
  beep :: boolean(),
  silence :: integer()
) :: response()

Record to a file until a given dtmf digit in the sequence is received

@spec say_alpha(sess :: t(), number :: String.t(), escape_digits :: String.t()) ::
  response()

Says a given character string

@spec say_date(sess :: t(), date :: integer(), escape_digits :: String.t()) ::
  response()

Says a given date. date - Is number of seconds elapsed since 00:00:00 on January 1, 1970. Coordinated Universal Time (UTC).

@spec say_datetime(
  sess :: t(),
  time :: integer(),
  escape_digits :: String.t(),
  format :: String.t(),
  timezone :: String.t()
) :: response()

Says a given time as specified by the format given

@spec say_digits(sess :: t(), number :: String.t(), escape_digits :: String.t()) ::
  response()

Say a given digit string, returning early if any of the given DTMF digits are received on the channel

@spec say_number(
  sess :: t(),
  number :: String.t(),
  escape_digits :: String.t(),
  gender :: String.t()
) :: response()

Say a given number, returning early if any of the given DTMF digits are received on the channel

@spec say_phonetic(sess :: t(), string :: String.t(), escape_digits :: String.t()) ::
  response()

Say a given character string with phonetics, returning early if any of the given DTMF digits are received on the channel

@spec say_time(sess :: t(), time :: integer(), escape_digits :: String.t()) ::
  response()

Say a given time, returning early if any of the given DTMF digits are received on the channel

@spec send_image(sess :: t(), image :: String.t()) :: response()

Sends the given image on a channel. Most channels do not support the transmission of images

@spec send_text(sess :: t(), text :: String.t()) :: response()

Sends the given text on a channel. Most channels do not support the transmission of text

@spec set_callerid(sess :: t(), number :: String.t()) :: response()

Changes the callerid of the current channel

@spec set_context(sess :: t(), context :: String.t()) :: response()

Sets the context for continuation upon exiting the application

@spec set_extension(sess :: t(), exten :: String.t()) :: response()

Changes the extension for continuation upon exiting the application

@spec set_music(sess :: t(), enable :: boolean(), class :: String.t()) :: response()

Enables/Disables the music on hold generator. If class is not specified, then the default music on hold class will be used

@spec set_priority(sess :: t(), priority :: String.t()) :: response()

Changes the priority for continuation upon exiting the application. The priority must be a valid priority or label

@spec set_variable(sess :: t(), name :: String.t(), value :: String.t()) :: response()

Sets a variable to the current channel

@spec stream_file(
  sess :: t(),
  file :: String.t(),
  escape_digits :: String.t(),
  offset :: integer()
) :: response()

Send the given file, allowing playback to be interrupted by the given digits, if any

@spec tdd_mode(sess :: t(), enable :: boolean()) :: response()

Enable/Disable TDD transmission/reception on a channel

@spec verbose(sess :: t(), msg :: String.t(), level :: integer()) :: response()

Sends message to the console via verbose message system. level is the verbose level (1-4)

@spec wait_for_digit(sess :: t(), timeout :: integer()) :: response()

Waits up to timeout milliseconds for channel to receive a DTMF digit