List recordings of an account

v1.0.0

List available on an Account.

To access a password protected cloud recording, add an "access_token" parameter to the download URL and provide as the value of the "access_token".

Prerequisites:

A Pro or a higher paid plan with Cloud Recording option enabled.
Scopes: recording:read:admin or account:read:admin

If the scope recording:read:admin is used, the Account ID of the Account must be provided in the accountId path parameter to list recordings that belong to the Account. This scope only works for sub accounts.

To list recordings of a master account, the scope must be account:read:admin and the value of accountId should be me.
: Medium

Input

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string"
    },
    "from": {
      "type": "string",
      "format": "date-time"
    },
    "next_page_token": {
      "type": "string"
    },
    "page_size": {
      "type": "integer"
    },
    "to": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": [
    "accountId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "from": {
      "type": "string",
      "format": "date-time",
      "description": "The start date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month. If no value is provided for this field, the default will be current date. For example, if you make the API request on June 30, 2020, without providing the “from” and “to” parameters, by default the value of 'from' field will be “2020-06-30” and the value of the 'to' field will be “2020-07-01”."
    },
    "meetings": {
      "type": "array",
      "description": "Meetings Object",
      "items": {
        "type": "object",
        "properties": {
          "duration": {
            "type": "integer",
            "description": "The scheduled duration of the meeting."
          },
          "host_id": {
            "type": "string",
            "description": "User ID of the user who is set as the host of the meeting."
          },
          "id": {
            "type": "string",
            "description": "Meeting ID - Unique Identifier of a meeting, also known as Meeting Number."
          },
          "recording_count": {
            "type": "integer",
            "description": "The total number of recordings retrieved from the account."
          },
          "recording_files": {
            "type": "array",
            "description": "Recording files object",
            "items": {
              "type": "object",
              "properties": {
                "download_url": {
                  "type": "string",
                  "description": "The URL using which the recording can be downloaded"
                },
                "file_size": {
                  "type": "number",
                  "description": "The size of the recording file in bytes."
                },
                "file_type": {
                  "type": "string",
                  "description": "The recording file type. The value of this field could be one of the following:<br>\n* `MP4`: Video file of the recording.<br>\n* `M4A` Audio-only file of the recording.<br>\n* `TB`: Timestamp file of the recording in JSON format.<br> \n* `TRANSCRIPT`: Transcription file of the recording in VTT format.<br> \n* `CHAT`: A TXT file containing in-meeting chat messages that were sent during the meeting.<br>\n* `CC`: File containing closed captions of the recording in VTT file format.<br>\n* `CSV`: File containing polling data in csv format.\n\nA recording file object with file type of either `CC` or `TB` **does not have** the following properties:<br>\n\t`id`, `status`, `file_size`, `recording_type`, and `play_url`.",
                  "enum": [
                    "MP4",
                    "M4A",
                    "CHAT",
                    "TRANSCRIPT",
                    "CC",
                    "CSV",
                    "TB"
                  ]
                },
                "id": {
                  "type": "string",
                  "description": "Recording ID. Identifier for the recording."
                },
                "meeting_id": {
                  "type": "string",
                  "description": "Universally unique identifier of the meeting instance that was being recorded."
                },
                "play_url": {
                  "type": "string",
                  "description": "The URL using which recording can be played."
                },
                "recording_end": {
                  "type": "string",
                  "description": "The date and time at which the recording ended."
                },
                "recording_start": {
                  "type": "string",
                  "description": "The date and time at which the recording started."
                },
                "recording_type": {
                  "type": "string",
                  "description": "The recording type. The value of this field can be one of the following:<br>\n* `shared_screen_with_speaker_view(CC)`\n* `shared_screen_with_speaker_view`\n* `shared_screen_with_gallery_view`\n* `shared_screen`\n* `active_speaker`\n* `gallery_view`\n* `audio_only`\n* `audio_transcript`\n* `chat_file`\n* `host_video`\n* `closed_caption`\n* `poll`\n* `timeline`\n* `thumbnail`\n",
                  "enum": [
                    "shared_screen_with_speaker_view(CC)",
                    "shared_screen_with_speaker_view",
                    "shared_screen_with_gallery_view",
                    "active_speaker",
                    "gallery_view",
                    "shared_screen",
                    "audio_only",
                    "audio_transcript",
                    "chat_file",
                    "poll",
                    "host_video",
                    "closed_caption",
                    "timeline",
                    "thumbnail"
                  ]
                },
                "status": {
                  "type": "string",
                  "description": "The status of the recording, either `completed` or `processing`. ",
                  "enum": [
                    "completed",
                    "processing"
                  ]
                }
              }
            }
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time at which the meeting started."
          },
          "topic": {
            "type": "string",
            "description": "Meeting topic."
          },
          "total_size": {
            "type": "integer",
            "description": "The total size of the meeting in bytes."
          },
          "uuid": {
            "type": "string",
            "description": "Universally Unique Identifier of a meeting instance. Each meeting instance will have its own meeting UUID."
          }
        }
      }
    },
    "next_page_token": {
      "type": "string",
      "description": "The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes."
    },
    "page_size": {
      "type": "integer",
      "description": "The number of records returned within a single API call."
    },
    "to": {
      "type": "string",
      "format": "date-time",
      "description": "The end date for the monthly range for which you would like to retrieve recordings. The maximum range can be a month."
    },
    "total_records": {
      "type": "integer",
      "description": "Total number of records found for this request across all pages."
    }
  }
}