Skip to main content

Frequency Documentation

Unscheduled Live

Hostname

https://prd-freq.frequency.com/api/2.3

Linear Channel Details

Return channel details associated to the account

Fields returned: title, description, status, linear_channel_id, linear_channel_override_status

Endpoint

GET /api/2.2/linear_channels

Parameters

Description

Data Type

Example

status

Optional. Returns channels based on their status. Accepted values:

  • All (default)

  • ERROR

  • OFFLINE

  • ON_AIR

  • PENDING_OFFLINE

  • PENDING_ON_AIR

string

from=2023-11-01

sort

Optional. Sorts list of channels by the following accepted values:

  • lastModifiedDate.desc (default)

  • lastModifiedDate

  • createdDate

  • title

  • linearChannelId

string

sort=lastModifiedDate.asc

linear_channel_name

Optional. Search a specific channel name.

string

linear_channel_name=My Channel Title

Request

Example

curl --location --request GET 'https://prd-freq.frequency.com/api/2.2/linear_channels?sort=lastModifiedDate.asc&status=ON_AIR&linear_channel_name=My Channel Title' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'

Response

Body

Switch Channels to Live

Bulk switch channels to live using an HLS url in the request payload.

FIelds returned: title, description, status, linear_channel_id, linear_channel_override_status, distributor, minutes_watched

Endpoint

POST /api/2.2/linear_channels/override

Request

Example

curl --location --request POST 'https://prd-freq.frequency.com/api/2.2/linear_channels/override' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'
--data '[
  {
    "title": "WBFF-Test",
    "description": "dummy description",
    "url": "http://test-freq-sbg-id3-transformation.frequency.com/KOKH_NEW.m3u8",
    "linear_channel_id": "1589"
  },
  {
    "title": "111",
    "description": "Description",
    "url": "http://test-freq-sbg-id3-transformation.frequency.com/KOKH_NEW.m3u8",
    "linear_channel_id": "1480"
  }
]'

Response

Body

Switch to Rescue Slate

Changes the stream to the technical difficulties fallback asset.

Fields returned: linear_channel_id, linear_channel_name, program_start_time, program_end_time, program_duration, program_id, program_title, program_description, series_name, season_number, episode_number, video_id

Endpoint

POST /api/2.2/linear_channels/override/rescue_slate

Request

Example

curl --location --request POST 'https://prd-freq.frequency.com/api/2.2/linear_channels/override/rescue_slate' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'
--data '[
  {
    "title": "WBFF-Test",
    "description": "dummy description",
    "url": "http://test-freq-sbg-id3-transformation.frequency.com/KOKH_NEW.m3u8",
    "linear_channel_id": "1589"
  },
  {
    "title": "111",
    "description": "Description",
    "url": "http://test-freq-sbg-id3-transformation.frequency.com/KOKH_NEW.m3u8",
    "linear_channel_id": "1480"
  }
]'

Response

Body

Return to Schedule

Bulk channel return to schedule. Synchronization with Unscheduled Live Switching with Studio front-end.

Fields returned: linear_channel_id, linear_channel_name, program_start_time, program_end_time, program_duration, program_id, program_title, component_type, component_start_time, component_duration, component_reference_id, component_title, series_name, season_number, episode_number

Endpoint

POST /api/2.2/linear_channels/return_to_schedule

Request

Example

curl --location --request GET 'https://prd-freq.frequency.com/api/2.3/reports/component/schedules?from=2023-09-01&to=2023-09-03' \
--header 'Content-Type: application/json' \
--header 'x-frequency-auth: dd61135eba-2c1cc8e4-37cc5e-3d54e0c2' \
--header 'x-frequency-deviceid: 8b7f9c2d-4a16-b8e5'
--data '[
  {
    "linear_channel_id": "1589"
  },
  {
    "linear_channel_id": "1480"
  }
]'

Response

Body

In this section: