Class: Telnyx::Resources::Texml::Accounts::Calls::RecordingsJson

Inherits:

Object

• Object
• Telnyx::Resources::Texml::Accounts::Calls::RecordingsJson

Defined in:

lib/telnyx/resources/texml/accounts/calls/recordings_json.rb

Overview

TeXML REST Commands

Instance Method Summary

• #initialize(client:) ⇒ RecordingsJson constructor private

  A new instance of RecordingsJson.

• #recordings_json(call_sid, account_sid:, play_beep: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_track: nil, send_recording_url: nil, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonResponse

  Some parameter documentations has been truncated, see Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonParams for more details.

• #retrieve_recordings_json(call_sid, account_sid:, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRetrieveRecordingsJsonResponse

  Returns recordings for a call identified by call_sid.

Constructor Details

#initialize(client:) ⇒ RecordingsJson

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of RecordingsJson.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/texml/accounts/calls/recordings_json.rb', line 88

def initialize(client:)
  @client = client
end

Instance Method Details

#recordings_json(call_sid, account_sid:, play_beep: nil, recording_channels: nil, recording_status_callback: nil, recording_status_callback_event: nil, recording_status_callback_method: nil, recording_track: nil, send_recording_url: nil, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonResponse

Some parameter documentations has been truncated, see Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonParams for more details.

Starts recording with specified parameters for call idientified by call_sid.

Parameters:

• call_sid (String) —

  Path param: The CallSid that identifies the call to update.

• account_sid (String) —

  Path param: The id of the account the resource belongs to.

• play_beep (Boolean) —

  Body param: Whether to play a beep when recording is started.

• recording_channels (Symbol, Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonParams::RecordingChannels) —

  Body param: When ‘dual`, final audio file has the first leg on channel A, and th

• recording_status_callback (String) —

  Body param: Url where status callbacks will be sent.

• recording_status_callback_event (String) —

  Body param: The changes to the recording’s state that should generate a call to

• recording_status_callback_method (Symbol, Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonParams::RecordingStatusCallbackMethod) —

  Body param: HTTP method used to send status callbacks.

• recording_track (Symbol, Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonParams::RecordingTrack) —

  Body param: The audio track to record for the call. The default is ‘both`.

• send_recording_url (Boolean) —

  Body param: Whether to send RecordingUrl in webhooks.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonResponse)

See Also:

• Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonParams

# File 'lib/telnyx/resources/texml/accounts/calls/recordings_json.rb', line 41

def recordings_json(call_sid, params)
  parsed, options = Telnyx::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonParams.dump_request(params)
  account_sid =
    parsed.delete(:account_sid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :post,
    path: ["texml/Accounts/%1$s/Calls/%2$s/Recordings.json", account_sid, call_sid],
    headers: {"content-type" => "application/x-www-form-urlencoded"},
    body: parsed,
    model: Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRecordingsJsonResponse,
    options: options
  )
end

#retrieve_recordings_json(call_sid, account_sid:, request_options: {}) ⇒ Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRetrieveRecordingsJsonResponse

Returns recordings for a call identified by call_sid.

Parameters:

• call_sid (String) —

  The CallSid that identifies the call to update.

• account_sid (String) —

  The id of the account the resource belongs to.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRetrieveRecordingsJsonResponse)

See Also:

• Models::Texml::Accounts::Calls::RecordingsJsonRetrieveRecordingsJsonParams

# File 'lib/telnyx/resources/texml/accounts/calls/recordings_json.rb', line 70

def retrieve_recordings_json(call_sid, params)
  parsed, options =
    Telnyx::Texml::Accounts::Calls::RecordingsJsonRetrieveRecordingsJsonParams.dump_request(params)
  account_sid =
    parsed.delete(:account_sid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["texml/Accounts/%1$s/Calls/%2$s/Recordings.json", account_sid, call_sid],
    model: Telnyx::Models::Texml::Accounts::Calls::RecordingsJsonRetrieveRecordingsJsonResponse,
    options: options
  )
end