View Source PlacetelAPI.Api.Recordings (placetel_api v2.0.0)

API calls for all endpoints tagged Recordings.

Link to this section Summary

Functions

Delete a recording Delete a recording by its ID

Fetch call recordings Provides a list of all call recordings

Fetch specific recording Fetch recording

Link to this section Functions

Link to this function

delete_recordings_id(connection, id, opts \\ [])

View Source
@spec delete_recordings_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete a recording Delete a recording by its ID

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Recording ID
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_recordings(connection, opts \\ [])

View Source
@spec get_recordings(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [PlacetelAPI.Model.Recording.t()]} | {:error, Tesla.Env.t()}

Fetch call recordings Provides a list of all call recordings

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :"filter[direction]" ([String.t]):
    • :"filter[from]" (String.t):
    • :"filter[to]" (String.t):
    • :"filter[date]" (Date.t): YYYY-MM-DD
    • :order (String.t):
    • :page (integer()): Page of results to fetch.
    • :per_page (integer()): Number of results to return per page.

returns

Returns

  • {:ok, [%Recording{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_recordings_id(connection, id, opts \\ [])

View Source
@spec get_recordings_id(Tesla.Env.client(), integer(), keyword()) ::
  {:ok, PlacetelAPI.Model.Recording.t()} | {:error, Tesla.Env.t()}

Fetch specific recording Fetch recording

parameters

Parameters

  • connection (PlacetelAPI.Connection): Connection to server
  • id (integer()): Recording ID
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, PlacetelAPI.Model.Recording.t} on success
  • {:error, Tesla.Env.t} on failure