Type alias GetRecordingsOptions

GetRecordingsOptions: {
    from?: string;
    to?: string;
    days?: number;
    status?: RecordingStatus;
    max?: number;
    serviceType?: string;
    format?: string;
    ownerType?: string;
    storageRegion?: string;
    locationId?: string;
    topic?: string;
    webexUserRequest?: boolean;
}

Options for ICallRecording.getRecordings. All fields are optional and are passed through to the recording API as query parameters where supported. webexUserRequest toggles the WebexUserRequest header (ad-hoc rate-limit bypass), defaulting to false.

Type declaration

  • Optional from?: string

    ISO-8601 start of the time window (inclusive). When omitted, it is derived from days (now - days), mirroring CallHistory's mandatory from date.

  • Optional to?: string

    ISO-8601 end of the time window (inclusive). When omitted, it defaults to the current time (now). The API requires both from and to to return results.

  • Optional days?: number

    Lookback window in days used to derive from when from is not provided. Defaults to 30. The list API only accepts a from/to interval of at most 30 days; larger windows are rejected, so callers must keep custom values within that limit. Ignored when an explicit from is supplied.

  • Optional status?: RecordingStatus

    Filter by recording status. Defaults to available.

  • Optional max?: number

    Maximum number of records to return per page. Defaults to 30.

  • Optional serviceType?: string

    Filter by the service that produced the recording (e.g. 'calling'). Sent only when provided; when omitted the API applies its own default.

  • Optional format?: string

    Filter by recording media format (e.g. 'MP3', 'MP4'). Sent only when provided.

  • Optional ownerType?: string

    Filter by recording owner type (e.g. 'user'). Sent only when provided.

  • Optional storageRegion?: string

    Filter by storage region (e.g. 'US'). Sent only when provided.

  • Optional locationId?: string

    Filter by the location id the recording belongs to. Sent only when provided.

  • Optional topic?: string

    Filter by recording topic. Sent only when provided.

  • Optional webexUserRequest?: boolean

    When true, sends the WebexUserRequest: true header. Defaults to false.

Settings

Member Visibility

Theme