GET /api/v1/call_recording_rules
List Call Recording Retention records.

Params

Param name
Description
ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

columns
Optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • user_id
  • sortable_order
  • description
  • recording_type
  • retention_seconds
  • offer_id
  • schedule_id
  • buyer_id
  • traffic_source_id
  • completed_at
  • Must be String

root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off


GET /api/v1/call_recording_rules/new
Build Call Recording Retention with defaults.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String

recording_type
Optional Blank Value Allowed

This type of recording will be deleted once the retention period has passed.

  • Must be one of: call, consumer_and_agent, consumer_and_buyer.

retention_seconds
Optional Blank Value Allowed

If a recording is older than this many seconds, it will be deleted.

  • Must be a decimal number.

offer_id
Optional Blank Value Allowed

Only recordings matching this offer will be deleted after the retention period.

schedule_id
Optional Blank Value Allowed

Only recordings matching this Schedule will be deleted after the retention period.

buyer_id
Optional Blank Value Allowed

Only recordings matching this Buyer will be deleted after the retention period.

traffic_source_id
Optional Blank Value Allowed

Only recordings matching this Traffic Source will be deleted after the retention period.


POST /api/v1/call_recording_rules
Create Call Recording Retention.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String

recording_type
Optional Blank Value Allowed

This type of recording will be deleted once the retention period has passed.

  • Must be one of: call, consumer_and_agent, consumer_and_buyer.

retention_seconds
Optional Blank Value Allowed

If a recording is older than this many seconds, it will be deleted.

  • Must be a decimal number.

offer_id
Optional Blank Value Allowed

Only recordings matching this offer will be deleted after the retention period.

schedule_id
Optional Blank Value Allowed

Only recordings matching this Schedule will be deleted after the retention period.

buyer_id
Optional Blank Value Allowed

Only recordings matching this Buyer will be deleted after the retention period.

traffic_source_id
Optional Blank Value Allowed

Only recordings matching this Traffic Source will be deleted after the retention period.


GET /api/v1/call_recording_rules/:id
Get Call Recording Retention by id.


PUT /api/v1/call_recording_rules/:id
Update Call Recording Retention by id.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String

recording_type
Optional Blank Value Allowed

This type of recording will be deleted once the retention period has passed.

  • Must be one of: call, consumer_and_agent, consumer_and_buyer.

retention_seconds
Optional Blank Value Allowed

If a recording is older than this many seconds, it will be deleted.

  • Must be a decimal number.

offer_id
Optional Blank Value Allowed

Only recordings matching this offer will be deleted after the retention period.

schedule_id
Optional Blank Value Allowed

Only recordings matching this Schedule will be deleted after the retention period.

buyer_id
Optional Blank Value Allowed

Only recordings matching this Buyer will be deleted after the retention period.

traffic_source_id
Optional Blank Value Allowed

Only recordings matching this Traffic Source will be deleted after the retention period.


DELETE /api/v1/call_recording_rules/:id
Destroy Call Recording Retention by id.